META-INF.maven-faces-plugin.components.trinidad.Command.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[UIXCommand is a base abstraction for
components that implement ActionSource and DialogSource.]]>
</description>
<icon>
<!-- small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/command.png</small-icon -->
</icon>
<component-type>org.apache.myfaces.trinidad.Command</component-type>
<component-class>org.apache.myfaces.trinidad.component.UIXCommand</component-class>
<property>
<description><![CDATA[a reference to an action method sent by the command component,
or the static outcome of an action. If the action starts with "dialog:",
useWindow attribute must be set to true.]]>
</description>
<property-name>actionExpression</property-name>
<property-class>javax.el.MethodExpression</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>
<mfp:jsp-property-name>action</mfp:jsp-property-name>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[a method reference to an action listener]]></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[a method reference to a return listener.This method
is used to process dialog returnEvents which are generated as a result of either
calling org.apache.myfaces.trinidad.context.RequestContext.returnFromDialog
directly or declaratively through the use of a returnActionListener tag.]]></description>
<property-name>returnListener</property-name>
<property-class>javax.el.MethodExpression</property-class>
<property-extension>
<mfp:method-binding-signature>
<mfp:parameter-type>org.apache.myfaces.trinidad.event.ReturnEvent</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[a method reference to a launch listener]]></description>
<property-name>launchListener</property-name>
<property-class>javax.el.MethodExpression</property-class>
<property-extension>
<mfp:method-binding-signature>
<mfp:parameter-type>org.apache.myfaces.trinidad.event.LaunchEvent</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[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.Command</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.ComponentBase</mfp:component-supertype>
<mfp:renderer-type>org.apache.myfaces.trinidad.Button</mfp:renderer-type>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.UIXCommandTag</mfp:tag-class>
<mfp:author>Gabrielle Crawford</mfp:author>
<mfp:component-metadata/>
<mfp:tag-class-modifier>abstract</mfp:tag-class-modifier>
<mfp:event>
<mfp:description>Event delivered when the "action" of the component has been
invoked; for example, by clicking on a button. The action may result
in page navigation.
</mfp:description>
<mfp:event-type>javax.faces.Action</mfp:event-type>
<mfp:event-delivery-phase>Invoke Application</mfp:event-delivery-phase>
<mfp:event-delivery-phase>Apply Request Values</mfp:event-delivery-phase>
</mfp:event>
<mfp:event>
<mfp:description>Event delivered when the dialog has completed successfully.</mfp:description>
<mfp:event-type>org.apache.myfaces.trinidad.Return</mfp:event-type>
<mfp:event-delivery-phase>Apply Request Values</mfp:event-delivery-phase>
</mfp:event>
<mfp:event>
<mfp:description>Event delivered to prompt the command to launch a dialog.</mfp:description>
<mfp:event-type>org.apache.myfaces.trinidad.Launch</mfp:event-type>
<mfp:event-delivery-phase>Invoke Application</mfp:event-delivery-phase>
<mfp:event-delivery-phase>Apply Request Values</mfp:event-delivery-phase>
</mfp:event>
</component-extension>
</component>
</faces-config>