Uses of Class
org.carewebframework.shell.layout.UIElementBase

Packages that use UIElementBase

Package	Description
org.carewebframework.shell
org.carewebframework.shell.designer
org.carewebframework.shell.layout
org.carewebframework.shell.plugins

Uses of UIElementBase in org.carewebframework.shell

Methods in org.carewebframework.shell that return UIElementBase

Modifier and Type	Method and Description
protected UIElementBase	CareWebShellEx.PathResolver.getRoot(UIElementTabPane tabPane) Returns the root for the specified tab pane.
UIElementBase	CareWebShellEx.register(String path, PluginDefinition def) Registers the plugin with the specified definition with the specified path.
UIElementBase	CareWebShellEx.register(String path, PluginDefinition def, IPropertyProvider propertySource) Registers the plugin with the specified definition with the specified path.
UIElementBase	CareWebShellEx.register(String path, String url) Register a plugin by specifying a path and a url.
UIElementBase	CareWebShellEx.register(String path, String url, IPropertyProvider propertySource) Register a plugin by specifying a path and a url.
UIElementBase	CareWebShellEx.registerFromId(String path, String id) Registers the plugin with the specified id and path.
UIElementBase	CareWebShellEx.registerFromId(String path, String id, IPropertyProvider propertySource) Registers the plugin with the specified id and path.
protected UIElementBase	CareWebShellEx.PathResolver.resolvePath(UIElementTabPane tabPane, String path) Resolves the path, returning the UI element to be used as the parent of the plugin.

Methods in org.carewebframework.shell with parameters of type UIElementBase

Modifier and Type	Method and Description
static void	AboutDialog.execute(UIElementBase component) Display an about dialog for the specified UI element.

Constructor parameters in org.carewebframework.shell with type arguments of type UIElementBase

Constructor and Description
CareWebShellEx.PathResolver(Class<? extends UIElementBase> rootClass, Class<? extends UIElementBase> childClass) Creates a path resolver.
CareWebShellEx.PathResolver(Class<? extends UIElementBase> rootClass, Class<? extends UIElementBase> childClass) Creates a path resolver.

Uses of UIElementBase in org.carewebframework.shell.designer

Classes in org.carewebframework.shell.designer with type parameters of type UIElementBase

Modifier and Type	Class and Description
class	PropertyEditorCustomTree<T extends UIElementBase> 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.

Methods in org.carewebframework.shell.designer that return UIElementBase

Modifier and Type	Method and Description
UIElementBase	PropertyGrid.getTarget() Returns the target UI element.
UIElementBase	PropertyEditorBase.getTarget() Returns the target UI element associated with this editor.
UIElementBase	LayoutChangedEvent.getUIElement() Returns the UI element that changed.
static UIElementBase	AddComponent.newChild(UIElementBase parentElement) Display the add component dialog, presenting a list of candidate plugins that may serve as children to the specified parent element.

Methods in org.carewebframework.shell.designer with parameters of type UIElementBase

Modifier and Type	Method and Description
static PropertyGrid	PropertyGrid.create(UIElementBase target, org.zkoss.zk.ui.Component parent) Creates a property grid for the given target UI element.
static PropertyGrid	PropertyGrid.create(UIElementBase target, org.zkoss.zk.ui.Component parent, boolean embedded) Creates a property grid for the given target UI element.
static void	LayoutDesigner.execute(UIElementBase rootElement) Display the Layout Manager dialog
static PluginDefinition	AddComponent.getDefinition(UIElementBase parentElement) Display the add component dialog, presenting a list of candidate plugins that may serve as children to the specified parent element.
protected void	PropertyEditorText.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid)
protected void	PropertyEditorList.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid)
protected void	PropertyEditorInteger.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid)
protected void	PropertyEditorIcon.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid)
protected void	PropertyEditorEnum.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid) Initialize the list, based on the configuration data which can specify an enumeration class, an iterable class, or the id of an iterable bean.
protected void	PropertyEditorDouble.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid)
protected void	PropertyEditorDate.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid)
protected void	PropertyEditorCustomTree.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	PropertyEditorCustom.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.
protected void	PropertyEditorColor.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid)
protected void	PropertyEditorChoiceList.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid)
protected void	PropertyEditorBoolean.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid)
protected void	PropertyEditorBase.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid) Initializes the property editor.
protected void	PropertyEditorAction.init(UIElementBase target, PropertyInfo propInfo, PropertyGrid propGrid) Initialize the list from the action registry.
static UIElementBase	AddComponent.newChild(UIElementBase parentElement) Display the add component dialog, presenting a list of candidate plugins that may serve as children to the specified parent element.
protected void	PropertyEditorCustomTree.resequenceTargets(org.zkoss.zul.Treechildren tc, UIElementBase parent) Resequence all UI elements to match that of the tree view.
void	DesignContextMenu.setOwner(UIElementBase owner) Sets the context menu's owner.
void	PropertyGrid.setTarget(UIElementBase target) Sets the target UI element for the property grid.
static void	DesignContextMenu.updateStates(UIElementBase ele, org.zkoss.zk.ui.ext.Disable add, org.zkoss.zk.ui.ext.Disable delete, org.zkoss.zk.ui.ext.Disable copy, org.zkoss.zk.ui.ext.Disable cut, org.zkoss.zk.ui.ext.Disable paste, org.zkoss.zk.ui.ext.Disable properties, org.zkoss.zk.ui.ext.Disable about) Updates states on input elements (typically buttons or menu items) according to state of the specified UI element.

Constructors in org.carewebframework.shell.designer with parameters of type UIElementBase

Constructor and Description
LayoutChangedEvent(org.zkoss.zk.ui.Component target, UIElementBase element)

Uses of UIElementBase in org.carewebframework.shell.layout

Subclasses of UIElementBase in org.carewebframework.shell.layout

Modifier and Type	Class and Description
class	UIElementActionBase Base class for UI elements that support an associated action.
class	UIElementButton Simple button stock object.
class	UIElementDesktop This is the topmost component of the layout.
class	UIElementFrame UI element that encapsulates an iframe or an include (as determined by URL).
class	UIElementLayout Wrapper for a UI layout component.
class	UIElementLink Simple hyperlink stock object.
class	UIElementMenubar Implements a shared menubar.
class	UIElementMenuBase Base implementation of a menu bar.
class	UIElementMenuItem Single menu item for inclusion in a menubar-based tree.
class	UIElementMenuItemBase Base class for representing a single menu item.
class	UIElementPlugin This class is used for all container-hosted plugins.
class	UIElementProxy Proxy for an arbitrary UI element that can store and return property values.
class	UIElementSplitterPane A child of the UIElementSplitterView.
class	UIElementSplitterView A splitter view has either a vertical or horizontal orientation and can contain any number of splitter panes which are placed side-by-side with splitter bars in between for manual sizing.
class	UIElementStepPane A step-oriented UI Element.
class	UIElementStepView A step-oriented UI Element.
class	UIElementTabMenu Implements a tab-based menubar.
class	UIElementTabMenuPane Single menu item for the tab menu.
class	UIElementTabPane Wraps the ZK Tab and Tabpanel components.
class	UIElementTabView Wraps the ZK Tabbox component.
class	UIElementToolbar Implements a shared toolbar.
class	UIElementTreePane A child of a UIElementTreeView, this UI element specifies the tree path where its associated tree node is to reside in the parent's tree.
class	UIElementTreeView A tree view consists of a selector pane on the left containing a ZK tree component and a view area on the right where tree panes are positioned.
class	UIElementZKBase This is an abstract class from which all ZK-based UI elements must derive.

Methods in org.carewebframework.shell.layout with type parameters of type UIElementBase

Modifier and Type	Method and Description
<T extends UIElementBase> T	UIElementBase.findChildElement(Class<T> clazz) Recurses the component subtree for a child belonging to the specified class.
<T extends UIElementBase> T	UIElementBase.getAncestor(Class<T> clazz) Returns the first ancestor corresponding to the specified class.
<T extends UIElementBase> T	UIElementBase.getChild(Class<T> clazz, UIElementBase last) Locates and returns a child that is an instance of the specified class.

Methods in org.carewebframework.shell.layout that return UIElementBase

Modifier and Type	Method and Description
UIElementBase	UILayout.deserialize(UIElementBase parent) Deserializes the layout, under the specified parent, starting from the layout origin.
static UIElementBase	UIElementZKBase.getAssociatedUIElement(org.zkoss.zk.ui.Component component) Returns the UI element that registered the ZK component.
UIElementBase	UIElementBase.getChild(int index) Gets the UI element child at the specified index.
UIElementBase	UIElementBase.getFirstChild() Returns the first child, or null if there are no children.
UIElementBase	UIElementBase.getFirstVisibleChild() Returns the first visible child.
UIElementBase	UIElementBase.getLastChild() Returns the last child, or null if there are no children.
UIElementBase	UIElementBase.getLastVisibleChild() Returns the last visible child.
UIElementBase	UIElementBase.getNextSibling(boolean visibleOnly) Returns this element's next sibling.
UIElementBase	UIElementBase.getParent() Returns the parent of this element.
UIElementBase	UIElementBase.getRoot() Returns the UI element at the root of the component tree.
UIElementBase	UIElementProxy.getTarget()

Methods in org.carewebframework.shell.layout that return types with arguments of type UIElementBase

Modifier and Type	Method and Description
Iterable<UIElementBase>	UIElementBase.getChildren() Returns an iterable of this component's children.
Class<? extends UIElementBase>	UILayout.getRootClass() Returns the class of the element at the root of the layout.
Iterable<UIElementBase>	UIElementLayout.getSerializableChildren() A linked layout has no serializable children.
Iterable<UIElementBase>	UIElementBase.getSerializableChildren() Returns an iterable of this component's serializable children.

Methods in org.carewebframework.shell.layout with parameters of type UIElementBase

Modifier and Type	Method and Description
void	UIElementDesktop.addChild(UIElementBase child) Overrides addChild to suppress onAddChild events for internally created children.
void	UIElementBase.addChild(UIElementBase child) Adds the specified child element.
protected void	UIElementBase.addChild(UIElementBase child, boolean doEvent) Adds the specified child element.
protected void	UIElementTreePane.afterAddChild(UIElementBase child) Initializes the child after it is added.
protected void	UIElementToolbar.afterAddChild(UIElementBase child)
protected void	UIElementMenuItemBase.afterAddChild(UIElementBase child)
protected void	UIElementMenuBase.afterAddChild(UIElementBase child)
protected void	UIElementBase.afterAddChild(UIElementBase child) Called after a child is logically added to the parent.
void	UIElementSplitterPane.afterParentChanged(UIElementBase oldParent)
protected void	UIElementBase.afterParentChanged(UIElementBase oldParent) Called after the parent has been changed.
protected void	UIElementTreePane.afterRemoveChild(UIElementBase child)
protected void	UIElementMenuItemBase.afterRemoveChild(UIElementBase child)
protected void	UIElementMenuBase.afterRemoveChild(UIElementBase child)
protected void	UIElementBase.afterRemoveChild(UIElementBase child) Called after a child is logically removed from the parent.
protected void	UIElementToolbar.beforeAddChild(UIElementBase child)
protected void	UIElementBase.beforeAddChild(UIElementBase child) Called before a child is logically added to the parent.
protected void	UIElementBase.beforeParentChanged(UIElementBase newParent) Called before the parent has been changed.
protected void	UIElementTreeView.beforeRemoveChild(UIElementBase child) Remove the associated tree node when a tree pane is removed.
protected void	UIElementTabView.beforeRemoveChild(UIElementBase child) Need to detach both the tab and the tab panel of the child component.
protected void	UIElementStepView.beforeRemoveChild(UIElementBase child)
protected void	UIElementBase.beforeRemoveChild(UIElementBase child) Called before a child is logically removed from the parent.
boolean	UIElementTreePane.canAcceptChild(UIElementBase child)
boolean	UIElementBase.canAcceptChild(UIElementBase child) Returns true if this element may accept the specified child.
boolean	UIElementBase.canAcceptParent(UIElementBase parent) Returns true if this element may accept the specified element as a parent.
UIElementBase	UILayout.deserialize(UIElementBase parent) Deserializes the layout, under the specified parent, starting from the layout origin.
<T extends UIElementBase> T	UIElementBase.getChild(Class<T> clazz, UIElementBase last) Locates and returns a child that is an instance of the specified class.
boolean	UIElementBase.hasAncestor(UIElementBase element) Returns true if specified element is an ancestor of this element.
boolean	UIElementBase.hasChild(UIElementBase element) Returns true if the specified element is a child of this element.
int	UIElementBase.indexOfChild(UIElementBase child) Returns the index of the specified child.
void	UIElementProxy.realize(UIElementBase parent) Realizes the creation or destruction of the proxied target.
void	UIElementBase.removeChild(UIElementBase child, boolean destroy) Removes the specified element as a child of this parent.
static UILayout	UILayout.serialize(UIElementBase parent) Serializes the UI element hierarchy under and including the specified element.
void	UIElementBase.setParent(UIElementBase parent) Sets the parent of this element, subject to the parent/child constraints applicable to each.

Method parameters in org.carewebframework.shell.layout with type arguments of type UIElementBase

Modifier and Type	Method and Description
boolean	UIElementTreePane.canAcceptChild(Class<? extends UIElementBase> clazz)
boolean	UIElementBase.canAcceptChild(Class<? extends UIElementBase> clazz) Returns true if this element may accept a child of the specified class.
static boolean	UIElementBase.canAcceptChild(Class<? extends UIElementBase> parentClass, Class<? extends UIElementBase> childClass) Returns true if childClass can be a child of the parentClass.
static boolean	UIElementBase.canAcceptChild(Class<? extends UIElementBase> parentClass, Class<? extends UIElementBase> childClass) Returns true if childClass can be a child of the parentClass.
boolean	UIElementBase.canAcceptParent(Class<? extends UIElementBase> clazz) Returns true if this element may accept a parent of the specified class.
static boolean	UIElementBase.canAcceptParent(Class<? extends UIElementBase> childClass, Class<? extends UIElementBase> parentClass) Returns true if parentClass can be a parent of childClass.
static boolean	UIElementBase.canAcceptParent(Class<? extends UIElementBase> childClass, Class<? extends UIElementBase> parentClass) Returns true if parentClass can be a parent of childClass.
protected static void	UIElementBase.registerAllowedChildClass(Class<? extends UIElementBase> clazz, Class<? extends UIElementBase> childClass) A UIElementBase subclass should call this in its static initializer block to register any subclasses that may be a child.
protected static void	UIElementBase.registerAllowedChildClass(Class<? extends UIElementBase> clazz, Class<? extends UIElementBase> childClass) A UIElementBase subclass should call this in its static initializer block to register any subclasses that may be a child.
protected static void	UIElementBase.registerAllowedParentClass(Class<? extends UIElementBase> clazz, Class<? extends UIElementBase> parentClass) A UIElementBase subclass should call this in its static initializer block to register any subclasses that may act as a parent.
protected static void	UIElementBase.registerAllowedParentClass(Class<? extends UIElementBase> clazz, Class<? extends UIElementBase> parentClass) A UIElementBase subclass should call this in its static initializer block to register any subclasses that may act as a parent.
void	UIElementBase.setDefinition(Class<? extends UIElementBase> clazz) Sets the plugin definition based on the specified class.

Constructors in org.carewebframework.shell.layout with parameters of type UIElementBase

Constructor and Description
UIElementProxy(UIElementBase target)

Uses of UIElementBase in org.carewebframework.shell.plugins

Methods in org.carewebframework.shell.plugins that return UIElementBase

Modifier and Type	Method and Description
UIElementBase	PluginDefinition.createElement(UIElementBase parent, IPropertyProvider propertySource) Creates an instance of the element based on its definition.

Methods in org.carewebframework.shell.plugins that return types with arguments of type UIElementBase

Modifier and Type	Method and Description
Class<? extends UIElementBase>	PluginDefinition.getClazz() Returns the UI element class associated with this definition.

Methods in org.carewebframework.shell.plugins with parameters of type UIElementBase

Modifier and Type	Method and Description
UIElementBase	PluginDefinition.createElement(UIElementBase parent, IPropertyProvider propertySource) Creates an instance of the element based on its definition.

Method parameters in org.carewebframework.shell.plugins with type arguments of type UIElementBase

Modifier and Type	Method and Description
static PluginDefinition	PluginDefinition.getDefinition(Class<? extends UIElementBase> clazz) Returns the plugin definition associated with the specified class.
void	PluginDefinition.setClazz(Class<? extends UIElementBase> clazz) Sets the UI element class associated with this definition.

Constructor parameters in org.carewebframework.shell.plugins with type arguments of type UIElementBase

Constructor and Description
PluginDefinition(String name, Class<? extends UIElementBase> clazz) Constructs a plugin definition for the specified plugin name and class.