org.zkoss.zul.impl
Class XulElement

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.impl.XulElement
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, HtmlBasedComponent, Component, Scope, ComponentCtrl, XulElement
Direct Known Subclasses:
Audio, Auxhead, Bandpopup, Box, Calendar, Cell, Colorbox, Columnchildren, Columnlayout, Detail, Div, Fisheyebar, Foot, Frozen, Grid, Groupbox, HeadersElement, Html, Image, Include, InputElement, Label, LabelElement, LayoutRegion, Listbox, Listfoot, Listitem, Menubar, Menuseparator, Paging, Panel, Panelchildren, Popup, Portalchildren, Portallayout, Progressmeter, Radiogroup, Row, Rows, Separator, Slider, Span, Splitter, Tabbox, Tablechildren, Tablelayout, Tabpanel, Tabpanels, Tabs, Toolbar, Tree, Treechildren, Treefoot, Treeitem, Treerow, Window

public abstract class XulElement
extends HtmlBasedComponent
implements XulElement

The fundamental class for XUL elements.

Events:
onOK, onCacnel and onCtrlKey.

Since:
3.0.6 supports onOK event., 3.0.6 supports onCancel event., 3.0.6 supports onCtrlKey event.
Author:
tomyeh
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent
HtmlBasedComponent.ExtraCtrl
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
AbstractComponent.Children
 
Field Summary
 
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
_height, _left, _top, _width, _zclass
 
Fields inherited from class org.zkoss.zk.ui.AbstractComponent
_visible
 
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
XulElement()
           
 
Method Summary
 java.lang.String getAction()
          Deprecated. since 5.0.0, use client-side event listener instead.
 java.lang.String getContext()
          Returns the ID of the popup (Popup) that should appear when the user right-clicks on the element (aka., context menu).
 java.lang.String getCtrlKeys()
          Returns what keystrokes to intercept.
 java.lang.String getPopup()
          Returns the ID of the popup (Popup) that should appear when the user clicks on the element.
 java.lang.String getTooltip()
          Returns the ID of the popup (Popup) that should be used as a tooltip window when the mouse hovers over the element for a moment.
protected  void renderProperties(ContentRenderer renderer)
          Renders the content of this component, excluding the enclosing tags and children.
 void setAction(java.lang.String action)
          Deprecated. since 5.0.0, use client-side event listener instead.
 void setContext(Popup popup)
          Sets the UUID of the popup that should appear when the user right-clicks on the element (aka., context menu).
 void setContext(java.lang.String context)
          Sets the ID of the popup (Popup) that should appear when the user right-clicks on the element (aka., context menu).
 void setCtrlKeys(java.lang.String ctrlKeys)
          Sets what keystrokes to intercept.
 void setPopup(Popup popup)
          Sets the UUID of the popup that should appear when the user clicks on the element.
 void setPopup(java.lang.String popup)
          Sets the ID of the popup (Popup) that should appear when the user clicks on the element.
 void setTooltip(Popup popup)
          Sets the UUID of the popup that should be used as a tooltip window when the mouse hovers over the element for a moment.
 void setTooltip(java.lang.String tooltip)
          Sets the ID of the popup (Popup) that should be used as a tooltip window when the mouse hovers over the element for a moment.
 
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, newExtraCtrl, service, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, clone, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, 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.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Constructor Detail

XulElement

public XulElement()
Method Detail

getCtrlKeys

public java.lang.String getCtrlKeys()
Returns what keystrokes to intercept.

Default: null.

Specified by:
getCtrlKeys in interface XulElement
Since:
3.0.6

setCtrlKeys

public void setCtrlKeys(java.lang.String ctrlKeys)
                 throws UiException
Sets what keystrokes to intercept.

The string could be a combination of the following:

^k
A control key, i.e., Ctrl+k, where k could be a~z, 0~9, #n
@k
A alt key, i.e., Alt+k, where k could be a~z, 0~9, #n
$n
A shift key, i.e., Shift+n, where n could be #n. Note: $a ~ $z are not supported.
#home
Home
#end
End
#ins
Insert
#del
Delete
#left
Left arrow
#right
Right arrow
#up
Up arrow
#down
Down arrow
#pgup
PageUp
#pgdn
PageDn
#f1 #f2 ... #f12
Function keys representing F1, F2, ... F12

For example,

^a^d@c#f10#left#right
It means you want to intercept Ctrl+A, Ctrl+D, Alt+C, F10, Left and Right.
^#left
It means Ctrl+Left.
^#f1
It means Ctrl+F1.
@#f3
It means Alt+F3.

Note: it doesn't support Ctrl+Alt, Shift+Ctrl, Shift+Alt or Shift+Ctrl+Alt.

Specified by:
setCtrlKeys in interface XulElement
Throws:
UiException
Since:
3.0.6

getContext

public java.lang.String getContext()
Returns the ID of the popup (Popup) that should appear when the user right-clicks on the element (aka., context menu).

Default: null (no context menu).

Specified by:
getContext in interface XulElement

setContext

public void setContext(java.lang.String context)
Sets the ID of the popup (Popup) that should appear when the user right-clicks on the element (aka., context menu).

An onOpen event is sent to the context menu if it is going to appear. Therefore, developers can manipulate it dynamically (perhaps based on OpenEvent.getReference) by listening to the onOpen event.

Note: To simplify the use, it not only searches its ID space, but also all ID spaces in the desktop. It first searches its own ID space, and then the other Id spaces in the same browser window (might have one or multiple desktops).

(since 3.0.2) If there are two components with the same ID (of course, in different ID spaces), you can specify the UUID with the following format:
uuid(comp_uuid)

Example:


 <label context="some">
 <label context="uuid(${some.uuid})"/>
 
Both reference a component whose ID is "some". But, if there are several components with the same ID, the first one can reference to any of them. And, the second one reference to the component in the same ID space (of the label component).

(since 3.6.3) the context menu can be shown by a position from Popup.open(org.zkoss.zk.ui.Component, String) or the location of x and y, you can specify the following format:

For example,
 <button label="show" context="id, start_before"/>
 

Specified by:
setContext in interface XulElement
See Also:
setContext(Popup)

setContext

public void setContext(Popup popup)
Sets the UUID of the popup that should appear when the user right-clicks on the element (aka., context menu).

Note: it actually invokes setContext("uuid(" + popup.getUuid() + ")")

Specified by:
setContext in interface XulElement
Since:
3.0.2
See Also:
setContext(String), Popup.open(org.zkoss.zk.ui.Component, String)

getPopup

public java.lang.String getPopup()
Returns the ID of the popup (Popup) that should appear when the user clicks on the element.

Default: null (no popup).

Specified by:
getPopup in interface XulElement

setPopup

public void setPopup(java.lang.String popup)
Sets the ID of the popup (Popup) that should appear when the user clicks on the element.

An onOpen event is sent to the popup menu if it is going to appear. Therefore, developers can manipulate it dynamically (perhaps based on OpenEvent.getReference) by listening to the onOpen event.

Note: To simplify the use, it not only searches its ID space, but also all ID spaces in the desktop. It first searches its own ID space, and then the other Id spaces in the same browser window (might have one or multiple desktops).

(since 3.0.2) If there are two components with the same ID (of course, in different ID spaces), you can specify the UUID with the following format:
uuid(comp_uuid)

(since 3.6.3) the popup can be shown by a position from Popup.open(org.zkoss.zk.ui.Component, String) or the location of x and y, you can specify the following format:

For example,
 <button label="show" popup="id, start_before"/>
 

Specified by:
setPopup in interface XulElement
See Also:
setPopup(Popup), Popup.open(org.zkoss.zk.ui.Component, String)

setPopup

public void setPopup(Popup popup)
Sets the UUID of the popup that should appear when the user clicks on the element.

Note: it actually invokes setPopup("uuid(" + popup.getUuid() + ")")

Specified by:
setPopup in interface XulElement
Since:
3.0.2
See Also:
setPopup(String)

getTooltip

public java.lang.String getTooltip()
Returns the ID of the popup (Popup) that should be used as a tooltip window when the mouse hovers over the element for a moment. The tooltip will automatically disappear when the mouse is moved away.

Default: null (no tooltip).

Specified by:
getTooltip in interface XulElement

setTooltip

public void setTooltip(java.lang.String tooltip)
Sets the ID of the popup (Popup) that should be used as a tooltip window when the mouse hovers over the element for a moment.

An onOpen event is sent to the tooltip if it is going to appear. Therefore, developers can manipulate it dynamically (perhaps based on OpenEvent.getReference) by listening to the onOpen event.

Note: To simplify the use, it not only searches its ID space, but also all ID spaces in the desktop. It first searches its own ID space, and then the other Id spaces in the same browser window (might have one or multiple desktops).

(since 3.0.2) If there are two components with the same ID (of course, in different ID spaces), you can specify the UUID with the following format:
uuid(comp_uuid)

(since 3.6.3) the tooltip can be shown by a position from Popup.open(org.zkoss.zk.ui.Component, String) or the location of x and y, and can be specified with a delay time (in millisecond), you can specify the following format:

For example,
 <button label="show" tooltip="id, start_before"/>
 

Specified by:
setTooltip in interface XulElement
See Also:
setTooltip(Popup), Popup.open(org.zkoss.zk.ui.Component, String)

setTooltip

public void setTooltip(Popup popup)
Sets the UUID of the popup that should be used as a tooltip window when the mouse hovers over the element for a moment.

Note: it actually invokes setTooltip("uuid(" + popup.getUuid() + ")")

Specified by:
setTooltip in interface XulElement
Since:
3.0.2
See Also:
setTooltip(String)

getAction

public java.lang.String getAction()
Deprecated. since 5.0.0, use client-side event listener instead.

Specified by:
getAction in interface XulElement

setAction

public void setAction(java.lang.String action)
Deprecated. since 5.0.0, use client-side event listener instead.

Specified by:
setAction in interface XulElement

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException
Description copied from class: HtmlBasedComponent
Renders the content of this component, excluding the enclosing tags and children.

See also Render Special Properties

Overrides:
renderProperties in class HtmlBasedComponent
Throws:
java.io.IOException


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo