org.carewebframework.shell.designer

Class PropertyEditorCustom

java.lang.Object

org.carewebframework.shell.designer.PropertyEditorBase

org.carewebframework.shell.designer.PropertyEditorCustom

All Implemented Interfaces:

org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>

Direct Known Subclasses:

PropertyEditorCustomTree

public class PropertyEditorCustom
extends PropertyEditorBase
implements org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>

Allows registration of custom editors for complex property types.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.zkoss.zul.Bandbox	bandbox
protected org.zkoss.zul.Bandpopup	bandpopup

Fields inherited from class org.carewebframework.shell.designer.PropertyEditorBase

component

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyEditorCustom()
protected	PropertyEditorCustom(String template)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doClose() Invoked when the associated bandbox is closed;
protected void	doOpen() Invoked when the associated bandbox is opened.
protected Object	getValue() Logic to return the value from the editor component.
protected void	init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid) For custom property editors, if a property getter is specified, the value returned by the getter is the real target.
void	onEvent(org.zkoss.zk.ui.event.Event event) Capture the bandbox onOpen event and invokes doOpen or doClose depending on the bandbox state.
void	setFocus() Sets focus to the editor component.
protected void	setValue(Object value) Logic to set the value in the editor component.

Methods inherited from class org.carewebframework.shell.designer.PropertyEditorBase

commit, getComponent, getPropInfo, getTarget, hasChanged, revert, setWrongValueException, setWrongValueMessage, updateValue

Methods inherited from class java.lang.Object

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

Field Detail

bandbox

protected final org.zkoss.zul.Bandbox bandbox

bandpopup

protected final org.zkoss.zul.Bandpopup bandpopup

Constructor Detail

PropertyEditorCustom

protected PropertyEditorCustom()

PropertyEditorCustom

protected PropertyEditorCustom(String template)
                        throws Exception

Throws:

Exception

Method Detail

doOpen

protected void doOpen()

Invoked when the associated bandbox is opened.

doClose

protected void doClose()

Invoked when the associated bandbox is closed;

init

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

For custom property editors, if a property getter is specified, the value returned by the getter is the real target.

Overrides:

init in class PropertyEditorBase

Parameters:

target - Target element.

propInfo - The property information.

propGrid - The parent property grid.

setFocus

public void setFocus()

Description copied from class: PropertyEditorBase

Sets focus to the editor component.

Overrides:

setFocus in class PropertyEditorBase

getValue

protected Object getValue()

Description copied from class: PropertyEditorBase

Logic to return the value from the editor component.

Specified by:

getValue in class PropertyEditorBase

Returns:

Value from the editor component.

setValue

protected void setValue(Object value)

Description copied from class: PropertyEditorBase

Logic to set the value in the editor component.

Specified by:

setValue in class PropertyEditorBase

Parameters:

value - Value for the editor component.

onEvent

public void onEvent(org.zkoss.zk.ui.event.Event event)
             throws Exception

Capture the bandbox onOpen event and invokes doOpen or doClose depending on the bandbox state.

Specified by:

onEvent in interface org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>

Throws:

Exception