Package ptolemy.actor.gui.properties

Class ActionGUIProperty

    • Field Detail

      • parse

        public Parameter parse
        A Boolean parameter that determines whether the moml text should be parsed before applying to the current model in the perform() method.

      • _action

        protected GUIAction _action
        The action.

    • Constructor Detail

      • ActionGUIProperty

        public ActionGUIProperty​(NamedObj container,
                         java.lang.String name)
                  throws IllegalActionException,
                         NameDuplicationException
        Construct a GUI property 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

      • configure

        public void configure​(java.net.URL base,
                      java.lang.String source,
                      java.lang.String text)
               throws java.lang.Exception
        Configure the object with data from the specified input source (a URL) and/or textual data. The object should interpret the source first, if it is specified, followed by the literal text, if that is specified. The new configuration should usually override any old configuration wherever possible, in order to ensure that the current state can be successfully retrieved.

        This method is defined to throw a very general exception to allow classes that implement the interface to use whatever exceptions are appropriate.

        Specified by:
        configure in interface Configurable
        Parameters:
        base - The base relative to which references within the input are found, or null if this is not known, or there is none.
        source - The input source, which specifies a URL, or null if none.
        text - Configuration information given as text, or null if none.
        Throws:
        java.lang.Exception - If something goes wrong.

      • getConfigureSource

        public java.lang.String getConfigureSource()
        Return the input source that was specified the last time the configure method was called.
        Specified by:
        getConfigureSource in interface Configurable
        Returns:
        The string representation of the input URL, or null if the no source has been used to configure this object, or null if no external source need be used to configure this object.

      • getConfigureText

        public java.lang.String getConfigureText()
        Return the text string that represents the current configuration of this object. Note that any configuration that was previously specified using the source attribute need not be represented here as well.
        Specified by:
        getConfigureText in interface Configurable
        Returns:
        A configuration string, or null if no configuration has been used to configure this object, or null if no configuration string need be used to configure this object.

      • perform

        public void perform()
        Perform this action. In this base class, if a source file is specified in the configuration of this item, e.g.: 
            <configure source="some_file.xml">
    </configure>
        then the source is read and its contents are used as the moml text. The moml text can also be given directly: 
            <configure>
      <entity name="C" class="ptolemy.actor.lib.Const">
      </entity>
    </configure>
        Depending on whether the parse parameter is true or false, the moml text may be parsed first or not. If it is parsed, the returned NamedObj is used to generate a new moml string to be applied to the model in the current tableau (the nearest tableau that contains this GUI property). If it is not parsed, then the moml text is directly applied to the model.