Class StringPropEditor
- All Implemented Interfaces:
IThemeListener, IEditedPropControllerOwner<StringProp, String>, IEditedPropertyEntry<StringProp, String>, IEditedPropertyEntryMultiProp<StringProp, String>, IPropertyDefined, IDisposedPart
- Direct Known Subclasses:
FontFamilyPropEditor, LocalizedStringPropEditor, VAPIDKeyPropEditor, WrapStringPropEditor
The String property editor consists of a simple entry field.
- Author:
- Christopher Mindus
Field Summary
FieldsFields inherited from class BaseEditor
appUI, combo, control, controller, definedButton, display, editor, focusListener, hasBeenModified, info, more, multipleValueWarningInput, options, parent, propController, shell, text, validator, wasDefinedAtFocusGainedConstructor Summary
ConstructorsMethod Summary
Modifier and TypeMethodDescriptionprotected voidcreate()Creates the property editor controls.protected booleandoUndefineIfEmpty(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.formatValue(String value) Formats the value for user input as a String.Gets the default defined value to set in the property when defined.protected StringGets the tooltip text to display in the entry fields (not the one for property errors or validator).protected StringGets the tooltip text to display in the entry fields (not the one for property errors).protected StringGets the property value for a user input.protected voidParses the options.Methods inherited from class BaseEditor
assignMaster, beginProcessEvent, canProcessEvents, checkInput, createCCombo, createControls, createGridLayout, createIzMenu, createMoreButton, createMoreIzMenu, createText, dispose, doValueChangeConversion, endProcessEvent, getBaseEditor, getCurrentInput, getCurrentValue, getCurrentValues, getModifyListener, getNativeToolTip, getOption, getSelectionListener, getSeverity, getShell, hasFocus, initialize, isDisposed, isPropReadOnly, onDefine, onDispose, onDoubleClick, onError, onF4List, onFocusGained, onFocusLost, onMore, onReadOnly, onThemeChanged, onUndefined, onUpdate, setColors, setCurrentValue, setEditable, setFocus, setInput, setInputValue, setInputValueFromProp, setToolTipText, showMenu, updateTooltip, validate
Field Details
descr
The description text, null for none.
Constructor Details
StringPropEditor
public StringPropEditor()Default constructor called before createControls.
Method Details
parseOptions
protected void parseOptions()Parses the options.create
protected void create()Creates the property editor controls.- Specified by:
createin classBaseEditor<StringProp, String>
getToolTipText
Gets the tooltip text to display in the entry fields (not the one for property errors or validator).- Specified by:
getToolTipTextin classBaseEditor<StringProp, String>
getToolTipText2
Gets the tooltip text to display in the entry fields (not the one for property errors).- Overrides:
getToolTipText2in classBaseEditor<StringProp, String>
getDefaultValue
Gets the default defined value to set in the property when defined.- Specified by:
getDefaultValuein interfaceIEditedPropControllerOwner<StringProp, String>- Specified by:
getDefaultValuein classBaseEditor<StringProp, String>
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.- Overrides:
doUndefineIfEmptyin classBaseEditor<StringProp, String>
getValue
Gets the property value for a user input.- Specified by:
getValuein classBaseEditor<StringProp, String>- Parameters:
input- The current user input.- Returns:
- The property value for the input, or null to un-define the property.
formatValue
Formats the value for user input as a String.- Specified by:
formatValuein interfaceIEditedPropControllerOwner<StringProp, String>- Specified by:
formatValuein classBaseEditor<StringProp, String>- Parameters:
value- The value.- Returns:
- The formatted value.