ptolemy.homer.kernel

Class LayoutParser

java.lang.Object

ptolemy.homer.kernel.LayoutParser

public class LayoutParser
extends java.lang.Object

Parse the layout XML file for tabs, screen orientation, and individual sink actor placement properties.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Justin Killian

Pt.AcceptedRating:

Red (jkillian)

Pt.ProposedRating:

Red (jkillian)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LayoutParser.ScreenOrientation The different screen orientations possible for the visual representation.

Constructor Summary

Constructors

Constructor and Description
LayoutParser(CompositeEntity topLevelActor) Parse the layout XML file so that the screen display can be set up according to the user's preferences.

Method Summary

Modifier and Type	Method and Description
LayoutParser.ScreenOrientation	getOrientation() Get the orientation of the screen from the parsed layout file.
java.util.ArrayList<AttributeElement>	getPositionableAttributes() Get the attributes with positions defined in the layout file.
java.util.HashSet<NamedObj>	getPositionableElements() Return all elements in the model that has its positions defined.
java.util.ArrayList<EntityElement>	getPositionableEntities() Get the entities with positions defined.
java.util.HashSet<NamedObj>	getProxyElements() Return all the elements in the model marked as proxies.
java.util.ArrayList<TabDefinition>	getTabDefinitions() Get the parsed tabs defined in the layout file.
static boolean	isPositionable(NamedObj node) Return true if the node has location defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutParser

public LayoutParser(CompositeEntity topLevelActor)

Parse the layout XML file so that the screen display can be set up according to the user's preferences.

Parameters:

topLevelActor - Top-level actor of the parsed model file.

Method Detail

getOrientation

public LayoutParser.ScreenOrientation getOrientation()

Get the orientation of the screen from the parsed layout file.

Returns:

The screen orientation (if defined by the layout).

getTabDefinitions

public java.util.ArrayList<TabDefinition> getTabDefinitions()
                                                     throws IllegalActionException,
                                                            NameDuplicationException

Get the parsed tabs defined in the layout file.

Returns:

All the tabs parsed, or null if no tabs were defined.

Throws:

IllegalActionException - If a tab description is incorrect

NameDuplicationException - If there's an error setting the style due to naming issues.

getPositionableEntities

public java.util.ArrayList<EntityElement> getPositionableEntities()
                                                           throws IllegalActionException

Get the entities with positions defined.

Returns:

All the entities with positions parsed.

Throws:

IllegalActionException - If an entity does not implement PortablePlaceable or if the location information is invalid for any of the entities.

getPositionableAttributes

public java.util.ArrayList<AttributeElement> getPositionableAttributes()
                                                                throws IllegalActionException

Get the attributes with positions defined in the layout file.

Returns:

All the attributes with locations parsed.

Throws:

IllegalActionException - If the location information is invalid for any of the attributes, or if the attribute is not Settable.

getProxyElements

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

Return all the elements in the model marked as proxies.

Returns:

The set of all named objects marked as proxies.

getPositionableElements

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

Return all elements in the model that has its positions defined.

Returns:

The set of all named objects with position information.

isPositionable

public static boolean isPositionable(NamedObj node)

Return true if the node has location defined.

Parameters:

node - The named object to check.

Returns:

True if the node has location defined, false otherwise.