org.carewebframework.shell.layout

Class UIElementDesktop

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

org.carewebframework.shell.layout.UIElementDesktop

public class UIElementDesktop
extends UIElementZKBase

This is the topmost component of the layout.

Field Summary

Fields inherited from class org.carewebframework.shell.layout.UIElementBase

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

Constructor and Description
UIElementDesktop(CareWebShell shell)

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(boolean activate) Forces a recalculation of window size when activation state changes.
void	addChild(UIElementBase child) Overrides addChild to suppress onAddChild events for internally created children.
org.zkoss.zul.Menu	addHelpMenu(PluginResourceHelp resource) Adds a menu item for the specified help resource.
org.zkoss.zul.Menu	addHelpMenu(String namedPath, String action) Adds a menu item to the help menu subtree.
org.zkoss.zul.Menu	addMenu(String namePath, String action, boolean fixed) Adds a ZK menu item to the main menu.
void	clear() Resets the desktop by removing all children and help menu items.
protected void	clearHelpMenu() Remove all non-fixed items from help menu.
String	getAppId() Returns the application id of this instance.
HelpViewer.HelpViewerMode	getHelpViewerMode() Returns the help viewer display mode for this desktop.
String	getIcon() Returns the url for the title bar icon.
UIElementMenubar	getMenubar() Returns the desktop's menu bar.
CareWebShell	getShell() Returns the shell that contains this desktop.
ThemeUtil.PanelStyle	getStyle() Returns the panel style to use for the desktop.
String	getTitle() Returns the title text.
UIElementToolbar	getToolbar() Returns the desktop's tool bar.
boolean	hasAppId(String appId) Returns true if the application id specified matches the desktop's application id.
void	setAppId(String appId) Sets the application id of this instance.
void	setDesignMode(boolean designMode) Augments the parent method by activating the associated design context menu when design mode is activated.
void	setHelpViewerMode(HelpViewer.HelpViewerMode mode) Sets the help viewer display mode for this desktop.
void	setIcon(String url) Sets the url for the title bar icon.
void	setStyle(ThemeUtil.PanelStyle style) Sets the panel style to use for the desktop.
void	setTitle(String text) Sets the title text.

Methods inherited from class org.carewebframework.shell.layout.UIElementZKBase

afterMoveTo, applyColor, applyHint, associateComponent, bind, createFromTemplate, createFromTemplate, createFromTemplate, editProperties, fullSize, getAssociatedUIElement, getEnableDesignModeMask, getInnerComponent, getOuterComponent, getParent, getTemplateUrl, hasVisibleElements, moveChild, setDesignContextMenu, setDesignContextMenu, setEnableDesignModeMask, setInnerComponent, setOuterComponent, swapChildren, unbind, updateVisibility

Methods inherited from class org.carewebframework.shell.layout.UIElementBase

about, activateChildren, addChild, afterAddChild, afterInitialize, afterParentChanged, afterRemoveChild, applyColor, applyHint, beforeAddChild, beforeInitialize, beforeParentChanged, beforeRemoveChild, bringToFront, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptParent, canAcceptParent, canAcceptParent, canAcceptParent, destroy, findChildElement, getAncestor, getChild, getChild, getChildCount, getChildren, getColor, getDefinition, getDisplayName, getEventManager, getFirstChild, getFirstVisibleChild, getHint, getIndex, getInstanceName, getLastChild, getLastVisibleChild, getNextSibling, getPropEditClass, getRejectReason, getRoot, getSerializableChildren, hasAncestor, hasChild, indexOfChild, isActivated, isContainer, isDesignMode, isEnabled, isLocked, isVisible, raise, raise, registerAllowedChildClass, registerAllowedParentClass, remove, removeChild, removeChildren, setColor, setDefinition, setDefinition, setEnabled, setHint, setIndex, setLocked, setParent, setRejectReason, setVisible, updateParentState, updateState, updateVisibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIElementDesktop

public UIElementDesktop(CareWebShell shell)
                 throws Exception

Throws:

Exception

Method Detail

getTitle

public String getTitle()

Returns the title text.

Returns:

The title text.

setTitle

public void setTitle(String text)

Sets the title text. This sets the title text of the desktop and the browser page.

Parameters:

text - The title text. Can be null;

getIcon

public String getIcon()

Returns the url for the title bar icon.

Returns:

Url of the title bar icon.

setIcon

public void setIcon(String url)

Sets the url for the title bar icon.

Parameters:

url - Url of the title bar icon.

getStyle

public ThemeUtil.PanelStyle getStyle()

Returns the panel style to use for the desktop.

Returns:

The panel style.

setStyle

public void setStyle(ThemeUtil.PanelStyle style)

Sets the panel style to use for the desktop.

Parameters:

style - The panel style.

setAppId

public void setAppId(String appId)

Sets the application id of this instance.

Parameters:

appId - The application id.

getAppId

public String getAppId()

Returns the application id of this instance.

Returns:

The application id.

hasAppId

public boolean hasAppId(String appId)

Returns true if the application id specified matches the desktop's application id. Handles nulls.

Parameters:

appId - The application id.

Returns:

True if the application ids match.

getShell

public CareWebShell getShell()

Returns the shell that contains this desktop.

Returns:

The owning shell.

clear

public void clear()

Resets the desktop by removing all children and help menu items.

getToolbar

public UIElementToolbar getToolbar()

Returns the desktop's tool bar.

Returns:

Desktop tool bar.

getMenubar

public UIElementMenubar getMenubar()

Returns the desktop's menu bar.

Returns:

Desktop menu bar.

addChild

public void addChild(UIElementBase child)

Overrides addChild to suppress onAddChild events for internally created children.

Overrides:

addChild in class UIElementBase

Parameters:

child - Element to add as a child.

activate

public void activate(boolean activate)

Forces a recalculation of window size when activation state changes.

Overrides:

activate in class UIElementZKBase

Parameters:

activate - The activate status.

setDesignMode

public void setDesignMode(boolean designMode)

Description copied from class: UIElementZKBase

Augments the parent method by activating the associated design context menu when design mode is activated.

Overrides:

setDesignMode in class UIElementZKBase

Parameters:

designMode - If true, design mode is activated.

addMenu

public org.zkoss.zul.Menu addMenu(String namePath,
                         String action,
                         boolean fixed)

Adds a ZK menu item to the main menu.

Parameters:

namePath - Determines the position of the menu item in the menu tree by caption text.

action - The action to be executed when the menu item is clicked.

fixed - If true, add to fixed menu. Otherwise, add to configurable menu.

Returns:

The menu item added. If the menu parameter was not null, this is the value returned. Otherwise, it is a reference to the newly created menu item.

addHelpMenu

public org.zkoss.zul.Menu addHelpMenu(String namedPath,
                             String action)

Adds a menu item to the help menu subtree. This action also sets an internal flag to cause the help menu subtree to be automatically sorted when it is opened.

Parameters:

namedPath - Determines the position of the new menu item within the help menu subtree.

action - The action to be invoked when the menu item is clicked.

Returns:

The newly created menu item.

addHelpMenu

public org.zkoss.zul.Menu addHelpMenu(PluginResourceHelp resource)

Adds a menu item for the specified help resource.

Parameters:

resource - The help resource.

Returns:

The newly created menu item.

clearHelpMenu

protected void clearHelpMenu()

Remove all non-fixed items from help menu.

getHelpViewerMode

public HelpViewer.HelpViewerMode getHelpViewerMode()

Returns the help viewer display mode for this desktop.

Returns:

The help viewer display mode.

setHelpViewerMode

public void setHelpViewerMode(HelpViewer.HelpViewerMode mode)

Sets the help viewer display mode for this desktop.

Parameters:

mode - The new help viewer display mode.