org.zkoss.zul
Class Listhead

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.impl.XulElement
              extended by org.zkoss.zul.impl.HeadersElement
                  extended by org.zkoss.zul.Listhead
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Listhead
extends HeadersElement

A list headers used to define multi-columns and/or headers.

Difference from XUL:

  1. There is no listcols in ZUL because it is merged into Listhead. Reason: easier to write Listbox.

Default getZclass(): z-listhead.(since 5.0.0)

Author:
tomyeh
See Also:
Serialized Form

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
Listhead()
           
 
Method Summary
 void beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
           
 void beforeParentChanged(org.zkoss.zk.ui.Component parent)
           
 Listbox getListbox()
          Returns the list box 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.
<T> T
getValue()
          Returns the value.
 java.lang.String getZclass()
           
 boolean isColumnsgroup()
          Returns whether to enable grouping of listheader with the header context menu.
 boolean isColumnshide()
          Returns whether to enable hiding of listheader 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 listheader with the header context menu.
 void setColumnshide(boolean columnshide)
          Sets whether to enable hiding of listheader with the header context menu.
 void setHflex(java.lang.String flex)
          Deprecated. as of release 6.0.0. To control the size of Listbox related components, please refer to Listbox and Listheader instead.
 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.
<T> void
setValue(T value)
          Sets the value.
 void setWidth(java.lang.String width)
          Deprecated. as of release 6.0.0. To control the size of Listbox related components, please refer to Listbox and Listheader 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

Listhead

public Listhead()
Method Detail

getListbox

public Listbox getListbox()
Returns the list box that it belongs to.

It is the same as AbstractComponent.getParent().


setColumnshide

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

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

Since:
6.5.0

isColumnshide

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

Default: true.

Since:
6.5.0

setColumnsgroup

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

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

Since:
6.5.0

isColumnsgroup

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

Default: true.

Since:
6.5.0

getMenupopup

public 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).

Since:
6.5.0

setMenupopup

public 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.
Since:
6.5.0
See Also:
setMenupopup(String)

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws java.io.IOException
Overrides:
renderProperties in class HeadersElement
Throws:
java.io.IOException

getValue

public <T> T getValue()
Returns the value.

Default: null.

Note: the value is application dependent, you can place whatever value you want.

Since:
3.6.0

setValue

public <T> void setValue(T value)
Sets the value.

Parameters:
value - the value.

Note: the value is application dependent, you can place whatever value you want.

Since:
3.6.0

setWidth

public void setWidth(java.lang.String width)
Deprecated. as of release 6.0.0. To control the size of Listbox related components, please refer to Listbox and Listheader instead.

Overrides:
setWidth in class org.zkoss.zk.ui.HtmlBasedComponent

setHflex

public void setHflex(java.lang.String flex)
Deprecated. as of release 6.0.0. To control the size of Listbox related components, please refer to Listbox and Listheader instead.

Overrides:
setHflex in class org.zkoss.zk.ui.HtmlBasedComponent

getZclass

public java.lang.String getZclass()
Overrides:
getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

beforeParentChanged

public void beforeParentChanged(org.zkoss.zk.ui.Component parent)
Specified by:
beforeParentChanged in interface org.zkoss.zk.ui.sys.ComponentCtrl
Overrides:
beforeParentChanged in class org.zkoss.zk.ui.AbstractComponent

beforeChildAdded

public void beforeChildAdded(org.zkoss.zk.ui.Component child,
                             org.zkoss.zk.ui.Component refChild)
Specified by:
beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl
Overrides:
beforeChildAdded in class org.zkoss.zk.ui.AbstractComponent


Copyright © 2012. All Rights Reserved.