META-INF.maven-faces-plugin.components.trinidad.Progress.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[UIXProgress is a base abstraction for
components that implement ActionSource and
indicate the progress of tasks running in
the server, typically navigating to a special
page once the task is complete.]]>
</description>
<icon>
<!-- small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/progress.png</small-icon -->
</icon>
<component-type>org.apache.myfaces.trinidad.Progress</component-type>
<component-class>org.apache.myfaces.trinidad.component.UIXProgress</component-class>
<property>
<description><![CDATA[The data model being used by this progress component.
The model should be of type
org.apache.myfaces.trinidad.model.BoundedRangeModel.]]>
</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[A reference to an action method sent by the progress component,
or the static outcome of an action. This is invoked when the task
under progress is complete.]]>
</description>
<property-name>action</property-name>
<property-class>javax.faces.el.MethodBinding</property-class>
<property-extension>
<mfp:method-binding-signature>
<mfp:return-type>java.lang.String</mfp:return-type>
</mfp:method-binding-signature>
<mfp:property-metadata/>
<mfp:state-holder>yes</mfp:state-holder>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[A method reference to an action listener.
This is invoked after the task in progress is complete.]]>
</description>
<property-name>actionListener</property-name>
<property-class>javax.faces.el.MethodBinding</property-class>
<property-extension>
<mfp:method-binding-signature>
<mfp:parameter-type>javax.faces.event.ActionEvent</mfp:parameter-type>
<mfp:return-type>void</mfp:return-type>
</mfp:method-binding-signature>
<mfp:property-metadata/>
<mfp:state-holder>yes</mfp:state-holder>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[whether data validation - client-side or
server-side -
will be skipped when
events are generated by this component.
When immediate is true, the command's action and
ActionListeners, including the default ActionListener
provided by the JavaServer Faces implementation,
will be executed during Apply Request Values phase
of the request processing lifecycle, rather than
waiting until the Invoke Application phase. Because
validation runs during Process Validators (after
Apply Request Values, but before Invoke Application),
setting immediate to true will skip validation.]]>
</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.Progress</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.ComponentBase</mfp:component-supertype>
<mfp:renderer-type>org.apache.myfaces.trinidad.Indicator</mfp:renderer-type>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.UIXProgressTag</mfp:tag-class>
<mfp:long-description><![CDATA[UIXProgress is a base abstraction for
components that implement ActionSource and
indicate the progress of tasks running in
the server, typically navigating to a special
page once the task is complete.
When the task is complete, an ActionEvent is
delivered.]]>
</mfp:long-description>
<mfp:author>Prakash Udupa</mfp:author>
<mfp:component-metadata/>
<mfp:tag-class-modifier>abstract</mfp:tag-class-modifier>
<mfp:event>
<mfp:description>Event delivered when the task is complete. The completeness of the
task is usually determined from state of the model attached to the
progress component.
</mfp:description>
<mfp:event-type>javax.faces.Action</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>
<fmd:component-metadata>
<fmd:default-property>value</fmd:default-property>
</fmd:component-metadata>
</component-extension>
</component>
</faces-config>