org.carewebframework.shell.designer

Class PropertyEditorCustomTree<T extends UIElementBase>

java.lang.Object

org.carewebframework.shell.designer.PropertyEditorBase

org.carewebframework.shell.designer.PropertyEditorCustom

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

Type Parameters:

T - Type of child element.

All Implemented Interfaces:

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

Direct Known Subclasses:

PropertyEditorMenubar, PropertyEditorOrderedChildren, PropertyEditorSplitterView, PropertyEditorStepView, PropertyEditorTabMenu, PropertyEditorTabView, PropertyEditorTreeView

public abstract class PropertyEditorCustomTree<T extends UIElementBase>
extends PropertyEditorCustom

Abstract class for implementing a custom property editor based on a tree view display of child elements that can be manipulated and whose properties may be edited.

Field Summary

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

bandbox, bandpopup

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

component

Constructor Summary

Constructors

Constructor and Description
PropertyEditorCustomTree(Class<T> childClass, String labelProperty, boolean hierarchical) Create the editor instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.zkoss.zul.Treeitem	addTreeitem(T child, org.zkoss.zk.ui.Component parent, org.zkoss.zul.Treeitem insertAfter) Adds a tree item under the specified parent.
protected boolean	canDemote(org.zkoss.zul.Treeitem item) Override to enable promotion of items
protected boolean	canPromote(org.zkoss.zul.Treeitem item) Override to enable promotion of items
boolean	commit() Commits changes to all proxies.
void	doClose() Invoked when the associated bandbox is closed;
protected PluginDefinition	getTargetDefinition() Returns the plugin definition for the proxied object.
boolean	hasChanged() Returns true if changes have been made since the last commit.
protected void	init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid) Initializes the property editor by constructing the tree view based on the child elements of the target element.
protected void	initProxy(org.carewebframework.shell.designer.PropertyEditorCustomTree.Proxy proxy) Subclasses may override to provide any special proxy initialization.
void	onChange(org.zkoss.zk.ui.event.Event event) Catches onChange events from the grid.
void	onClick$btnAdd() Add a new item.
void	onClick$btnDelete() Delete the selected item.
void	onClick$btnDown() Move the selected tree item down one level.
void	onClick$btnLeft() Promote the selected tree item.
void	onClick$btnRight() Demote the selected tree item.
void	onClick$btnUp() Move the selected tree item up one level.
void	onClose(org.zkoss.zk.ui.event.Event event) If the property grid is closed, instead close the bandbox.
void	onDoubleClick$tree(org.zkoss.zk.ui.event.Event event) Double-clicking a tree item allows in place editing.
void	onLabelChange$tree()
void	onSelect$tree() Occurs when the tree view selection changes.
protected void	resequenceTargets(org.zkoss.zul.Treechildren tc, UIElementBase parent) Resequence all UI elements to match that of the tree view.
boolean	revert() Reverts all changes to the last committed state.

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

doOpen, getValue, onEvent, setFocus, setValue

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

getComponent, getPropInfo, getTarget, setWrongValueException, setWrongValueMessage, updateValue

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyEditorCustomTree

public PropertyEditorCustomTree(Class<T> childClass,
                        String labelProperty,
                        boolean hierarchical)
                         throws Exception

Create the editor instance.

Parameters:

childClass - This is the class of child elements managed by this editor. It is used to create new instances of the UI element from within the editor and to restrict the selection of child elements to that type only.

The owner class may be null. In this case, there is no restriction on the child type. The user is prompted for an element type when creating a new instance.

labelProperty - This is the name of the property on the child UI element that will be synchronized with the label of the corresponding tree node. It may be null.

hierarchical - If true, the editor assumes that child elements may contain other child elements.

Throws:

Exception - Unspecified exception.

Method Detail

getTargetDefinition

protected PluginDefinition getTargetDefinition()

Returns the plugin definition for the proxied object. This is used to for cases where a proxy is created for a child element that does not yet exist. It enables the proxy to defer creation of the proxied element until a commit occurs.

Note that if there is no specified plugin definition, the add component dialog will be presented, allowing the user to select which definition to use.

Returns:

The plugin definition to use. This may be null.

initProxy

protected void initProxy(org.carewebframework.shell.designer.PropertyEditorCustomTree.Proxy proxy)

Subclasses may override to provide any special proxy initialization.

Parameters:

proxy - Proxy to be initialized.

init

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

Initializes the property editor by constructing the tree view based on the child elements of the target element.

Overrides:

init in class PropertyEditorCustom

Parameters:

target - Target element whose children will be represented in the tree view.

propInfo - The property information associated with the child elements.

propGrid - The parent property grid.

commit

public boolean commit()

Commits changes to all proxies.

Overrides:

commit in class PropertyEditorBase

Returns:

True if the operation was successful.

revert

public boolean revert()

Reverts all changes to the last committed state. This is done by simply discarding all proxies and recreating them from the original child elements.

Overrides:

revert in class PropertyEditorBase

Returns:

True if the operation was successful.

addTreeitem

protected org.zkoss.zul.Treeitem addTreeitem(T child,
                                 org.zkoss.zk.ui.Component parent,
                                 org.zkoss.zul.Treeitem insertAfter)

Adds a tree item under the specified parent.

Parameters:

child - Child to be associated (via a proxy) with the newly created tree item.

parent - The tree parent to receive the new tree item.

insertAfter - Tree item after which new item will be added (may be null).

Returns:

The newly created tree item.

resequenceTargets

protected void resequenceTargets(org.zkoss.zul.Treechildren tc,
                     UIElementBase parent)

Resequence all UI elements to match that of the tree view.

Parameters:

tc - Root of subtree.

parent - The parent UI element.

onSelect$tree

public void onSelect$tree()

Occurs when the tree view selection changes.

onDoubleClick$tree

public void onDoubleClick$tree(org.zkoss.zk.ui.event.Event event)

Double-clicking a tree item allows in place editing.

Parameters:

event - The double click event.

onLabelChange$tree

public void onLabelChange$tree()

doClose

public void doClose()

Description copied from class: PropertyEditorCustom

Invoked when the associated bandbox is closed;

Overrides:

doClose in class PropertyEditorCustom

onClose

public void onClose(org.zkoss.zk.ui.event.Event event)

If the property grid is closed, instead close the bandbox.

Parameters:

event - The close event.

onClick$btnAdd

public void onClick$btnAdd()

Add a new item.

onClick$btnDelete

public void onClick$btnDelete()

Delete the selected item. If the associated proxy does not yet contain a proxied target, it is simply removed from the proxy list. Otherwise, it is marked as deleted, but remains in the list.

onClick$btnUp

public void onClick$btnUp()

Move the selected tree item up one level.

onClick$btnDown

public void onClick$btnDown()

Move the selected tree item down one level.

onClick$btnLeft

public void onClick$btnLeft()

Promote the selected tree item.

onClick$btnRight

public void onClick$btnRight()

Demote the selected tree item.

onChange

public void onChange(org.zkoss.zk.ui.event.Event event)

Catches onChange events from the grid.

Parameters:

event - The onChange event.

canPromote

protected boolean canPromote(org.zkoss.zul.Treeitem item)

Override to enable promotion of items

Parameters:

item - The item to test.

Returns:

True if the item can be promoted.

canDemote

protected boolean canDemote(org.zkoss.zul.Treeitem item)

Override to enable promotion of items

Parameters:

item - The item to test.

Returns:

True if the item can be demoted.

hasChanged

public boolean hasChanged()

Returns true if changes have been made since the last commit.

Overrides:

hasChanged in class PropertyEditorBase

Returns:

True if pending changes exist.