META-INF.maven-faces-plugin.components.trinidad.EditableValue.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 editableValue web element contains all the shared attributes
supported by all Apache Trinidad components that support the JSF
EditableValueHolder interface.]]>
</description>
<icon>
<!-- small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/editableValue.png</small-icon -->
</icon>
<component-type>org.apache.myfaces.trinidad.EditableValue</component-type>
<component-class>org.apache.myfaces.trinidad.component.UIXEditableValue</component-class>
<property>
<description><![CDATA[whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.]]>
</description>
<property-name>immediate</property-name>
<property-class>boolean</property-class>
<default-value>false</default-value>
</property>
<property>
<description><![CDATA[whether the component's value is currently valid]]></description>
<property-name>valid</property-name>
<property-class>boolean</property-class>
<default-value>true</default-value>
<property-extension>
<mfp:tag-attribute-excluded>true</mfp:tag-attribute-excluded>
</property-extension>
</property>
<property>
<description><![CDATA[whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.]]>
</description>
<property-name>required</property-name>
<property-class>boolean</property-class>
<default-value>false</default-value>
<property-extension/>
</property>
<property>
<description><![CDATA[whether a local value is currently set. If false, values are being retrieved from any attached ValueBinding]]>
</description>
<property-name>localValueSet</property-name>
<property-class>boolean</property-class>
<property-extension>
<mfp:tag-attribute-excluded>true</mfp:tag-attribute-excluded>
</property-extension>
</property>
<property>
<description><![CDATA[the current submitted value. This value,
if non-null, is set by the Renderer to store a possibly invalid value
for later conversion or redisplay, and has not yet been converted
into the proper type for this component instance. This method
should only be used by the decode() and validate() method
of this component, or its corresponding Renderer; however, user code
may manually set it to null to erase any submitted value.]]>
</description>
<property-name>submittedValue</property-name>
<property-class>java.lang.Object</property-class>
<property-extension>
<mfp:tag-attribute-excluded>true</mfp:tag-attribute-excluded>
</property-extension>
</property>
<property>
<description><![CDATA[a method reference to a validator method]]></description>
<property-name>validator</property-name>
<property-class>javax.faces.el.MethodBinding</property-class>
<property-extension>
<mfp:method-binding-signature>
<mfp:parameter-type>javax.faces.context.FacesContext</mfp:parameter-type>
<mfp:parameter-type>javax.faces.component.UIComponent</mfp:parameter-type>
<mfp:parameter-type>java.lang.Object</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 value change listener]]></description>
<property-name>valueChangeListener</property-name>
<property-class>javax.faces.el.MethodBinding</property-class>
<property-extension>
<mfp:method-binding-signature>
<mfp:parameter-type>javax.faces.event.ValueChangeEvent</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[<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>]]>
</description>
<property-name>requiredMessageDetail</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:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<component-extension>
<mfp:component-family>org.apache.myfaces.trinidad.EditableValue</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.Value</mfp:component-supertype>
<mfp:renderer-type>org.apache.myfaces.trinidad.EditableValue</mfp:renderer-type>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.UIXEditableValueTag</mfp:tag-class>
<mfp:author>Adam Winer</mfp:author>
<mfp:component-class-modifier>abstract</mfp:component-class-modifier>
<mfp:tag-class-modifier>abstract</mfp:tag-class-modifier>
<mfp:event>
<mfp:description>Event delivered when a new value is entered by a user.</mfp:description>
<mfp:event-type>javax.faces.ValueChange</mfp:event-type>
<mfp:event-delivery-phase>Process Validations</mfp:event-delivery-phase>
<mfp:event-delivery-phase>Apply Request Values</mfp:event-delivery-phase>
</mfp:event>
</component-extension>
</component>
</faces-config>