West"

From Documentation
m ((via JWB))
 
Line 65: Line 65:
  
 
=Properties and Features=
 
=Properties and Features=
== Caption ==
 
A layout region might have a caption, which is specified by declaring a child component called caption.
 
{{ZK EE}}
 
{{versionSince| 6.5.0}}
 
  
<source lang="xml" >
+
{{LayoutCommonAttributes}}
<borderlayout>
 
<west>
 
<caption label="search" image="/img/live.gif">
 
<combobox>
 
<comboitem label="item 1" />
 
<comboitem label="item 2" />
 
<comboitem label="item 3" />
 
<comboitem label="item 4" />
 
</combobox>
 
</caption>
 
<div>
 
Content
 
</div>
 
</west>
 
</borderlayout>
 
</source>
 
 
 
== Closable ==
 
Whether users can open or close the region. Require <code>collapsible="true"</code>.
 
Default: true.
 
 
 
{{versionSince| 8.5.2}}
 
 
 
== Slidable ==
 
Whether users can slide (preview) the region when clicked on a collapsed region. Require <code>collapsible="true"</code>.
 
Default: true.
 
 
 
{{versionSince| 8.5.2}}
 
  
 
=Supported Events=
 
=Supported Events=

Latest revision as of 09:09, 10 January 2023

West

Employment/Purpose

A west region of a border layout and only allows one component as its child.

Example

ZKCompRef Borderlayout.jpg

<borderlayout height="450px">
	<north title="North" maxsize="300" size="50%" splittable="true" collapsible="true">
		<borderlayout>
			<west title="West" size="25%" flex="true" maxsize="250" splittable="true" collapsible="true">
				<div style="background:#B8D335">
					<label value="25%"
						style="color:white;font-size:50px" />
				</div>
			</west>
			<center border="none">
				<div style="background:#E6D92C" vflex="1">
					<label value="25%"
						style="color:white;font-size:50px" />
				</div>
			</center>
			<east size="50%" border="none">
				<label value="Here is a non-border"
					style="color:gray;font-size:30px" />
			</east>
		</borderlayout>
	</north>
	<center border="0">
		<borderlayout>
			<west maxsize="600" size="30%" border="0" splittable="true">
				<div style="background:#E6D92C" vflex="1">
					<label value="30%"
						style="color:white;font-size:50px" />
				</div>
			</west>
			<center>
				<label value="Here is a border"
					style="color:gray;font-size:30px" />
			</center>
			<east title="East" size="30%" collapsible="true">
				<div style="background:#B8D335"  vflex="1">
					<label value="30%"
						style="color:white;font-size:50px" />
				</div>
			</east>
		</borderlayout>
	</center>
</borderlayout>

How to Layout

For more details, please refer to Borderlayout.

Properties and Features

Caption

  • Available for ZK:
  • http://www.zkoss.org/product/zkhttp://www.zkoss.org/whyzk/zkeeVersion ee.png

Since 6.5.0

A layout region may have a caption, which is specified by declaring a child component <caption>.

<borderlayout>
	<north>
		<caption label="search" image="/img/live.gif"/>
		<div>
		Content
		</div>	
	</north>
</borderlayout>

Closable

Since 8.5.2 Default: true

Whether users can open or close the region. Require collapsible="true". Notice you need to click the icon on the title or on the splitter to open/close a region. Clicking a title slides a region instead of opening it.

Closable.gif


Slidable

Since 8.5.2 Default: true

Whether users can slide (preview) the region when clicking on the title of the collapsed region. It opens the region like a drawer overlapping on the <center>, so it doesn't affect the size of <center> which is different from opening the region. Require collapsible="true".


Layout slidable.gif

Supported Events

Name
Event Type
None None

Supported Children

*ALL

Use Cases

Borderlayout

Version History

Last Update : 2023/01/10


Version Date Content
6.5.0 June 2012 ZK-969: The LayoutRegion component support caption component as it's title
8.5.2 May 2018 ZK-3329: Collapsible Borderlayout region in slide or open mode only


Last Update : 2023/01/10

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