ptolemy.homer.kernel

Class PositionableElement

java.lang.Object

ptolemy.homer.kernel.PositionableElement

Direct Known Subclasses:

AttributeElement, EntityElement, HomerWidgetElement

public abstract class PositionableElement
extends java.lang.Object

Abstract definition of elements.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Peter Foldes

Pt.AcceptedRating:

Red (pdf)

Pt.ProposedRating:

Red (pdf)

Constructor Summary

Constructors

Constructor and Description
PositionableElement(NamedObj element) Store the element that should have its location defined.

Method Summary

Modifier and Type	Method and Description
abstract void	addToContainer(PortableContainer container) Add the visual representation of the element to the provided container.
NamedObj	getElement() Get the underlying element.
HomerLocation	getLocation() Get the location of the element.
java.lang.String	getTab() Get the location of the element.
void	setLocation(int x, int y, int width, int height) Set the location of this element's representation.
void	setTab(java.lang.String tag) Set the tab attribute in the underlying named object wrapped by this element.

Methods inherited from class java.lang.Object

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

Constructor Detail

PositionableElement

public PositionableElement(NamedObj element)

Store the element that should have its location defined.

Parameters:

element - The object with the location defined.

Method Detail

addToContainer

public abstract void addToContainer(PortableContainer container)
                             throws IllegalActionException

Add the visual representation of the element to the provided container.

Parameters:

container - The container to place the representation in.

Throws:

IllegalActionException - If the element cannot be added to the container.

getElement

public NamedObj getElement()

Get the underlying element.

Returns:

The Ptolemy element with Android specific location information.

getLocation

public HomerLocation getLocation()
                          throws IllegalActionException

Get the location of the element.

Returns:

Return the location object of the element.

Throws:

IllegalActionException - If the location of the element is not defined.

See Also:

setLocation(int, int, int, int)

getTab

public java.lang.String getTab()

Get the location of the element.

Returns:

Return the location object of the element.

See Also:

setTab(String)

setLocation

public void setLocation(int x,
                        int y,
                        int width,
                        int height)
                 throws IllegalActionException

Set the location of this element's representation.

Parameters:

x - The x position of the top-left corner.

y - The y position of the top-left corner.

width - The width of the representation.

height - The height of the representation.

Throws:

IllegalActionException - If the location cannot be set.

See Also:

getLocation()

setTab

public void setTab(java.lang.String tag)
            throws IllegalActionException

Set the tab attribute in the underlying named object wrapped by this element.

Parameters:

tag - The tag identifier of the tab this element belongs to.

Throws:

IllegalActionException - If the tab cannot be set.

See Also:

getTab()