CareWebShell (CWF Shell 6.0.0-RC3 API)

java.lang.Object
- org.fujion.component.BaseComponent
- - org.fujion.component.BaseUIComponent
  - - org.fujion.component.Div
    - - org.carewebframework.shell.CareWebShell

All Implemented Interfaces:

org.fujion.ancillary.IDisable, org.fujion.ancillary.IElementIdentifier, org.fujion.ancillary.INamespace

Direct Known Subclasses:

CareWebShellEx
```
@Component(tag="cwfShell",
           widgetClass="Div",
           parentTag="*",
           childTag=@Component.ChildTag(value="*"))
public class CareWebShell
extends org.fujion.component.Div
implements org.fujion.ancillary.INamespace
```
Implements a generic UI shell that can be dynamically extended with plug-ins.

Nested Class Summary
- Nested classes/interfaces inherited from class org.fujion.component.BaseComponent
  org.fujion.component.BaseComponent.SubComponent

Field Summary

Fields
Modifier and Type	Field and Description
`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`

Constructor Summary

Constructors
Constructor and Description

CareWebShell()
Create the shell instance.

Constructors
Constructor and Description
`CareWebShell()` Create the shell instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.fujion.component.BaseMenuComponent`	`addMenu(String path, String action)` Adds a menu.
`void`	`addToolbarComponent(org.fujion.component.BaseComponent component)` Adds a component to the common tool bar.
`void`	`buildUI(Layout layout)` Build the UI based on the specified layout.
`ElementPlugin`	`getActivatedPlugin(String id)` Locates an activated plugin with the specified id.
`Iterable<ElementPlugin>`	`getActivatedPlugins()` Returns a list of all active plugins.
`Collection<ElementPlugin>`	`getActivatedPlugins(Collection<ElementPlugin> list)` Populates a list of all activated plugins.
`static String`	`getApplicationName()` Returns the application name for this instance of the CareWeb shell.
`String`	`getAppProperty(String queryParam, String propName)`
`ElementDesktop`	`getDesktop()` Returns a reference to the current UI desktop.
`protected IHelpViewer`	`getHelpViewer()` Returns reference to the help viewer.
`String`	`getLayout()` Returns the name of the layout to be loaded.
`ElementPlugin`	`getLoadedPlugin(String id)` Locates a loaded plugin with the specified id.
`ElementPlugin`	`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<ElementPlugin>`	`getLoadedPlugins()` Returns a list of all plugins currently loaded into the UI.
`org.fujion.component.MessageWindow`	`getMessageWindow()` Returns the message window instance for managing slide-down messages.
`List<String>`	`getPropertyGroups()` Returns a list of property groups bound to loaded plugins.
`Layout`	`getUILayout()` Returns a reference to the current UI layout.
`boolean`	`isAutoStart()` Returns the auto-start setting.
`boolean`	`isLogoutConfirm()` Returns true if confirmation is required upon user-initiated logout.
`void`	`loadLayout(String resource)` Loads a layout from the specified resource.
`void`	`lock()` Lock the desktop.
`void`	`logout()` Logout user after confirmation prompt.
`protected void`	`onAttach(org.fujion.component.Page page)`
`void`	`onCommand(CommandEvent event)` Handle help requests.
`void`	`onKeycapture(org.fujion.event.KeycaptureEvent event)` Capture unhandled shortcut key press events.
`void`	`registerHelpResource(PluginResourceHelp resource)` Registers a help resource.
`void`	`registerPlugin(ElementPlugin 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`	`setLogoutConfirm(boolean logoutConfirm)` Set to true if confirmation is required upon user-initiated logout.
`void`	`start()` Executed once all plugins are loaded.
`void`	`unregisterPlugin(ElementPlugin plugin)` Unregisters a plugin and its resources.

Methods inherited from class org.fujion.component.BaseUIComponent
_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, removeClass, removeMask, removeStyle, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent
_attach, _initProps, addChild, addChild, addChild, addChildren, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bringToFront, defaultify, destroy, destroyChildren, detach, finalize, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, getAncestor, getAncestor, getAttribute, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getController, getControllers, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasAttribute, hasEventListener, hasEventListener, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, notifyAncestors, notifyDescendants, nullify, onDestroy, propertyChange, removeAttribute, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setAttribute, setContent, setContentSynced, setData, setIndex, setName, setParent, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validatePage, validateParent, wireController

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - log
```
protected static final org.apache.commons.logging.Log log
```
  - 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.
  - onAttach
```
protected void onAttach(org.fujion.component.Page page)
```
    Overrides:
    
    onAttach in class org.fujion.component.BaseComponent
  - onCommand
```
public void onCommand(CommandEvent event)
```
    Handle help requests.
    
    Parameters:
    
    event - A command event.
  - onKeycapture
```
public void onKeycapture(org.fujion.event.KeycaptureEvent event)
```
    Capture unhandled shortcut key press events.
    
    Parameters:
    
    event - Control key event.
  - getDesktop
```
public ElementDesktop getDesktop()
```
    Returns a reference to the current UI desktop.
    
    Returns:
    
    The current UI desktop.
  - getUILayout
```
public Layout getUILayout()
```
    Returns a reference to the current UI layout.
    
    Returns:
    
    The current UI layout.
  - start
```
public void start()
```
    Executed once all plugins are loaded.
  - loadLayout
```
public void loadLayout(String resource)
                throws Exception
```
    Loads a layout from the specified resource.
    
    Parameters:
    
    resource - The layout resource to load.
    
    Throws:
    
    Exception - Unspecified exception.
  - getLayout
```
@Component.PropertyGetter(value="layout")
public String getLayout()
```
    Returns the name of the layout to be loaded.
    
    Returns:
    
    Name of layout to be loaded.
  - setLayout
```
@Component.PropertySetter(value="layout")
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.
  - isLogoutConfirm
```
public boolean isLogoutConfirm()
```
    Returns true if confirmation is required upon user-initiated logout.
    
    Returns:
    
    True if confirmation is required upon user-initiated logout.
  - setLogoutConfirm
```
public void setLogoutConfirm(boolean logoutConfirm)
```
    Set to true if confirmation is required upon user-initiated logout.
    
    Parameters:
    
    logoutConfirm - True if confirmation is required upon user-initiated logout.
  - buildUI
```
public void buildUI(Layout layout)
```
    Build the UI based on the specified layout.
    
    Parameters:
    
    layout - Layout for building UI.
  - reset
```
public void reset()
```
    Resets the desktop to its baseline state and clears registered help modules and property groups.
  - registerPlugin
```
public void registerPlugin(ElementPlugin plugin)
```
    Registers a plugin and its resources. Called internally when a plugin is instantiated.
    
    Parameters:
    
    plugin - Plugin to register.
  - unregisterPlugin
```
public void unregisterPlugin(ElementPlugin plugin)
```
    Unregisters a plugin and its resources. Called internally when a plugin is destroyed.
    
    Parameters:
    
    plugin - Plugin to unregister.
  - addToolbarComponent
```
public void addToolbarComponent(org.fujion.component.BaseComponent 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.fujion.component.BaseMenuComponent 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<ElementPlugin> getLoadedPlugins()
```
    Returns a list of all plugins currently loaded into the UI.
    
    Returns:
    
    Currently loaded plugins.
  - getLoadedPlugin
```
public ElementPlugin 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 ElementPlugin 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 ElementPlugin 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<ElementPlugin> getActivatedPlugins()
```
    Returns a list of all active plugins.
    
    Returns:
    
    List of all active plugins.
  - getActivatedPlugins
```
public Collection<ElementPlugin> getActivatedPlugins(Collection<ElementPlugin> 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.
  - getAppProperty
```
public String getAppProperty(String queryParam,
                             String propName)
```
  - logout
```
public void logout()
```
    Logout user after confirmation prompt.
  - lock
```
public void lock()
```
    Lock the desktop.
  - getMessageWindow
```
public org.fujion.component.MessageWindow getMessageWindow()
```
    Returns the message window instance for managing slide-down messages.
    
    Returns:
    
    A message window instance.
  - getHelpViewer
```
protected IHelpViewer getHelpViewer()
```
    Returns reference to the help viewer. If not already created, one will be created and initialized with the registered help sets.
    
    Returns:
    
    A help viewer reference.

Class CareWebShell

Nested Class Summary

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.fujion.component.BaseUIComponent

Methods inherited from class org.fujion.component.BaseComponent

Methods inherited from class java.lang.Object

Field Detail

log

LBL_NO_LAYOUT

LBL_LOGOUT_CONFIRMATION

LBL_LOGOUT_CONFIRMATION_CAPTION

LBL_LOGOUT_CANCEL

Constructor Detail

CareWebShell

Method Detail

getApplicationName

onAttach

onCommand

onKeycapture

getDesktop

getUILayout

start

loadLayout

getLayout

setLayout

isAutoStart

setAutoStart

isLogoutConfirm

setLogoutConfirm

buildUI

reset

registerPlugin

unregisterPlugin

addToolbarComponent

registerHelpResource

registerStyleSheet

registerPropertyGroup

addMenu

getLoadedPlugins

getLoadedPlugin

getLoadedPlugin

getActivatedPlugin

getActivatedPlugins

getActivatedPlugins

getLoadedPluginDefinitions

getPropertyGroups

getAppProperty

logout

lock

getMessageWindow

getHelpViewer