You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by ba...@apache.org on 2005/11/09 20:01:58 UTC
svn commit: r332104 - in /myfaces/forrest/trunk: content/xdocs/
content/xdocs/sandbox/ resources/images/
Author: baranda
Date: Wed Nov 9 11:01:47 2005
New Revision: 332104
URL: http://svn.apache.org/viewcvs?rev=332104&view=rev
Log:
Added documentation for the sandbox selectManyPicklist component. Also, changed x to s for sandbox components in the docs
Added:
myfaces/forrest/trunk/content/xdocs/sandbox/selectManyPicklist.xml
myfaces/forrest/trunk/resources/images/selectManyPicklist.jpg (with props)
Modified:
myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml
myfaces/forrest/trunk/content/xdocs/sandbox/component-template.xml
myfaces/forrest/trunk/content/xdocs/sandbox/form.xml
myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggest.xml
myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggestAjax.xml
myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml
myfaces/forrest/trunk/content/xdocs/site.xml
Modified: myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml?rev=332104&r1=332103&r2=332104&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml Wed Nov 9 11:01:47 2005
@@ -8,7 +8,7 @@
<document>
<header>
<title>Ajax DataTable</title>
- <subtitle><x:autoUpdateDataTable></subtitle>
+ <subtitle><s:autoUpdateDataTable></subtitle>
</header>
<body>
<!-- Description -->
@@ -62,7 +62,7 @@
<section>
<title>Usage</title>
<source>
- <x:autoUpdateDataTable [ all standard dataTable attributes allowed ]
+ <s:autoUpdateDataTable [ all standard dataTable attributes allowed ]
[ preserveDataModel="{true|false}" ]
[ forceIdIndexFormula="value-binding" ]
[ sortColumn="value-binding" ]
@@ -71,7 +71,7 @@
[ frequency="value-binding" ]>
standard dataTable body (<h:column> tags and optional "header" and "footer" facets)
</t:command_sortheader>
- <x:autoUpdateDataTable>
+ <s:autoUpdateDataTable>
</source>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/sandbox/component-template.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/sandbox/component-template.xml?rev=332104&r1=332103&r2=332104&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/sandbox/component-template.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/sandbox/component-template.xml Wed Nov 9 11:01:47 2005
@@ -10,7 +10,7 @@
<header>
<!-- ex. JSCook Menu -->
<title>[TO DO]</title>
- <!-- ex. <x:jsCookMenu> -->
+ <!-- ex. <s:jsCookMenu> -->
<subtitle>[TO DO]</subtitle>
</header>
<body>
Modified: myfaces/forrest/trunk/content/xdocs/sandbox/form.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/sandbox/form.xml?rev=332104&r1=332103&r2=332104&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/sandbox/form.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/sandbox/form.xml Wed Nov 9 11:01:47 2005
@@ -9,7 +9,7 @@
<!-- component name -->
<header>
<title>Form</title>
- <subtitle><x:form/></subtitle>
+ <subtitle><s:form/></subtitle>
</header>
<body>
<!-- Description -->
@@ -61,8 +61,8 @@
<section>
<title>Usage</title>
<source>
-<x:form scheme="https" servername="www.domain.org" port="1234">
-</x:form>
+<s:form scheme="https" servername="www.domain.org" port="1234">
+</s:form>
</source>
</section>
<!-- Syntax -->
Modified: myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggest.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggest.xml?rev=332104&r1=332103&r2=332104&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggest.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggest.xml Wed Nov 9 11:01:47 2005
@@ -9,7 +9,7 @@
<!-- component name -->
<header>
<title>Input Suggest</title>
- <subtitle><x:inputSuggest></subtitle>
+ <subtitle><s:inputSuggest></subtitle>
</header>
<body>
<!-- Description -->
Modified: myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggestAjax.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggestAjax.xml?rev=332104&r1=332103&r2=332104&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggestAjax.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/sandbox/inputSuggestAjax.xml Wed Nov 9 11:01:47 2005
@@ -8,7 +8,7 @@
<document>
<header>
<title>Ajax Suggest</title>
- <subtitle><x:inputSuggestAjax></subtitle>
+ <subtitle><s:inputSuggestAjax></subtitle>
</header>
<body>
<!-- Description -->
@@ -55,7 +55,7 @@
</section>
<section>
<title>Syntax</title>
- <source><x:Ajaxsuggest id="id" binding="control binding"
+ <source><s:Ajaxsuggest id="id" binding="control binding"
auggestedItemsMethod="backend bean callback method" value="Bean"/>
</source>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml?rev=332104&r1=332103&r2=332104&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml Wed Nov 9 11:01:47 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Schedule</title>
- <subtitle><x:schedule/></subtitle>
+ <subtitle><s:schedule/></subtitle>
</header>
<body>
<!-- Description -->
@@ -64,7 +64,7 @@
<section>
<title>Usage</title>
<source>
-<x:schedule [ UI component attributes ]
+<s:schedule [ UI component attributes ]
[ UI command attributes ]
[value="#{backingBean.scheduleModel}"]
[visibleStartHour="7"]
@@ -77,7 +77,7 @@
[headerDateFormat="dd-MM-yyyy"]
[compactWeekRowHeight="200"]
[compactMonthRowHeight="100"]>
-</x:schedule>
+</s:schedule>
</source>
</section>
Added: myfaces/forrest/trunk/content/xdocs/sandbox/selectManyPicklist.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/sandbox/selectManyPicklist.xml?rev=332104&view=auto
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/sandbox/selectManyPicklist.xml (added)
+++ myfaces/forrest/trunk/content/xdocs/sandbox/selectManyPicklist.xml Wed Nov 9 11:01:47 2005
@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
+
+<document>
+ <!-- component name -->
+ <header>
+ <title>Picklist</title>
+ <subtitle><s:selectManyPicklist/></subtitle>
+ </header>
+ <body>
+ <!-- Description -->
+ <section>
+ <title>Description</title>
+ <p>
+ A picklist component is a selection component where a set of items
+ can be selected from a list that contains all the available items to a list
+ that contains the selected items.
+ </p>
+ <p>
+ The component is based on the t:selectManyListbox component, so it contains
+ the same attributes. Soon, more specific attributes will be added.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section>
+ <title>Screen Shot</title>
+ <figure src="images/selectManyPicklist.jpg" alt="picklist"/>
+ </section>
+ <!-- API -->
+ <section>
+ <title>API</title>
+ <table>
+ <tr>
+ <td>author</td>
+ <td>Bruno Aranda</td>
+ </tr>
+ <tr>
+ <td>component-family</td>
+ <td>javax.faces.SelectMany</td>
+ </tr>
+ <tr>
+ <td>renderer-type</td>
+ <td>org.apache.myfaces.PicklistRenderer</td>
+ </tr>
+ <tr>
+ <td>component-class</td>
+ <td>org.apache.myfaces.custom.picklist.HtmlSelectManyPicklist</td>
+ </tr>
+ <tr>
+ <td>renderer-class</td>
+ <td>rg.apache.myfaces.custom.picklist.HtmlPicklistRenderer</td>
+ </tr>
+ <tr>
+ <td>tag-class</td>
+ <td>org.apache.myfaces.custom.picklist.HtmlSelectManyPicklistTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<s:selectManyPicklist [ Standard selectManyListbox attributes ] />
+ </source>
+ </section>
+
+ <!-- Syntax -->
+ <section>
+ <title>Syntax</title>
+ <note label="<s:selectManyPicklist/>">
+ <code>
+ In the current state, this component uses the same attributes than the h:selectManyListBox component. Specific attributes will be added soon.
+ </code>
+ <br/>
+ </note>
+ </section>
+
+ <!-- Instructions -->
+ <section>
+ <title>Instructions</title>
+ <p>see sandbox/picklist.jsf 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>
+ </footer>
+
+</document>
Modified: myfaces/forrest/trunk/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/site.xml?rev=332104&r1=332103&r2=332104&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/site.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/site.xml Wed Nov 9 11:01:47 2005
@@ -159,6 +159,7 @@
<inputSuggest label="Input Suggest" href="inputSuggest.html"/>
<schedule label="Schedule" href="schedule.html"/>
<form label="Form" href="form.html"/>
+ <picklist label="Picklist" href="selectManyPicklist.html"/>
</sandbox-components>
<!--
<community href="community/" label="Community" tab="community">
Added: myfaces/forrest/trunk/resources/images/selectManyPicklist.jpg
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/resources/images/selectManyPicklist.jpg?rev=332104&view=auto
==============================================================================
Binary file - no diff available.
Propchange: myfaces/forrest/trunk/resources/images/selectManyPicklist.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream