Class EditorScreenActionProp

    • Constructor Detail

      • 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 Detail

      • clone

        public EditorScreenActionProp clone()
                                     throws java.lang.CloneNotSupportedException
        Clone must be overridden.
        Overrides:
        clone in class ScreenActionProp
        Throws:
        java.lang.CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.
      • getCNText

        public java.lang.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.
      • verify

        public void verify​(PropVerification verification)
        Verifies this property container. The check performed is the extension of classes and that no circular reference is present.
        Specified by:
        verify in interface IGProp<GProp<?>[]>
        Overrides:
        verify in class PropCnr
        Parameters:
        verification - The property verification class.