ptolemy.homer.kernel

Class HomerMultiContent

java.lang.Object

ptolemy.homer.kernel.MultiContent<TabScenePanel>

ptolemy.homer.kernel.HomerMultiContent

public class HomerMultiContent
extends MultiContent<TabScenePanel>

The class responsible for displaying the content area and managing the tab creation, removal, and event propagation.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Peter Foldes

Pt.AcceptedRating:

Red (pdf)

Pt.ProposedRating:

Red (pdf)

Constructor Summary

Constructors

Constructor and Description
HomerMultiContent(TabScenePanel contentPrototype) Create a content container.
HomerMultiContent(TabScenePanel contentPrototype, CompositeEntity model) Create a content container.

Method Summary

Modifier and Type	Method and Description
void	add(NamedObj element) Add a NamedObj element and notify all listeners.
void	addElement(java.lang.String tabTag, PositionableElement element) Add a positionable element to the selected tab.
void	addListener(java.awt.event.ActionListener listener) Add an action listener.
java.lang.String	addTab(ComponentEntity topLevel, java.lang.String tag, java.lang.String name, ContentPrototype content) Add a tab with the provided parameters.
void	clear() Clear the contents, but keep all the listeners attached.
boolean	contains(NamedObj key) Determine if the NamedObj already exists.
java.util.HashSet<NamedObj>	getRemoteElements() Get the remote model elements.
void	remove(NamedObj element) Remove the NamedObj element and notify all listeners.
void	removeElement(PositionableElement element) Remove the positionable element and its associated NamedObj.
void	removeListener(java.awt.event.ActionListener listener) Remove an action listener.
void	removeTab(int index) Remove a tab at the provided index.
void	removeTab(java.lang.String tag) Remove the tab given its tag.
void	setNameAt(int position, java.lang.String text) Rename a content area at a given position.

Methods inherited from class ptolemy.homer.kernel.MultiContent

_getContents, _getOrder, _initializeContents, addTab, addTab, addTab, getAllTabs, getContent, getElement

Methods inherited from class java.lang.Object

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

Constructor Detail

HomerMultiContent

public HomerMultiContent(TabScenePanel contentPrototype)

Create a content container.

Parameters:

contentPrototype - A prototype of the content area. This prototype is used to create multiple content areas on demand.

HomerMultiContent

public HomerMultiContent(TabScenePanel contentPrototype,
                         CompositeEntity model)
                  throws IllegalActionException,
                         NameDuplicationException

Create a content container.

Parameters:

contentPrototype - A prototype of the content area. This prototype is used to create multiple content areas on demand.

model - The model to be parsed.

Throws:

IllegalActionException - If any of the elements can't be placed into a content area.

NameDuplicationException - If multiple elements exist with the same name. Element names within a workspace must be unique.

Method Detail

add

public void add(NamedObj element)

Add a NamedObj element and notify all listeners.

Parameters:

element - The NamedObj to be added.

addElement

public void addElement(java.lang.String tabTag,
                       PositionableElement element)
                throws IllegalActionException

Add a positionable element to the selected tab.

Overrides:

addElement in class MultiContent<TabScenePanel>

Parameters:

tabTag - The tag of the target tab.

element - The positionable element.

Throws:

IllegalActionException - If the content area is not set.

addListener

public void addListener(java.awt.event.ActionListener listener)

Add an action listener.

Parameters:

listener - The listener to add.

addTab

public java.lang.String addTab(ComponentEntity topLevel,
                               java.lang.String tag,
                               java.lang.String name,
                               ContentPrototype content)
                        throws IllegalActionException,
                               NameDuplicationException

Add a tab with the provided parameters.

Overrides:

addTab in class MultiContent<TabScenePanel>

Parameters:

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.

tag - The tag identifier used for the content area.

name - Name of the tab. Can be used for visualization.

content - The specific content for the new tab.

Returns:

The tag identifier of the tab.

Throws:

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

NameDuplicationException - If the attribute is not of an acceptable class for the container, if the name contains a period, or if a content area with the same tag already exist.

clear

public void clear()

Clear the contents, but keep all the listeners attached.

Overrides:

clear in class MultiContent<TabScenePanel>

contains

public boolean contains(NamedObj key)

Determine if the NamedObj already exists.

Parameters:

key - The NamedObj object to look for.

Returns:

Whether or not the NamedObj is already marked as remote.

getRemoteElements

public java.util.HashSet<NamedObj> getRemoteElements()

Get the remote model elements.

Returns:

The hashset of NamedObj elements.

remove

public void remove(NamedObj element)

Remove the NamedObj element and notify all listeners.

Parameters:

element - The NamedObj to be removed.

removeElement

public void removeElement(PositionableElement element)

Remove the positionable element and its associated NamedObj.

Overrides:

removeElement in class MultiContent<TabScenePanel>

Parameters:

element - The positionable element to be removed.

removeListener

public void removeListener(java.awt.event.ActionListener listener)

Remove an action listener.

Parameters:

listener - The listener to remove.

See Also:

addListener(ActionListener)

removeTab

public void removeTab(int index)

Remove a tab at the provided index.

Parameters:

index - The ordinal position of the tab to remove.

removeTab

public void removeTab(java.lang.String tag)

Remove the tab given its tag.

Overrides:

removeTab in class MultiContent<TabScenePanel>

Parameters:

tag - The identifier of the tab to be removed.

setNameAt

public void setNameAt(int position,
                      java.lang.String text)
               throws IllegalActionException

Rename a content area at a given position.

Overrides:

setNameAt in class MultiContent<TabScenePanel>

Parameters:

position - The position of the tab.

text - The new title of the tab.

Throws:

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