|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Popup
public class Popup
A container that is displayed as a popup.
The popup window does not have any special frame.
Popups can be displayed when an element is clicked by assigning
the id of the popup to either the XulElement.setPopup(java.lang.String)
,
XulElement.setContext(java.lang.String)
or XulElement.setTooltip(java.lang.String)
attribute of the element.
Default getZclass()
: z-popup.(since 3.5.0)
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 | |
---|---|
|
Popup()
|
protected |
Popup(boolean visible)
|
Method Summary | |
---|---|
void |
close()
Closes this popup at the client. |
String |
getZclass()
|
void |
open(org.zkoss.zk.ui.Component ref)
Opens this popup right below the specified component at the client. |
void |
open(org.zkoss.zk.ui.Component ref,
String position)
Opens this popup right below the specified component at the client. |
void |
open(int x,
int y)
Opens this popup to the specified location at the client. |
void |
open(String x,
String y)
Opens this popup to the specified location at the client. |
void |
service(org.zkoss.zk.au.AuRequest request,
boolean everError)
Processes an AU request. |
boolean |
setVisible(boolean visible)
Not allowed. |
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, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, 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, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, 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, 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 |
Constructor Detail |
---|
public Popup()
protected Popup(boolean visible)
Method Detail |
---|
public void open(String x, String y)
In most cases, the popup is shown automatically when specified
in the tooltip, popup and context properties
(XulElement.setTooltip(java.lang.String)
, XulElement.setPopup(java.lang.String)
,
and XulElement.setContext(java.lang.String)
).
However, if you want to show it manually, you can invoke this
method directly.
x
- the X coordinatey
- the Y coordinatepublic void open(int x, int y)
In most cases, the popup is shown automatically when specified
in the tooltip, popup and context properties
(XulElement.setTooltip(java.lang.String)
, XulElement.setPopup(java.lang.String)
,
and XulElement.setContext(java.lang.String)
).
However, if you want to show it manually, you can invoke this
method directly.
x
- the X coordinatey
- the Y coordinatepublic void open(org.zkoss.zk.ui.Component ref)
By default the position "at_pointer" is assumed.(since 5.0.0)
ref
- the reference component to position the popup.
It cannot be null.open(Component, String)
public void open(org.zkoss.zk.ui.Component ref, String position)
In most cases, the popup is shown automatically when specified
in the tooltip, popup and context properties
(XulElement.setTooltip(java.lang.String)
, XulElement.setPopup(java.lang.String)
,
and XulElement.setContext(java.lang.String)
).
However, if you want to show it manually, you can invoke this
method directly.
Possible values for the position attribute are:
ref
- the reference component to position the popup.
It cannot be null.position
- the descriptions above are for a locale where the UI is
displayed left to right and top to bottom. In this case, before is the top,
after is the bottom, start is the left and end is the right. For right to left locales,
start is the right and end is the left.public void close()
In most cases, the popup is closed automatically when the user clicks outside of the popup.
public boolean setVisible(boolean visible)
open(java.lang.String, java.lang.String)
to open, and close()
to close.
setVisible
in interface org.zkoss.zk.ui.Component
setVisible
in class org.zkoss.zk.ui.AbstractComponent
public String getZclass()
getZclass
in class org.zkoss.zk.ui.HtmlBasedComponent
public void service(org.zkoss.zk.au.AuRequest request, boolean everError)
Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean)
,
it also handles onOpen.
service
in interface org.zkoss.zk.ui.sys.ComponentCtrl
service
in class org.zkoss.zk.ui.HtmlBasedComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |