|
||||||||||
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.impl.HeadersElement
org.zkoss.zul.Columns
public class Columns
Defines the columns of a grid.
Each child of a columns element should be a Column
element.
Default getZclass()
: z-columns.(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 | |
---|---|
Columns()
|
Method Summary | ||
---|---|---|
void |
beforeChildAdded(org.zkoss.zk.ui.Component child,
org.zkoss.zk.ui.Component refChild)
|
|
void |
beforeParentChanged(org.zkoss.zk.ui.Component parent)
|
|
Grid |
getGrid()
Returns the grid that it belongs to. |
|
String |
getMenupopup()
Returns the ID of the Menupopup ( Menupopup ) that should appear
when the user clicks on the element. |
|
|
getValue()
Returns the value. |
|
String |
getZclass()
|
|
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. |
|
protected void |
renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
|
|
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 |
setHflex(String flex)
Deprecated. as of release 6.0.0. To control the size of Grid related components, please refer to Grid and Column instead. |
|
void |
setMenupopup(String mpop)
Sets the ID of the menupopup ( Menupopup ) that should appear
when the user clicks on the element of each column. |
|
|
setValue(T value)
Sets the value. |
|
void |
setWidth(String width)
Deprecated. as of release 6.0.0. To control the size of Grid related components, please refer to Grid and Column instead. |
Methods inherited from class org.zkoss.zul.impl.HeadersElement |
---|
isSizable, service, setSizable |
Methods inherited from class org.zkoss.zul.impl.XulElement |
---|
clone, getContext, getCtrlKeys, getPopup, getTooltip, 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, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, 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, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, 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, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, 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 Columns()
Method Detail |
---|
public Grid getGrid()
It is the same as AbstractComponent.getParent()
.
public void setColumnshide(boolean columnshide)
Note that it is only applied when getMenupopup()
is auto.
public boolean isColumnshide()
Default: true.
public void setColumnsgroup(boolean columnsgroup)
Note that it is only applied when getMenupopup()
is auto.
public boolean isColumnsgroup()
Default: true.
public String getMenupopup()
Menupopup
) that should appear
when the user clicks on the element.
Default: none (a default menupopup).
public void setMenupopup(String mpop)
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)
mpop
- an ID of the menupopup component, "none", or "auto".
"none" is assumed by default, "auto" means the menupopup component is
created automatically.setMenupopup(String)
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws IOException
renderProperties
in class HeadersElement
IOException
public <T> T getValue()
Default: null.
Note: the value is application dependent, you can place whatever value you want.
public <T> void setValue(T value)
value
- the value.
Note: the value is application dependent, you can place whatever value you want.
public void setWidth(String width)
Grid
and Column
instead.
setWidth
in class org.zkoss.zk.ui.HtmlBasedComponent
public void setHflex(String flex)
Grid
and Column
instead.
setHflex
in class org.zkoss.zk.ui.HtmlBasedComponent
public String getZclass()
getZclass
in class org.zkoss.zk.ui.HtmlBasedComponent
public void beforeParentChanged(org.zkoss.zk.ui.Component parent)
beforeParentChanged
in interface org.zkoss.zk.ui.sys.ComponentCtrl
beforeParentChanged
in class org.zkoss.zk.ui.AbstractComponent
public void beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
beforeChildAdded
in interface org.zkoss.zk.ui.sys.ComponentCtrl
beforeChildAdded
in class org.zkoss.zk.ui.AbstractComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |