ptolemy.homer.kernel

Class TabDefinition

java.lang.Object

ptolemy.homer.kernel.TabDefinition

public class TabDefinition
extends java.lang.Object

Define tab properties and content.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Peter Foldes

Pt.AcceptedRating:

Red (pdf)

Pt.ProposedRating:

Red (pdf)

Constructor Summary

Constructors

Constructor and Description
TabDefinition(ComponentEntity topLevel, java.lang.String tag, java.lang.String name) Tab element to hold the content for visual representation.

Method Summary

Modifier and Type	Method and Description
void	addContent(PositionableElement element) Add an element to the contents of this tab.
java.lang.Object	getContent() Remove an element to the contents of this tab. /** Return the content area of the tab.
java.util.ArrayList<PositionableElement>	getElements() Get all the elements on this tab.
java.lang.String	getName() Get the name of the tab.
StringAttribute	getTabAttribute() Get the underlying Ptolemy object representing the tab.
java.lang.String	getTag() Get the tag used to identify the tab.
void	removeContent(PositionableElement element) Remove an element to the contents of this tab.
void	setContent(ContentPrototype content) Set the content area of the tab.
void	setName(java.lang.String name) Set the name of the tab.

Methods inherited from class java.lang.Object

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

Constructor Detail

TabDefinition

public TabDefinition(ComponentEntity topLevel,
                     java.lang.String tag,
                     java.lang.String name)
              throws IllegalActionException,
                     NameDuplicationException

Tab element to hold the content for visual representation.

Parameters:

tag - The tag used to identify this tab.

name - The name of the tab. This will used in the user interface.

topLevel - The container containing all tab definitions. If the container does not have the attribute that contains all tab definition information, it will be created.

Throws:

NameDuplicationException - If the name coincides with an attribute already in the container.

IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.

Method Detail

addContent

public void addContent(PositionableElement element)
                throws IllegalActionException

Add an element to the contents of this tab. The element has to have at least the location defined.

Parameters:

element - Ptolemy element with location defined.

Throws:

IllegalActionException - If the element cannot be added to the tab content area, or if the tab content area has not been set.

See Also:

setContent(ContentPrototype)

getContent

public java.lang.Object getContent()

Remove an element to the contents of this tab. /** Return the content area of the tab.

Returns:

The content area of the tab, or null if it has not been set.

See Also:

setContent(ContentPrototype)

getName

public java.lang.String getName()

Get the name of the tab.

Returns:

The name of the tab.

See Also:

setName(String)

getTabAttribute

public StringAttribute getTabAttribute()

Get the underlying Ptolemy object representing the tab.

Returns:

The Ptolemy object representing the tab.

getTag

public java.lang.String getTag()

Get the tag used to identify the tab.

Returns:

The tag of the tab.

setContent

public void setContent(ContentPrototype content)

Set the content area of the tab.

Parameters:

content - The content to be used in the tab.

See Also:

getContent()

setName

public void setName(java.lang.String name)
             throws IllegalActionException

Set the name of the tab.

Parameters:

name - The new name of the tab.

Throws:

IllegalActionException - If the new name is not accepted by the model.

See Also:

getName()

removeContent

public void removeContent(PositionableElement element)
                   throws IllegalActionException

Remove an element to the contents of this tab.

Parameters:

element - Ptolemy element with location defined.

Throws:

IllegalActionException - If the element cannot be removed from the tab content area, or if the tab content area has not been set.

getElements

public java.util.ArrayList<PositionableElement> getElements()

Get all the elements on this tab.

Returns:

List of all elements kept on this tab.