You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by mm...@apache.org on 2005/07/11 23:57:43 UTC
svn commit: r215888 [2/2] - in /myfaces/forrest/trunk/content/xdocs: ./
components/
Modified: myfaces/forrest/trunk/content/xdocs/components/treeTable.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/treeTable.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/treeTable.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/treeTable.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Tree Column</title>
- <subtitle><x:treeColumn></subtitle>
+ <subtitle><x:treeColumn/></subtitle>
</header>
<body>
<!-- Description -->
@@ -57,32 +57,43 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:tree id="String"
+ value="TreeModel"
+ var="String"
+ expandRoot="{true|false}">
+ <x:treeColumn header="UIComponent"
+ footer="UIComponent">
+ ...(anyComponent)...
+ </x:treeColumn>
+</x:tree>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:tree id="String"
- value="TreeModel"
- var="String"
- expandRoot="true">
- <x:treeColumn header="UIComponent"
- footer="UIComponent">
- ...(anyComponent)...
- </x:treeColumn>
- </x:tree>
- </p>
+ <note label="<x:treeColumn>">
+ <code>header - the header uicomponent.</code><br/>
+ <code>footer - the footer uicomponent.</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- Just nest a treeColumn inside of a tree element.
- header - the header uicomponent.
- footer - the footer uicomponent.
+ Just nest a treeColumn inside of a tree element,
+ see doc of tree for help about attributes.
+ </p>
+ <p>
<x:tree> defines the tree.
+ <br/>
<x:treeColumn> outlines the column where the tree structure
will be render as part of the tree table.
- see doc of tree for help about attributes.
+ </p>
+ <p>
see examples/treeTable.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/uiSaveState.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/uiSaveState.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/uiSaveState.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/uiSaveState.xml Mon Jul 11 14:57:41 2005
@@ -12,54 +12,57 @@
<section>
<title>Description</title>
<p>
- Traditional JSP Applications save their state information within
- HttpSession objects. This is an easy to use but not always satisfying approach:
+ Traditional JSP Applications save their state information within
+ HttpSession objects. This is an easy to use but not always satisfying approach:
</p>
<ul>
<li>
- HttpSession objects must have an expiration date (timeout) that
- prevents the server from running out of memory over the time.
- The always boring question for web admins: How long should I set
- the session timout?
+ HttpSession objects must have an expiration date (timeout) that
+ prevents the server from running out of memory over the time.
+ The always boring question for web admins: How long should I set
+ the session timout?
</li>
- </ul>
- <ul>
<li>
- Server restarting is a thrilling task: Will all objects in active
- sessions be serialized and restored successfully? If business
- classes have changed in the meantime, this task is likely to fail.
+ Server restarting is a thrilling task: Will all objects in active
+ sessions be serialized and restored successfully? If business
+ classes have changed in the meantime, this task is likely to fail.
</li>
- </ul>
- <ul>
<li>
- Running multiple redundant servers is a challenge. You must use
- cluster environments which are expensive and difficult to handle.
+ Running multiple redundant servers is a challenge. You must use
+ cluster environments which are expensive and difficult to handle.
</li>
</ul>
<p>
- MyFaces supports a different approach. It makes it possible to write
- sophisticated applications without any use of the HttpSession. All
- state information of the current view and the model beans can be
- encoded to the client response.
+ MyFaces supports a different approach. It makes it possible to write
+ sophisticated applications without any use of the HttpSession. All
+ state information of the current view and the model beans can be
+ encoded to the client response. MyFaces introduces a new Component
+ "UISaveState" with the corresponding Tag <x:save_state>.
+ <br/>
+ Example (see "sample1.jsp" of the "examples" web application):
+ </p>
+ <source>
+<x:save_state id="save1" value="#{calcForm.number1}" />
+<x:save_state id="save2" value="#{calcForm.number2}" />
+<x:save_state id="save3" value="#{ucaseForm.text}" />
+ </source>
+ <p>
+ The current values of the three properties number1, number2 and text
+ are automatically saved within the client response and get restored
+ at the next client request.
</p>
<p>
- MyFaces introduces a new Component "UISaveState" with the corresponding
- Tag <x:save_state>.
- Example (see "sample1.jsp" of the "examples" web application):
- <x:save_state id="save1" value="#{calcForm.number1}" />
- <x:save_state id="save2" value="#{calcForm.number2}" />
- <x:save_state id="save3" value="#{ucaseForm.text}" />
- The current values of the three properties number1, number2 and text
- are automatically saved within the client response and get restored
- at the next client request.
+ You can also save the whole bean.
+ <br/>
+ Example:
</p>
+ <source>
+<x:save_state id="saveCalcForm" value="#{calcForm}"/>
+ </source>
<p>
- You can also save the whole bean.
- Example:
- <x:save_state id="saveCalcForm" value="#{calcForm}"/>
- The whole bean automatically is saved and restored by MyFaces.
- To be able to save and restore the value of a bean property or the
- bean itself, it must implement the Serializable interface.
+ The whole bean automatically is saved and restored by MyFaces.
+ To be able to save and restore the value of a bean property or the
+ bean itself, it must implement the Serializable interface.
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/validateCreditCard.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/validateCreditCard.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/validateCreditCard.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/validateCreditCard.xml Mon Jul 11 14:57:41 2005
@@ -19,26 +19,27 @@
<title>Description</title>
<p>
A validator, that validates credit card format for:
- </p>
- <table>
- <tr>
- <td>American Express</td>
- </tr>
- <tr>
- <td>Discover</td>
- </tr>
- <tr>
- <td>Mastercard</td>
- </tr>
- <tr>
- <td>Visa</td>
- </tr>
- <tr>
- <td>or even none of that cards</td>
- </tr>
- </table>
-
+ </p>
+ <table>
+ <tr>
+ <td>American Express</td>
+ </tr>
+ <tr>
+ <td>Discover</td>
+ </tr>
+ <tr>
+ <td>Mastercard</td>
+ </tr>
+ <tr>
+ <td>Visa</td>
+ </tr>
+ <tr>
+ <td>or even none of that cards</td>
+ </tr>
+ </table>
</section>
+ <!-- Screen Shot -->
+
<!-- API -->
<section>
<title>API</title>
@@ -65,6 +66,17 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<h:inputText id="creditCardNumber"
+ value="#{validateForm.creditCardNumber}"
+ required="true">
+ <x:validateCreditCard />
+</h:inputText>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
@@ -79,11 +91,12 @@
<!-- Instructions -->
<section>
<title>Instructions</title>
- <p>By default, all cards are allowed. You can disable one with card="false".
-Note if you specify none="true", all cardtypes will be ignored. It is based
-upon Jakarta Commons' Validator.
-
-See "examples/validate.jsp" for an example!</p>
+ <p>
+ By default, all cards are allowed. You can disable one with card="false".
+ Note if you specify none="true", all cardtypes will be ignored. It is based
+ upon Jakarta Commons' Validator.
+ </p>
+ <p>See "examples/validate.jsp" for an example!</p>
</section>
</body>
<footer>
Modified: myfaces/forrest/trunk/content/xdocs/components/validateEmail.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/validateEmail.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/validateEmail.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/validateEmail.xml Mon Jul 11 14:57:41 2005
@@ -18,10 +18,10 @@
<section>
<title>Description</title>
<p>
- A custom validator for email addresses, based upons Jakarta Commons.
+ A custom validator for email addresses, based upons Jakarta Commons.
</p>
</section>
- <!-- screen shot -->
+ <!-- Screen Shot -->
<!-- API -->
<section>
@@ -49,6 +49,17 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<h:inputText id="email2"
+ value="#{validateForm.email2}"
+ required="true">
+ <x:validateEmail />
+</h:inputText>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
@@ -59,8 +70,11 @@
<!-- Instructions -->
<section>
<title>Instructions</title>
- <p>A validator, that validates email address format. It is based upon Jakarta Commons' Validator. See "examples/validate.jsp" for an example!
-</p>
+ <p>
+ A validator, that validates email address format.
+ It is based upon Jakarta Commons' Validator.
+ </p>
+ <p>see "examples/validate.jsp" for an example!</p>
</section>
</body>
<footer>
Modified: myfaces/forrest/trunk/content/xdocs/components/validateEqual.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/validateEqual.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/validateEqual.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/validateEqual.xml Mon Jul 11 14:57:41 2005
@@ -18,10 +18,10 @@
<section>
<title>Description</title>
<p>
- A custom validator for equal input.
+ A custom validator for equal input.
</p>
</section>
- <!-- screen shot -->
+ <!-- Screen Shot -->
<!-- API -->
<section>
@@ -49,19 +49,33 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<h:inputText id="equal2"
+ value="#{validateForm.equal2}"
+ required="true">
+ <x:validateEqual for="equal" />
+</h:inputText>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <note label="<x:validateEqual/>">
+ <note label="<x:validateEqual/>">
<code>for (required)</code><br/>
</note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
- <p>In attribute <code>for</code> you specify a component, which value must equal
-with the value of that component, on which this validator is embedded.
-A common example is twice password, or twice email-address. See "examples/validate.jsp" for an example! </p>
+ <p>
+ In attribute <code>for</code> you specify a component, which value must equal
+ with the value of that component, on which this validator is embedded.
+ A common example is twice password, or twice email-address.
+ </p>
+ <p>see "examples/validate.jsp" for an example!</p>
</section>
</body>
<footer>
Modified: myfaces/forrest/trunk/content/xdocs/components/validateISBN.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/validateISBN.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/validateISBN.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/validateISBN.xml Mon Jul 11 14:57:41 2005
@@ -11,7 +11,7 @@
<!-- ex. JSCook Menu -->
<title>Validate ISBN codes</title>
<!-- ex. <x:jsCookMenu> -->
- <subtitle><x:validateISBN/></subtitle>
+ <subtitle><x:validateISBN/></subtitle>
</header>
<body>
<!-- Description -->
@@ -21,7 +21,8 @@
A custom validator for isbn codes, based upons Jakarta Commons.
</p>
</section>
- <!-- API -->
+ <!-- Screen Shot -->
+
<!-- API -->
<section>
<title>API</title>
@@ -40,6 +41,17 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<h:inputText id="isbn"
+ value="#{validateForm.isbn}"
+ required="true">
+ <x:validateISBN />
+</h:inputText>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
@@ -50,8 +62,11 @@
<!-- Instructions -->
<section>
<title>Instructions</title>
- <p>Insert <code><x:validateISBN/></code> inside your <code><h:inputXXX/></code>-Component to validate an expected ISBN code. See "examples/validate.jsp" for an example!
-</p>
+ <p>
+ Insert <code><x:validateISBN/></code>
+ inside your <code><h:inputXXX/></code>-Component
+ to validate an expected ISBN code.
+ </p>
</section>
</body>
<footer>
Modified: myfaces/forrest/trunk/content/xdocs/components/validateRegExpr.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/validateRegExpr.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/validateRegExpr.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/validateRegExpr.xml Mon Jul 11 14:57:41 2005
@@ -18,10 +18,10 @@
<section>
<title>Description</title>
<p>
- Component for validating regular expressions.
+ Component for validating regular expressions.
</p>
</section>
- <!-- screen shot -->
+ <!-- Screen Shot -->
<!-- API -->
<section>
@@ -49,6 +49,17 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<h:inputText id="regExprValue"
+ value="#{validateForm.regExpr}"
+ required="true">
+ <x:validateRegExpr pattern='\d{5}'/>
+</h:inputText>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
@@ -60,15 +71,20 @@
<section>
<title>Instructions</title>
<p>
- In attribute <code>pattern</code> you are able to specify a regular expression,
-on which the value should be validated. The validator is based upon Jakarta Commons' Validator. See "examples/validate.jsp" for an example!
+ In attribute <code>pattern</code> you are able to specify
+ a regular expression, on which the value should be validated.
+ The validator is based upon Jakarta Commons' Validator.
</p>
+ <p>see "examples/validate.jsp" for an example!</p>
</section>
</body>
<footer>
- <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br />
- © 2004 - 2005, Apache Software Foundation
- </legal>
+ <legal>
+ Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc.
+ in the United States and other countries.
+ <br/>
+ © 2004 - 2005, Apache Software Foundation
+ </legal>
</footer>
</document>
Modified: myfaces/forrest/trunk/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/site.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/site.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/site.xml Mon Jul 11 14:57:41 2005
@@ -43,7 +43,6 @@
<newspaperTable label="Newspaper Table" href="newspaperTable.html"/>
<aliasBean label="Alias Bean" href="aliasBean.html"/>
<Buffer label="Buffer" href="buffer.html"/>
- <dataScroller label="dataScroller" href="dataScroller.html"/>
<fileUpload label="File Upload" href="fileUpload.html"/>
<tabbedPane label="TabbedPane" href="tabbedPane.html"/>
<calendar label="Calendar" href="calendar.html"/>