Class BaseEditor<PROP extends GProp<?>,PROP_VALUE>

Method Details

• getBaseEditor

  public static BaseEditor<?,?> getBaseEditor(org.eclipse.swt.widgets.Control control)

  Gets the property editor in question for a control that e.g. has focus.

  Parameters:

  control - The control that has focus.

  Returns:

  The instance of the base editor, null for none.

• createControls

  public MultiPropEditor createControls(PropertyEditor editor, PropertyEditorInfo info, String[] options, org.eclipse.swt.widgets.Composite parent, PropCnr[] containers, Atom atom, DefinedButton definedButton)

  Creates the required controls in the composite.

  Specified by:

  createControls in interface IEditedPropertyEntry<PROP extends GProp<?>,PROP_VALUE>

  Parameters:

  editor - The property editor instance.

  info - The information about edited item.

  options - The options.

  parent - Parent composite, where to place components.

  containers - The containers for the edited property.

  atom - Atom name of the property in the containers.

  definedButton - The define-button or null for none.

  Returns:

  null for normal editors, the instance of the multi-property editor in case of multiple editable entries (lines).

• assignMaster

  public EditedPropController<PROP,PROP_VALUE> assignMaster(MultiPropCnr master, Class<PROP> propertyClass, PropLabel label)

  Assigns the master property controller.

  Specified by:

  assignMaster in interface IEditedPropertyEntryMultiProp<PROP extends GProp<?>,PROP_VALUE>

  Parameters:

  master - The master property container of the MultiPropCnr.

  propertyClass - Property class for items.

  label - Label for this entry.

  Returns:

  The instance of the item property controller.

• getShell

  public org.eclipse.swt.widgets.Shell getShell()

  Gets the shell.

• onThemeChanged

  public final void onThemeChanged(ApplicationUI appUI)

  Called once the new theme has stabilized after a period of time. This method cannot be overridden.

  Specified by:

  onThemeChanged in interface IThemeListener

  Parameters:

  appUI - The new ApplicationUI instance.

• dispose

  public final void dispose()

  Disposes of this instance, cannot be overridden (use onDispose instead).

  Specified by:

  dispose in interface IEditedPropertyEntry<PROP extends GProp<?>,PROP_VALUE>

• onDispose

  protected void onDispose()

  Called when the editor is disposed of. Override to implement required code. By default, this method does nothing.

• isPropReadOnly

  protected boolean isPropReadOnly()

  Checks if read-only.

• createGridLayout

  protected org.eclipse.swt.layout.GridLayout createGridLayout(int count, int cxSpacing)

  Creates the grid layout for the composite parent and assigns it.

• createMoreButton

  protected void createMoreButton(String toolTipText)

  Creates a "more..." button.

• createMoreIzMenu

  protected IzMenu createMoreIzMenu()

  Creates the menu for a component. The menu is shown upon onMore by default.

• createIzMenu

  protected IzMenu createIzMenu(org.eclipse.swt.widgets.Control control)

  Creates the menu for a component. The menu is shown upon onMore by default.

• onMore

  public void onMore()

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

• showMenu

  public void showMenu()

  Shows the menu.

• onF4List

  public void onF4List()

  Called when F4 is pressed in a Text field. Override to display dialog box.

• createText

  protected org.eclipse.swt.widgets.Text createText()

  Creates an entry field and registers it.

• createCCombo

  protected org.eclipse.swt.custom.CCombo createCCombo(String[] entries)

  Creates a combobox, fills and registers it.

• onDoubleClick

  protected void onDoubleClick(org.eclipse.swt.widgets.Event e)

  Called when mouse is double-clicked in the text or combobox.

• getCurrentInput

  public String getCurrentInput()

  Gets the user input.

  Specified by:

  getCurrentInput in interface IEditedPropControllerOwner<PROP extends GProp<?>,PROP_VALUE>

• onFocusGained

  protected void onFocusGained()

  Upon focus gained, the selection of an entry field is selected fully and for a combobox, cursor is placed first.

• onFocusLost

  protected void onFocusLost()

  Called when focus is lost. The control can set the selection to the beginning of the field to show the text.

• setToolTipText

  protected void setToolTipText(String msg)

  Sets the tooltip text. The default is to apply the getToolTipText() text to the edit control.

  Parameters:

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

• updateTooltip

  public void updateTooltip()

  Updates the tooltip.

• getNativeToolTip

  public IzToolTip getNativeToolTip()

  Gets a "native" tooltip to use.

  Returns:

  null for none, otherwise the IzToolTip instance.

• getToolTipText2

  protected String getToolTipText2()

  Gets the tooltip text to display in the entry fields (not the one for property errors).

• setFocus

  protected void setFocus()

  Focuses the editor. The default is to place focus in the control (text or combobox), or the "more..." button. Other behavior must override this method.

• onDefine

  public void onDefine(boolean on)

  Called from the PropertyDefinedButton.

  Specified by:

  onDefine in interface IPropertyDefined

  Parameters:

  on - The defined state.

• setEditable

  protected void setEditable(boolean on)

  Sets the input-capable editable state when e.g. and extends-final property is encountered. This also sets the enabled state of the "more..." button.

  Override this method if additional enabled states must be processed.

• setInput

  protected boolean setInput(String input)

  Updates the entry or visible part in the editor with a new property value that is not in error state. The default implementation updates the combo box or text with the value.toString() representation. The existing input should be checked for difference in order not to update the entry if not required. If the input is null, it means no change of the current input the user has made or was previously set.

  Returns:

  true if changed, false for no change.

• doValueChangeConversion

  protected boolean doValueChangeConversion()

  Returns if the property value should be checked by converting current string input back-and-forth with the current value.

  Returns:

  The default is to perform this (i.e. return true) if there is a Text or Combo input control.

• setInputValueFromProp

  protected void setInputValueFromProp(PROP_VALUE value)

  Sets the input value from an update of the property value. If the input is null, it means the same as setting an empty value.

  The default is to call doValueChangeConversion() and if it returns true, the value is retrieved using getCurrentValue() with try-catch, and if the returned value is the same as the value passed into this method, nothing is performed. Otherwise setInputValue(Object) is called.

  Parameters:

  value - The value to set, null for empty.

• setInputValue

  protected void setInputValue(PROP_VALUE value)

  Sets the input value when editing, when formatting the value from a string. If the input is null, it means the same as setting an empty value.

  Parameters:

  value - The value to set, null for empty.

• hasFocus

  public boolean hasFocus()

  Checks if this editor has focus.

• setColors

  protected void setColors(org.eclipse.swt.widgets.Control... additional)

  Sets the colors for the controls depending on error, focus and define state.

• getModifyListener

  protected org.eclipse.swt.events.ModifyListener getModifyListener()

  Gets the modify listener.

• getSelectionListener

  protected org.eclipse.swt.events.SelectionListener getSelectionListener()

  Gets the selection listener.

• canProcessEvents

  public boolean canProcessEvents()

  Checks if it's OK to process events.

• beginProcessEvent

  public void beginProcessEvent()

  Begins processing events, blocking e.g. property events or callbacks in SWT events.

• endProcessEvent

  public void endProcessEvent()

  Begins processing events, blocking e.g. property events or callbacks in SWT events.

• checkInput

  protected void checkInput(boolean focusLost)

  Checks the input.

• getCurrentValue

  public PROP_VALUE getCurrentValue()

  Gets the current value from the property, not user input. If several properties are selected, the value is only returned when the value is the same for all properties (otherwise null is returned).

  Returns:

  The property value, or null if not defined.

• getCurrentValues

  public HashSet<PROP_VALUE> getCurrentValues()

  Gets the array of values currently used. Null entries may be present.

• setCurrentValue

  public void setCurrentValue(PROP_VALUE value)

  Sets the current value to all properties.

• validate

  protected PROP_VALUE validate(String input, boolean focusLost) throws Exception

  Routine to check the input from a text or combobox. It is called whenever a selection is done in the combobox or text input in either the entry field or the combobox. A potential validator is called by default.

  Parameters:

  input - The user input.

  focusLost - Flag for validation at focus lost resulting in e.g. removal of value for empty strings.

  Returns:

  The value object or null to remove or un-define it.

  Throws:

  Exception - For validation errors.

• doUndefineIfEmpty

  protected boolean doUndefineIfEmpty(boolean focusLost)

  Keeps empty strings as defined, when input has been changed specifically to empty string, or if the entry was defined when editing began.

• onUpdate

  public void onUpdate(PROP_VALUE value)

  Called when the property is updated without errors, with a new value.

  Specified by:

  onUpdate in interface IEditedPropControllerOwner<PROP extends GProp<?>,PROP_VALUE>

• onError

  public void onError(String input, String message, int severity, boolean isMultipleValueWarning, boolean isChildError)

  Called when the property is updated due to an error.

  Specified by:

  onError in interface IEditedPropControllerOwner<PROP extends GProp<?>,PROP_VALUE>

• onUndefined

  public void onUndefined()

  Called when the property is undefined.

  Specified by:

  onUndefined in interface IEditedPropControllerOwner<PROP extends GProp<?>,PROP_VALUE>

• getSeverity

  public int getSeverity()

  The error severity.

• onReadOnly

  public void onReadOnly(boolean on)

  Called when the read-only state changes.

  Specified by:

  onReadOnly in interface IEditedPropControllerOwner<PROP extends GProp<?>,PROP_VALUE>

• initialize

  public void initialize(PROP prop) throws PropException

  Initializes a newly created property (e.g. a reference property for accepted classes, etc).

  Specified by:

  initialize in interface IEditedPropControllerOwner<PROP extends GProp<?>,PROP_VALUE>

  Parameters:

  prop - The newly created orphan property.

  Throws:

  PropException - For property errors.

• getOption

  public String getOption(String name)

  Gets the options of a specified name as "option=".

  Parameters:

  name - The name.

  Returns:

  The String after the equal sign, null if not found.

• create

  protected abstract void create()

  Creates the property editor controls.

• getToolTipText

  protected abstract String getToolTipText()

  Gets the tooltip text to display in the entry fields (not the one for property errors or validator).

• getDefaultValue

  public abstract PROP_VALUE getDefaultValue()

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

  Specified by:

  getDefaultValue in interface IEditedPropControllerOwner<PROP extends GProp<?>,PROP_VALUE>

• getValue

  protected abstract PROP_VALUE getValue(String input) throws Exception

  Gets the property value for a user input.

  Parameters:

  input - The current user input.

  Returns:

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

  Throws:

  Exception - For validation errors.

• formatValue

  public abstract String formatValue(PROP_VALUE value)

  Formats the value for user input as a String.

  Specified by:

  formatValue in interface IEditedPropControllerOwner<PROP extends GProp<?>,PROP_VALUE>

  Parameters:

  value - The value.

  Returns:

  The formatted value.