org.zkoss.zul.api
Interface Columns

All Superinterfaces:
java.lang.Cloneable, Component, HeadersElement, HtmlBasedComponent, Scope, java.io.Serializable, XulElement
All Known Implementing Classes:
Columns

public interface Columns
extends HeadersElement

Defines the columns of a grid. Each child of a columns element should be a Column element.

Default HtmlBasedComponent.getZclass(): z-columns.(since 3.5.0)

Since:
3.5.2
Author:
tomyeh

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
 Grid getGridApi()
          Returns the grid that it belongs to.
 java.lang.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 columns with the header context menu.
 boolean isColumnshide()
          Returns whether to enable hiding of columns with the header context menu.
 void setColumnsgroup(boolean columnsgroup)
          Sets whether to enable grouping of columns with the header context menu.
 void setColumnshide(boolean columnshide)
          Sets whether to enable hiding of columns with the header context menu.
 void setMenupopup(java.lang.String mpop)
          Sets the ID of the menupopup (Menupopup) that should appear when the user clicks on the element of each column.
 void setPopupApi(Menupopup mpop)
          Deprecated. As of release 5.0.0, replaced with XulElement.setPopup(Popup).
 
Methods inherited from interface org.zkoss.zul.impl.api.HeadersElement
isSizable, setSizable
 
Methods inherited from interface org.zkoss.zul.impl.api.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
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.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Method Detail

getGridApi

Grid getGridApi()
Returns the grid that it belongs to.

It is the same as Component.getParent().


setColumnshide

void setColumnshide(boolean columnshide)
Sets whether to enable hiding of columns with the header context menu.

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


isColumnshide

boolean isColumnshide()
Returns whether to enable hiding of columns with the header context menu.

Default: true.


setColumnsgroup

void setColumnsgroup(boolean columnsgroup)
Sets whether to enable grouping of columns with the header context menu.

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


isColumnsgroup

boolean isColumnsgroup()
Returns whether to enable grouping of columns with the header context menu.

Default: true.


getMenupopup

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

Default: none (a default menupoppup).


setMenupopup

void setMenupopup(java.lang.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", or "auto". "none" is assumed by default, "auto" means the menupopup component is created automatically.
See Also:
setMenupopup(String)

setPopupApi

void setPopupApi(Menupopup mpop)
Deprecated. As of release 5.0.0, replaced with XulElement.setPopup(Popup).



Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo