Package com.iizigo.prop.editor
Class StringPropEditor
- java.lang.Object
- com.iizigo.prop.BaseEditor<StringProp,java.lang.String>
- com.iizigo.prop.editor.StringPropEditor
- All Implemented Interfaces:
IEditedPropControllerOwner<StringProp,java.lang.String>,IEditedPropertyEntry<StringProp,java.lang.String>,IEditedPropertyEntryMultiProp<StringProp,java.lang.String>,IPropertyDefined
- Direct Known Subclasses:
ConnectionProfilePropEditor,FontFamilyPropEditor,LocalizedStringPropEditor,VAPIDKeyPropEditor,WrapStringPropEditor
public class StringPropEditor extends BaseEditor<StringProp,java.lang.String>
The String property editor consists of a simple entry field.- Author:
- Christopher Mindus
Field Summary
Fields Modifier and Type Field Description protected java.lang.StringdescrThe description text, null for none.Fields inherited from class com.iizigo.prop.BaseEditor
appUI, combo, control, controller, definedButton, display, editor, focusListener, hasBeenModified, info, more, multipleValueWarningInput, options, parent, propController, shell, text, validator, wasDefinedAtFocusGained
Constructor Summary
Constructors Constructor Description StringPropEditor()Default constructor called before createControls.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected 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.java.lang.StringformatValue(java.lang.String value)Formats the value for user input as a String.java.lang.StringgetDefaultValue()Gets the default defined value to set in the property when defined.protected java.lang.StringgetToolTipText()Gets the tooltip text to display in the entry fields (not the one for property errors or validator).protected java.lang.StringgetToolTipText2()Gets the tooltip text to display in the entry fields (not the one for property errors).protected java.lang.StringgetValue(java.lang.String input)Gets the property value for a user input.protected voidparseOptions()Parses the options.Methods inherited from class com.iizigo.prop.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, isPropReadOnly, onDefine, onDispose, onDoubleClick, onError, onF4List, onFocusGained, onFocusLost, onMore, onReadOnly, onUndefined, onUpdate, setColors, setCurrentValue, setEditable, setFocus, setInput, setInputValue, setInputValueFromProp, setToolTipText, showMenu, updateTooltip, validate
Method Detail
parseOptions
protected void parseOptions()
Parses the options.
create
protected void create()
Creates the property editor controls.- Specified by:
createin classBaseEditor<StringProp,java.lang.String>
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:
getToolTipTextin classBaseEditor<StringProp,java.lang.String>
getToolTipText2
protected java.lang.String getToolTipText2()
Gets the tooltip text to display in the entry fields (not the one for property errors).- Overrides:
getToolTipText2in classBaseEditor<StringProp,java.lang.String>
getDefaultValue
public java.lang.String getDefaultValue()
Gets the default defined value to set in the property when defined.- Specified by:
getDefaultValuein interfaceIEditedPropControllerOwner<StringProp,java.lang.String>- Specified by:
getDefaultValuein classBaseEditor<StringProp,java.lang.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,java.lang.String>
getValue
protected java.lang.String getValue(java.lang.String input)
Gets the property value for a user input.- Specified by:
getValuein classBaseEditor<StringProp,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:
formatValuein interfaceIEditedPropControllerOwner<StringProp,java.lang.String>- Specified by:
formatValuein classBaseEditor<StringProp,java.lang.String>- Parameters:
value- The value.- Returns:
- The formatted value.