Class EditorScreenActionProp

All Implemented Interfaces:
IVSActionActorParticipantProvider, IPropDesigner, EventListener, IGProp<GProp<?>[]>, IPropCnr, IVSActionListener, IVSComponentListener, IVSComponentState, Cloneable, org.eclipse.core.runtime.IAdaptable

public class EditorScreenActionProp extends ScreenActionProp implements IPropDesigner, IVSActionActorParticipantProvider
This Screen Action property container for a terminal host screen property.
  • Constructor Details

    • EditorScreenActionProp

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

      public EditorScreenActionProp(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

    • getDesigner

      public ScreenDesignerProp getDesigner()
      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Returns:
      The instance of the Designer Extension.
    • getScreen

      public EditorScreenProp getScreen()
      Gets the screen property.
      Overrides:
      getScreen in class ScreenActionProp
      Returns:
      The screen property.
    • clone

      Clone must be overridden.
      Overrides:
      clone in class ScreenActionProp
      Throws:
      CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.
    • getSelectionField

      public EditorScreenFieldProp getSelectionField()
      Gets the selection field.
      Overrides:
      getSelectionField in class ScreenActionProp
      Returns:
      The screen field property.
    • getCNText

      public String getCNText()
      Gets the text for viewers.
      Returns:
      The text.
    • appendCNStyledTextAdditions

      public void appendCNStyledTextAdditions(org.eclipse.jface.viewers.StyledString ss)
      Appends optional items to styled text.
      Parameters:
      ss - The StyledString.
    • createToolTip

      public org.eclipse.swt.widgets.Composite createToolTip(org.eclipse.swt.widgets.Composite parent)
      Creates the tooltip composite.
      Parameters:
      parent - Parent composite.
      Returns:
      Created tooltip composite in parent.
    • setActionActor

      public boolean setActionActor(boolean doPerform, VSAction action, ComplexOperation op)
      Sets the provider as the Actor in the VSAction. This means adding an Action Actor of appropriate type.
      Specified by:
      setActionActor in interface IVSActionActorParticipantProvider
      Parameters:
      doPerform - Flag indicating operation is tested (false) or to be performed (true).
      action - The action referenced.
      op - The complex operation, null when doPerform==false.
      Returns:
      Success state.
    • removeActionActor

      public boolean removeActionActor(org.eclipse.swt.widgets.Shell shell, ComplexOperation op)
      Removes the provider as the Actor in the VSAction. This means removing an Action Actor of appropriate type.
      Specified by:
      removeActionActor in interface IVSActionActorParticipantProvider
      Parameters:
      shell - The shell.
      op - The complex operation.
      Returns:
      Success state.