Package ptolemy.actor.gui

Class SizeAttribute

  • All Implemented Interfaces:
    java.awt.event.ComponentListener, java.lang.Cloneable, java.util.EventListener, HasTypeConstraints, Typeable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable, ValueListener
    public class SizeAttribute
extends Parameter
implements java.awt.event.ComponentListener
    This attribute stores the width and height of a graphical component. The token in this attribute is an IntMatrixToken containing a matrix of dimension 1x2, containing the width and the height, in that order. By default, this attribute has visibility NONE, so the user will not see it in parameter editing dialogs.

    Note that this attribute is typically used to record the size of a component within a frame (a top-level window). To record the size and position of the frame, use WindowPropertiesAttribute.

    Since:
    Ptolemy II 1.0
    Version:
    $Id$
    Author:
    Edward A. Lee
    See Also:
    WindowPropertiesAttribute
    Pt.AcceptedRating:
    Red (johnr)
    Pt.ProposedRating:
    Red (eal)

    • Constructor Detail

      • SizeAttribute

        public SizeAttribute​(NamedObj container,
                     java.lang.String name)
              throws IllegalActionException,
                     NameDuplicationException
        Construct an attribute with the given name contained by the specified entity. The container argument must not be null, or a NullPointerException will be thrown. This attribute will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace.
        Parameters:
        container - The container.
        name - The name of this attribute.
        Throws:
        IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.
        NameDuplicationException - If the name coincides with an attribute already in the container.

    • Method Detail

      • clone

        public java.lang.Object clone​(Workspace workspace)
                       throws java.lang.CloneNotSupportedException
        Clone the attribute into the specified workspace. This calls the base class and then sets the attribute public members to refer to the attributes of the new attribute.
        Overrides:
        clone in class Parameter
        Parameters:
        workspace - The workspace for the new attribute
        Returns:
        A new director.
        Throws:
        java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.
        See Also:
        Object.clone()

      • componentHidden

        public void componentHidden​(java.awt.event.ComponentEvent event)
        Do nothing. This method is invoked when the component has been made invisible.
        Specified by:
        componentHidden in interface java.awt.event.ComponentListener
        Parameters:
        event - The component event.

      • componentMoved

        public void componentMoved​(java.awt.event.ComponentEvent event)
        Do nothing. This method is invoked when the component's position changes.
        Specified by:
        componentMoved in interface java.awt.event.ComponentListener
        Parameters:
        event - The component event.

      • componentResized

        public void componentResized​(java.awt.event.ComponentEvent event)
        Record the new size. This method is invoked when the component's size changes.
        Specified by:
        componentResized in interface java.awt.event.ComponentListener
        Parameters:
        event - The component event.

      • componentShown

        public void componentShown​(java.awt.event.ComponentEvent event)
        Do nothing. This method is invoked when the component has been made visible.
        Specified by:
        componentShown in interface java.awt.event.ComponentListener
        Parameters:
        event - The component event.

      • recordSize

        public void recordSize​(java.awt.Component component)
        Set the value of the attribute to match those of the specified component.
        Parameters:
        component - The component whose size is to be recorded.

      • setSize

        public boolean setSize​(java.awt.Component component)
        Set the size of the specified component to match the current value of the attribute. If the value of the attribute has not been set, then do nothing. If it has not already done so, this method also registers with the component as a listener for component events like resizing.
        Parameters:
        component - The component whose size is to be set.
        Returns:
        True if successful.