org.carewebframework.shell.designer

Class PropertyEditorBase

java.lang.Object

org.carewebframework.shell.designer.PropertyEditorBase

Direct Known Subclasses:

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

public abstract class PropertyEditorBase
extends Object

All property editors must descend from this abstract class.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.zkoss.zul.impl.XulElement	component

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyEditorBase(String template) Create property editor using the specified template.
protected	PropertyEditorBase(org.zkoss.zul.impl.XulElement component) Create property editor using the specified component for editing.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	commit() Commit the changed value.
org.zkoss.zul.impl.XulElement	getComponent() Returns the component used to edit the property.
PropertyInfo	getPropInfo() Returns the PropertyInfo object associated with this editor.
UIElementBase	getTarget() Returns the target UI element 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(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid) Initializes the property editor.
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.

Methods inherited from class java.lang.Object

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

Field Detail

component

protected final org.zkoss.zul.impl.XulElement component

Constructor Detail

PropertyEditorBase

protected PropertyEditorBase(String template)
                      throws Exception

Create property editor using the specified template.

Parameters:

template - The template to create the editing component.

Throws:

Exception - Unspecified exception.

PropertyEditorBase

protected PropertyEditorBase(org.zkoss.zul.impl.XulElement component)

Create property editor using the specified component for editing.

Parameters:

component - The component used to edit the property.

Method Detail

getComponent

public org.zkoss.zul.impl.XulElement getComponent()

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 UIElementBase getTarget()

Returns the target UI element associated with this editor.

Returns:

Target UI element.

updateValue

public void updateValue()

Updates the last committed value.

setFocus

public void setFocus()

Sets focus to the editor component.

init

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

Initializes the property editor.

Parameters:

target - The target UI element.

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.