|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XulElement
The fundamental class for XUL elements.
Events:
onOK, onCacnel and onCtrlKey.
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()
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. |
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 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.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Method Detail |
---|
java.lang.String getCtrlKeys()
Default: null.
void setCtrlKeys(java.lang.String ctrlKeys) throws UiException
The string could be a combination of the following:
For example,
Note: it doesn't support Ctrl+Alt, Shift+Ctrl, Shift+Alt or Shift+Ctrl+Alt.
UiException
java.lang.String getContext()
Popup
) that should appear when the
user right-clicks on the element (aka., context menu).
Default: null (no context menu).
void setContext(java.lang.String context)
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:
<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).
setContext(Popup)
void setContext(Popup popup)
Note: it actually invokes
setContext("uuid(" + popup.getUuid() + ")")
setContext(String)
java.lang.String getPopup()
Popup
) that should appear when the
user clicks on the element.
Default: null (no poppup).
void setPopup(java.lang.String 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)
setPopup(Popup)
void setPopup(Popup popup)
Note: it actually invokes
setPopup("uuid(" + popup.getUuid() + ")")
setPopup(String)
java.lang.String getTooltip()
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).
void setTooltip(java.lang.String tooltip)
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)
setTooltip(Popup)
void setTooltip(Popup popup)
Note: it actually invokes
setTooltip("uuid(" + popup.getUuid() + ")")
setTooltip(String)
java.lang.String getAction()
void setAction(java.lang.String action)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |