zul.mesh

Class ColumnMenuWidget

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.mesh.HeadWidget

zul.mesh.ColumnMenuWidget

Direct Known Subclasses:

Columns, Listhead

public class ColumnMenuWidget
extends HeadWidget

A skeletal implementation for a column menu widget.

Since:

6.5.0

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
String	getMenupopup() Returns the ID of the Menupopup (Menupopup) that should appear when the user clicks on the element.
boolean	isColumnsgroup() Returns whether to enable grouping of the widget with the header context menu.
boolean	isColumnshide() Returns whether to enable hiding of the widget with the header context menu.
void	setColumnsgroup(boolean columnsgroup) Sets whether to enable grouping of the widget with the header context menu.
void	setColumnshide(boolean columnshide) Sets whether to enable hiding of the widget with the header context menu.
void	setMenupopup(String mpop) Sets the ID of the menupopup (Menupopup) that should appear when the user clicks on the element of each column.
void	syncColMenu() Synchronizes the menu of this widget.

Methods inherited from class zul.mesh.HeadWidget

getMeshWidget, isSizable, setSizable

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

setColumnshide

public void setColumnshide(boolean columnshide)

Sets whether to enable hiding of the widget with the header context menu.

Note that it is only applied when getMenupopup() is auto.

Parameters:

columnshide -

isColumnshide

public boolean isColumnshide()

Returns whether to enable hiding of the widget with the header context menu.

Default: true.

Returns:

boolean

setColumnsgroup

public void setColumnsgroup(boolean columnsgroup)

Sets whether to enable grouping of the widget with the header context menu.

Note that it is only applied when getMenupopup() is auto.

Parameters:

columnsgroup -

isColumnsgroup

public boolean isColumnsgroup()

Returns whether to enable grouping of the widget with the header context menu.

Default: true.

Returns:

boolean

setMenupopup

public void setMenupopup(String mpop)

Sets the ID of the menupopup (Menupopup) that should appear when the user clicks on the element of each column.

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.

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)

Parameters:

mpop - an ID of the menupopup component, "none", "auto" or "auto-keep". "none" is assumed by default, "auto" means the menupopup component is created automatically, "auto-keep" means the menupopup component is created automatically and keep the menupopup open after setting column visibility.

See Also:

setMenupopup(String)

getMenupopup

public String getMenupopup()

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

Default: none (a default menupoppup).

Returns:

String

syncColMenu

public void syncColMenu()

Synchronizes the menu of this widget. This method is called automatically if the widget is created at the server (i.e., Widget.inServer is true). You have to invoke this method only if you create this widget at client and change the content of the column's menu.