Organigram"

From Documentation
m ((via JWB))
 
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{ZKDevelopersReferencePageHeader}}
 
= Organigram =
 
= Organigram =
  
 
*Java API: <javadoc>org.zkoss.zkmax.zul.Organigram </javadoc>
 
*Java API: <javadoc>org.zkoss.zkmax.zul.Organigram </javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zkmax.layout.Organigram </javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zkmax.layout.Organigram </javadoc>
 +
 +
{{ZK EE}}
 +
{{versionSince| 8.6.0}}
  
 
= Employment/Purpose =
 
= Employment/Purpose =
  
−
<tt>Organigram</tt> is a component for showing organizational chart by using tree data structure, it also support TreeModel to hold data, Organigram only accept one <tt>Orgchildren</tt> as child, developers can put <tt>Orgchildren</tt>, <tt>Orgitem</tt> and <tt>Orgnode</tt> in <tt>Organigram</tt> to display data.
+
<code>Organigram</code> is a component for showing organizational chart by using tree data structure, it also support TreeModel to hold data, Organigram only accept one <code>Orgchildren</code> as child, developers can put <code>Orgchildren</code>, <code>Orgitem</code> and <code>Orgnode</code> in <code>Organigram</code> to display data.
 +
 
 +
<code>Organigram</code> supports [https://www.zkoss.org/wiki/ZK_Developer%27s_Reference/Performance_Tips/Client_Render_on_Demand Client Render on Demand]
 +
 
 +
= Browser Support =
 +
*For IE, this component only supports 11+, it is based on [https://developer.mozilla.org/en-US/docs/Web/CSS/flex CSS Flexbox], please check browser compatibility before using it.
  
 
= Example =
 
= Example =
−
 
+
[[Image:Organigram example.png]]
 
<source lang="xml" >
 
<source lang="xml" >
 
<organigram width="600px">
 
<organigram width="600px">
 
<orgchildren>
 
<orgchildren>
−
<orgitem>
+
<orgitem label="Item1">
−
<orgnode label="Item1"/>
 
 
<orgchildren>
 
<orgchildren>
−
<orgitem>
+
<orgitem label="Item2">
−
<orgnode label="Item2"/>
 
 
<orgchildren>
 
<orgchildren>
−
<orgitem>
+
<orgitem label="Item3"/>
−
<orgnode label="Item3"/>
+
<orgitem label="Item4">
−
</orgitem>
 
−
<orgitem>
 
−
<orgnode label="Item4"/>
 
 
<orgchildren>
 
<orgchildren>
−
<orgitem>
+
<orgitem label="Item5"/>
−
<orgnode label="Item5"/>
 
−
</orgitem>
 
 
</orgchildren>
 
</orgchildren>
 
</orgitem>
 
</orgitem>
 
</orgchildren>
 
</orgchildren>
 
</orgitem>
 
</orgitem>
−
<orgitem>
+
<orgitem label="Item6">
−
<orgnode label="Item6"/>
+
<orgchildren>
 +
<orgitem label="Item7"/>
 +
<orgitem label="Item8"/>
 +
</orgchildren>
 
</orgitem>
 
</orgitem>
 
</orgchildren>
 
</orgchildren>
Line 41: Line 46:
 
</source>
 
</source>
  
−
 
+
= Model-Driven Display =
−
<source language="xml">
+
[[Image:Organigram example2.png]]
 +
<source lang="xml">
 
<zscript><![CDATA[
 
<zscript><![CDATA[
−
DefaultTreeNode root = new DefaultTreeNode(null, new DefaultTreeNode[]{
+
DefaultTreeNode root = new DefaultTreeNode(null, new DefaultTreeNode[]{
−
new DefaultTreeNode("Item1", new DefaultTreeNode[]{
+
new DefaultTreeNode("Item1", new DefaultTreeNode[]{
−
new DefaultTreeNode("Item2"), new DefaultTreeNode("Item3"), new DefaultTreeNode("Item4")
+
new DefaultTreeNode("Item2"), new DefaultTreeNode("Item3"), new DefaultTreeNode("Item4")
−
})
+
})
−
});
+
});
−
DefaultTreeModel model = new DefaultTreeModel(root);
+
DefaultTreeModel model = new DefaultTreeModel(root);
−
model.addOpenPath(new int[]{0});
+
model.addOpenPath(new int[]{0});
−
    ]]></zscript>
+
]]></zscript>
 
<organigram width="600px" model="${model}"/>
 
<organigram width="600px" model="${model}"/>
 
</source>
 
</source>
 +
 +
 +
= Selection =
 +
 +
<code>Organigram</code> supports single selection, Orgitem can be selected by users clicking or by programming:
 +
 +
<javadoc method="setSelectedItem(org.zkoss.zkmax.zul.Orgitem)">org.zkoss.zkmax.zul.Organigram</javadoc> , <javadoc method="setSelected(java.lang.Boolean)">org.zkoss.zkmax.zul.Orgitem</javadoc>.
 +
 +
When an Orgitem is selected, the onSelect event will sent back to the server to notify the application, you can call <javadoc method="getSelectedItem()">org.zkoss.zkmax.zul.Organigram</javadoc> to get the selected Orgitem.
 +
 +
Example:
 +
 +
[[Image:Organigram selection.png]]
 +
<source lang="xml">
 +
<organigram width="600px" onSelect="Clients.log(self.getSelectedItem().getLabel())">
 +
<orgchildren>
 +
<orgitem label="Item1">
 +
<orgchildren>
 +
<orgitem label="Item2"/>
 +
<orgitem label="Item3" selected="true"/>
 +
<orgitem label="Item4"/>
 +
</orgchildren>
 +
</orgitem>
 +
</orgchildren>
 +
</organigram>
 +
</source>
 +
 +
 +
 +
= Custom Orgitem =
 +
you can also render Organigram with your customized Renderer and Template, please refer to:
 +
 +
[https://www.zkoss.org/wiki/ZK_Developer%27s_Reference/MVC/View/Template/Organigram_Template Organigram Template]
 +
 +
[https://www.zkoss.org/wiki/ZK_Developer%27s_Reference/MVC/View/Renderer/Organigram_Renderer Organigram Renderer]
 +
 +
 +
 +
=Supported Events=
 +
 +
{| class='wikitable' | width="100%"
 +
! <center>Name</center>
 +
! <center>Event Type</center>
 +
|-
 +
| <center><code>onSelect</code></center>
 +
| '''Event:''' <javadoc>org.zkoss.zk.ui.event.SelectEvent</javadoc>
 +
Notifies one that the user has selected a new item in the organigram.
 +
|-
 +
|}
 +
*Inherited Supported Events: [[ZK_Component_Reference/Base_Components/XulElement#Supported_Events | XulElement]]
 +
 +
 +
=Supported Children=
 +
 +
*[[ZK_Component_Reference/Layouts/Organigram/Orgchildren | Orgchildren]]
 +
 +
 +
 +
=Version History=
 +
{{LastUpdated}}
 +
 +
{| class='wikitable' | width="100%"
 +
! Version !! Date !! Content
 +
|-
 +
| &nbsp;
 +
| &nbsp;
 +
| &nbsp;
 +
|}
 +
 +
{{ZKComponentReferencePageFooter}}

Latest revision as of 14:08, 12 January 2022


DocumentationZK Component ReferenceLayoutsOrganigram
Organigram


Organigram

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

Since 8.6.0

Employment/Purpose

Organigram is a component for showing organizational chart by using tree data structure, it also support TreeModel to hold data, Organigram only accept one Orgchildren as child, developers can put Orgchildren, Orgitem and Orgnode in Organigram to display data.

Organigram supports Client Render on Demand

Browser Support

  • For IE, this component only supports 11+, it is based on CSS Flexbox, please check browser compatibility before using it.

Example

Organigram example.png 

	<organigram width="600px">
		<orgchildren>
			<orgitem label="Item1">
				<orgchildren>
					<orgitem label="Item2">
						<orgchildren>
							<orgitem label="Item3"/>
							<orgitem label="Item4">
								<orgchildren>
									<orgitem label="Item5"/>
								</orgchildren>
							</orgitem>
						</orgchildren>
					</orgitem>
					<orgitem label="Item6">
						<orgchildren>
							<orgitem label="Item7"/>
							<orgitem label="Item8"/>
						</orgchildren>
					</orgitem>
				</orgchildren>
			</orgitem>
		</orgchildren>
	</organigram>

Model-Driven Display

Organigram example2.png 

	<zscript><![CDATA[
		DefaultTreeNode root = new DefaultTreeNode(null, new DefaultTreeNode[]{
			new DefaultTreeNode("Item1", new DefaultTreeNode[]{
				new DefaultTreeNode("Item2"), new DefaultTreeNode("Item3"), new DefaultTreeNode("Item4")
			})
		});
		DefaultTreeModel model = new DefaultTreeModel(root);
		model.addOpenPath(new int[]{0});
	]]></zscript>
	<organigram width="600px" model="${model}"/>


Selection

Organigram supports single selection, Orgitem can be selected by users clicking or by programming:

Organigram.setSelectedItem(Orgitem) , Orgitem.setSelected(Boolean).

When an Orgitem is selected, the onSelect event will sent back to the server to notify the application, you can call Organigram.getSelectedItem() to get the selected Orgitem.

Example:

Organigram selection.png 

	<organigram width="600px" onSelect="Clients.log(self.getSelectedItem().getLabel())">
		<orgchildren>
			<orgitem label="Item1">
				<orgchildren>
					<orgitem label="Item2"/>
					<orgitem label="Item3" selected="true"/>
					<orgitem label="Item4"/>
				</orgchildren>
			</orgitem>
		</orgchildren>
	</organigram>


Custom Orgitem

you can also render Organigram with your customized Renderer and Template, please refer to:

Organigram Template

Organigram Renderer


Supported Events

Name
Event Type
onSelect
 Event: SelectEvent

Notifies one that the user has selected a new item in the organigram.


Supported Children

* Orgchildren


Version History

Last Update : 2022/01/12


Version Date Content
     



Last Update : 2022/01/12

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


Retrieved from "https://www.zkoss.org/_w/index.php?title=ZK_Component_Reference/Layouts/Organigram&oldid=52754"