com.iizigo.prop.editor

Class StringMapPropEditor

java.lang.Object

com.iizigo.prop.BaseEditor<StringMapProp,Map<String,String>>

com.iizigo.prop.editor.StringMapPropEditor

All Implemented Interfaces:

IEditedPropControllerOwner<StringMapProp,Map<String,String>>, IEditedPropertyEntry<StringMapProp,Map<String,String>>, IEditedPropertyEntryMultiProp<StringMapProp,Map<String,String>>, IPropertyDefined

public class StringMapPropEditor
extends BaseEditor<StringMapProp,Map<String,String>>

The Duration property editor that uses a Long value for the duration in milliseconds.

Author:

Christopher Mindus

Field Summary

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 and Description
StringMapPropEditor() Default constructor called before createControls.

Method Summary

Modifier and Type	Method and Description
protected void	create() Creates the property editor controls.
String	formatValue(Map<String,String> value) Formats the value for user input as a String.
Map<String,String>	getDefaultValue() Gets the default defined value to set in the property when defined.
protected String	getToolTipText() Gets the tooltip text to display in the entry fields (not the one for property errors or validator).
protected Map<String,String>	getValue(String input) Gets the property value for a user input.
void	onMore() Called when the "more..." button is pressed.
void	onUndefined() Called when undefined.
void	onUpdate(Map<String,String> map) Called when a property event has been fired and the edited entry needs to be updated.
protected void	setColors(Control... additional) Sets the colors for the controls depending on error, focus and define state.

Methods inherited from class com.iizigo.prop.BaseEditor

assignMaster, beginProcessEvent, canProcessEvents, checkInput, createCCombo, createControls, createGridLayout, createIzMenu, createMoreButton, createMoreIzMenu, createText, dispose, doUndefineIfEmpty, doValueChangeConversion, endProcessEvent, getBaseEditor, getCurrentInput, getCurrentValue, getCurrentValues, getModifyListener, getNativeToolTip, getOption, getSelectionListener, getSeverity, getShell, getToolTipText2, hasFocus, initialize, isPropReadOnly, onDefine, onDispose, onDoubleClick, onError, onF4List, onFocusGained, onFocusLost, onReadOnly, setCurrentValue, setEditable, setFocus, setInput, setInputValue, setInputValueFromProp, setToolTipText, showMenu, updateTooltip, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringMapPropEditor

public StringMapPropEditor()

Default constructor called before createControls.

Method Detail

create

protected void create()

Creates the property editor controls.

Specified by:

create in class BaseEditor<StringMapProp,Map<String,String>>

setColors

protected void setColors(Control... additional)

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

Overrides:

setColors in class BaseEditor<StringMapProp,Map<String,String>>

onMore

public void onMore()

Called when the "more..." button is pressed. Override to display drop-down menu.

Overrides:

onMore in class BaseEditor<StringMapProp,Map<String,String>>

onUndefined

public void onUndefined()

Called when undefined.

Specified by:

onUndefined in interface IEditedPropControllerOwner<StringMapProp,Map<String,String>>

Overrides:

onUndefined in class BaseEditor<StringMapProp,Map<String,String>>

onUpdate

public void onUpdate(Map<String,String> map)

Called when a property event has been fired and the edited entry needs to be updated. This method is also called when setting up the edited entry the first time.

Specified by:

onUpdate in interface IEditedPropControllerOwner<StringMapProp,Map<String,String>>

Overrides:

onUpdate in class BaseEditor<StringMapProp,Map<String,String>>

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<StringMapProp,Map<String,String>>

getDefaultValue

public Map<String,String> getDefaultValue()

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

Specified by:

getDefaultValue in interface IEditedPropControllerOwner<StringMapProp,Map<String,String>>

Specified by:

getDefaultValue in class BaseEditor<StringMapProp,Map<String,String>>

getValue

protected Map<String,String> getValue(String input)
                               throws Exception

Gets the property value for a user input.

Specified by:

getValue in class BaseEditor<StringMapProp,Map<String,String>>

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 String formatValue(Map<String,String> value)

Formats the value for user input as a String.

Specified by:

formatValue in interface IEditedPropControllerOwner<StringMapProp,Map<String,String>>

Specified by:

formatValue in class BaseEditor<StringMapProp,Map<String,String>>

Parameters:

value - The value.

Returns:

The formatted value.