META-INF.maven-faces-plugin.components.trinidad.TreeTable.xml Maven / Gradle / Ivy
<?xml version="1.0" encoding="utf-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<faces-config version="2.0" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:tr="http://myfaces.apache.org/trinidad"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:mfp="http://myfaces.apache.org/maven-faces-plugin"
xmlns:fmd="http://java.sun.com/xml/ns/javaee/faces/design-time-metadata">
<component>
<description><![CDATA[The Apache Trinidad TreeTable is used to display data that is structured in a hierarchical format.]]>
</description>
<icon>
<!-- small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/baseTreeTable.png</small-icon -->
</icon>
<component-type>org.apache.myfaces.trinidad.TreeTable</component-type>
<component-class>org.apache.myfaces.trinidad.component.UIXTreeTable</component-class>
<property>
<description>
<![CDATA[
If the root node should be rendered or not. Defaults to true.
]]>
</description>
<property-name>rootNodeRendered</property-name>
<property-class>boolean</property-class>
<default-value>true</default-value>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
<fmd:required>false</fmd:required>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[the maximum number of records that can be displayed at
one time (range size).
Each level of depth in the tree can have a different range size.
The first number in the array sets the range size for the root
collection. Each subsequent number sets the range size for the
corresponding depth. The last number becomes the default for
each subsequent level of depth.
If a node has more children than
the range size, navigation rows will be rendered above and
below the child nodes.]]>
</description>
<property-name>rowsByDepth</property-name>
<property-class>int[]</property-class>
<property-extension>
<mfp:mutable>sometimes</mfp:mutable>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[a method reference to a rangeChange listener that
will be called when a new range is selected.]]>
</description>
<property-name>rangeChangeListener</property-name>
<property-class>javax.el.MethodExpression</property-class>
<property-extension>
<mfp:method-binding-signature>
<mfp:parameter-type>org.apache.myfaces.trinidad.event.RangeChangeEvent</mfp:parameter-type>
<mfp:return-type>void</mfp:return-type>
</mfp:method-binding-signature>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[Sets a height to the content of the table.
This generates a scrollbar to access all rows in the current range.]]>
</description>
<property-name>height</property-name>
<property-class>java.lang.String</property-class>
</property>
<component-extension>
<mfp:component-family>org.apache.myfaces.trinidad.TreeTable</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.Tree</mfp:component-supertype>
<mfp:renderer-type>org.apache.myfaces.trinidad.BaseTreeTable</mfp:renderer-type>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.UIXTreeTableTag</mfp:tag-class>
<mfp:long-description><![CDATA[<html:p>
The Apache Trinidad TreeTable is used to display data that is structured in a hierarchical format.
This component displays a hierarchy
in a UI similar to a Trinidad Table, and is more elaborate than the Tree component.
TreeTable supports displaying columns of data per element in the hierarchy.
Unlike the Tree component, TreeTable
only supports single rooted hierarchies. The features of the TreeTable
component include mechanisms for focusing in on subtrees (within the main
tree), as well as expanding and collapsing elements in the hierarchy.
</html:p>
<html:p>
Like the Table, the TreeTable's children must be Trinidad
Column components. Like the Tree, the TreeTable has a "nodeStamp"
facet which renders the "Object Name" Column.
The "Object Name" Column contains the primary identifier of an element
in the hierarchy. For example, in an organization chart of employees, the "Object Name"
Column might be the employee name.
</html:p>]]>
</mfp:long-description>
<mfp:author>Arjuna Wijeyekoon</mfp:author>
<mfp:component-metadata/>
<mfp:tag-class-modifier>abstract</mfp:tag-class-modifier>
<mfp:unsupported-agents>pda phone voice</mfp:unsupported-agents>
<fmd:component-metadata>
<fmd:default-property>id</fmd:default-property>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.CoreColumn</fmd:preferred-child-components>
</fmd:component-metadata>
</component-extension>
</component>
</faces-config>