META-INF.maven-faces-plugin.components.trinidad.SelectRange.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[UIXSelectRange is a base abstraction for
components that select a
range.]]>
</description>
<icon>
<!-- small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/selectRange.png</small-icon -->
</icon>
<component-type>org.apache.myfaces.trinidad.SelectRange</component-type>
<component-class>org.apache.myfaces.trinidad.component.UIXSelectRange</component-class>
<facet>
<description><![CDATA[use to customize the label of each range selection.]]></description>
<facet-name>rangeLabel</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.CoreSelectItem</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<property>
<description><![CDATA[the name of the EL variable that provides access to the "start"
and "end" variables that point to the start and end row in
the each range from the data model. This can be used to customize
the range text.]]>
</description>
<property-name>var</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 range change
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>
<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[<html> the data model being used by this component.
The specific model class is
<code>org.apache.myfaces.trinidad.model.CollectionModel</code>.
You may also use other model instances, e.g.,
<code>java.util.List</code> ,
array, and <code>javax.faces.model.DataModel</code>.
This component will automatically convert the instance
into a <code>CollectionModel</code>.</html>]]>
</description>
<property-name>value</property-name>
<property-class>java.lang.Object</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[the maximum number of rows to display in a single range of rows.
Some ranges might have fewer
than the number of rows specified by this attribute (eg: the last range
might have an insufficient number of rows).
To display all rows at once, set this attribute to 0.]]>
</description>
<property-name>rows</property-name>
<property-class>int</property-class>
<default-value>25</default-value>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[the index of the first row in the currently range of rows.
This index is zero-based. This attribute is used to control
which range of rows to display to the user.]]>
</description>
<property-name>first</property-name>
<property-class>int</property-class>
<default-value>0</default-value>
</property>
<component-extension>
<mfp:component-family>org.apache.myfaces.trinidad.SelectRange</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.ComponentBase</mfp:component-supertype>
<mfp:renderer-type>org.apache.myfaces.trinidad.ChoiceBar</mfp:renderer-type>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.UIXSelectRangeTag</mfp:tag-class>
<mfp:long-description><![CDATA[UIXSelectRange is a base abstraction for
components that select a
range, e.g, 5 - 10 of 50.]]>
</mfp:long-description>
<mfp:author>Jeanne Waldman</mfp:author>
<mfp:tag-class-modifier>abstract</mfp:tag-class-modifier>
<mfp:event>
<mfp:description>Event delivered when the user selects a new range.</mfp:description>
<mfp:event-type>org.apache.myfaces.trinidad.RangeChange</mfp:event-type>
<mfp:event-delivery-phase>Any Phase</mfp:event-delivery-phase>
<mfp:event-delivery-phase>Invoke Application</mfp:event-delivery-phase>
</mfp:event>
</component-extension>
</component>
</faces-config>