org.carewebframework.shell

Class CareWebShell

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

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

Direct Known Subclasses:

CareWebShellEx

public class CareWebShell
extends org.zkoss.zul.Div
implements org.zkoss.zk.ui.ext.AfterCompose

Implements a generic UI shell that can be dynamically extended with plug-ins.

See Also:

Serialized Form

Nested Class Summary

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
String	LBL_CONFIRM_CLOSE
String	LBL_LOGOUT_CANCEL
String	LBL_LOGOUT_CONFIRMATION
String	LBL_LOGOUT_CONFIRMATION_CAPTION
String	LBL_NO_LAYOUT
protected static org.apache.commons.logging.Log	log

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
CareWebShell() Create the shell instance.

Method Summary

Methods

Modifier and Type	Method and Description
org.zkoss.zul.Menu	addMenu(String path, String action) Adds a menu.
void	addToolbarComponent(org.zkoss.zk.ui.Component component) Adds a component to the common tool bar.
void	afterCompose() Perform additional initializations.
void	buildUI(UILayout layout) Build the UI based on the specified layout.
void	clearMessages() Clears all slide-down messages;
void	clearMessages(String tag) Clears all slide-down messages with specified tag;
PluginContainer	getActivatedPlugin(String id) Locates an activated plugin with the specified id.
Iterable<PluginContainer>	getActivatedPlugins() Returns a list of all active plugins.
Collection<PluginContainer>	getActivatedPlugins(Collection<PluginContainer> list) Populates a list of all activated plugins.
static String	getApplicationName() Returns the application name for this instance of the CareWeb shell.
org.zkoss.zk.ui.event.ClientInfoEvent	getClientInformation() Return information about the browser client.
String	getLayout() Returns the name of the layout to be loaded.
PluginContainer	getLoadedPlugin(String id) Locates a loaded plugin with the specified id.
PluginContainer	getLoadedPlugin(String id, boolean forceInit) Locates a loaded plugin with the specified id.
Iterable<PluginDefinition>	getLoadedPluginDefinitions() Returns a list of all plugin definitions that are currently in use (i.e., have associated plugins loaded) in the environment.
Iterable<PluginContainer>	getLoadedPlugins() Returns a list of all plugins currently loaded into the UI.
List<String>	getPropertyGroups() Returns a list of property groups bound to loaded plugins.
UIElementDesktop	getUIDesktop() Returns a reference to the current UI desktop.
UILayout	getUILayout() Returns a reference to the current UI layout.
boolean	isAutoStart() Returns the auto-start setting.
void	loadLayoutByAppId() Loads a layout based on the appId query parameter setting.
void	loadLayoutByAppId(String appId) Loads the layout associated with the given application id.
void	loadLayoutFromResource(String resource) Loads a layout from the specified resource.
void	lock() Lock the desktop.
void	logout() Logout user after confirmation prompt.
void	onCommand(CommandEvent event) Handle help requests.
void	onCtrlKey(org.zkoss.zk.ui.event.Event event) Capture unhandled shortcut key press events.
void	registerHelpResource(PluginResourceHelp resource) Registers a help resource.
void	registerPlugin(PluginContainer plugin) Registers a plugin and its resources.
void	registerPropertyGroup(String propertyGroup) Registers a property group.
void	registerStyleSheet(String url) Registers an external style sheet.
void	reset() Resets the desktop to its baseline state and clears registered help modules and property groups.
void	setAutoStart(boolean autoStart) Sets the auto-start setting.
void	setLayout(String defaultLayoutName) Sets the layout to be loaded.
void	showMessage(MessageWindow.MessageInfo messageInfo) Shows a slide-down message.
void	showMessage(String message) Shows a slide-down message.
void	showMessage(String message, String caption) Shows a slide-down message.
void	showMessage(String message, String caption, String color) Shows a slide-down message.
void	showMessage(String message, String caption, String color, int duration) Shows a slide-down message.
void	showMessage(String message, String caption, String color, Integer duration, String tag) Shows a slide-down message.
void	showMessage(String message, String caption, String color, Integer duration, String tag, String action) Shows a slide-down message.
void	start() Executed once all plugins are loaded.
void	unregisterPlugin(PluginContainer plugin) Unregisters a plugin and its resources.

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

log

protected static final org.apache.commons.logging.Log log

LBL_CONFIRM_CLOSE

public final String LBL_CONFIRM_CLOSE

LBL_NO_LAYOUT

public final String LBL_NO_LAYOUT

LBL_LOGOUT_CONFIRMATION

public final String LBL_LOGOUT_CONFIRMATION

LBL_LOGOUT_CONFIRMATION_CAPTION

public final String LBL_LOGOUT_CONFIRMATION_CAPTION

LBL_LOGOUT_CANCEL

public final String LBL_LOGOUT_CANCEL

Constructor Detail

CareWebShell

public CareWebShell()

Create the shell instance.

Method Detail

getApplicationName

public static String getApplicationName()

Returns the application name for this instance of the CareWeb shell.

Returns:

Application name, or null if not set.

afterCompose

public void afterCompose()

Perform additional initializations.

Specified by:

afterCompose in interface org.zkoss.zk.ui.ext.AfterCompose

onCommand

public void onCommand(CommandEvent event)

Handle help requests.

Parameters:

event - A command event.

getClientInformation

public org.zkoss.zk.ui.event.ClientInfoEvent getClientInformation()

Return information about the browser client.

Returns:

Client information.

onCtrlKey

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

Capture unhandled shortcut key press events.

Parameters:

event - Control key event.

getUIDesktop

public UIElementDesktop getUIDesktop()

Returns a reference to the current UI desktop.

Returns:

The current UI desktop.

getUILayout

public UILayout getUILayout()

Returns a reference to the current UI layout.

Returns:

The current UI layout.

start

public void start()

Executed once all plugins are loaded.

loadLayoutFromResource

public void loadLayoutFromResource(String resource)
                            throws Exception

Loads a layout from the specified resource.

Parameters:

resource - URL of the resource containing the layout configuration.

If url of format "app:xxx", then layout associated with application id "xxx" is loaded.

If url of format "shared:xxx", then shared layout named "xxx" is loaded.

If url of format "private:xxx", then user layout named "xxx" is loaded.

Otherwise, resource is assumed to be a resource url.

Throws:

Exception - Unspecified exception.

loadLayoutByAppId

public void loadLayoutByAppId(String appId)
                       throws Exception

Loads the layout associated with the given application id.

Parameters:

appId - An application id.

Throws:

Exception - Unspecified exception.

loadLayoutByAppId

public void loadLayoutByAppId()
                       throws Exception

Loads a layout based on the appId query parameter setting.

Throws:

Exception - Unspecified exception.

getLayout

public String getLayout()

Returns the name of the layout to be loaded.

Returns:

Name of layout to be loaded.

setLayout

public void setLayout(String defaultLayoutName)
               throws Exception

Sets the layout to be loaded. If null, the layout specified by the configuration will be loaded.

Parameters:

defaultLayoutName - The default layout name.

Throws:

Exception - Unspecified exception.

isAutoStart

public boolean isAutoStart()

Returns the auto-start setting.

Returns:

True if the start method is to be called automatically after loading a layout. False if the start method must be called manually.

setAutoStart

public void setAutoStart(boolean autoStart)

Sets the auto-start setting.

Parameters:

autoStart - True if the start method is to be called automatically after loading a layout. False if the start method must be called manually.

buildUI

public void buildUI(UILayout layout)
             throws Exception

Build the UI based on the specified layout.

Parameters:

layout - Layout for building UI.

Throws:

Exception - Unspecified exception.

reset

public void reset()

Resets the desktop to its baseline state and clears registered help modules and property groups.

registerPlugin

public void registerPlugin(PluginContainer plugin)

Registers a plugin and its resources. Called internally when a plugin is instantiated.

Parameters:

plugin - Plugin to register.

unregisterPlugin

public void unregisterPlugin(PluginContainer plugin)

Unregisters a plugin and its resources. Called internally when a plugin is destroyed.

Parameters:

plugin - Plugin to unregister.

addToolbarComponent

public void addToolbarComponent(org.zkoss.zk.ui.Component component)

Adds a component to the common tool bar.

Parameters:

component - Component to add

registerHelpResource

public void registerHelpResource(PluginResourceHelp resource)

Registers a help resource.

Parameters:

resource - Resource defining the help menu item to be added.

registerStyleSheet

public void registerStyleSheet(String url)

Registers an external style sheet. If the style sheet has not already been registered, creates a style component and adds it to the current page.

Parameters:

url - URL of style sheet.

registerPropertyGroup

public void registerPropertyGroup(String propertyGroup)

Registers a property group.

Parameters:

propertyGroup - Property group to register.

addMenu

public org.zkoss.zul.Menu addMenu(String path,
                         String action)

Adds a menu.

Parameters:

path - Path for the menu.

action - Associated action for the menu.

Returns:

Created menu item.

getLoadedPlugins

public Iterable<PluginContainer> getLoadedPlugins()

Returns a list of all plugins currently loaded into the UI.

Returns:

Currently loaded plugins.

getLoadedPlugin

public PluginContainer getLoadedPlugin(String id)

Locates a loaded plugin with the specified id.

Parameters:

id - Id of plugin to locate.

Returns:

A reference to the loaded plugin, or null if not found.

getLoadedPlugin

public PluginContainer getLoadedPlugin(String id,
                              boolean forceInit)

Locates a loaded plugin with the specified id.

Parameters:

id - Id of plugin to locate.

forceInit - If true the plugin will be initialized if not already so.

Returns:

A reference to the loaded and fully initialized plugin, or null if not found.

getActivatedPlugin

public PluginContainer getActivatedPlugin(String id)

Locates an activated plugin with the specified id.

Parameters:

id - Id of plugin to locate.

Returns:

The requested plugin, or null if not found.

getActivatedPlugins

public Iterable<PluginContainer> getActivatedPlugins()

Returns a list of all active plugins.

Returns:

List of all active plugins.

getActivatedPlugins

public Collection<PluginContainer> getActivatedPlugins(Collection<PluginContainer> list)

Populates a list of all activated plugins.

Parameters:

list - The list to be populated. If null, a new list is created.

Returns:

A list of active plugins.

getLoadedPluginDefinitions

public Iterable<PluginDefinition> getLoadedPluginDefinitions()

Returns a list of all plugin definitions that are currently in use (i.e., have associated plugins loaded) in the environment.

Returns:

List of PluginDefinition objects that have corresponding plugins loaded in the environment. May be empty, but never null.

getPropertyGroups

public List<String> getPropertyGroups()

Returns a list of property groups bound to loaded plugins. Guarantees each group name will appear at most once in the list.

Returns:

List of all property groups bound to loaded plugins.

logout

public void logout()

Logout user after confirmation prompt.

lock

public void lock()

Lock the desktop.

showMessage

public void showMessage(String message)

Shows a slide-down message.

Parameters:

message - Message to display.

See Also:

MessageWindow.show(String)

showMessage

public void showMessage(String message,
               String caption)

Shows a slide-down message.

Parameters:

message - Message to display.

caption - Caption for message.

See Also:

MessageWindow.show(String, String)

showMessage

public void showMessage(String message,
               String caption,
               String color)

Shows a slide-down message.

Parameters:

message - Message to display

caption - Caption for message.

color - Background color for message window.

See Also:

MessageWindow.show(String, String, String)

showMessage

public void showMessage(String message,
               String caption,
               String color,
               int duration)

Shows a slide-down message.

Parameters:

message - Message to display

caption - Caption for message.

color - Background color for message window.

duration - Message duration in milliseconds.

See Also:

MessageWindow.show(String, String, String, int)

showMessage

public void showMessage(String message,
               String caption,
               String color,
               Integer duration,
               String tag)

Shows a slide-down message.

Parameters:

message - Message to display

caption - Caption for message.

color - Background color for message window.

duration - Message duration in milliseconds.

tag - Tag to classify message.

See Also:

MessageWindow.show(String, String, String, Integer, String)

showMessage

public void showMessage(String message,
               String caption,
               String color,
               Integer duration,
               String tag,
               String action)

Shows a slide-down message.

Parameters:

message - Message to display

caption - Caption for message.

color - Background color for message window.

duration - Message duration in milliseconds.

tag - Tag to classify message.

action - Javascript action.

See Also:

MessageWindow.show(String, String, String, Integer, String, String)

showMessage

public void showMessage(MessageWindow.MessageInfo messageInfo)

Shows a slide-down message.

Parameters:

messageInfo - Message info structure.

See Also:

MessageWindow.show(MessageInfo)

clearMessages

public void clearMessages()

Clears all slide-down messages;

See Also:

MessageWindow.clear()

clearMessages

public void clearMessages(String tag)

Clears all slide-down messages with specified tag;

Parameters:

tag - Messages with this tag will be cleared.

See Also:

MessageWindow.clear(String)