Field Detail

• title

  protected java.lang.String title

• moreText

  protected java.lang.String moreText

• tooltipText

  protected java.lang.String tooltipText

• itemDefined

  protected java.lang.String itemDefined

• image

  protected org.eclipse.swt.graphics.Image image

• classes

  protected java.lang.Class<?>[] classes

• isVSRoot

  protected boolean isVSRoot

• tip

  protected IzToolTip tip

• miSelect

  protected IzMenuItem miSelect

• miGoto

  protected IzMenuItem miGoto

Constructor Detail

• VSRelativeReferencePropEditor

  public VSRelativeReferencePropEditor()

  Default constructor called before createControls.

Method Detail

• 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<?>,​java.lang.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​(org.eclipse.swt.widgets.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,
                                         org.eclipse.swt.widgets.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<?>,​java.lang.String>

• onList

  protected void onList()

  Called when the "more..." button is pressed. Override to display dialog box.

• onDoubleClick

  protected void onDoubleClick​(org.eclipse.swt.widgets.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<?>,​java.lang.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​(java.lang.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 java.lang.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<?>,​java.lang.String>

• setToolTipText

  protected void setToolTipText​(java.lang.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<?>,​java.lang.String>

  Parameters:

  msg - Message in tooltip (normally error), null for none, in which case the getToolTipText2() is used.

• getDefaultValue

  public java.lang.String getDefaultValue()

  Gets the default defined value to set in the property when defined.

  Specified by:

  getDefaultValue in interface IEditedPropControllerOwner<VSRelativeReference<?>,​java.lang.String>

  Specified by:

  getDefaultValue in class BaseEditor<VSRelativeReference<?>,​java.lang.String>

• getValue

  protected java.lang.String getValue​(java.lang.String input)

  Gets the property value for a user input.

  Specified by:

  getValue in class BaseEditor<VSRelativeReference<?>,​java.lang.String>

  Parameters:

  input - The current user input.

  Returns:

  The property value for the input, or null to un-define the property.

• formatValue

  public java.lang.String formatValue​(java.lang.String value)

  Formats the value for user input as a String.

  Specified by:

  formatValue in interface IEditedPropControllerOwner<VSRelativeReference<?>,​java.lang.String>

  Specified by:

  formatValue in class BaseEditor<VSRelativeReference<?>,​java.lang.String>

  Parameters:

  value - The value.

  Returns:

  The formatted value.