Class LevelSkippingTableauFactory

  • All Implemented Interfaces:
    java.lang.Cloneable, Changeable, Configurable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

    public class LevelSkippingTableauFactory
    extends TableauFactory
    This class is an attribute that creates a tableau to view an object contained by the model associated with the specified effigy. When a model is opened, this object looks for a contained entity with the name given by entityName, or looks for the first contained entity if no name is given, and opens that entity rather than the model associated with the specified effigy.
    Since:
    Ptolemy II 1.0
    Version:
    $Id$
    Author:
    Edward A. Lee
    Pt.AcceptedRating:
    Red (eal)
    Pt.ProposedRating:
    Yellow (eal)
    • Field Detail

      • entityName

        public StringParameter entityName
        The name of the contained entity to open, or an empty string to just open the first one found. This is a string that defaults to empty.
    • Method Detail

      • createTableau

        public Tableau createTableau​(Effigy effigy)
                              throws java.lang.Exception
        Create a tableau for the specified effigy by identifying an object contained by the specified effigy as given by entityName, or the first entity contained by that object if no entityName is given. If the specified effigy is not an instance of PtolemyEffigy, this simply return null. If the model associated with the effigy does not contain the specified entity, then also return null.
        Overrides:
        createTableau in class TableauFactory
        Parameters:
        effigy - The model effigy.
        Returns:
        A tableau for the effigy, or null if one cannot be created.
        Throws:
        java.lang.Exception - If the factory should be able to create a Tableau for the effigy, but something goes wrong.