META-INF.maven-faces-plugin.components.trinidad.Group.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 group component is an invisible control that aggregates semantically-related children; the group itself has no associated client representation (visual or API).
Some parent components may have special representation for groups like adding separators around the group but this is a special case and is not always rendered this way.
In most cases, only the children of the group will be rendered directly to the page.
There will be no layout applied to the children so the natural layout behavior of the underlying HTML elements will apply.
If you require a more predictable layout, you should use a layout component such as panelGroupLayout.]]>
</description>
<icon>
<!-- small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/group.png</small-icon -->
</icon>
<component-type>org.apache.myfaces.trinidad.Group</component-type>
<component-class>org.apache.myfaces.trinidad.component.UIXGroup</component-class>
<property>
<description><![CDATA[
<html>
indicates if a visual group start boundary is desired. The default value of 'dontCare'
indicates no preference. A value of 'show' indicates a preference to show a start boundary.
A value of 'hide' indicates a preference to not show a start boundary. Regardless of the
start boundary value, whether a visual boundary will be displayed is up to the group's
parent component.
</html>
]]>
</description>
<property-name>startBoundary</property-name>
<property-class>java.lang.String</property-class>
<default-value>dontCare</default-value>
<property-extension>
<fmd:property-metadata>
<fmd:required>false</fmd:required>
<fmd:property-values>show hide dontCare</fmd:property-values>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[
<html>
indicates if a visual group end boundary is desired. The default value of 'dontCare'
indicates no preference. A value of 'show' indicates a preference to show an end boundary.
A value of 'hide' indicates a preference to not show an end boundary. Regardless of the
end boundary value, whether a visual boundary will be displayed is up to the group's
parent component.
</html>
]]>
</description>
<property-name>endBoundary</property-name>
<property-class>java.lang.String</property-class>
<default-value>dontCare</default-value>
<property-extension>
<fmd:property-metadata>
<fmd:required>false</fmd:required>
<fmd:property-values>show hide dontCare</fmd:property-values>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[
<html>
a title value for the group. Whether anything is done with this title value is up to the
group's parent component.
</html>
]]>
</description>
<property-name>title</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata>
<mfp:translatable>true</mfp:translatable>
</mfp:property-metadata>
<fmd:property-metadata>
<fmd:required>false</fmd:required>
</fmd:property-metadata>
</property-extension>
</property>
<component-extension>
<mfp:component-family>org.apache.myfaces.trinidad.Group</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.ComponentBase</mfp:component-supertype>
<mfp:tag-name>tr:group</mfp:tag-name>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.UIXGroupTag</mfp:tag-class>
<mfp:long-description><![CDATA[The group component is an invisible control that aggregates semantically-related children; the group itself has no associated client representation (visual or API).
Some parent components may have special representation for groups like adding separators around the group but this is a special case and is not always rendered this way.
In most cases, only the children of the group will be rendered directly to the page.
There will be no layout applied to the children so the natural layout behavior of the underlying HTML elements will apply.
If you require a more predictable layout, you should use a layout component such as panelGroupLayout.]]>
</mfp:long-description>
<mfp:example>
<mfp:source-code>
<![CDATA[
<tr:panelFormLayout labelWidth="33%" fieldWidth="67%">
<tr:inputText label="non-group item 1"/>
<tr:group>
<tr:inputText label="group item 1"/>
<tr:inputText label="group item 2"/>
<tr:inputText label="group item 3"/>
</tr:group>
<tr:inputText label="non-group item 2"/>
</tr:panelFormLayout>
]]>
</mfp:source-code>
</mfp:example>
<mfp:author>Matt Cooper</mfp:author>
<mfp:component-metadata/>
</component-extension>
</component>
</faces-config>