Listheader"

From Documentation
m (Created page with 'init')
 
(15 intermediate revisions by 6 users not shown)
Line 1: Line 1:
init
+
{{ZKComponentReferencePageHeader}}
 +
 
 +
= Listheader =
 +
 
 +
*Demonstration: [http://www.zkoss.org/zkdemo/listbox/sorting Listbox (Sorting) ]
 +
*Java API: <javadoc>org.zkoss.zul.Listheader</javadoc>
 +
*JavaScript API: <javadoc directory="jsdoc">zul.sel.Listheader</javadoc>
 +
*Style Guide: [[ZK_Style_Guide/XUL_Component_Specification/Listheader| Listheader]]
 +
 
 +
= Employment/Purpose =
 +
 
 +
The list header which defines the attributes and header of a columen of a list box. Its parent must be <tt>Listhead</tt>.
 +
 
 +
= Example =
 +
 
 +
[[Image:ZKComRef_ Listbox_Example.png]]
 +
 
 +
<source lang="xml" >
 +
<window title="listbox demo" border="normal" width="250px">
 +
        <listbox id="box">
 +
            <listhead sizable="true">
 +
                <listheader label="name" sort="auto"/>
 +
                <listheader label="gender" sort="auto"/>
 +
            </listhead>
 +
            <listitem>
 +
                <listcell label="Mary"/>
 +
                <listcell label="FEMALE"/>
 +
            </listitem>
 +
            <listitem>
 +
                <listcell label="John"/>
 +
                <listcell label="MALE"/>
 +
            </listitem>
 +
            <listitem>
 +
                <listcell label="Jane"/>
 +
                <listcell label="FEMALE"/>
 +
            </listitem>
 +
            <listitem>
 +
                <listcell label="Henry"/>
 +
                <listcell label="MALE"/>
 +
            </listitem>
 +
            <listfoot >
 +
                <listfooter><label value="This is footer1"/></listfooter>
 +
                <listfooter><label value="This is footer2"/></listfooter>
 +
            </listfoot>
 +
        </listbox>       
 +
</window>
 +
</source>
 +
 
 +
=Supported Events=
 +
 
 +
{| border="1" | width="100%"
 +
! <center>Name</center>
 +
! <center>Event Type</center>
 +
 
 +
|-
 +
| <center><tt>onSort</tt></center>
 +
| '''Event:''' <javadoc>org.zkoss.zk.ui.event.SortEvent</javadoc>
 +
Denotes user has sorted the row of this column.
 +
 
 +
|-
 +
| <center><tt>onGroup</tt></center>
 +
| '''Event:''' <javadoc>org.zkoss.zk.ui.event.SortEvent</javadoc>
 +
[ZK PE]
 +
[Since 6.5.0]
 +
Denotes user has grouped all the cells under a column.
 +
|-
 +
| <center><tt>onUngroup</tt></center>
 +
| '''Event:''' <javadoc>org.zkoss.zk.ui.event.SortEvent</javadoc>
 +
[ZK EE]
 +
[Since 6.5.0]
 +
Denotes user has ungrouped all the cells under a column.
 +
 
 +
|}
 +
 
 +
*Inherited Supported Events: [[ZK_Component_Reference/Base_Components/HeaderElement#Supported_Events | HeaderElement]]
 +
 
 +
=Supported Children=
 +
 
 +
*ALL
 +
 
 +
=Use Cases=
 +
 
 +
{| border='1px' | width="100%"
 +
! Version !! Description !! Example Location
 +
|-
 +
| 5.0
 +
| Multiline Listheader
 +
| http://www.zkoss.org/forum/listComment/6864
 +
|}
 +
 
 +
=Version History=
 +
{{LastUpdated}}
 +
 
 +
{| border='1px' | width="100%"
 +
! Version !! Date !! Content
 +
|-
 +
| 6.5.0
 +
| June 2012
 +
| [http://tracker.zkoss.org/browse/ZK-120 ZK-120]: Provide menupopup="auto" for listbox
 +
|-
 +
| 6.5.0
 +
| June 2012
 +
| [http://tracker.zkoss.org/browse/ZK-147 ZK-147]: Support ungroup for grid's column menu
 +
|}
 +
 
 +
{{ZKComponentReferencePageFooter}}

Revision as of 06:20, 25 July 2012

Listheader

Employment/Purpose

The list header which defines the attributes and header of a columen of a list box. Its parent must be Listhead.

Example

ZKComRef Listbox Example.png

 <window title="listbox demo" border="normal" width="250px">
         <listbox id="box">
             <listhead sizable="true">
                 <listheader label="name" sort="auto"/>
                 <listheader label="gender" sort="auto"/>
             </listhead>
             <listitem>
                 <listcell label="Mary"/>
                 <listcell label="FEMALE"/>
             </listitem>
             <listitem>
                 <listcell label="John"/>
                 <listcell label="MALE"/>
             </listitem>
             <listitem>
                 <listcell label="Jane"/>
                 <listcell label="FEMALE"/>
             </listitem>
             <listitem>
                 <listcell label="Henry"/>
                 <listcell label="MALE"/>
             </listitem>
             <listfoot >
                 <listfooter><label value="This is footer1"/></listfooter>
                 <listfooter><label value="This is footer2"/></listfooter>
             </listfoot>
         </listbox>        
 </window>

Supported Events

Name
Event Type
onSort
Event: SortEvent

Denotes user has sorted the row of this column.

onGroup
Event: SortEvent
[ZK PE]
[Since 6.5.0]

Denotes user has grouped all the cells under a column.

onUngroup
Event: SortEvent
[ZK EE]
[Since 6.5.0]

Denotes user has ungrouped all the cells under a column.

Supported Children

*ALL

Use Cases

Version Description Example Location
5.0 Multiline Listheader http://www.zkoss.org/forum/listComment/6864

Version History

Last Update : 2012/07/25


Version Date Content
6.5.0 June 2012 ZK-120: Provide menupopup="auto" for listbox
6.5.0 June 2012 ZK-147: Support ungroup for grid's column menu



Last Update : 2012/07/25

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.