Package com.iizigo.prop.editor

Class VSRelativeReferencePropEditor

java.lang.Object
com.iizigo.prop.BaseEditor<VSRelativeReference<?>,String>
com.iizigo.prop.editor.VSRelativeReferencePropEditor
All Implemented Interfaces:
IThemeListener, IEditedPropControllerOwner<VSRelativeReference<?>,String>, IEditedPropertyEntry<VSRelativeReference<?>,String>, IEditedPropertyEntryMultiProp<VSRelativeReference<?>,String>, IPropertyDefined
Direct Known Subclasses:
VSActionActorParticipantEditor
public class VSRelativeReferencePropEditor extends BaseEditor<VSRelativeReference<?>,String>
The VirtualSpace Reference property editor consists of a simple entry field and a more button to perform a selection.
Author:
Christopher Mindus

  • Field Details

    • title

      protected String title

    • moreText

      protected String moreText

    • tooltipText

      protected String tooltipText

    • itemDefined

      protected String itemDefined

    • image

      protected Image image

    • classes

      protected Class<?>[] classes

    • isVSRoot

      protected boolean isVSRoot

    • tip

      protected IzToolTip tip

    • miSelect

      protected IzMenuItem miSelect

    • miGoto

      protected IzMenuItem miGoto

  • Constructor Details

    • VSRelativeReferencePropEditor

      public VSRelativeReferencePropEditor()
      Default constructor called before createControls.

  • Method Details

    • setup

      protected void setup()
      Override to provide user settings.

    • create

      protected void create()
      Creates the property editor controls.
      Specified by:
      create in class BaseEditor<VSRelativeReference<?>,String>

    • buildMenu

      protected void buildMenu()
      Called to build the menu.

    • getVirtualSpace

      protected EditorVirtualSpace getVirtualSpace(int ask)
      Gets the VirtualSpace, prompted to create it perhaps, or connect.
      Parameters:
      ask - Question when -1, to connect or create, 0=connect, 1=create.
      Returns:
      null if canceled.

    • getVirtualSpace

      protected static EditorVirtualSpace getVirtualSpace(Shell shell, int ask, IPropertyEditorController controller, EditedPropController<?,?> propController, Atom atom)
      Gets the VirtualSpace, prompted to create it perhaps, or connect.
      Parameters:
      ask - Question when -1, to connect or create, 0=connect, 1=create.
      Returns:
      null if canceled.

    • onCreateVSField

      protected void onCreateVSField()
      Creates a field.

    • onCreateVSTable

      protected void onCreateVSTable()
      Creates a table.

    • onCreateVSAction

      protected void onCreateVSAction()
      Creates a action.

    • onCreateVSColumn

      protected static void onCreateVSColumn(EditorVirtualSpace ns, IPropertyEditorController controller, EditedPropController<?,?> propController, Text text, VSRelativeReference<?> reference)
      Creates a column.

    • onCreateMenu

      protected void onCreateMenu(IzMenu menu, boolean isPost)
      Called to create the menu items.

    • onMore

      public void onMore()
      Called when the "more..." button is pressed. Override to display dialog box.
      Overrides:
      onMore in class BaseEditor<VSRelativeReference<?>,String>

    • onList

      protected void onList()
      Called when the "more..." button is pressed. Override to display dialog box.

    • onDoubleClick

      protected void onDoubleClick(Event e)
      Called when mouse is double-clicked in the text or combobox. Overridden to check if Goto reference is enabled, and if so goes there.
      Overrides:
      onDoubleClick in class BaseEditor<VSRelativeReference<?>,String>

    • onGoto

      protected boolean onGoto(boolean doPerform)
      Goto reference.

    • getCurrentReferenceTarget

      protected VSComponent getCurrentReferenceTarget()
      Gets the current property reference target. This reference is retrieved from the current input. If the path contains "Module:/", it is assumed to be a hard path. Otherwise the getBaseReferencePath() is prepended.

    • getReferenceTarget

      protected VSComponent getReferenceTarget(String relativeReference)
      Gets the current property reference target. This reference is retrieved from the current input. If the path contains "Module:/", it is assumed to be a hard path. Otherwise the getBaseReferencePath() is prepended.

    • getToolTipText

      protected String getToolTipText()
      Gets the tooltip text to display in the entry fields (not the one for property errors or validator).
      Specified by:
      getToolTipText in class BaseEditor<VSRelativeReference<?>,String>

    • setToolTipText

      protected void setToolTipText(String msg)
      Sets the tooltip text. The default is to apply the getToolTipText() text to the edit control.

      An attempt to show the tooltip of the reference target's DesignerProp tooltip is done.

      Overrides:
      setToolTipText in class BaseEditor<VSRelativeReference<?>,String>
      Parameters:
      msg - Message in tooltip (normally error), null for none, in which case the getToolTipText2() is used.

    • getDefaultValue

      public String getDefaultValue()
      Gets the default defined value to set in the property when defined.
      Specified by:
      getDefaultValue in interface IEditedPropControllerOwner<VSRelativeReference<?>,String>
      Specified by:
      getDefaultValue in class BaseEditor<VSRelativeReference<?>,String>

    • getValue

      protected String getValue(String input)
      Gets the property value for a user input.
      Specified by:
      getValue in class BaseEditor<VSRelativeReference<?>,String>
      Parameters:
      input - The current user input.
      Returns:
      The property value for the input, or null to un-define the property.

    • formatValue

      public String formatValue(String value)
      Formats the value for user input as a String.
      Specified by:
      formatValue in interface IEditedPropControllerOwner<VSRelativeReference<?>,String>
      Specified by:
      formatValue in class BaseEditor<VSRelativeReference<?>,String>
      Parameters:
      value - The value.
      Returns:
      The formatted value.