Splitter"

From Documentation
m (Created page with 'init')
 
m
Line 1: Line 1:
init
+
{{ZKComponentReferencePageHeader}}
 +
 
 +
= (Splitter) =
 +
 
 +
*Demonstration:
 +
*Java API: <javadoc>org.zkoss.zul.Splitter</javadoc>
 +
*JavaScript API: <javadoc directory="jsdoc">zul.box.Splitter</javadoc>
 +
 
 +
= Employment/Purpose =
 +
An element which should appear before or after an element inside a box (Box, Vbox and Hbox).
 +
 
 +
When the splitter is dragged, the sibling elements of the splitter are resized. If <tt>getCollapse()</tt> is true, a grippy in placed inside the splitter, and one sibling element of the splitter is collapsed when the grippy is clicked.
 +
 
 +
 
 +
= Example =
 +
 
 +
[[Image:ZKComRef_Splitter_Examples.PNG]]
 +
 
 +
<source lang="xml" >
 +
<hbox spacing="0" width="100%">
 +
<vbox height="200px">
 +
Column 1-1: The left-top box. To know whether a splitter is collapsed,
 +
you can listen to the onOpen event.
 +
<splitter collapse="after" />
 +
Column 1-2: You can enforce to open or collapse programming by calling
 +
setOpen method.
 +
</vbox>
 +
<splitter collapse="before" />
 +
Column 2: Whether a splitter allows users to open or collapse depending
 +
on the collapse attribue.
 +
</hbox>
 +
</source>
 +
 
 +
 
 +
=Supported events=
 +
 
 +
{| border="1" | width="100%"
 +
! <center>Name</center>
 +
! <center>Event Type</center>
 +
|-
 +
|<center><tt>onOpen </tt></center>
 +
|'''Event:''' <javadoc>org.zkoss.ui.zk.ui.event.Event</javadoc>
 +
|}
 +
 
 +
When a splitter is collapsed or opened by a user, the <tt>onOpen</tt> event is sent to the application.
 +
=Supported Children=
 +
 
 +
*NONE
 +
 
 +
=Use cases=
 +
 
 +
{| border='1px' | width="100%"
 +
! Version !! Description !! Example Location
 +
|-
 +
| 5.0+
 +
| Text
 +
| Text
 +
|}
 +
 
 +
=Version History=
 +
 
 +
{| border='1px' | width="100%"
 +
! Version !! Date !! Content
 +
|-
 +
| 5.0.1
 +
| 4/20/2010
 +
| Initialization
 +
|}
 +
 
 +
{{ZKComponentReferencePageFooter}}

Revision as of 02:39, 22 April 2010

(Splitter)

Employment/Purpose

An element which should appear before or after an element inside a box (Box, Vbox and Hbox).

When the splitter is dragged, the sibling elements of the splitter are resized. If getCollapse() is true, a grippy in placed inside the splitter, and one sibling element of the splitter is collapsed when the grippy is clicked.


Example

ZKComRef Splitter Examples.PNG

<hbox spacing="0" width="100%">
	<vbox height="200px">
		Column 1-1: The left-top box. To know whether a splitter is collapsed,
		you can listen to the onOpen event.
		<splitter collapse="after" />
		Column 1-2: You can enforce to open or collapse programming by calling
		setOpen method.
	</vbox>
	<splitter collapse="before" />
	Column 2: Whether a splitter allows users to open or collapse depending
	on the collapse attribue.
</hbox>


Supported events

Name
Event Type
onOpen
Event: Event

When a splitter is collapsed or opened by a user, the onOpen event is sent to the application.

Supported Children

  • NONE

Use cases

Version Description Example Location
5.0+ Text Text

Version History

Version Date Content
5.0.1 4/20/2010 Initialization



Last Update : 2010/04/22

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