META-INF.maven-faces-plugin.validators.trinidad.DateRestriction.xml Maven / Gradle / Ivy
<?xml version="1.0" ?>
<!--
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:mfp="http://myfaces.apache.org/maven-faces-plugin"
xmlns:fmd="http://java.sun.com/xml/ns/javaee/faces/design-time-metadata">
<validator>
<description><![CDATA[Validate that the date entered is within a given restriction.]]></description>
<display-name>validateDateRestriction</display-name>
<validator-id>org.apache.myfaces.trinidad.DateRestriction</validator-id>
<validator-class>org.apache.myfaces.trinidadinternal.validator.DateRestrictionValidator</validator-class>
<property>
<description><![CDATA[Whether the converter should be disabled, default to false.]]>
</description>
<property-name>disabled</property-name>
<property-class>boolean</property-class>
<default-value>false</default-value>
</property>
<property>
<description><![CDATA[Specify the month which are invalid for your use case.
The attribute takes a whitespace delimited list of months.
Possible values are jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.]]>
</description>
<property-name>invalidMonths</property-name>
<property-class>java.lang.String[]</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[Specify the weekdays which are invalid for your use case.
The attribute takes whitespace delimited list of weekdays.
Possible values are sun, mon, tue, wed, thu, fri, sat.]]>
</description>
<property-name>invalidDaysOfWeek</property-name>
<property-class>java.lang.String[]</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[To specifiy a concrete List of Dates, use the invalidDays attribute and wire it
to a DateListProvider implementation. This returns a list of dates, which are invalid.]]>
</description>
<property-name>invalidDays</property-name>
<property-class>org.apache.myfaces.trinidad.model.DateListProvider</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[<p>
The detail error message to be used for constructing faces messages,
when input value exceeds the <code>invalidMonths</code> value
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the invalid month
</li>
</ul>
</p>]]>
</description>
<property-name>messageDetailInvalidMonths</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata>
<mfp:translatable>true</mfp:translatable>
</mfp:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[<p>
The detail error message to be used for constructing faces messages,
when input value is less than the set <code>invalidDaysOfWeek</code>
value.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the invalid weekday
</li>
</ul>
</p>]]>
</description>
<property-name>messageDetailInvalidDaysOfWeek</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata>
<mfp:translatable>true</mfp:translatable>
</mfp:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[<p>
The detail error message to be used for constructing faces messages,
when input value is less than the set <code>invalidDate</code>
value.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the invalid date
</li>
</ul>
</p>]]>
</description>
<property-name>messageDetailInvalidDays</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata>
<mfp:translatable>true</mfp:translatable>
</mfp:property-metadata>
</property-extension>
</property>
<validator-extension>
<mfp:tag-name>tr:validateDateRestriction</mfp:tag-name>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.validator.ValidateDateRestrictionTag</mfp:tag-class>
<mfp:long-description><![CDATA[<html:p>
Validate that the date is valid with some given restrictions.
</html:p>]]></mfp:long-description>
<mfp:example>
<mfp:source-code>
<![CDATA[<tr:inputDate id="days" value="#{bean.date}"
label="Select a date, but check possible holidays first">
<tr:convertDateTime pattern="yyyy-MM-dd"/>
<tr:validateDateRestriction invalidDays="#{bean.date.nationalHolidays}" />
</tr:inputDate>
<tr:inputDate id="month" value="#{bean.date}"
label="Select a date, but not within November or December">
<tr:convertDateTime pattern="yyyy-MM-dd"/>
<tr:validateDateRestriction invalidMonths="Nov Dec" />
</tr:inputDate>
<tr:inputDate id="daysOfWeek" value="#{bean.date}"
label="Select a date, but not a Monday">
<tr:convertDateTime pattern="yyyy-MM-dd"/>
<tr:validateDateRestriction invalidDaysOfWeek="Mon"/>
</tr:inputDate>]]>
</mfp:source-code>
</mfp:example>
<mfp:author>Matthias Wessendorf</mfp:author>
</validator-extension>
</validator>
</faces-config>