ptolemy.homer.kernel

Class HomerWidgetElement

java.lang.Object

ptolemy.homer.kernel.PositionableElement

ptolemy.homer.kernel.HomerWidgetElement

public class HomerWidgetElement
extends PositionableElement

The definition of any named object that has a Netbeans widget representation.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Peter Foldes

Pt.AcceptedRating:

Red (pdf)

Pt.ProposedRating:

Red (pdf)

Constructor Summary

Constructors

Constructor and Description
HomerWidgetElement(NamedObj element, org.netbeans.api.visual.widget.Scene scene) Create a new definition of an element.

Method Summary

Modifier and Type	Method and Description
void	addToContainer(PortableContainer container) It's normally used to add the visual representation of the element to the provided container.
org.netbeans.api.visual.widget.Widget	getWidget() Return the Netbeans widget representing the element.

Methods inherited from class ptolemy.homer.kernel.PositionableElement

getElement, getLocation, getTab, setLocation, setTab

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HomerWidgetElement

public HomerWidgetElement(NamedObj element,
                          org.netbeans.api.visual.widget.Scene scene)

Create a new definition of an element.

Parameters:

element - The Ptolemy named object to wrap.

scene - The graphical area where the widget representing the element will be added to.

Method Detail

addToContainer

public void addToContainer(PortableContainer container)
                    throws IllegalActionException

It's normally used to add the visual representation of the element to the provided container. In this case getWidget() should be used to get the representation, and added to the container manually.

Specified by:

addToContainer in class PositionableElement

Parameters:

container - The container to place the representation in. Not used.

Throws:

IllegalActionException - The method will always return the exception. Use getWidget() instead.

getWidget

public org.netbeans.api.visual.widget.Widget getWidget()

Return the Netbeans widget representing the element. If it's not yet created, this method will create it.

Returns:

The Netbeans widget representing the element.