You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by lu...@apache.org on 2008/07/02 00:36:52 UTC
svn commit: r673223 - in /myfaces/tomahawk/trunk/sandbox/core: ./
src/main/java/org/apache/myfaces/custom/comparetovalidator/
src/main/java/org/apache/myfaces/custom/convertStringUtils/
src/main/java/org/apache/myfaces/custom/fisheye/ src/main/java/org...
Author: lu4242
Date: Tue Jul 1 15:36:51 2008
New Revision: 673223
URL: http://svn.apache.org/viewvc?rev=673223&view=rev
Log:
apply myfaces-builder-plugin:tagdoc-index and tagdoc-content to sandbox
Added:
myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-component.vm
myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-converter.vm
myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-tag.vm
myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-validator.vm
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_autoUpdateDataTable-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_convertStringUtils-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_exporterActionListener-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_fishEyeNavigationMenu-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_focus-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_form-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_graphicImageDynamic-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggest-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggestAjax-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_limitRendered-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_passwordStrength-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_roundedDiv-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCSV-base.xml (with props)
myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCompareTo-base.xml (with props)
Modified:
myfaces/tomahawk/trunk/sandbox/core/pom.xml
myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/comparetovalidator/AbstractCompareToValidator.java
myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/convertStringUtils/StringUtilsConverter.java
myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/fisheye/AbstractHtmlFishEyeNavigationMenu.java
myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/graphicimagedynamic/GraphicImageDynamic.java
myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/limitrendered/AbstractUILimitRendered.java
myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/passwordStrength/AbstractPasswordStrengthComponent.java
myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/roundeddiv/AbstractHtmlRoundedDiv.java
myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/suggestajax/inputsuggestajax/AbstractInputSuggestAjax.java
Modified: myfaces/tomahawk/trunk/sandbox/core/pom.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/pom.xml?rev=673223&r1=673222&r2=673223&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/pom.xml (original)
+++ myfaces/tomahawk/trunk/sandbox/core/pom.xml Tue Jul 1 15:36:51 2008
@@ -397,8 +397,25 @@
</executions>
</plugin>
-->
+ <plugin>
+ <!-- Generate report content -->
+ <groupId>org.apache.myfaces.buildtools</groupId>
+ <artifactId>myfaces-builder-plugin</artifactId>
+ <version>1.0.1-SNAPSHOT</version>
+ <configuration>
+ <taglibs>
+ <s>http://myfaces.apache.org/sandbox</s>
+ </taglibs>
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>tagdoc-content</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
-
</build>
<reporting>
<plugins>
@@ -410,6 +427,17 @@
<tldDocDir>${basedir}/target/site/tlddoc</tldDocDir>
</configuration>
</plugin>
+ <plugin>
+ <!-- Generate report index -->
+ <groupId>org.apache.myfaces.buildtools</groupId>
+ <artifactId>myfaces-builder-plugin</artifactId>
+ <version>1.0.1-SNAPSHOT</version>
+ <configuration>
+ <taglibs>
+ <s>http://myfaces.apache.org/sandbox</s>
+ </taglibs>
+ </configuration>
+ </plugin>
</plugins>
</reporting>
</profile>
Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/comparetovalidator/AbstractCompareToValidator.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/comparetovalidator/AbstractCompareToValidator.java?rev=673223&r1=673222&r2=673223&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/comparetovalidator/AbstractCompareToValidator.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/comparetovalidator/AbstractCompareToValidator.java Tue Jul 1 15:36:51 2008
@@ -41,85 +41,65 @@
/**
*
* Validates this component against another component.
- *
+ * <p>
* Specify the foreign component with the for={foreign-component-id} attribute.
- *
+ * </p>
+ * <p>
* Valid operator attribute values:
- *
- * equals: eq, ==, =,
- * not equals: ne, !=,
- * greater than: gt, >,
- * less than: lt, <,
- * greater than or equals: ge, >=,
- * less than or equals: le, <=
- *
+ * </p>
+ * <ul>
+ * <li>equals: eq, ==, =,</li>
+ * <li>not equals: ne, !=,</li>
+ * <li>greater than: gt, >,</li>
+ * <li>less than: lt, <,</li>
+ * <li>greater than or equals: ge, >=,</li>
+ * <li>less than or equals: le, <=</li>
+ * </ul>
+ * <p>
* If the comparator attribute is specified, the component values are compared
* using the specified java.util.Comparator object.
* If no comparator is specified, the component values must implement Comparable
* and are compared using compareTo().
* If either value or foreign value does not implement Comparable and no Comparator
* is specified, validation always succeeds.
- *
+ * </p>
+ * <p>
* Put this validator on the bottom-most component to insure that
* the foreign component's value has been converted and validated first.
- *
+ * </p>
+ * <p>
* However, this validator will attempt to convert and validate the foreign
* component's value if this has not already occurred. This process may not
* be identical to the standard JSF conversion and validation process.
- *
+ * </p><p>
* The validation error message key is currently hardcoded as
- *
- * "{0} value <{1}> must be {2} {3} value <{4}>"
- *
- * where {0} is the parent component id,
- * {1} is the parent component value,
- * {2} is the operator name,
- * {3} is the foreign component id, and
- * {4} is the foreign component value.
- *
+ * </p>
+ * <p>
+ * "{0} value <{1}> must be {2} {3} value <{4}>"
+ * </p>
+ * where
+ * <ul>
+ * <li>{0} is the parent component id,</li>
+ * <li>{1} is the parent component value,</li>
+ * <li>{2} is the operator name,</li>
+ * <li>{3} is the foreign component id, and</li>
+ * <li>{4} is the foreign component value.</li>
+ * </ul>
+ * <p>
* The alternateOperatorName attribute can specify a custom operator name.
* For example, use "after" instead of "greater than" when comparing dates.
- *
+ * </p><p>
* The message attribute can specify an alternate validation error message key.
* For example, use "{0} must be {2} {3}" to remove values from the message.
- *
- *
- * faces-config.xml configuration:
- *
- * <validator>
- * <description>CompareTo validator</description>
- * <validator-id>org.apache.myfaces.validator.CompareTo</validator-id>
- * <validator-class>org.apache.myfaces.custom.comparetovalidator.CompareToValidator</validator-class>
- * </validator>
- *
- *
- * Facelets configuration (inside a taglib.xml file):
- *
- * <tag>
- * <tag-name>compareToValidator</tag-name>
- * <validator>
- * <validator-id>org.apache.myfaces.validator.CompareTo</validator-id>
- * </validator>
- * </tag>
- *
- *
- * Example usage:
- *
- * <t:inputCalendar id="startDate"/>
- * <t:inputCalendar id="endDate">
- * <sandbox:compareToValidator operator="gt" for="startDate" />
- * <sandbox:compareToValidator operator="gt" for="startDate" message="Start date must be before end date." />
- * <sandbox:compareToValidator operator="gt" for="startDate" message="{0} must be {2} {3}" />
- * <sandbox:compareToValidator operator="gt" for="startDate" alternateOperatorName="after" />
- * <sandbox:compareToValidator operator="gt" for="startDate" message="{0} must be {2} {3}" alternateOperatorName="after" />
- * <sandbox:compareToValidator operator="gt" for="startDate" comparator="#{dateComparator}" />
- * <t:inputCalendar>
- *
- *
+ * </p>
+ * <p>
* Known issues:
- * - Operator names should be localized.
- * - The default message key should be localized.
- * - Perhaps an exception should be thrown if the two values are not Comparable and no Comparator is specified.
+ * </p>
+ * <ul>
+ * <li> Operator names should be localized.</li>
+ * <li> The default message key should be localized.</li>
+ * <li> Perhaps an exception should be thrown if the two values are not Comparable and no Comparator is specified.</li>
+ * </ul>
*
* @JSFValidator
* name = "s:validateCompareTo"
@@ -384,7 +364,7 @@
public abstract void setFor(String string);
/**
- * Operator for comparison: equals: eq, ==, =, not equals: ne, !=, greater than: gt, >, less than: lt, <, greater than or equals: ge, >=, less than or equals: le, <=
+ * Operator for comparison: equals: eq, ==, =, not equals: ne, !=, greater than: gt, >, less than: lt, <, greater than or equals: ge, >=, less than or equals: le, <=
*
* @JSFProperty
* @return
Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/convertStringUtils/StringUtilsConverter.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/convertStringUtils/StringUtilsConverter.java?rev=673223&r1=673222&r2=673223&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/convertStringUtils/StringUtilsConverter.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/convertStringUtils/StringUtilsConverter.java Tue Jul 1 15:36:51 2008
@@ -31,17 +31,16 @@
/**
* Converts the format of a string
- *
- * Provides runtime modification of a string. Uses Apache Lang StringUtils and WordUtils
- * to peform operations.
* <p>
- * Example:
- * <code>
- * <h:outputText value="#{backingBean.customer.name}">
- * <t:convertStringUtils format="capitalize" trim="true" maxLength="50"/>
- * </h:outputText>
- * </code>
+ * Converter which modifies a string by changing the input text into upper case, lower case, capitalized. The
+ * input string can be optionally trimmed and truncated at some max length. Ellipses (...) can be added to a
+ * truncated string.
+ * </p>
* <p>
+ * Provides runtime modification of a string. Uses Apache Lang StringUtils and WordUtils
+ * to peform operations.
+ * </p>
+ *
* @JSFConverter
* name = "s:convertStringUtils"
* tagClass = "org.apache.myfaces.custom.convertStringUtils.StringUtilsConverterTag"
Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/fisheye/AbstractHtmlFishEyeNavigationMenu.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/fisheye/AbstractHtmlFishEyeNavigationMenu.java?rev=673223&r1=673222&r2=673223&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/fisheye/AbstractHtmlFishEyeNavigationMenu.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/fisheye/AbstractHtmlFishEyeNavigationMenu.java Tue Jul 1 15:36:51 2008
@@ -27,8 +27,17 @@
/**
* Provide a FishEye toolbar component from the DOJO toolkit
- *
- * A Mac OSX-style toolbar, using the DOJO toolkit.
+ * <p>
+ * A navigation menu/toolbar with a nice mouse-over effect,
+ * similar to the Mac OS X Dock. It is actually a JSF
+ * implementation of the Fisheye List widget from the
+ * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>.
+ * </p>
+ * <p>
+ * The component makes use of the Tomahawk navigation framework,
+ * so the menu items can be added using t:navigationMenuItem
+ * child components.
+ * </p>
*
* @see <a href="http://dojotoolkit.org/">http://dojotoolkit.org/</a>
*
Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/graphicimagedynamic/GraphicImageDynamic.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/graphicimagedynamic/GraphicImageDynamic.java?rev=673223&r1=673222&r2=673223&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/graphicimagedynamic/GraphicImageDynamic.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/graphicimagedynamic/GraphicImageDynamic.java Tue Jul 1 15:36:51 2008
@@ -29,6 +29,21 @@
/**
* Extends standard graphicImage.
+ * <p>
+ * This tag renders a html img tag and can be used to render dynamic images.
+ * </p>
+ * <p>
+ * Embedding images into html pages requires a second request to get the binary data
+ * stream of the image. The result is that the state of the view including the state of request
+ * scoped beans will not be available when the image is requested.
+ * </p>
+ * <p>
+ * The image data is written by an image renderer which can be defined by the
+ * imageRendererClass attribute.
+ * </p>
+ * <p>
+ * This component is able to use nested f:param elements to pass parameters to the image renderer.
+ * </p>
*
* @JSFComponent
* name = "s:graphicImageDynamic"
Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/limitrendered/AbstractUILimitRendered.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/limitrendered/AbstractUILimitRendered.java?rev=673223&r1=673222&r2=673223&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/limitrendered/AbstractUILimitRendered.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/limitrendered/AbstractUILimitRendered.java Tue Jul 1 15:36:51 2008
@@ -36,16 +36,16 @@
/**
* Tag that allows for selective rendering based on a count or by child index
- *
+ * <p>
* Component that only renders a subset of its children components. Provides
* functionality that the JSTL choose tag has, but leverages the
* {@link javax.faces.component.UIComponent#isRendered()} method instead
* of using when tags with test attributes.
+ * </p>
* <p>It can either use a filter type of "count" or "index". If count,
* the given number of children will be rendered (so for example, a value of 2 will cause
* the first two children that are have a true <tt>isRendered</tt> result
* to be rendered. If index, it will render the given indexes.</p>
- * <p>See the taglib for more documentation</p>
*
* @JSFComponent
* name = "s:limitRendered"
Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/passwordStrength/AbstractPasswordStrengthComponent.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/passwordStrength/AbstractPasswordStrengthComponent.java?rev=673223&r1=673222&r2=673223&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/passwordStrength/AbstractPasswordStrengthComponent.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/passwordStrength/AbstractPasswordStrengthComponent.java Tue Jul 1 15:36:51 2008
@@ -23,6 +23,22 @@
import org.apache.myfaces.component.AlignProperty;
/**
+ * The passwordStrength component is needed by the web sites
+ * which ask the user to enter a powerful password for the
+ * purpose of the registration stuff.
+ * <p>
+ * The component enables its user to know the strength of the password
+ * while (he/she) types it before even submit the form to the server
+ * [please see the screenshots].
+ * </p>
+ * <p>
+ * The component enables its user to define his custom security policy
+ * for his password in an easy manner.
+ * </p>
+ * <p>
+ * The component also have 2 types of presenting the password strength.
+ * Till now the strength can be represented as text or progressbar.
+ * </p>
*
* @JSFComponent
* name = "s:passwordStrength"
@@ -77,21 +93,39 @@
/**
* This string determines the expression of the custom security rule of the password
+ * <p>
* Note that the expression has the following format :
+ * </p>
+ * <p>
* *******************************************************
+ * </p>
+ * <p>
* S (Number) N (Number) A (Number)
- * Where S stands for Symbols
- * Where N stands for Numbers
- * Where A stands for Alphabets
+ * </p>
+ * <ul>
+ * <li>Where S stands for Symbols</li>
+ * <li>Where N stands for Numbers</li>
+ * <li>Where A stands for Alphabets</li>
+ * </ul>
+ * <p>
* *******************************************************
+ * </p>
+ * <p>
* For example) A4N2S3A2
* Means that the password will be as following :
- * 4 or more Alphabets followed by
- * 2 or more Numbers followed by
- * 3 or more Symbols followed by
- * 2 or more Alphabets
+ * </p>
+ * <ul>
+ * <li>4 or more Alphabets followed by</li>
+ * <li>2 or more Numbers followed by</li>
+ * <li>3 or more Symbols followed by</li>
+ * <li>2 or more Alphabets</li>
+ * </ul>
+ * <p>
* *******************************************************
+ * </p>
+ * <p>
* Note also that the useCustomSecurity should be set to true.
+ * </p>
*
* @JSFProperty
*/
Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/roundeddiv/AbstractHtmlRoundedDiv.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/roundeddiv/AbstractHtmlRoundedDiv.java?rev=673223&r1=673222&r2=673223&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/roundeddiv/AbstractHtmlRoundedDiv.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/roundeddiv/AbstractHtmlRoundedDiv.java Tue Jul 1 15:36:51 2008
@@ -24,10 +24,15 @@
/**
* Component that allows for a rounded border effect on DIV tags that is supported in CSS2 compatible browsers and IE6.
- *
+ * <p>
* Component that generates a DIV tag with rounded corners that may
* be either 3D or 2D in appearence.
- *
+ * </p><p>
+ * The "roundedDiv" component creates a DIV tag that contains images to
+ * produce rounded corners. The rounded effect can be either 3D with lighting effects
+ * or 2D with a solid color border.
+ * </p>
+ *
* @JSFComponent
* name = "s:roundedDiv"
* class = "org.apache.myfaces.custom.roundeddiv.HtmlRoundedDiv"
Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/suggestajax/inputsuggestajax/AbstractInputSuggestAjax.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/suggestajax/inputsuggestajax/AbstractInputSuggestAjax.java?rev=673223&r1=673222&r2=673223&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/suggestajax/inputsuggestajax/AbstractInputSuggestAjax.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/suggestajax/inputsuggestajax/AbstractInputSuggestAjax.java Tue Jul 1 15:36:51 2008
@@ -27,6 +27,13 @@
/**
* Provides an input textbox with "suggest" functionality, using an ajax request to the server.
+ * <p>
+ * A tag that defines an autosuggest control complete with Ajax binding.<br/>
+ * This allows you to do real time autocompletion via asynchronous
+ * server requests. Note, this control is experimental and it is currently
+ * located in the MyFaces sandbox and can be subject to
+ * alteration in the immediate future. So use it with care.
+ * </p>
*
* @JSFComponent
* name = "s:inputSuggestAjax"
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-component.vm
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-component.vm?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-component.vm (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-component.vm Tue Jul 1 15:36:51 2008
@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<document>
+ <properties>
+ <title><${component.name}></title>
+ </properties>
+ <body>
+ <section name="Summary">
+ <p>
+ <b>Tag name:</b> <${component.name}>
+ <br/>
+#set ($javadocPath = "../apidocs/" + $component.getClassName().replace('.', '/') )
+ <b>UIComponent class:</b> <a href="${tagdocUtils.platformAgnosticPath( $javadocPath )}.html">${component.className}</a>
+ <br/>
+#if ($component.tagClass)
+#set ($javadocPath = "../apidocs/" + $component.getTagClass().replace('.', '/') )
+ <b>Tag class:</b> <a href="${tagdocUtils.platformAgnosticPath( $javadocPath )}.html">${component.tagClass}</a>
+ <br/>
+#end
+ <b>Component type:</b> ${component.type}
+ <br/>
+ <b>Component family:</b> ${component.family}
+ <br/>
+#if (${component.rendererType})
+ <b>Renderer type:</b> ${component.rendererType}
+ <br/>
+#set ($rendererClasses = $tagdocUtils.getRendererClasses($component,$model).values() )
+#foreach ($rendererClass in $rendererClasses)
+#set ($javadocPath = "../apidocs/" + $rendererClass.replace('.', '/') )
+ <b>Renderer class:</b> <a href="${tagdocUtils.platformAgnosticPath( $javadocPath )}.html">${rendererClass}</a>
+ <br/>
+#end
+#end
+ <br/>
+${component.longDescription}
+ </p>
+ </section>
+#if ($baseContent)
+$baseContent
+#end
+#set($facetList = ${tagdocUtils.getSortedFacetList($component)})
+#if ($facetList.size() != 0)
+ <section name="Supported Facets">
+ <p>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Required</th>
+ <th>Description</th>
+ </tr>
+#foreach( $facet in $facetList )
+ <tr>
+ <td>$facet.name</td>
+ <td>$facet.isRequired()</td>
+#if ($facet.longDescription)
+ <td>$facet.longDescription</td>
+#else
+ <td></td>
+#end
+ </tr>
+#end
+ </table>
+ </p>
+ </section>
+#end
+#set ($propertyList = ${tagdocUtils.getSortedPropertyList($component)})
+#if ($propertyList.size() != 0)
+ <section name="Attributes">
+<table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Supports EL?</th>
+ <th>Description</th>
+ </tr>
+#foreach( $property in $propertyList )
+#if (!$property.isTagExcluded())
+ <tr>
+ <td>$property.jspName</td>
+#set ($type = ${tagdocUtils.getDisplayType($component.className,$property.jspName,$property.className)})
+ <td>$type</td>
+#if ($property.jspName == "action")
+ <td>Yes</td>
+#elseif ($property.isMethodBinding() || $property.isMethodExpression())
+ <td>Only EL</td>
+#elseif ($property.jspName == "binding")
+ <td>Only EL</td>
+#elseif ($property.isLiteralOnly())
+ <td>No</td>
+#else
+ <td>Yes</td>
+#end
+#if ($property.longDescription)
+ <td>$property.longDescription</td>
+#else
+ <td></td>
+#end
+ </tr>
+#end
+#end
+</table>
+#end
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-converter.vm
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-converter.vm?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-converter.vm (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-converter.vm Tue Jul 1 15:36:51 2008
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<document>
+ <properties>
+ <title><${converter.name}></title>
+ </properties>
+ <body>
+ <section name="Summary">
+ <p>
+ <b>Tag name:</b> <${converter.name}>
+ <br/>
+#set ($javadocPath = "../apidocs/" + $converter.getClassName().replace('.', '/') )
+ <b>Converter class:</b> <a href="${tagdocUtils.platformAgnosticPath( $javadocPath )}.html">${converter.className}</a>
+ <br/>
+#if ($converter.tagClass)
+#set ($javadocPath = "../apidocs/" + $converter.getTagClass().replace('.', '/') )
+ <b>Tag class:</b> <a href="${tagdocUtils.platformAgnosticPath( $javadocPath )}.html">${converter.tagClass}</a>
+ <br/>
+#end
+ <b>converter id:</b> ${converter.converterId}
+ <br/>
+${converter.longDescription}
+ </p>
+ </section>
+#if ($baseContent)
+$baseContent
+#end
+#set ($propertyList = ${tagdocUtils.getSortedPropertyList($converter)})
+#if ($propertyList.size() != 0)
+ <section name="Attributes">
+<table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Supports EL?</th>
+ <th>Description</th>
+ </tr>
+#foreach( $property in $propertyList )
+#if (!$property.isTagExcluded())
+ <tr>
+ <td>$property.jspName</td>
+#set ($type = ${tagdocUtils.getDisplayType($converter.className,$property.jspName,$property.className)})
+ <td>$type</td>
+#if ($property.jspName == "action")
+ <td>Yes</td>
+#elseif ($property.isMethodBinding() || $property.isMethodExpression())
+ <td>Only EL</td>
+#elseif ($property.jspName == "binding")
+ <td>Only EL</td>
+#elseif ($property.isLiteralOnly())
+ <td>No</td>
+#else
+ <td>Yes</td>
+#end
+#if ($property.longDescription)
+ <td>$property.longDescription</td>
+#else
+ <td></td>
+#end
+ </tr>
+#end
+#end
+</table>
+#end
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-tag.vm
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-tag.vm?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-tag.vm (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-tag.vm Tue Jul 1 15:36:51 2008
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<document>
+ <properties>
+ <title><${tag.name}></title>
+ </properties>
+ <body>
+ <section name="Summary">
+ <p>
+ <b>Tag name:</b> <${tag.name}>
+ <br/>
+#set ($javadocPath = "../apidocs/" + $tag.getClassName().replace('.', '/') )
+ <b>Tag class:</b> <a href="${tagdocUtils.platformAgnosticPath( $javadocPath )}.html">${tag.className}</a>
+ <br/>
+${tag.longDescription}
+ </p>
+ </section>
+#if ($baseContent)
+$baseContent
+#end
+#set ($attributeList = ${tagdocUtils.getSortedAttributeList($tag)})
+#if ($attributeList.size() != 0)
+ <section name="Attributes">
+<table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Description</th>
+ </tr>
+#foreach( $attribute in $attributeList )
+#if (!$attribute.isTagExcluded())
+ <tr>
+ <td>$attribute.name</td>
+#set ($type = ${tagdocUtils.getDisplayType($tag.className,$attribute.name,$attribute.className)})
+ <td>$type</td>
+ <td>$attribute.isRequired()</td>
+#if ($attribute.longDescription)
+ <td>$attribute.longDescription</td>
+#else
+ <td></td>
+#end
+ </tr>
+#end
+#end
+</table>
+#end
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-validator.vm
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-validator.vm?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-validator.vm (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/resources/META-INF/xdoc-validator.vm Tue Jul 1 15:36:51 2008
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<document>
+ <properties>
+ <title><${validator.name}></title>
+ </properties>
+ <body>
+ <section name="Summary">
+ <p>
+ <b>Tag name:</b> <${validator.name}>
+ <br/>
+#set ($javadocPath = "../apidocs/" + $validator.getClassName().replace('.', '/') )
+ <b>Validator class:</b> <a href="${tagdocUtils.platformAgnosticPath( $javadocPath )}.html">${validator.className}</a>
+ <br/>
+#if ($validator.tagClass)
+#set ($javadocPath = "../apidocs/" + $validator.getTagClass().replace('.', '/') )
+ <b>Tag class:</b> <a href="${tagdocUtils.platformAgnosticPath( $javadocPath )}.html">${validator.tagClass}</a>
+ <br/>
+#end
+ <b>validator id:</b> ${validator.validatorId}
+ <br/>
+${validator.longDescription}
+ </p>
+ </section>
+#if ($baseContent)
+$baseContent
+#end
+#set ($propertyList = ${tagdocUtils.getSortedPropertyList($validator)})
+#if ($propertyList.size() != 0)
+ <section name="Attributes">
+<table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Supports EL?</th>
+ <th>Description</th>
+ </tr>
+#foreach( $property in $propertyList )
+#if (!$property.isTagExcluded())
+ <tr>
+ <td>$property.jspName</td>
+#set ($type = ${tagdocUtils.getDisplayType($validator.className,$property.jspName,$property.className)})
+ <td>$type</td>
+#if ($property.jspName == "action")
+ <td>Yes</td>
+#elseif ($property.isMethodBinding() || $property.isMethodExpression())
+ <td>Only EL</td>
+#elseif ($property.jspName == "binding")
+ <td>Only EL</td>
+#elseif ($property.isLiteralOnly())
+ <td>No</td>
+#else
+ <td>Yes</td>
+#end
+#if ($property.longDescription)
+ <td>$property.longDescription</td>
+#else
+ <td></td>
+#end
+ </tr>
+#end
+#end
+</table>
+#end
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_autoUpdateDataTable-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_autoUpdateDataTable-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_autoUpdateDataTable-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_autoUpdateDataTable-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ <div><img src="../images/autoUpdateDataTable.jpg" alt="autoUpdateDataTable"/></div>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+ <s:autoUpdateDataTable [ all standard dataTable attributes allowed ]
+ [ preserveDataModel="{true|false}" ]
+ [ forceIdIndexFormula="value-binding" ]
+ [ sortColumn="value-binding" ]
+ [ sortAscending="value-binding" ]
+ [ preserveSort="{true|false}" ]
+ [ frequency="value-binding" ]>
+ standard dataTable body (<h:column> tags and optional "header" and "footer" facets)
+ </t:command_sortheader>
+ <s:autoUpdateDataTable>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>THIS COMPONENT IS DEPRECATED!.
+ </p>
+ <p>
+ <code>
+ frequency - defines the time in seconds between the Ajax-Requests
+ </code>
+ </p>
+ <p>
+ Note - This component is different to others, it uses Ajax mechanisms
+ to fetch data from the server, thus the backend binding can
+ and will be used outside of the standard JSF lifecycle to deliver the data.
+ </p>
+ <p>Use the autoUpdateDataTable tag always within a form tag.</p>
+ <p>
+ It is also not very advisable, to put some input fields
+ (or checkboxes, radio buttons, etc.) into the dataTable, since after every submit
+ (which happens periodically) all the form data is cleared.
+ </p>
+ <p>see examples/ajaxDataTableSingle.jsp for an example.</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_autoUpdateDataTable-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_autoUpdateDataTable-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_convertStringUtils-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_convertStringUtils-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_convertStringUtils-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_convertStringUtils-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+ <h:outputText value="#{backingBean.customer.name}">
+ <s:convertStringUtils format="capitalize" trim="true"/>
+ </h:outputText>
+ <h:outputText value="#{backingBean.customer.description}">
+ <s:convertStringUtils trim="true" maxLength="64" appendEllipsesDuringOutput="true"/>
+ </h:outputText>
+ <h:inputText value="#{backingBean.customer.stateCode}">
+ <s:convertStringUtils format="uppercase" />
+ </h:inputText>
+
+ <h:outputText value="#{backingBean.customer.name}">
+ <t:convertStringUtils format="capitalize" trim="true" maxLength="50"/>
+ </h:outputText>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>See the convertStringUtils.jsp for an example.</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_convertStringUtils-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_convertStringUtils-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_exporterActionListener-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_exporterActionListener-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_exporterActionListener-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_exporterActionListener-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ <div><img src="../images/exporterActionListener.jpg" alt="exporterActionListener"/></div>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+
+ <h:commandButton value="export">
+
+ <s:exporterActionListener filename="myFile"
+ fileType="<XLS or PDF>"
+ for="<your Tomahawk DataScroller ID>"
+ showDisplayedPageOnly="true or false (default: false)"/>
+
+ </h:commandButton>
+
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>see exporter.jsp in the Sandbox examples.</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_exporterActionListener-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_exporterActionListener-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_fishEyeNavigationMenu-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_fishEyeNavigationMenu-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_fishEyeNavigationMenu-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_fishEyeNavigationMenu-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ <div><img src="../images/fisheye1.png" alt="fisheye"/></div>
+ <div><img src="../images/fisheye2.png" alt="fisheye"/></div>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+<s:fishEyeNavigationMenu [id="myToolbar"]
+ [rendered="true|false"]
+ [itemWidth="50"]
+ [itemHeight="50"]
+ [itemMaxWidth="200"]
+ [itemMaxHeight="200"]
+ [orientation="horizontal|vertical"]
+ [effectUnits="2"]
+ [itemPadding="10"]
+ [attachEdge="top|bottom"]
+ [visibleWindow="4"]
+ [labelEdge="top|bottom"]>
+</s:fishEyeNavigationMenu>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>see fisheye.jsp in the Sandbox examples.</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_fishEyeNavigationMenu-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_fishEyeNavigationMenu-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_focus-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_focus-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_focus-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_focus-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve"><h:inputText id="textfield" value="#{bean.value}" />
+<s:focus id="focus" for="textfield" /></source>
+ <source xml:space="preserve"><s:focus id="focus" for="#{bean.focusedComponentId}" /></source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>This component must be placed on the page in such a way that it is rendered
+ after all components to which it might contain a reference. Generally,
+ the best place for this component is right before the closing form tag.</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_focus-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_focus-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_form-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_form-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_form-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_form-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+<s:form scheme="https" servername="www.domain.org" port="1234">
+</s:form>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>The tag allows control for the action attribute of the form.</p>
+ <p>
+ Every JSF request goes to the same url which renders the response.
+ The s:form component allows to use a different scheme, servername or
+ port when a form is submitted. This is normally needed to change
+ from http to https to submit security related data.
+
+ </p>
+ <p>
+ Even more, by setting an entirely different 'action' and 'method'
+ attribute the standard behaviour of the JSF-Form can be overwritten
+ completely. This might be useful for special cases of forms, e.g. for
+ form based authentication.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_form-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_form-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_graphicImageDynamic-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_graphicImageDynamic-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_graphicImageDynamic-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_graphicImageDynamic-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+<s:graphicImageDynamic imageRendererClass="ImageRendererClass" >
+ <f:param name="param" value="value" />
+</s:graphicImageDynamic>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>see sandbox examples graphicImageDynamic.jsf and graphicImageDynamicText.jsf</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_graphicImageDynamic-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_graphicImageDynamic-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggest-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggest-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggest-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggest-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ <div><img src="../images/inputSuggest.png" alt="inputSuggest"/></div>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">[TODO]</source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>[TODO]</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggest-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggest-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggestAjax-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggestAjax-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggestAjax-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggestAjax-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ <div><img src="../images/inputsuggestajax.jpg" alt="InputSuggestAjax"/></div>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve"><s:inputSuggestAjax id="id" binding="control binding"
+ suggestedItemsMethod="backend bean callback method" value="Bean"/>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>
+ Note - This component is different to others, it uses Ajax mechanisms
+ to fetch preview data from the server, thus the backend binding can
+ and will be used outside of the standard JSF lifecycle to deliver the data.
+
+ <br/><br/>
+ Description of the call order:<br/>
+ <code>
+ control -> Ajax request -> suggestionMethod in backend bean -> values pushed into the control binding -> result sent back to the client -> control shows suggestion drop down
+ </code>
+ <br/><br/>
+ On the backend side, a callback method - the suggestion method, has to be implemented,
+ which is called by the Ajax request and
+ fetches the data from a data source. The data then is pushed into the control binding similarly
+ to drop down menus and other controls which use the SelectItem object as data holder.
+ The rest is done automatically.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggestAjax-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_inputSuggestAjax-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_limitRendered-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_limitRendered-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_limitRendered-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_limitRendered-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,158 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+<s:limitRendered
+ id="String"
+ binding="EL"
+ rendered="Boolean"
+ type="count|index"
+ value="Object">
+ <h:outputText />
+ ...
+</s:limitRendered>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>
+ The limitRendered component limits the number of children components
+ that are rendered. It can do this by one of two methods, by index or by count.
+ </p>
+ <p>
+ The component was inspired by the c:choose of JSTL, but has been enhanced for JSF.
+ Like the choose tag, it can render only one child, but that is where the similarity
+ ends. See below for examples and usage.
+ </p>
+ </section>
+ <section name="Examples">
+ <strong>type == count</strong>
+ <p>
+ Because the defautls are count and 1, if no attributes are specified, only the first
+ child that is rendered will be rendered. "A" will be rendered:
+ </p>
+ <source xml:space="preserve">
+<s:limitRendered>
+ <h:outputText value="A" />
+ <h:outputText value="B" />
+ <h:outputText value="C" />
+</s:limitRendered>
+ </source>
+ <p>
+ Only "B" will be rendered:
+ </p>
+ <source xml:space="preserve">
+<s:limitRendered>
+ <h:outputText value="A" rendered="false" />
+ <h:outputText value="B" />
+ <h:outputText value="C" />
+</s:limitRendered>
+ </source>
+ <p>
+ The following example shows that the value with count may exceed the number or rendered
+ children. In this case, although the count is 3, there are only 2 components that able
+ to be rendered. "B C" will be rendered:
+ </p>
+ <source xml:space="preserve">
+<s:limitRendered value="3">
+ <h:outputText value="A" rendered="false" />
+ <h:outputText value="B" />
+ <h:outputText value="C" />
+</s:limitRendered>
+ </source>
+ <strong>type == index</strong>
+ <p>
+ If the value is null, the component does nothing. So in this example, "A B C" is rendered:
+ </p>
+ <source xml:space="preserve">
+<s:limitRendered type="index">
+ <h:outputText value="A" rendered="false" />
+ <h:outputText value="B" />
+ <h:outputText value="C" />
+</s:limitRendered>
+ </source>
+ <p>
+ If the component is not rendered, and its index is given, nothing is rendered for that index.
+ In this example, nothing is rendered since index 0 is A and A is not rendered:
+ </p>
+ <source xml:space="preserve">
+<s:limitRendered type="index" value="0">
+ <h:outputText value="A" rendered="false" />
+ <h:outputText value="B" />
+ <h:outputText value="C" />
+</s:limitRendered>
+ </source>
+ <p>
+ Negative indexes are also allowed. You may interpret a negative index as {component.getChildren().size() - value)}.
+ In this example "B" is rendered because 3 (the number of components) minus 2 is 1, the index of the second component:
+ </p>
+ <source xml:space="preserve">
+<s:limitRendered type="index" value="-2">
+ <h:outputText value="A" />
+ <h:outputText value="B" />
+ <h:outputText value="C" />
+</s:limitRendered>
+ </source>
+ <p>
+ The value doesn't have to be one value with an index, it can be given any index, as long as it is within the
+ size of the children collection. This example renders "A, B, C":
+ </p>
+ <source xml:space="preserve">
+<s:limitRendered type="index" value="0, 1, -1">
+ <h:outputText value="A" />
+ <h:outputText value="B" />
+ <h:outputText value="C" />
+</s:limitRendered>
+ </source>
+ </section>
+ <section name="Valid Input">
+ <p>
+ The value property can except many types of data.
+ </p>
+<strong>type == count</strong>
+ <p>The value can be:</p>
+<ul>
+ <li>An instance of "java.lang.Number". The value is taken as "((Number)value).intValue()"</li>
+
+ <li>An object whose "toString()" is parsable by "Integer.parseInt(String)". So in the above examples,
+ a string of "2" is valid</li>
+
+ <li>"null" which is treated as "0"</li>
+</ul>
+<strong>type == index</strong>
+ <p>
+ With index, the value must be in the range of the children components. So for example, using a value of 5 or a value
+ of -5 on a component with 4 children will throw an exception. The value needs to be a set of values
+ that can be coerced into integers. Valid sets are:
+ </p>
+<ul>
+ <li>Instance of "java.util.Collection"</li>
+
+ <li>Instance of "int[]"</li>
+
+ <li>Instance of, or castable to, "Object[]"</li>
+
+ <li>A string with comma-separated numbers (white-space is okay, it is trimmed)</li>
+
+ <li>"null" which will render all children that can be rendered</li>
+
+ <li>[]</li>
+</ul>
+ <p>
+ In the case of a collection or an object array, the items in the collection or array must be "java.lang.Number"
+ instances or objects whose "toString()" is parsable by "Integer.parseInt(String)".
+ </p>
+ <p>
+ See the example code for more information.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_limitRendered-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_limitRendered-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_passwordStrength-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_passwordStrength-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_passwordStrength-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_passwordStrength-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ <div><img src="../images/pwd1.jpg" alt="passwordStrength"/></div>
+ <div><img src="../images/pwd2.jpg" alt="passwordStrength"/></div>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+
+ <s:passwordStrength [id="txtPwdText"]
+ [preferredPasswordLength="10"]
+ [value="#{passwordStrengthBean.password}"]
+ [prefixText="Strength : "]
+ [textStrengthDescriptions="Very Poor;Weak;Average;Strong;Excellent"]
+ [strengthIndicatorType="text|bar"]
+ [useCustomSecurity="true|false"]
+ [customSecurityExpression="A3S2N3A2"]
+ [penaltyRatio="50"]>
+ </s:passwordStrength>
+
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>see passwordStrength.jsp in the Sandbox examples.</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_passwordStrength-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_passwordStrength-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_roundedDiv-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_roundedDiv-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_roundedDiv-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_roundedDiv-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ <div><img src="../images/roundedDiv.png" alt="roundedDiv"/></div>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+<s:roundedDiv
+ id="String"
+ binding="EL"
+ rendered="Boolean"
+ backgroundColor="Color|HEX Color String"
+ borderColor="Color|HEX Color String"
+ color="Color|HEX Color String"
+ borderWidth="Integer"
+ radius="Integer"
+ size="Dimension|String"
+ corners="String"
+ inverse="Boolean"
+ layout="table|div"
+ contentStyle="String"
+ contentStyleClass="String">
+ ...Contents...
+</s:roundedDiv>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>See the file roundedDiv.jsp for an example.</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_roundedDiv-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_roundedDiv-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCSV-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCSV-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCSV-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCSV-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+ <f:verbatim>enter credit card numbers, separated by a period:</f:verbatim>
+ <h:inputText id="creditCardNumber" value="#{backingBean.creditCardNumbers}" required="true">
+ <s:validateCSV subvalidatorId="org.apache.myfaces.validator.CreditCard" separator="\\." />
+ </h:inputText>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>
+ Use this validator to allow users to enter multiple input values in a single input,
+ separated by a comma, semicolon, or other custom separator. The CSVValidator will
+ separate the input values and call the subvalidator for each of those values.
+ </p>
+ <p>See "myfaces-example-sandbox/validatecsv.jsp" for an example.</p>
+ </section>
+ <!-- Additional Information -->
+ <section name="Known issues">
+ <p>
+ The separator, if specified, must be a valid regex for separating the input String, eq "\\."
+ </p>
+ <p>
+ Parameters cannot be passed.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCSV-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCSV-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCompareTo-base.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCompareTo-base.xml?rev=673223&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCompareTo-base.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCompareTo-base.xml Tue Jul 1 15:36:51 2008
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN"
+ "http://maven.apache.org/dtd/xdoc_1_0.dtd">
+<document>
+ <properties>
+ <title></title>
+ </properties>
+ <!-- All code under body will be put after "Summary" section -->
+ <body>
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+ <t:inputCalendar id="startDate"/>
+ <t:inputCalendar id="endDate">
+ <sandbox:compareToValidator operator="gt" for="startDate" />
+ <sandbox:compareToValidator operator="gt" for="startDate" message="Start date must be before end date." />
+ <sandbox:compareToValidator operator="gt" for="startDate" message="{0} must be {2} {3}" />
+ <sandbox:compareToValidator operator="gt" for="startDate" alternateOperatorName="after" />
+ <sandbox:compareToValidator operator="gt" for="startDate" message="{0} must be {2} {3}" alternateOperatorName="after" />
+ <sandbox:compareToValidator operator="gt" for="startDate" comparator="#{dateComparator}" />
+ <t:inputCalendar>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+ <p>
+ If the comparator attribute is specified, the component values are compared
+ using the specified java.util.Comparator object. If no comparator is specified, the
+ component values must implement Comparable and are compared using compareTo().
+ If either value or foreign value does not implement Comparable and no Comparator
+ is specified, validation always succeeds.
+ </p>
+ <p>
+ Put this validator on the bottom-most component to insure that
+ the foreign component's value has been converted and validated first.
+ However, this validator will attempt to convert and validate the foreign
+ component's value if this has not already occurred. This process may not
+ be identical to the standard JSF conversion and validation process.
+ </p>
+ <p>See "myfaces-example-sandbox/validateCompareTo.jsp" for an example.</p>
+ </section>
+ <!-- Additional Information -->
+ <section name="Known issues">
+
+ <p>
+ The validation error message key is currently hardcoded as
+ "{0} value <{1}> must be {2} {3} value <{4}>"
+ and should be localized.
+ </p>
+ <p>
+ Operator names should be localized.
+ </p>
+ <p>
+ Perhaps an exception should be thrown if the two values are not
+ Comparable and no Comparator is specified.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCompareTo-base.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/main/tagdoc/s_validateCompareTo-base.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL