org.carewebframework.shell.designer

Class PropertyEditorBase<T extends org.fujion.component.BaseUIComponent>

java.lang.Object

org.carewebframework.shell.designer.PropertyEditorBase<T>

Type Parameters:

T - The input component class.

All Implemented Interfaces:

Comparable<PropertyEditorBase<T>>

Direct Known Subclasses:

PropertyEditorBoolean, PropertyEditorColor, PropertyEditorCustom, PropertyEditorDate, PropertyEditorDouble, PropertyEditorIcon, PropertyEditorInteger, PropertyEditorList, PropertyEditorText

public abstract class PropertyEditorBase<T extends org.fujion.component.BaseUIComponent>
extends Object
implements Comparable<PropertyEditorBase<T>>

All property editors must descend from this abstract class.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	editor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyEditorBase(String template) Create property editor using the specified template.
protected	PropertyEditorBase(T editor) Create property editor using the specified component for editing.

Method Summary

Modifier and Type	Method and Description
boolean	commit() Commit the changed value.
int	compareTo(PropertyEditorBase<T> o)
T	getEditor() Returns the component used to edit the property.
PropertyInfo	getPropInfo() Returns the PropertyInfo object associated with this editor.
Object	getTarget() Returns the target object associated with this editor.
protected abstract Object	getValue() Logic to return the value from the editor component.
boolean	hasChanged() Returns true if the property value has been changed since the last commit.
protected void	init(Object target, PropertyInfo propInfo, PropertyGrid propGrid) Initializes the property editor.
protected void	onChange(org.fujion.event.ChangeEvent event) Notify the property grid that the value has changed.
boolean	revert() Revert changes to the property value.
void	setFocus() Sets focus to the editor component.
protected abstract void	setValue(Object value) Logic to set the value in the editor component.
void	setWrongValueException(Throwable exc) Updates the wrong value message at the client.
void	setWrongValueMessage(String message) Updates the wrong value message at the client.
void	updateValue() Updates the last committed value.
protected void	wireController()

Methods inherited from class java.lang.Object

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

Field Detail

editor

protected final T extends org.fujion.component.BaseUIComponent editor

Constructor Detail

PropertyEditorBase

protected PropertyEditorBase(String template)

Create property editor using the specified template.

Parameters:

template - The template to create the editing component.

PropertyEditorBase

protected PropertyEditorBase(T editor)

Create property editor using the specified component for editing.

Parameters:

editor - The component used to edit the property.

Method Detail

wireController

protected void wireController()

getEditor

public T getEditor()

Returns the component used to edit the property.

Returns:

The editor component.

getValue

protected abstract Object getValue()

Logic to return the value from the editor component.

Returns:

Value from the editor component.

setValue

protected abstract void setValue(Object value)

Logic to set the value in the editor component.

Parameters:

value - Value for the editor component.

hasChanged

public boolean hasChanged()

Returns true if the property value has been changed since the last commit.

Returns:

True if pending changes exist.

getPropInfo

public PropertyInfo getPropInfo()

Returns the PropertyInfo object associated with this editor.

Returns:

PropInfo object.

getTarget

public Object getTarget()

Returns the target object associated with this editor.

Returns:

Target object.

updateValue

public void updateValue()

Updates the last committed value.

setFocus

public void setFocus()

Sets focus to the editor component.

init

protected void init(Object target,
                    PropertyInfo propInfo,
                    PropertyGrid propGrid)

Initializes the property editor.

Parameters:

target - The target object.

propInfo - The PropertyInfo instance reflecting the property being edited on the target.

propGrid - The property grid owning this property editor.

commit

public boolean commit()

Commit the changed value.

Returns:

True if the operation was successful.

revert

public boolean revert()

Revert changes to the property value.

Returns:

True if the operation was successful.

setWrongValueException

public void setWrongValueException(Throwable exc)

Updates the wrong value message at the client.

Parameters:

exc - The exception to display.

setWrongValueMessage

public void setWrongValueMessage(String message)

Updates the wrong value message at the client.

Parameters:

message - If null, any existing message is removed. Otherwise, the specified method is displayed next to the editor component.

compareTo

public int compareTo(PropertyEditorBase<T> o)

Specified by:

compareTo in interface Comparable<PropertyEditorBase<T extends org.fujion.component.BaseUIComponent>>

onChange

@EventHandler(value="change",
              target="@editor")
protected void onChange(org.fujion.event.ChangeEvent event)

Notify the property grid that the value has changed.

Parameters:

event - The change event.