META-INF.maven-faces-plugin.components.trinidad.NavigationTree.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[Apache Trinidad navigationTree components are used to display hierarchical navigation data.]]></description>
<icon>
<!-- small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/baseNavigationTree.png</small-icon -->
</icon>
<component-type>org.apache.myfaces.trinidad.NavigationTree</component-type>
<component-class>org.apache.myfaces.trinidad.component.UIXNavigationTree</component-class>
<xi:include href="includes/RowDisclosureEvent.xml" xpointer="/faces-config/component/*"/>
<xi:include href="includes/DisclosedRowKeys.xml" xpointer="/faces-config/component/*"/>
<facet>
<description><![CDATA[the component to use to stamp each element in the
tree. Only certain types of components are supported,
including all
components with no behavior and most components that implement the
EditableValueHolder or ActionSource interfaces.]]>
</description>
<facet-name>nodeStamp</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.CoreCommandNavigationItem</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<property>
<description><![CDATA[the hierarchy of tree data - must be of type
org.apache.myfaces.trinidad.model.MenuModel]]>
</description>
<property-name>value</property-name>
<property-class>java.lang.Object</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[the starting level, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.]]>
</description>
<property-name>startLevel</property-name>
<property-class>int</property-class>
<default-value>0</default-value>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
<fmd:required>false</fmd:required>
<fmd:property-editor>UNSIGNED_INTEGER</fmd:property-editor>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>]]>
</description>
<property-name>varStatus</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
<fmd:value-expression>PROHIBITED</fmd:value-expression>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[whether data validation
should be skipped when row disclosure
events are generated by this component.
When immediate is false (the default), events will
be delivered during the Invoke Application phase, which
will trigger validation. When set to true, events
will be executed during the Apply Request Values phase.]]>
</description>
<property-name>immediate</property-name>
<property-class>boolean</property-class>
<default-value>false</default-value>
</property>
<component-extension>
<mfp:component-family>org.apache.myfaces.trinidad.NavigationTree</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.CollectionBase</mfp:component-supertype>
<mfp:component-superclass>org.apache.myfaces.trinidad.component.UIXNavigationHierarchy</mfp:component-superclass>
<mfp:renderer-type>org.apache.myfaces.trinidad.NavigationTree</mfp:renderer-type>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.UIXNavigationTreeTag</mfp:tag-class>
<mfp:long-description><![CDATA[<html:p>
Apache Trinidad navigationTree components are used to display hierarchical navigation data.
</html:p>]]>
</mfp:long-description>
<mfp:author>Gabrielle Crawford</mfp:author>
<mfp:tag-class-modifier>abstract</mfp:tag-class-modifier>
</component-extension>
</component>
</faces-config>