org.carewebframework.shell

Class AboutDialog

java.lang.Object

org.zkoss.zk.ui.event.GenericEventListener

org.zkoss.zk.ui.util.GenericComposer<T>

org.zkoss.zk.ui.util.GenericAutowireComposer<T>

org.zkoss.zk.ui.util.GenericForwardComposer<org.zkoss.zk.ui.Component>

org.carewebframework.ui.FrameworkController

org.carewebframework.shell.AboutDialog

All Implemented Interfaces:

Serializable, org.zkoss.zk.ui.event.EventListener, org.zkoss.zk.ui.event.SerializableEventListener, org.zkoss.zk.ui.util.ComponentActivationListener, org.zkoss.zk.ui.util.ComponentCloneListener, org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>, org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

public class AboutDialog
extends FrameworkController

Displays an "about" dialog for a given UI element.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.carewebframework.ui.FrameworkController

root

Fields inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

_separator, application, applicationScope, arg, componentScope, desktop, desktopScope, execution, page, pageScope, param, requestScope, self, session, sessionScope, spaceOwner, spaceScope

Fields inherited from class org.zkoss.zk.ui.util.GenericComposer

_applied

Constructor Summary

Constructors

Constructor and Description
AboutDialog()

Method Summary

Methods

Modifier and Type	Method and Description
void	doAfterCompose(org.zkoss.zk.ui.Component comp)
void	doBeforeComposeChildren(org.zkoss.zk.ui.Component comp)
static void	execute(Class<?> clazz) Display an about dialog for the specified class.
static void	execute(Manifest manifest) Display an about dialog for the specified manifest.
static void	execute(PluginDefinition def) Display an about dialog for the specified plugin definition.
static void	execute(UIElementBase component) Display an about dialog for the specified UI element.
String	getCustom() Returns the label for the custom button.
String	getIcon() Returns the url of the icon to display in the header.
String	getSource() Returns the item source to display in the header.
String	getTitle() Returns the subtitle text.
void	onClick$btnCustom() Display the manifest viewer when detail button is clicked.
void	setIcon(String icon) Sets the default url of the icon to display in the header.
void	setSource(String source) Sets the default item source to display in the header.

Methods inherited from class org.carewebframework.ui.FrameworkController

abortBackgroundThread, abortBackgroundThreads, addThread, cleanup, getAppContext, getAppFramework, getController, getController, getEventManager, hasActiveThreads, onRefresh, refresh, removeThread, startBackgroundThread, threadAborted, threadFinished

Methods inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

alert, didActivate, getPage, willClone, willPassivate

Methods inherited from class org.zkoss.zk.ui.util.GenericComposer

doBeforeCompose, doCatch, doFinally

Methods inherited from class org.zkoss.zk.ui.event.GenericEventListener

bindComponent, getController, onEvent, unbindComponent

Methods inherited from class java.lang.Object

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

Constructor Detail

AboutDialog

public AboutDialog()

Method Detail

execute

public static void execute(UIElementBase component)

Display an about dialog for the specified UI element.

Parameters:

component - UI element whose attributes are to be displayed.

execute

public static void execute(Class<?> clazz)

Display an about dialog for the specified class.

Parameters:

clazz - Class whose attributes are to be displayed.

execute

public static void execute(PluginDefinition def)

Display an about dialog for the specified plugin definition.

Parameters:

def - Plugin definition whose attributes are to be displayed.

execute

public static void execute(Manifest manifest)

Display an about dialog for the specified manifest.

Parameters:

manifest - Manifest whose attributes are to be displayed.

doAfterCompose

public void doAfterCompose(org.zkoss.zk.ui.Component comp)
                    throws Exception

Specified by:

doAfterCompose in interface org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>

Overrides:

doAfterCompose in class FrameworkController

Throws:

Exception

doBeforeComposeChildren

public void doBeforeComposeChildren(org.zkoss.zk.ui.Component comp)
                             throws Exception

Specified by:

doBeforeComposeChildren in interface org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

Overrides:

doBeforeComposeChildren in class org.zkoss.zk.ui.util.GenericComposer<org.zkoss.zk.ui.Component>

Throws:

Exception

onClick$btnCustom

public void onClick$btnCustom()

Display the manifest viewer when detail button is clicked.

getIcon

public String getIcon()

Returns the url of the icon to display in the header.

Returns:

Icon url.

setIcon

public void setIcon(String icon)

Sets the default url of the icon to display in the header.

Parameters:

icon - Icon url.

getSource

public String getSource()

Returns the item source to display in the header.

Returns:

Item source.

setSource

public void setSource(String source)

Sets the default item source to display in the header.

Parameters:

source - Item source.

getCustom

public String getCustom()

Returns the label for the custom button.

Returns:

The label for the custom button. If null, the custom button remains hidden.

getTitle

public String getTitle()

Returns the subtitle text.

Returns:

Subtitle text.