org.carewebframework.shell.designer

Class PropertyGrid

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Window

org.carewebframework.shell.designer.PropertyGrid

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.IdSpace, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.ext.Framable

public class PropertyGrid
extends org.zkoss.zul.Window

Dialog for managing property values of UI elements within the designer. Each editable property of the target UI element is presented as a row in the grid with its associated property editor.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zul.Window

org.zkoss.zul.Window.Mode

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zul.Window

EMBEDDED, HIGHLIGHTED, MODAL, OVERLAPPED, POPUP

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
PropertyGrid()

Method Summary

Methods

Modifier and Type	Method and Description
protected PropertyEditorBase	addPropertyEditor(PropertyInfo propInfo, boolean append) Adds a property editor to the grid for the specified property definition.
protected boolean	commitChanges(boolean commit) Commit or revert all pending changes to the target object.
static PropertyGrid	create(UIElementBase target, org.zkoss.zk.ui.Component parent) Creates a property grid for the given target UI element.
static PropertyGrid	create(UIElementBase target, org.zkoss.zk.ui.Component parent, boolean embedded) Creates a property grid for the given target UI element.
protected PropertyEditorBase	findEditor(String propName) Returns the editor associated with the named property, or null if none found.
boolean	getPropertiesModified()
UIElementBase	getTarget() Returns the target UI element.
boolean	hasPendingChanges() Returns true if there are uncommitted edits.
void	onChange(org.zkoss.zk.ui.event.Event event) Handles change events from property editors.
void	onClick$btnApply() Clicking the apply button commits any pending edits.
void	onClick$btnCancel() Clicking the cancel button cancels any pending edits and, if embedded mode is not active, closes the dialog.
void	onClick$btnOK() Clicking the OK button commits any pending edits and closes the dialog.
void	onClick$btnRestore() Clicking the restore button cancels any pending edits.
void	onClose() Overrides the onClose method to prevent dialog closure when in embedded mode.
void	onSelect(org.zkoss.zk.ui.event.Event event) Handles the selection of a row in the property grid.
void	setTarget(UIElementBase target) Sets the target UI element for the property grid.

Methods inherited from class org.zkoss.zul.Window

beforeChildAdded, clone, doEmbedded, doHighlighted, doModal, doOverlapped, doPopup, getBorder, getCaption, getContentSclass, getContentStyle, getDefaultActionOnShow, getMinheight, getMinwidth, getMode, getModeType, getPosition, getTitle, getZclass, inEmbedded, inHighlighted, inModal, inOverlapped, inPopup, insertBefore, isClosable, isCollapsible, isMaximizable, isMaximized, isMinimizable, isMinimized, isShadow, isSizable, onChildRemoved, onModal, onPageDetached, renderProperties, service, setBorder, setBorder, setClosable, setContentSclass, setContentStyle, setDefaultActionOnShow, setDraggable, setMaximizable, setMaximized, setMinheight, setMinimizable, setMinimized, setMinwidth, setMode, setMode, setMode, setPosition, setShadow, setSizable, setTitle, setTopmost, setVisible

Methods inherited from class org.zkoss.zul.impl.XulElement

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onPageAttached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zk.ui.IdSpace

getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, getAttribute, getAttributes, hasAttribute, hasAttribute, removeAttribute, removeAttribute, removeScopeListener, setAttribute, setAttribute

Constructor Detail

PropertyGrid

public PropertyGrid()

Method Detail

create

public static PropertyGrid create(UIElementBase target,
                  org.zkoss.zk.ui.Component parent)
                           throws Exception

Creates a property grid for the given target UI element.

Parameters:

target - UI element whose properties are to be edited.

parent - Parent component for property grid (may be null).

Returns:

Newly created PropertyGrid instance.

Throws:

Exception - Unspecified exception.

create

public static PropertyGrid create(UIElementBase target,
                  org.zkoss.zk.ui.Component parent,
                  boolean embedded)
                           throws Exception

Creates a property grid for the given target UI element.

Parameters:

target - UI element whose properties are to be edited.

parent - Parent component for property grid (may be null).

embedded - If true, the property grid is embedded within another component.

Returns:

Newly created PropertyGrid instance.

Throws:

Exception - Unspecified exception.

setTarget

public void setTarget(UIElementBase target)

Sets the target UI element for the property grid. Iterates throw the target's property definitions and presents a row for each editable property.

Parameters:

target - UI element whose properties are to be edited.

addPropertyEditor

protected PropertyEditorBase addPropertyEditor(PropertyInfo propInfo,
                                   boolean append)

Adds a property editor to the grid for the specified property definition.

Parameters:

propInfo - Property definition information.

append - If true, the property editor is appended to the end of the grid. Otherwise, it is inserted at the beginning.

Returns:

The newly added property editor.

commitChanges

protected boolean commitChanges(boolean commit)

Commit or revert all pending changes to the target object.

Parameters:

commit - True to commit. False to revert.

Returns:

True if all operations completed successfully.

findEditor

protected PropertyEditorBase findEditor(String propName)

Returns the editor associated with the named property, or null if none found.

Parameters:

propName - The property name.

Returns:

The associated property editor (may be null).

hasPendingChanges

public boolean hasPendingChanges()

Returns true if there are uncommitted edits.

Returns:

True if there are uncommitted edits.

getPropertiesModified

public boolean getPropertiesModified()

getTarget

public UIElementBase getTarget()

Returns the target UI element.

Returns:

The target UI element.

onClick$btnCancel

public void onClick$btnCancel()

Clicking the cancel button cancels any pending edits and, if embedded mode is not active, closes the dialog.

onClick$btnApply

public void onClick$btnApply()

Clicking the apply button commits any pending edits.

onClick$btnRestore

public void onClick$btnRestore()

Clicking the restore button cancels any pending edits.

onClick$btnOK

public void onClick$btnOK()

Clicking the OK button commits any pending edits and closes the dialog.

onClose

public void onClose()

Overrides the onClose method to prevent dialog closure when in embedded mode.

Overrides:

onClose in class org.zkoss.zul.Window

onSelect

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

Handles the selection of a row in the property grid.

Parameters:

event - Row selection event.

onChange

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

Handles change events from property editors.

Parameters:

event - Change event.