ptolemy.homer.kernel

Class MultiContent<T extends ContentPrototype>

java.lang.Object

ptolemy.homer.kernel.MultiContent<T>

Type Parameters:

T - The class implementing a ContentPrototype. It represents a tab that can create one similar to itself using the prototype pattern.

Direct Known Subclasses:

HomerMultiContent

public class MultiContent<T extends ContentPrototype>
extends java.lang.Object

Store a model's element representations on multiple contents.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Peter Foldes

Pt.AcceptedRating:

Red (pdf)

Pt.ProposedRating:

Red (pdf)

Constructor Summary

Constructors

Constructor and Description
MultiContent(T contentPrototype) Create a new multi-content frame based on a content prototype.
MultiContent(T contentPrototype, CompositeEntity model) The constructor takes a model that is parsed for elements with location attributes.

Method Summary

Modifier and Type	Method and Description
protected java.util.HashMap<java.lang.String,TabDefinition>	_getContents() Return the content mapping.
protected java.util.ArrayList<java.lang.String>	_getOrder() Return the order of the contents.
protected void	_initializeContents(ContentPrototype contentPrototype, CompositeEntity model) Parse the model and create the multiple content areas.
void	addElement(java.lang.String tabTag, PositionableElement element) Add an element to a specific content area.
java.lang.String	addTab(ComponentEntity topLevel, java.lang.String tabName) Add a new content area to the MultiContent.
java.lang.String	addTab(ComponentEntity topLevel, java.lang.String tabName, ContentPrototype content) Add a new content area to the MultiContent.
java.lang.String	addTab(ComponentEntity topLevel, java.lang.String tabTag, java.lang.String tabName) Add a new content area to the MultiContent.
java.lang.String	addTab(ComponentEntity topLevel, java.lang.String tabTag, java.lang.String tabName, ContentPrototype content) Add a new content area to the MultiContent with a specific content.
void	clear() Clear all data.
java.util.ArrayList<TabDefinition>	getAllTabs() Get all content areas as a list.
java.lang.Object	getContent(java.lang.String tabTag) Get a content area based on a unique tag value.
PositionableElement	getElement(NamedObj object) Return a positionable element if the named object is in any of the tabs.
void	removeElement(PositionableElement element) Remove an element from all content areas.
void	removeTab(java.lang.String tag) Remove a content area from the contents.
void	setNameAt(int position, java.lang.String text) Rename a content area at a given position.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiContent

public MultiContent(T contentPrototype)

Create a new multi-content frame based on a content prototype.

Parameters:

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

MultiContent

public MultiContent(T contentPrototype,
                    CompositeEntity model)
             throws IllegalActionException,
                    NameDuplicationException

The constructor takes a model that is parsed for elements with location attributes. All that should be represented are parsed and placed in multiple content areas depending on their parameters.

Parameters:

model - The model to be parsed.

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

Throws:

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

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

Method Detail

addTab

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

Add a new content area to the MultiContent with a specific content. The new content area will be the last in order.

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.

tabTag - The tag identifier used for the content area.

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

content - The specific content for the new tab.

Returns:

The tab identifier.

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, if the name contains a period, or if a content area with the same tag already exist.

addTab

public java.lang.String addTab(ComponentEntity topLevel,
                               java.lang.String tabTag,
                               java.lang.String tabName)
                        throws IllegalActionException,
                               NameDuplicationException

Add a new content area to the MultiContent. The new content area will be the last in order.

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.

tabTag - The tag identifier used for the content area.

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

Returns:

The tab identifier.

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, if the name contains a period, or if a content area with the same tag already exist.

addTab

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

Add a new content area to the MultiContent. The new content area will be the last in order.

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.

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

content - The content to use in the new tab.

Returns:

The newly generated tab identifier.

Throws:

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

IllegalActionException - If the tab could not be created in the model.

addTab

public java.lang.String addTab(ComponentEntity topLevel,
                               java.lang.String tabName)
                        throws NameDuplicationException,
                               IllegalActionException

Add a new content area to the MultiContent. The new content area will be the last in order.

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.

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

Returns:

The newly generated tab identifier.

Throws:

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

IllegalActionException - If the tab could not be created in the model.

addElement

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

Add an element to a specific content area.

Parameters:

tabTag - The tag identifying the content area.

element - The element to be added to the content area.

Throws:

IllegalActionException - If the content area is not set.

removeElement

public void removeElement(PositionableElement element)

Remove an element from all content areas.

Parameters:

element - The element to be removed.

getContent

public java.lang.Object getContent(java.lang.String tabTag)

Get a content area based on a unique tag value.

Parameters:

tabTag - The tag that identifies a content area.

Returns:

The content area object.

getAllTabs

public java.util.ArrayList<TabDefinition> getAllTabs()

Get all content areas as a list. This list is ordered based in the ordering in the original model.

Returns:

The ordered list of content areas.

removeTab

public void removeTab(java.lang.String tag)

Remove a content area from the contents.

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.

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.

clear

public void clear()

Clear all data.

getElement

public PositionableElement getElement(NamedObj object)

Return a positionable element if the named object is in any of the tabs.

Parameters:

object - The named object to check.

Returns:

The positionable element wrapping the named object if it's contained, null otherwise.

_getContents

protected java.util.HashMap<java.lang.String,TabDefinition> _getContents()

Return the content mapping.

Returns:

The mapping of tag identifiers to tab definitions.

_getOrder

protected java.util.ArrayList<java.lang.String> _getOrder()

Return the order of the contents.

Returns:

The ordered list of tag identifiers.

_initializeContents

protected void _initializeContents(ContentPrototype contentPrototype,
                                   CompositeEntity model)
                            throws IllegalActionException,
                                   NameDuplicationException

Parse the model and create the multiple content areas. All elements that have positions defined are placed into a content area defined by the elements parameters.

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 places into a content area.

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