|
||||||||||
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 |
---|
HtmlBasedComponent.ExtraCtrl |
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
AbstractComponent.Children |
Field Summary |
---|
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
_height, _left, _top, _width, _zclass |
Fields inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
_visible |
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(Component child,
Component refChild)
Default: does nothing. |
void |
beforeParentChanged(Component parent)
Default: does nothing. |
Grid |
getGrid()
Returns the grid that it belongs to. |
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. |
java.lang.Object |
getValue()
Returns the value. |
java.lang.String |
getZclass()
Returns the ZK Cascading Style class(es) for this component. |
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(ContentRenderer renderer)
Renders the content of this component, excluding the enclosing tags and children. |
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 |
setPopup(Menupopup mpop)
Deprecated. As of release 5.0.0, replaced with XulElement.setPopup(Popup) . |
void |
setPopupApi(Menupopup mpopApi)
Deprecated. As of release 5.0.0, replaced with XulElement.setPopup(Popup) . |
void |
setValue(java.lang.Object value)
Sets the value. |
Methods inherited from class org.zkoss.zul.impl.HeadersElement |
---|
isSizable, service, setSizable |
Methods inherited from class org.zkoss.zul.impl.XulElement |
---|
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, newExtraCtrl, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from interface org.zkoss.zk.ui.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Constructor Detail |
---|
public Columns()
Method Detail |
---|
public Grid getGrid()
It is the same as AbstractComponent.getParent()
.
public Grid getGridApi()
It is the same as AbstractComponent.getParent()
.
getGridApi
in interface Columns
public void setColumnshide(boolean columnshide)
Note that it is only applied when getMenupopup()
is auto.
setColumnshide
in interface Columns
public boolean isColumnshide()
Default: true.
isColumnshide
in interface Columns
public void setColumnsgroup(boolean columnsgroup)
Note that it is only applied when getMenupopup()
is auto.
setColumnsgroup
in interface Columns
public boolean isColumnsgroup()
Default: true.
isColumnsgroup
in interface Columns
public java.lang.String getMenupopup()
Menupopup
) that should appear
when the user clicks on the element.
Default: none (a default menupoppup).
getMenupopup
in interface Columns
public void setMenupopup(java.lang.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)
setMenupopup
in interface Columns
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)
public void setPopup(Menupopup mpop)
XulElement.setPopup(Popup)
.
public void setPopupApi(Menupopup mpopApi)
XulElement.setPopup(Popup)
.
setPopupApi
in interface Columns
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
See also Render Special Properties
renderProperties
in class HeadersElement
java.io.IOException
public java.lang.Object getValue()
Default: null.
Note: the value is application dependent, you can place whatever value you want.
public void setValue(java.lang.Object value)
value
- the value.
Note: the value is application dependent, you can place whatever value you want.
public java.lang.String getZclass()
HtmlBasedComponent
Default: null (the default value depends on element).
HtmlBasedComponent.setZclass(java.lang.String)
) will completely replace the default style
of a component. In other words, the default style of a component
is associated with the default value of HtmlBasedComponent.getZclass()
.
Once it is changed, the default style won't be applied at all.
If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String)
instead.
getZclass
in interface HtmlBasedComponent
getZclass
in class HtmlBasedComponent
HtmlBasedComponent.getSclass()
public void beforeParentChanged(Component parent)
AbstractComponent
beforeParentChanged
in interface ComponentCtrl
beforeParentChanged
in class AbstractComponent
parent
- the new parent. If null, it means detachment.ComponentCtrl.beforeParentChanged(org.zkoss.zk.ui.Component)
public void beforeChildAdded(Component child, Component refChild)
AbstractComponent
beforeChildAdded
in interface ComponentCtrl
beforeChildAdded
in class AbstractComponent
child
- the child to be added (never null).refChild
- another child component that the new child
will be inserted before it. If null, the new child will be the
last child.ComponentCtrl.beforeChildAdded(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |