Hbox"

From Documentation
 
(36 intermediate revisions by 10 users not shown)
Line 3: Line 3:
 
= Hbox =
 
= Hbox =
  
 +
*Demonstration: [http://www.zkoss.org/zkdemo/layout/box Hbox]
 
*Java API: <javadoc>org.zkoss.zul.Hbox</javadoc>
 
*Java API: <javadoc>org.zkoss.zul.Hbox</javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zul.box.Box</javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zul.box.Box</javadoc>
 +
*Style Guide: [[ZK_Style_Guide/XUL_Component_Specification/Hbox| Hbox]]
  
 
= Employment/Purpose =
 
= Employment/Purpose =
  
The hbox component is used to create a horizontally oriented box. Each component placed in the hbox will be placed horizontally in a row.
+
The hbox component is used to layout its child components horizontally and control those children's horizontal and vertical position..
 +
 
 +
 
 +
== Recommend Hlayout ==
 +
Notice that hbox and vbox are designed to provide a more sophisticated layout, such as splitter, alignment, and packing. ZK renders these 2 components with an HTML table.
 +
If you only need the components for layout, we suggest using [[ZK_Component_Reference/Layouts/Hlayout | Hlayout]] and [[ZK_Component_Reference/Layouts/Vlayout | Vlayout]] instead, since the performance is much better (due to the use of HTML DIV instead of TABLE).
  
 
= Example =
 
= Example =
Line 27: Line 34:
 
</source>
 
</source>
  
=Supported events=
+
=Properties=
  
{| border="1" | width="100%"
+
* '''Inherited Properties''': [[ZK Component Reference/Containers/Box#Properties | Box]]
 +
 
 +
==Align and Pack==
 +
[[Image:ZKComRef_Hbox_Simple_Examples_align_pack.PNG]]
 +
 
 +
<source lang="xml" highlight="23">
 +
<zk xmlns:n="native">
 +
    <style content=".box {| class='wikitable' | width="100%"
 +
    <custom-attributes
 +
        packs="${['', 'start', 'center', 'end']}"
 +
        aligns="${['', 'stretch', 'start', 'center', 'end']}"
 +
    />
 +
 
 +
    <vlayout>
 +
        <hlayout height="70px" width="900px">
 +
            <div hflex="1" vflex="1" sclass="box">
 +
              <n:h3>pack / align</n:h3>
 +
            </div>
 +
            <div forEach="${packs}" hflex="1" vflex="1" sclass="box">
 +
              <n:h3>${each}</n:h3>
 +
            </div>
 +
        </hlayout>
 +
        <hlayout forEach="${aligns}" height="100px" width="900px">
 +
            <custom-attributes align="${each}"/>
 +
            <div hflex="1" vflex="1" sclass="box">
 +
              <n:h3>${align}</n:h3>
 +
            </div>
 +
         
 +
            <hbox forEach="${packs}" align="${align}" pack="${each}" hflex="1" vflex="1" sclass="box">
 +
                <button label="1" />
 +
                <button label="2" />
 +
                <button label="3" />
 +
            </hbox>
 +
        </hlayout>
 +
    </vlayout>
 +
</zk>
 +
</source>
 +
{{versionSince| 5.0.0}}
 +
 
 +
= Cell Component  =
 +
In ZK5, we have introduced a new component named Cell which can be embedded into a Grid or Box (Hbox and Vbox) to fully control the layout and the style. You can now use the rowspan or the colspan property to layout your Grid, for example a content cell can now cross over multiple rows. The code below demonstrates how to do this:
 +
 
 +
<source lang="xml" >
 +
<hbox>
 +
    <cell sclass="years">
 +
        ...
 +
    </cell>
 +
</hbox>
 +
</source>
 +
{{versionSince| 5.0.0}}
 +
 
 +
= Limitation =
 +
Box component is consisted by Table element. Therefore, when put Input element like Textbox, Combobox inside Box component, specify width and height to Box component will be ignored when browser try to render table element.
 +
 
 +
For example,
 +
<source lang="xml">
 +
<hbox height="200px" width="200px" style="border: 1px solid red">
 +
    <textbox hflex="1" value="1" />
 +
    <textbox hflex="1" value="1" />
 +
</hbox>
 +
</source>
 +
You will see the Box width exceed 200px. Also check the [http://jsfiddle.net/A5g9q/ sample] with pure HTML in jsfiddle.
 +
 
 +
=Supported Events=
 +
 
 +
{| class='wikitable' | width="100%"
 
! <center>Name</center>
 
! <center>Name</center>
 
! <center>Event Type</center>
 
! <center>Event Type</center>
 
|-
 
|-
| Text
+
| None
| Text
+
| None
 
|}
 
|}
 +
*Inherited Supported Events: [[ZK Component Reference/Containers/Box#Supported_Events | Box]]
  
 
=Supported Children=
 
=Supported Children=
Line 41: Line 114:
 
  *ALL
 
  *ALL
  
=Use cases=
+
=Use Cases=
  
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
 
! Version !! Description !! Example Location
 
! Version !! Description !! Example Location
 
|-
 
|-
| 5.0+
+
| &nbsp;
| Text
+
| &nbsp;
| Text
+
| &nbsp;
 
|}
 
|}
  
 
=Version History=
 
=Version History=
 
+
{{LastUpdated}}
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
 
! Version !! Date !! Content
 
! Version !! Date !! Content
 
|-
 
|-
| 5.x.x
+
| &nbsp;
| x/x/20xx
+
| &nbsp;
| Initialization
+
| &nbsp;
 
|}
 
|}
  
 
{{ZKComponentReferencePageFooter}}
 
{{ZKComponentReferencePageFooter}}

Latest revision as of 01:25, 23 January 2024

Hbox

Employment/Purpose

The hbox component is used to layout its child components horizontally and control those children's horizontal and vertical position..


Recommend Hlayout

Notice that hbox and vbox are designed to provide a more sophisticated layout, such as splitter, alignment, and packing. ZK renders these 2 components with an HTML table. If you only need the components for layout, we suggest using Hlayout and Vlayout instead, since the performance is much better (due to the use of HTML DIV instead of TABLE).

Example

ZKComRef Hbox Simple Examples.PNG

<zk>
	<vbox>
		<button label="Button 1" />
		<button label="Button 2" />
	</vbox>
	<hbox>
		<button label="Button 3" />
		<button label="Button 4" />
	</hbox>
</zk>

Properties

  • Inherited Properties: Box

Align and Pack

ZKComRef Hbox Simple Examples align pack.PNG

<zk xmlns:n="native">
    <style content=".box {| class='wikitable' | width="100%"
    <custom-attributes 
        packs="${['', 'start', 'center', 'end']}"
        aligns="${['', 'stretch', 'start', 'center', 'end']}"
    />

    <vlayout>
        <hlayout height="70px" width="900px">
            <div hflex="1" vflex="1" sclass="box">
              <n:h3>pack / align</n:h3>
            </div>
            <div forEach="${packs}" hflex="1" vflex="1" sclass="box">
              <n:h3>${each}</n:h3>
            </div>
        </hlayout>
        <hlayout forEach="${aligns}" height="100px" width="900px">
            <custom-attributes align="${each}"/> 
            <div hflex="1" vflex="1" sclass="box">
              <n:h3>${align}</n:h3>
            </div>
          
            <hbox forEach="${packs}" align="${align}" pack="${each}" hflex="1" vflex="1" sclass="box">
                <button label="1" />
                <button label="2" />
                <button label="3" />
            </hbox>
        </hlayout>
    </vlayout>
</zk>

Since 5.0.0

Cell Component

In ZK5, we have introduced a new component named Cell which can be embedded into a Grid or Box (Hbox and Vbox) to fully control the layout and the style. You can now use the rowspan or the colspan property to layout your Grid, for example a content cell can now cross over multiple rows. The code below demonstrates how to do this:

<hbox>
    <cell sclass="years">
        ...
    </cell>
</hbox>

Since 5.0.0

Limitation

Box component is consisted by Table element. Therefore, when put Input element like Textbox, Combobox inside Box component, specify width and height to Box component will be ignored when browser try to render table element.

For example,

<hbox height="200px" width="200px" style="border: 1px solid red">
    <textbox hflex="1" value="1" />
    <textbox hflex="1" value="1" />
</hbox>

You will see the Box width exceed 200px. Also check the sample with pure HTML in jsfiddle.

Supported Events

Name
Event Type
None None
  • Inherited Supported Events: Box

Supported Children

*ALL

Use Cases

Version Description Example Location
     

Version History

Last Update : 2024/01/23


Version Date Content
     



Last Update : 2024/01/23

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