org.carewebframework.shell

Class CareWebShellEx

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Div

org.carewebframework.shell.CareWebShell

org.carewebframework.shell.CareWebShellEx

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.AfterCompose, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class CareWebShellEx
extends CareWebShell

This class is provided primarily for backward compatibility with the old fixed layout of tab views containing tree views. It can only be used with a layout that contains a tab view component. Its public methods are fully compatible with version 1.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CareWebShellEx.PathResolver Locates the plugin's parent UI element given a tab pane and a path.

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

Modifier and Type	Field and Description
static String	TOOLBAR_PATH

Fields inherited from class org.carewebframework.shell.CareWebShell

LBL_CONFIRM_CLOSE, LBL_LOGOUT_CANCEL, LBL_LOGOUT_CONFIRMATION, LBL_LOGOUT_CONFIRMATION_CAPTION, LBL_NO_LAYOUT

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
CareWebShellEx()

Method Summary

Methods

Modifier and Type	Method and Description
CareWebShellEx.PathResolver	getPathResolver() Returns the path resolver implementation.
UIElementBase	register(String path, PluginDefinition def) Registers the plugin with the specified definition with the specified path.
UIElementBase	register(String path, PluginDefinition def, IPropertyProvider propertySource) Registers the plugin with the specified definition with the specified path.
UIElementBase	register(String path, String url) Register a plugin by specifying a path and a url.
UIElementBase	register(String path, String url, IPropertyProvider propertySource) Register a plugin by specifying a path and a url.
UIElementBase	registerFromId(String path, String id) Registers the plugin with the specified id and path.
UIElementBase	registerFromId(String path, String id, IPropertyProvider propertySource) Registers the plugin with the specified id and path.
void	registerLayout(String path, String resource) Registers a layout at the specified path.
UIElementMenuItem	registerMenu(String path, String action) Register a menu.
void	setPathResolver(CareWebShellEx.PathResolver pathResolver) Sets the path resolver implementation.

Methods inherited from class org.carewebframework.shell.CareWebShell

addMenu, addToolbarComponent, afterCompose, buildUI, clearMessages, clearMessages, getActivatedPlugin, getActivatedPlugins, getActivatedPlugins, getApplicationName, getClientInformation, getLayout, getLoadedPlugin, getLoadedPlugin, getLoadedPluginDefinitions, getLoadedPlugins, getPropertyGroups, getUIDesktop, getUILayout, isAutoStart, loadLayoutByAppId, loadLayoutByAppId, loadLayoutFromResource, lock, logout, onCommand, onCtrlKey, registerHelpResource, registerPlugin, registerPropertyGroup, registerStyleSheet, reset, setAutoStart, setLayout, showMessage, showMessage, showMessage, showMessage, showMessage, showMessage, showMessage, start, unregisterPlugin

Methods inherited from class org.zkoss.zul.Div

getAlign, renderProperties, setAlign

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

clone, 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, getZclass, getZindex, getZIndex, service, setAction, setClass, setDraggable, 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, beforeChildAdded, 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, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, 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, setVisible, 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

Field Detail

TOOLBAR_PATH

public static final String TOOLBAR_PATH

See Also:

Constant Field Values

Constructor Detail

CareWebShellEx

public CareWebShellEx()

Method Detail

registerFromId

public UIElementBase registerFromId(String path,
                           String id)
                             throws Exception

Registers the plugin with the specified id and path. If a tree path is absent, the plugin is associated with the tab itself.

Parameters:

path - Format is <tab name>\<tree node path>

id - Unique id of plugin

Returns:

Container created for the plugin.

Throws:

Exception - Unspecified exception.

registerFromId

public UIElementBase registerFromId(String path,
                           String id,
                           IPropertyProvider propertySource)
                             throws Exception

Registers the plugin with the specified id and path. If a tree path is absent, the plugin is associated with the tab itself.

Parameters:

path - Format is <tab name>\<tree node path>

id - Unique id of plugin

propertySource - Optional source for retrieving property values.

Returns:

Container created for the plugin.

Throws:

Exception - Unspecified exception.

register

public UIElementBase register(String path,
                     String url)
                       throws Exception

Register a plugin by specifying a path and a url.

Parameters:

path - Format is <tab name>\<tree node path>

url - Main url of plugin.

Returns:

Container created for the plugin.

Throws:

Exception - Unspecified exception.

register

public UIElementBase register(String path,
                     String url,
                     IPropertyProvider propertySource)
                       throws Exception

Register a plugin by specifying a path and a url.

Parameters:

path - Format is <tab name>\<tree node path>

url - Main url of plugin.

propertySource - Optional source for retrieving property values.

Returns:

Container created for the plugin.

Throws:

Exception - Unspecified exception.

registerMenu

public UIElementMenuItem registerMenu(String path,
                             String action)

Register a menu.

Parameters:

path - Path for the menu.

action - Associated action for the menu.

Returns:

Created menu.

register

public UIElementBase register(String path,
                     PluginDefinition def)
                       throws Exception

Registers the plugin with the specified definition with the specified path. If a tree path is absent, the plugin is associated with the tab itself.

Parameters:

path - Format is <tab name>\<tree node path>

def - Plugin definition

Returns:

The newly created plugin.

Throws:

Exception - Unspecified exception.

register

public UIElementBase register(String path,
                     PluginDefinition def,
                     IPropertyProvider propertySource)
                       throws Exception

Registers the plugin with the specified definition with the specified path. If a tree path is absent, the plugin is associated with the tab itself.

Parameters:

path - Format is <tab name>\<tree node path>

def - Plugin definition

propertySource - Optional source for retrieving property values.

Returns:

The newly created plugin.

Throws:

Exception - Unspecified exception.

registerLayout

public void registerLayout(String path,
                  String resource)
                    throws Exception

Registers a layout at the specified path.

Parameters:

path - Format is <tab name>\<tree node path>

resource - Location of the xml layout.

Throws:

Exception - Unspecified exception.

getPathResolver

public CareWebShellEx.PathResolver getPathResolver()

Returns the path resolver implementation. This implementation determines where in the layout the plugin should be placed based on a path. A default implementation is provided.

Returns:

The path resolver.

setPathResolver

public void setPathResolver(CareWebShellEx.PathResolver pathResolver)

Sets the path resolver implementation. This must be set before any resources are registered.

Parameters:

pathResolver - The path resolver.