org.carewebframework.shell.designer

Class DesignContextMenu

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Popup

org.zkoss.zul.Menupopup

org.carewebframework.shell.designer.DesignContextMenu

All Implemented Interfaces:

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

public class DesignContextMenu
extends org.zkoss.zul.Menupopup
implements org.zkoss.zk.ui.IdSpace

Context menu for designer.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Avoid exception if menu not attached to a desktop.
static DesignContextMenu	create() Creates an instance of the design context menu.
static DesignContextMenu	getInstance() Returns an instance of the design context menu.
void	onClick$mnuAbout() Invoke owner's about dialog.
void	onClick$mnuAdd() Present Add Component dialog containing valid choices for this owner.
void	onClick$mnuCopy() Copies the XML layout with the owner as the root node to the clipboard.
void	onClick$mnuCut() Copies the XML layout with the owner as the root node to the clipboard, then deletes the owner.
void	onClick$mnuDelete() Remove owner from the layout.
void	onClick$mnuPaste() Paste the XML layout in the clipboard into the layout with the owner as the parent node.
void	onClick$mnuProperties() Invoke owner's property editor.
void	onClick$mnuView() Display the clipboard viewer.
void	onClipboardChange() Called when clipboard contents changes.
void	onOpen(org.zkoss.zk.ui.event.Event event) Sets the context menu's owner based on the UI element that invoked the menu.
void	setListener(org.zkoss.zk.ui.Component listener) Sets the component that is to receive layout change events.
void	setOwner(UIElementBase owner) Sets the context menu's owner.
static void	updateStates(UIElementBase ele, org.zkoss.zk.ui.ext.Disable add, org.zkoss.zk.ui.ext.Disable delete, org.zkoss.zk.ui.ext.Disable copy, org.zkoss.zk.ui.ext.Disable cut, org.zkoss.zk.ui.ext.Disable paste, org.zkoss.zk.ui.ext.Disable properties, org.zkoss.zk.ui.ext.Disable about) Updates states on input elements (typically buttons or menu items) according to state of the specified UI element.

Methods inherited from class org.zkoss.zul.Menupopup

beforeChildAdded, getZclass

Methods inherited from class org.zkoss.zul.Popup

open, open, open, open, service, setVisible

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

clone, getContext, getCtrlKeys, getPopup, getTooltip, renderProperties, 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, getZindex, getZIndex, 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, 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, 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

Methods inherited from interface org.zkoss.zk.ui.IdSpace

getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, getAttribute, getAttributes, hasAttribute, hasAttribute, removeAttribute, removeAttribute, removeScopeListener, setAttribute, setAttribute

Constructor Detail

DesignContextMenu

public DesignContextMenu()

Method Detail

getInstance

public static DesignContextMenu getInstance()

Returns an instance of the design context menu. This is a singleton with the desktop scope and is cached once created.

Returns:

The design context menu for the active destkop.

create

public static DesignContextMenu create()

Creates an instance of the design context menu.

Returns:

New design context menu.

updateStates

public static void updateStates(UIElementBase ele,
                org.zkoss.zk.ui.ext.Disable add,
                org.zkoss.zk.ui.ext.Disable delete,
                org.zkoss.zk.ui.ext.Disable copy,
                org.zkoss.zk.ui.ext.Disable cut,
                org.zkoss.zk.ui.ext.Disable paste,
                org.zkoss.zk.ui.ext.Disable properties,
                org.zkoss.zk.ui.ext.Disable about)

Updates states on input elements (typically buttons or menu items) according to state of the specified UI element. Any parameter may be null.

Parameters:

ele - A UI element.

add - Add input element.

delete - Delete input element.

copy - Copy input element.

cut - Cut input element.

paste - Paste input element.

properties - Properties input element.

about - About input element.

close

public void close()

Avoid exception if menu not attached to a desktop.

Overrides:

close in class org.zkoss.zul.Popup

setOwner

public void setOwner(UIElementBase owner)

Sets the context menu's owner. This modifies the member menu item states to reflect the current owner.

Parameters:

owner - Menu's owner.

setListener

public void setListener(org.zkoss.zk.ui.Component listener)

Sets the component that is to receive layout change events.

Parameters:

listener - Event listener.

onOpen

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

Sets the context menu's owner based on the UI element that invoked the menu.

Parameters:

event - The open event.

onClick$mnuProperties

public void onClick$mnuProperties()

Invoke owner's property editor.

onClick$mnuAbout

public void onClick$mnuAbout()
                      throws Exception

Invoke owner's about dialog.

Throws:

Exception - Unspecified exception.

onClick$mnuDelete

public void onClick$mnuDelete()

Remove owner from the layout.

onClick$mnuAdd

public void onClick$mnuAdd()

Present Add Component dialog containing valid choices for this owner.

onClick$mnuCopy

public void onClick$mnuCopy()
                     throws Exception

Copies the XML layout with the owner as the root node to the clipboard.

Throws:

Exception - Unspecified exception.

onClick$mnuCut

public void onClick$mnuCut()
                    throws Exception

Copies the XML layout with the owner as the root node to the clipboard, then deletes the owner.

Throws:

Exception - Unspecified exception.

onClick$mnuPaste

public void onClick$mnuPaste()
                      throws Exception

Paste the XML layout in the clipboard into the layout with the owner as the parent node.

Throws:

Exception - Unspecified exception.

onClick$mnuView

public void onClick$mnuView()
                     throws Exception

Display the clipboard viewer.

Throws:

Exception - Unspecified exception.

onClipboardChange

public void onClipboardChange()

Called when clipboard contents changes.