zkmax.wgt

Class Drawer

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zkmax.wgt.Drawer

public class Drawer
extends Widget

A drawer.

Available in ZK EE.

Only support browsers that support Flex and CSS Transitions. (IE10+, Edge, Chrome, Firefox, Safari)

Since:

9.0.0

Author:

rudyhuang

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

Modifier and Type	Method and Description
void	close() Closes the drawer.
String	getPosition() Returns the position of this drawer.
String	getTitle() Returns the title of this drawer.
boolean	isAutodrop() Returns whether it is opened automatically when the mouse cursor is near the page edge.
boolean	isClosable() Returns whether it is closeable by user (a button).
boolean	isMask() Returns whether it is masked when opened.
void	open() Opens the drawer.
void	setAutodrop(boolean autodrop) Sets whether it is opened automatically when the mouse cursor is near the page edge.
void	setClosable(boolean closable) Sets whether it is closeable by user (a button).
void	setMask(boolean mask) Sets whether it is masked when opened.
void	setPosition(String position) Sets the position of this drawer.
void	setTitle(String title) Sets the title of this drawer.

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

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTabindex, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTabindex, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

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

setTitle

public void setTitle(String title)

Sets the title of this drawer. null means no title.

Parameters:

title - the title.

getTitle

public String getTitle()

Returns the title of this drawer. null means no title.

Default: null.

Returns:

String

setPosition

public void setPosition(String position)

Sets the position of this drawer. Valid values are "left", "right", "top" and "bottom".

Parameters:

position - the position of this drawer.

getPosition

public String getPosition()

Returns the position of this drawer. Valid values are "left", "right", "top" and "bottom".

Default: right.

Returns:

String

setMask

public void setMask(boolean mask)

Sets whether it is masked when opened.

Parameters:

mask - mask enabled?

isMask

public boolean isMask()

Returns whether it is masked when opened.

Default: true.

Returns:

boolean

setClosable

public void setClosable(boolean closable)

Sets whether it is closeable by user (a button).

Parameters:

closable - closable enabled?

isClosable

public boolean isClosable()

Returns whether it is closeable by user (a button).

Default: false.

Returns:

boolean

setAutodrop

public void setAutodrop(boolean autodrop)

Sets whether it is opened automatically when the mouse cursor is near the page edge.

Parameters:

autodrop - autodrop enabled?

isAutodrop

public boolean isAutodrop()

Returns whether it is opened automatically when the mouse cursor is near the page edge.

Default: false.

Returns:

boolean

open

public void open()

Opens the drawer.

close

public void close()

Closes the drawer.