|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object zk.Object zk.Widget zul.Widget zul.wgt.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 Widget.setPopup(zul.wgt.Popup)
,
Widget.setContext(zul.wgt.Popup)
or Widget.setTooltip(zul.wgt.Popup)
attribute of the element.
Default Widget.getZclass()
: z-popup.
Field Summary |
---|
Fields inherited from class zk.Widget |
---|
$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName |
Fields inherited from class zk.Object |
---|
$class, $oid |
Method Summary | |
---|---|
protected void |
afterCloseAnima_()
The handling after the closing effect of popup. |
protected void |
afterOpenAnima_()
The handling after the opening effect of popup. |
void |
close(Map opts)
Closes this popup at the client. |
protected void |
closeAnima_()
The effect for closing the popup. |
boolean |
isOpen()
Returns whether the popup is visible. |
void |
open(String ref,
Offset offset,
String position,
Map opts)
Opens the popup. |
void |
open(Widget ref,
Offset offset,
String position,
Map opts)
Opens the popup. |
protected void |
openAnima_()
The effect for opening the popup. |
void |
position(Widget ref,
Offset offset,
String position,
Map opts)
Sets the popup position. |
protected boolean |
shallStackup_()
Returns whether to instantiate a stackup when open(_global_.String, _global_.Offset, _global_.String, _global_.Map)
is called. |
Methods inherited from class zul.Widget |
---|
afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from class zk.Object |
---|
$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public boolean isOpen()
public void open(String ref, Offset offset, String position, Map opts)
Note: the ref with the position parameter is prior to the offset parameter, if any.
ref
- the uuid of the ref widget.offset
- the offset of x and yposition
- Possible values for the position attributeopts
- if opts.sendOnOpen exists, it will fire onOpen event. If opts.disableMask exists,
it will show a disable mask. If opts.overflow exists, it allows the popup to appear
out of the screen range. If opts.dodgeRef exists, it will avoid covering the reference
element.open(zk.Widget, Offset, String, Map)
public void open(Widget ref, Offset offset, String position, Map opts)
Note: the ref with the position parameter is prior to the offset parameter, if any.
ref
- the referred widget.offset
- the offset of x and yposition
- Possible values for the position attribute are:
opts
- if opts.sendOnOpen exists, it will fire onOpen event. If opts.disableMask exists,
it will show a disable mask. If opts.overflow exists, it allows the popup to appear
out of the screen range. If opts.dodgeRef exists, it will avoid covering the reference
element.protected void openAnima_()
protected void afterOpenAnima_()
protected boolean shallStackup_()
open(_global_.String, _global_.Offset, _global_.String, _global_.Map)
is called.
If the derive class created its own stackup (such as creating a shadow), it shall override this method to return false.
public void position(Widget ref, Offset offset, String position, Map opts)
Note: the ref with the position parameter is prior to the offset parameter, if any.
ref
- the referred widget.offset
- the offset of x and yposition
- Possible values for the position attribute
refer to open(_global_.String, _global_.Offset, _global_.String, _global_.Map)
.
opts
- a map of addition options.jqzk.position(Dimension,String,Map)
.public void close(Map opts)
In most cases, the popup is closed automatically when the user clicks outside of the popup.
opts
- if opts.sendOnOpen exists, it will fire onOpen event.protected void closeAnima_()
protected void afterCloseAnima_()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |