com.iizigo.prop.editor

Class StrokePropEditor

java.lang.Object

com.iizigo.prop.BaseEditor<StrokeProp,GStroke>

com.iizigo.prop.editor.StrokePropEditor

All Implemented Interfaces:

IEditedPropControllerOwner<StrokeProp,GStroke>, IEditedPropertyEntry<StrokeProp,GStroke>, IEditedPropertyEntryMultiProp<StrokeProp,GStroke>, IPropertyDefined

public class StrokePropEditor
extends BaseEditor<StrokeProp,GStroke>

The Stroke property editor.

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

Method Summary

Modifier and Type	Method and Description
protected void	create() Creates the property editor controls.
String	formatValue(GStroke value) Formats the value for user input as a String.
GStroke	getDefaultValue() Gets the default defined value to set in the property when defined.
static GStroke	getLastStroke() Gets a last-stroke.
protected String	getToolTipText() Gets the tooltip text to display in the entry fields (not the one for property errors or validator).
protected GStroke	getValue(String input) Gets the property value for a user input.
void	mouseDoubleClick(MouseEvent e) Double-click on preview or text displays color chooser.
void	mouseDown(MouseEvent e) Mouse down.
void	mouseUp(MouseEvent e) Mouse up, not processed.
void	onDefine(boolean on) Called from the PropertyDefinedButton.
protected void	onDispose() Called when the editor is disposed of.
protected void	onDoubleClick(Event e) Called when mouse is double-clicked in the text or combobox.
void	onMore() Called when the "more..." button is pressed.
void	onUndefined() Called when undefined.
void	onUpdate(GStroke stroke) 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, 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

StrokePropEditor

public StrokePropEditor()

Default constructor called before createControls.

Method Detail

getLastStroke

public static GStroke getLastStroke()

Gets a last-stroke.

create

protected void create()

Creates the property editor controls.

Specified by:

create in class BaseEditor<StrokeProp,GStroke>

setColors

protected void setColors(Control... additional)

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

Overrides:

setColors in class BaseEditor<StrokeProp,GStroke>

onDispose

protected void onDispose()

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

Overrides:

onDispose in class BaseEditor<StrokeProp,GStroke>

onDoubleClick

protected void onDoubleClick(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<StrokeProp,GStroke>

onMore

public void onMore()

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

Overrides:

onMore in class BaseEditor<StrokeProp,GStroke>

onUndefined

public void onUndefined()

Called when undefined.

Specified by:

onUndefined in interface IEditedPropControllerOwner<StrokeProp,GStroke>

Overrides:

onUndefined in class BaseEditor<StrokeProp,GStroke>

onUpdate

public void onUpdate(GStroke stroke)

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<StrokeProp,GStroke>

Overrides:

onUpdate in class BaseEditor<StrokeProp,GStroke>

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<StrokeProp,GStroke>

getDefaultValue

public GStroke getDefaultValue()

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

Specified by:

getDefaultValue in interface IEditedPropControllerOwner<StrokeProp,GStroke>

Specified by:

getDefaultValue in class BaseEditor<StrokeProp,GStroke>

getValue

protected GStroke getValue(String input)
                    throws Exception

Gets the property value for a user input.

Specified by:

getValue in class BaseEditor<StrokeProp,GStroke>

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(GStroke value)

Formats the value for user input as a String.

Specified by:

formatValue in interface IEditedPropControllerOwner<StrokeProp,GStroke>

Specified by:

formatValue in class BaseEditor<StrokeProp,GStroke>

Parameters:

value - The value.

Returns:

The formatted value.

onDefine

public void onDefine(boolean on)

Called from the PropertyDefinedButton.

Specified by:

onDefine in interface IPropertyDefined

Overrides:

onDefine in class BaseEditor<StrokeProp,GStroke>

Parameters:

on - The defined state.

mouseDoubleClick

public void mouseDoubleClick(MouseEvent e)

Double-click on preview or text displays color chooser.

Parameters:

e -

mouseDown

public void mouseDown(MouseEvent e)

Mouse down.

mouseUp

public void mouseUp(MouseEvent e)

Mouse up, not processed.