Package com.iizix.term.prop

Class ScreenActionProp

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.term.prop.ScreenActionProp
All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, IVSActionListener, IVSComponentListener, IVSComponentState, Cloneable
Direct Known Subclasses:
EditorScreenActionProp
public class ScreenActionProp extends PropCnr implements IVSActionListener
This Screen Action property container for a terminal host screen.

  • Field Details Link icon

    • vsAction Link icon

      protected VSAction vsAction
      The connected action, null for none.

      Note: use thread-safe code when working with this variable as it can become unresolved, thus null.

    • NAME_VS_TABLE Link icon

      public static final String NAME_VS_TABLE
      Atom name: vsTable.
      See Also:

    • NAME_SELECTION_FIELD Link icon

      public static final String NAME_SELECTION_FIELD
      Atom name: selFld.
      See Also:

    • NAME_SELECTION_STRING Link icon

      public static final String NAME_SELECTION_STRING
      Atom name: selStr.
      See Also:

    • NAME_UNSELECTION_STRING Link icon

      public static final String NAME_UNSELECTION_STRING
      Atom name: unselStr.
      See Also:

    • NAME_SELECTION_REQUIRED Link icon

      public static final String NAME_SELECTION_REQUIRED
      Atom name: selReq.
      See Also:

    • NAME_SINGLE_SELECTION Link icon

      public static final String NAME_SINGLE_SELECTION
      Atom name: single.
      See Also:

    • NAME_SEND_KEY Link icon

      public static final String NAME_SEND_KEY
      Atom name: sendKey.
      See Also:

  • Constructor Details Link icon

    • ScreenActionProp Link icon

      public ScreenActionProp()
      Creates the Screen Action property container without a name. The name must be set in all cases using the setPropertyAtom call.

    • ScreenActionProp Link icon

      public ScreenActionProp(Atom propertyAtom)
      Creates the Screen Action property container with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - the name of the component, unique within it's parent.

  • Method Details Link icon

    • clone Link icon

      public ScreenActionProp clone() throws CloneNotSupportedException
      Overrides clone to clear VSAction reference.
      Overrides:
      clone in class PropCnr
      Throws:
      CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.

    • getScreen Link icon

      public ScreenProp getScreen()
      Gets the screen property.
      Returns:
      The screen property.

    • updateCachedValues Link icon

      protected void updateCachedValues()
      Updates the cached values.

    • getDescription Link icon

      public String getDescription()
      Gets the description.
      Returns:
      The description, null for none.

    • getPropBaseReference Link icon

      public PropCnr getPropBaseReference()
      Gets a base property container reference instance from the container or any parent containers. The method is used by PropRelativeReference to look up the reference instance in order to resolve the relative path to the target property.
      Specified by:
      getPropBaseReference in interface IGProp<GProp<?>[]>
      Overrides:
      getPropBaseReference in class PropCnr
      Returns:
      The screen fields instance.

    • getSelectionField Link icon

      public ScreenFieldProp getSelectionField()
      Gets the selection field.
      Returns:
      The screen field property.

    • getSelectionString Link icon

      public String getSelectionString()
      Gets the selection string.
      Returns:
      The selection string, or null for none.

    • getUnselectionString Link icon

      public String getUnselectionString()
      Gets the unselection string.
      Returns:
      The unselection string, or null for none.

    • isSelectionRequired Link icon

      public boolean isSelectionRequired()
      Retrieves if selection is required.
      Returns:
      true if selection in VSTable is required for action to be enabled.

    • isSingleSelectionField Link icon

      public boolean isSingleSelectionField()
      Get the single-selection flag (default is multiple).
      Returns:
      true if single-selection, false for multiple selection.

    • getSendKey Link icon

      public int getSendKey()
      Gets the send key.
      Returns:
      The send key, or zero for none.

    • getSendKeyDescription Link icon

      public String getSendKeyDescription()
      Gets the send key description.
      Returns:
      The description of the key, or null for none.

    • getVSAction Link icon

      public VSAction getVSAction()
      Gets the connected VSAction.
      Returns:
      The VSAction instance, or null for none.

    • onResolved Link icon

      public void onResolved(VSRelativeReference<?> reference, VSAction action)
      Called when the property reference has been resolved. UI components use this method to set its state according to the action, this is handled in by the UIComp class.

      Components must override to provide the implementation for e.g. value contents, styles, etc.

      Specified by:
      onResolved in interface IVSActionListener
      Parameters:
      reference - The VSRelativeReference instance holding the reference.
      action - The target reference.

    • onBroken Link icon

      public void onBroken(VSRelativeReference<?> reference, VSAction action)
      Called when the property reference has been broken, i.e. unresolved.
      Specified by:
      onBroken in interface IVSActionListener
      Parameters:
      reference - The VSRelativeReference instance holding the reference.
      action - The target reference.

    • onStateChanged Link icon

      public void onStateChanged(VSAction action, IVSComponentState.State state, boolean on)
      Called when the action changes state.
      Specified by:
      onStateChanged in interface IVSActionListener
      Parameters:
      action - The VS action.
      state - The state change.
      on - New state.

    • onParentStateChanged Link icon

      public void onParentStateChanged(IVSComponent parent, IVSComponentState.State state, boolean on)
      Called when the column changes state.
      Specified by:
      onParentStateChanged in interface IVSComponentListener
      Parameters:
      parent - The parent who's state was changed.
      state - The state change, possible values PARENT_ENABLED, PARENT_READONLY, PARENT_VISIBLE.
      on - New state.

    • onActionInvoked Link icon

      public void onActionInvoked(VSAction action, VSActionTXProcess process)
      Called before the action invokes the Action Actors.
      Specified by:
      onActionInvoked in interface IVSActionListener
      Parameters:
      action - The VS action.
      process - The initialized process.

    • onActionCompleted Link icon

      public void onActionCompleted(VSAction action, VSActionTXProcess process, Throwable exception)
      Called after the action completes the TXP processing i.e. all its Action Actor calls. This method is called regardless of success or failures. It can be used to check the state of the process.
      Specified by:
      onActionCompleted in interface IVSActionListener
      Parameters:
      action - The VS action.
      process - The completed process.
      exception - Potential exception in TX process, null for none.