org.zkoss.zul.impl.api
Interface XulElement

All Superinterfaces:

java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable

All Known Subinterfaces:

Applet, Audio, Auxhead, Auxheader, Bandbox, Bandpopup, Box, Button, Calendar, Captcha, Caption, Center, Chart, Checkbox, Column, Columnchildren, Columnlayout, Columns, Combobox, Comboitem, Datebox, Decimalbox, Detail, Div, Doublebox, East, Fisheye, Fisheyebar, Foot, Footer, FormatInputElement, Grid, Group, Groupbox, Groupfoot, Hbox, HeaderElement, HeadersElement, Html, Iframe, Image, Imagemap, Include, InputElement, Intbox, Jasperreport, Label, LabelElement, LabelImageElement, LayoutRegion, Listbox, Listcell, Listfoot, Listfooter, Listgroup, Listgroupfoot, Listhead, Listheader, Listitem, Longbox, Menu, Menubar, Menuitem, Menupopup, Menuseparator, North, NumberInputElement, Paging, Panel, Panelchildren, Popup, Portalchildren, Portallayout, Progressmeter, Radio, Radiogroup, Row, Rows, Separator, Slider, South, Space, Span, Spinner, Splitter, Tab, Tabbox, Tablechildren, Tablelayout, Tabpanel, Tabpanels, Tabs, Textbox, Timebox, Toolbar, Toolbarbutton, Tree, Treecell, Treechildren, Treecol, Treecols, Treefoot, Treefooter, Treeitem, Treerow, Vbox, West, Window

All Known Implementing Classes:

Applet, Audio, Auxhead, Auxheader, Bandbox, Bandpopup, Box, Button, Calendar, Captcha, Caption, Center, Chart, Checkbox, Column, Columnchildren, Columnlayout, Columns, Combobox, Comboitem, Datebox, Decimalbox, Detail, Div, Doublebox, East, FailoverButton, FileuploadDlg, Fisheye, Fisheyebar, Foot, Footer, FormatInputElement, Grid, Group, Groupbox, Groupfoot, Hbox, HeaderElement, HeadersElement, Html, Iframe, Image, Imagemap, Include, InputElement, Intbox, Jasperreport, Label, LabelElement, LabelImageElement, LayoutRegion, Listbox, Listcell, Listfoot, Listfooter, Listgroup, Listgroupfoot, Listhead, Listheader, Listitem, Longbox, MainWindow, Menu, Menubar, Menuitem, Menupopup, Menuseparator, MessageboxDlg, MessageboxDlg.Button, North, NumberInputElement, Paging, Panel, Panelchildren, Popup, Portalchildren, Portallayout, Progressmeter, Radio, Radiogroup, Row, Rows, Separator, SimpleAutoComplete, Slider, South, Space, Span, Spinner, Splitter, Tab, Tabbox, Tablechildren, Tablelayout, Tabpanel, Tabpanels, Tabs, Textbox, ThemeImage, Timebox, Toolbar, Toolbarbutton, Tree, Treecell, Treechildren, Treecol, Treecols, Treefoot, Treefooter, Treeitem, Treerow, Vbox, West, Window, XulElement

public interface XulElement
extends HtmlBasedComponent

The fundamental class for XUL elements.

Events:
onOK, onCacnel and onCtrlKey.

Since:

3.5.2

Author:

tomyeh

Field Summary

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Method Summary

java.lang.String	getAction() Returns the client-side action (CSA).
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.
void	setAction(java.lang.String action) Sets the client-side action.
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 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, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, unsetVariable

Method Detail

getCtrlKeys

java.lang.String getCtrlKeys()

Returns what keystrokes to intercept.

Default: null.

setCtrlKeys

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.

Throws:

UiException

getContext

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).

setContext

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 ignores the ID space when locating the component at the client. In other words, it searches for the first component with the specified ID, no matter it is in the same ID space or not.

(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:

 <code>
 <label context="some">
 <label context="uuid(${some.uuid})"/>
 </code>
 

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).

See Also:

setContext(Popup)

setContext

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() + ")")

See Also:

setContext(String)

getPopup

java.lang.String getPopup()

Returns the ID of the popup (Popup) that should appear when the user clicks on the element.

Default: null (no poppup).

setPopup

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 ignores the ID space when locating the component at the client. In other words, it searches for the first component with the specified ID, no matter it is in the same ID space or not.

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

See Also:

setPopup(Popup)

setPopup

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() + ")")

See Also:

setPopup(String)

getTooltip

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.

Default: null (no tooltip).

setTooltip

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 ignores the ID space when locating the component at the client. In other words, it searches for the first component with the specified ID, no matter it is in the same ID space or not.

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

See Also:

setTooltip(Popup)

setTooltip

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() + ")")

See Also:

setTooltip(String)

getAction

java.lang.String getAction()

Returns the client-side action (CSA).

The format:
action1: javascript1; javascript2; action2: javascript3

You could specify any action as long as JavaScript supports, such as onfocus, onblur, onmouseover and onmousout.

setAction

void setAction(java.lang.String action)

Sets the client-side action.