org.carewebframework.shell.designer

Class PropertyEditorCustomTree<T extends ElementBase>

java.lang.Object

org.carewebframework.shell.designer.PropertyEditorBase<org.fujion.component.Popupbox>

org.carewebframework.shell.designer.PropertyEditorCustom

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

Type Parameters:

T - Type of child element.

All Implemented Interfaces:

Comparable<PropertyEditorBase<org.fujion.component.Popupbox>>

Direct Known Subclasses:

PropertyEditorMenubar, PropertyEditorOrderedChildren, PropertyEditorSplitterView, PropertyEditorStepView, PropertyEditorTabView, PropertyEditorTreeView, PropertyEditorTriggers

public class PropertyEditorCustomTree<T extends ElementBase>
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PropertyEditorCustomTree.Proxy Subclass ElementProxy to allow us to synchronize changes to label property with the corresponding tree node.

Field Summary

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

popup

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

editor

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected PropertyEditorCustomTree.Proxy	addProxy(PropertyEditorCustomTree.Proxy proxy) Add a proxy to the proxy list.
protected org.fujion.component.Treenode	addTreenode(PropertyEditorCustomTree.Proxy proxy, org.fujion.component.BaseComponent parent, org.fujion.component.Treenode insertAfter) Adds a tree node under the specified parent.
protected boolean	canDemote(org.fujion.component.Treenode node) Override to enable promotion of items
protected boolean	canPromote(org.fujion.component.Treenode node) Override to enable promotion of items
boolean	commit() Commits changes to all proxies.
void	doClose() Invoked when the associated component is closed;
protected Object	getValue() Logic to return the value from the editor component.
boolean	hasChanged() Returns true if changes have been made since the last commit.
protected void	init(Object 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(PropertyEditorCustomTree.Proxy proxy) Subclasses may override to provide any special proxy initialization.
protected PropertyEditorCustomTree.Proxy	newProxy(ElementBase child) Creates a new proxy for the specified child.
protected PropertyEditorCustomTree.Proxy	newProxy(PluginDefinition def) Creates a new proxy for a child to be created.
void	onLabelChange$tree()
protected void	resequenceTargets(org.fujion.component.BaseComponent tc, ElementBase parent) Resequence all UI elements to match that of the tree view.
boolean	revert() Reverts all changes to the last committed state.
protected void	setValue(Object value) Logic to set the value in the editor component.
protected void	wireController()

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

doOpen, setFocus

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

compareTo, getEditor, getPropInfo, getTarget, onChange, 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)

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 child 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.

Method Detail

initProxy

protected void initProxy(PropertyEditorCustomTree.Proxy proxy)

Subclasses may override to provide any special proxy initialization.

Parameters:

proxy - Proxy to be initialized.

init

protected void init(Object 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.

wireController

protected void wireController()

Overrides:

wireController in class PropertyEditorBase<org.fujion.component.Popupbox>

commit

public boolean commit()

Commits changes to all proxies.

Overrides:

commit in class PropertyEditorBase<org.fujion.component.Popupbox>

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<org.fujion.component.Popupbox>

Returns:

True if the operation was successful.

addTreenode

protected org.fujion.component.Treenode addTreenode(PropertyEditorCustomTree.Proxy proxy,
                                                    org.fujion.component.BaseComponent parent,
                                                    org.fujion.component.Treenode insertAfter)

Adds a tree node under the specified parent.

Parameters:

proxy - The proxy associated with the tree node.

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

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

Returns:

The newly created tree node.

resequenceTargets

protected void resequenceTargets(org.fujion.component.BaseComponent tc,
                                 ElementBase parent)

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

Parameters:

tc - Root of subtree.

parent - The parent UI element.

newProxy

protected PropertyEditorCustomTree.Proxy newProxy(ElementBase child)

Creates a new proxy for the specified child.

Parameters:

child - Element to be proxied. May not be null.

Returns:

The proxy wrapping the specified child.

newProxy

protected PropertyEditorCustomTree.Proxy newProxy(PluginDefinition def)

Creates a new proxy for a child to be created.

Parameters:

def - Plugin definition for child to be created.

Returns:

The proxy wrapping the specified plugin definition.

addProxy

protected PropertyEditorCustomTree.Proxy addProxy(PropertyEditorCustomTree.Proxy proxy)

Add a proxy to the proxy list.

Parameters:

proxy - Proxy to add

Returns:

The newly added proxy.

onLabelChange$tree

public void onLabelChange$tree()

doClose

public void doClose()

Description copied from class: PropertyEditorCustom

Invoked when the associated component is closed;

Overrides:

doClose in class PropertyEditorCustom

canPromote

protected boolean canPromote(org.fujion.component.Treenode node)

Override to enable promotion of items

Parameters:

node - The node to test.

Returns:

True if the node can be promoted.

canDemote

protected boolean canDemote(org.fujion.component.Treenode node)

Override to enable promotion of items

Parameters:

node - The node to test.

Returns:

True if the node can be demoted.

hasChanged

public boolean hasChanged()

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

Overrides:

hasChanged in class PropertyEditorBase<org.fujion.component.Popupbox>

Returns:

True if pending changes exist.

getValue

protected Object getValue()

Description copied from class: PropertyEditorBase

Logic to return the value from the editor component.

Specified by:

getValue in class PropertyEditorBase<org.fujion.component.Popupbox>

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<org.fujion.component.Popupbox>

Parameters:

value - Value for the editor component.