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 [1/2] - in /myfaces/forrest/trunk/content/xdocs: ./
components/
Author: mmarinschek
Date: Mon Jul 11 14:57:41 2005
New Revision: 215888
URL: http://svn.apache.org/viewcvs?rev=215888&view=rev
Log: (empty)
Removed:
myfaces/forrest/trunk/content/xdocs/components/site.xml
Modified:
myfaces/forrest/trunk/content/xdocs/components/aliasBean.xml
myfaces/forrest/trunk/content/xdocs/components/buffer.xml
myfaces/forrest/trunk/content/xdocs/components/calendar.xml
myfaces/forrest/trunk/content/xdocs/components/commandSortHeader.xml
myfaces/forrest/trunk/content/xdocs/components/dataList.xml
myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml
myfaces/forrest/trunk/content/xdocs/components/extDataTable.xml
myfaces/forrest/trunk/content/xdocs/components/fileUpload.xml
myfaces/forrest/trunk/content/xdocs/components/forceId.xml
myfaces/forrest/trunk/content/xdocs/components/htmlEditor.xml
myfaces/forrest/trunk/content/xdocs/components/inputDate.xml
myfaces/forrest/trunk/content/xdocs/components/javascriptListener.xml
myfaces/forrest/trunk/content/xdocs/components/jscookmenu.xml
myfaces/forrest/trunk/content/xdocs/components/newspaperTable.xml
myfaces/forrest/trunk/content/xdocs/components/panelNavigation.xml
myfaces/forrest/trunk/content/xdocs/components/panelStack.xml
myfaces/forrest/trunk/content/xdocs/components/popup.xml
myfaces/forrest/trunk/content/xdocs/components/rssTicker.xml
myfaces/forrest/trunk/content/xdocs/components/stylesheet.xml
myfaces/forrest/trunk/content/xdocs/components/tabbedPane.xml
myfaces/forrest/trunk/content/xdocs/components/tiles.xml
myfaces/forrest/trunk/content/xdocs/components/tree.xml
myfaces/forrest/trunk/content/xdocs/components/tree2.xml
myfaces/forrest/trunk/content/xdocs/components/treeTable.xml
myfaces/forrest/trunk/content/xdocs/components/uiSaveState.xml
myfaces/forrest/trunk/content/xdocs/components/validateCreditCard.xml
myfaces/forrest/trunk/content/xdocs/components/validateEmail.xml
myfaces/forrest/trunk/content/xdocs/components/validateEqual.xml
myfaces/forrest/trunk/content/xdocs/components/validateISBN.xml
myfaces/forrest/trunk/content/xdocs/components/validateRegExpr.xml
myfaces/forrest/trunk/content/xdocs/site.xml
Modified: myfaces/forrest/trunk/content/xdocs/components/aliasBean.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/aliasBean.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/aliasBean.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/aliasBean.xml Mon Jul 11 14:57:41 2005
@@ -9,19 +9,22 @@
<!-- component name -->
<header>
<title>Alias Bean</title>
- <subtitle><x:aliasBean></subtitle>
+ <subtitle><x:aliasBean/></subtitle>
</header>
<body>
<!-- Description -->
<section>
<title>Description</title>
+ <p>A tag that defines a new bean (alias) with a given value.</p>
<p>
- A tag that defines a new bean (alias) with a given value.
- This allows you to design a subform with a generic (fictive) beans and to include it in all the pages where you use it.
- You just need to make an alias to the real bean named after the generic bean before including the subform.
-
- When used within an aliasBeansScope tag, this tag adds the alias to the aliasBeansScope.
- This makes configuration with multiple aliasBeans easier to write.
+ This allows you to design a subform with a generic (fictive) beans
+ and to include it in all the pages where you use it. You just need
+ to make an alias to the real bean named after the generic bean
+ before including the subform.
+ <br/>
+ When used within an aliasBeansScope tag, this tag adds the alias
+ to the aliasBeansScope. This makes configuration with multiple
+ aliasBeans easier to write.
</p>
</section>
<!-- screen shot -->
@@ -58,24 +61,35 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:aliasBean alias="#{holder}" value="#{aliasTest1}">
+ <f:subview id="simulatedIncludedSubform1">
+ <h:outputLabel for="name" value="Name :"/>
+ <h:inputText id="name" value="#{holder.name}"/>
+ </f:subview>
+</x:aliasBean>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:aliasBean alias="Bean" value="String">
- </p>
+ <note label="<x:aliasBean/>">
+ <code>alias - The bean that will be set to the given value (Example : #{holder}).</code><br/>
+ <code>
+ value - The value that the alias can be set to.
+ This can be a string (like "toto") or a reference to an existing
+ bean (like "#{myBean.member1}").
+ </code>
+ <br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
- <p>
- alias - The bean that will be set to the given value
- (Example : #{holder}).
- value - The value that the alias can be set to. This can be
- a string (like "toto") or a reference to an existing
- bean (like "#{myBean.member1}").
- see examples/aliasBean.jsp for an example!
- </p>
+ <p>see examples/aliasBean.jsp for an example!</p>
</section>
</body>
<footer>
Modified: myfaces/forrest/trunk/content/xdocs/components/buffer.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/buffer.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/buffer.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/buffer.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Buffer</title>
- <subtitle><x:buffer></subtitle>
+ <subtitle><x:buffer/></subtitle>
</header>
<body>
<!-- Description -->
@@ -50,21 +50,29 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:buffer into="Bean">
+ <x:div>
+ <h:outputText value="String"/>
+ </x:div>
+</x:buffer>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:buffer into="Bean">
- <x:div>
- <h:outputText value="String"/>
- </x:div>
- </x:buffer>
- </p>
+ <note label="<x:buffer/>">
+ <code>into</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
- <p>Just nest Element to buffer into a x:buffer-Element, see examples/buffer.jsp for an example!</p>
+ <p>Just nest elements to buffer into a <x:buffer>-element.</p>
+ <p>see examples/buffer.jsp for an example!</p>
</section>
</body>
<footer>
Modified: myfaces/forrest/trunk/content/xdocs/components/calendar.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/calendar.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/calendar.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/calendar.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Calendar</title>
- <subtitle><x:inputCalendar></subtitle>
+ <subtitle><x:inputCalendar/></subtitle>
</header>
<body>
<!-- Description -->
@@ -14,7 +14,8 @@
<p>
Renders a calendar component allowing to choose a date from a month view.
Change the month by navigating in the header bar.
-
+ </p>
+ <p>
The calendar component is automatically rendered using the
week-names, the month-names and the start of the week of the
current locale, so localisation support is given (for an
@@ -25,8 +26,24 @@
<!-- screen shot -->
<section>
<title>Screen Shots</title>
- <figure src="images/calendar_popup.png" alt="calendar_popup"/>
- <figure src="images/calendar_nopopup.png" alt="calendar_nopopup"/>
+ <table>
+ <tr>
+ <th>
+ Popup
+ </th>
+ <th>
+ No Popup
+ </th>
+ </tr>
+ <tr>
+ <td>
+ <figure src="images/calendar_popup.png" alt="calendar_popup"/>
+ </td>
+ <td>
+ <figure src="images/calendar_nopopup.png" alt="calendar_nopopup"/>
+ </td>
+ </tr>
+ </table>
</section>
<!-- API -->
<section>
@@ -62,19 +79,93 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:calendar [ HTML universal attributes ]
+ [ HTML event handler attributes ]
+ [ UIInput standard attributes (i.e. valueChangeListener) ]
+ [monthYearRowClass="month-and-year-header-row-css-class"]
+ [weekRowClass="week-header-row-css-class"]
+ [dayCellClass="empty-or-date-cell-css-class"]
+ [currentDayCellClass="currently-selected-day-cell-css-class"]>
+</x:calendar>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:calendar [ HTML universal attributes ]
- [ HTML event handler attributes ]
- [ UIInput standard attributes (i.e. valueChangeListener) ]
- [monthYearRowClass="month-and-year-header-row-css-class"]
- [weekRowClass="week-header-row-css-class"]
- [dayCellClass="empty-or-date-cell-css-class"]
- [currentDayCellClass="currently-selected-day-cell-css-class"]>
- </x:calendar>
- </p>
+ <note label="<x:calendar/>">
+ <code>
+ monthYearRowClass - CSS class to be used for the header-row showing
+ month and year.
+ </code>
+ <br/>
+ <code>
+ weekRowClass - CSS class to be used for the header-row showing the week-days.
+ </code>
+ <br/>
+ <code>
+ dayCellClass - CSS class to be used for the cells showing days.
+ </code>
+ <br/>
+ <code>
+ currentDayCellClass - CSS class to be used for the cell of the currently selected date.
+ </code>
+ <br/>
+ <code>
+ renderAsPopup - Render the input-calendar as a java-script popup on client.
+ </code>
+ <br/>
+ <code>
+ addResources - Automatically add the input-calendar scripts and css files to
+ the header, set that to false to provide the scripts yourself.
+ </code>
+ <br/>
+ <code>
+ popupDateFormat - Defines the date format used by the java-script popup on client.
+ </code>
+ <br/>
+ <code>
+ popupButtonString - Defines the string displayed on the button which leads to
+ the calendar-popup-window (... by default).
+ </code>
+ <br/>
+ <code>
+ popupGotoString - Set the string for "Go To Current Month".
+ </code>
+ <br/>
+ <code>
+ popupTodayString - Set the string for "Today is".
+ </code>
+ <br/>
+ <code>
+ popupWeekString - Set the string for "Wk".
+ </code>
+ <br/>
+ <code>
+ popupScrollLeftMessage - Set the string for scrolling to the left.
+ </code>
+ <br/>
+ <code>
+ popupScrollRightMessage - Set the string for scrolling to the right.
+ </code>
+ <br/>
+ <code>
+ popupSelectMonthMessage - Set the string for "Click to select a month".
+ </code>
+ <br/>
+ <code>
+ popupSelectYearMessage - Set the string for "Click to select a year".
+ </code>
+ <br/>
+ <code>
+ popupSelectDateMessage - Set the string for "Select [date] as date"
+ (do not replace [date], it will be replaced by the current date).
+ </code>
+ <br/>
+ </note>
</section>
<!-- Instructions -->
<section>
@@ -82,28 +173,8 @@
<p>
Standard core tags (i.e. a new Converter can be set for
value-bindings to values other than java.util.Date).
-
- monthYearRowClass - CSS class to be used for the header-row showing month and year.
- weekRowClass - CSS class to be used for the header-row showing the week-days.
- dayCellClass - CSS class to be used for the cells showing days.
- currentDayCellClass - CSS class to be used for the cell of the currently selected date.
- renderAsPopup - Render the input-calendar as a java-script popup on client.
- addResources - Automatically add the input-calendar scripts and css files to the header,
- set that to false to provide the scripts yourself.
- popupDateFormat - Defines the date format used by the java-script popup on client.
- popupButtonString - Defines the string displayed on the button
- which leads to the calendar-popup-window (... by default).
- popupGotoString - Set the string for "Go To Current Month".
- popupTodayString - Set the string for "Today is".
- popupWeekString - Set the string for "Wk".
- popupScrollLeftMessage - Set the string for scrolling to the left.
- popupScrollRightMessage - Set the string for scrolling to the right.
- popupSelectMonthMessage - Set the string for "Click to select a month".
- popupSelectYearMessage - Set the string for "Click to select a year".
- popupSelectDateMessage - Set the string for "Select [date] as date"
- (do not replace [date], it will be replaced by the current date).
- see examples/calendar.jsp for an example!
</p>
+ <p>see examples/calendar.jsp for an example!</p>
</section>
</body>
<footer>
Modified: myfaces/forrest/trunk/content/xdocs/components/commandSortHeader.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/commandSortHeader.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/commandSortHeader.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/commandSortHeader.xml Mon Jul 11 14:57:41 2005
@@ -11,7 +11,7 @@
<!-- ex. JSCook Menu -->
<title>SortHeader</title>
<!-- ex. <x:jsCookMenu> -->
- <subtitle><x:commandSortHeader></subtitle>
+ <subtitle><x:commandSortHeader/></subtitle>
</header>
<body>
<!-- Description -->
@@ -69,25 +69,33 @@
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:commandSortHeader [ all standard commandLink attributes allowed ]
+ [ columnName="unique-column-name" ]
+ [ arrow="{true|false}" ] >
+ nested link text and/or image(s)
+</x:command_sortheader>
+ </source>
+ </section>
+
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:commandSortHeader [ all standard commandLink attributes allowed ]
- columnName="unique-column-name"
- [ arrow="{true|false}" ] >
- nested link text and/or image(s)
- </x:command_sortheader>
- </p>
+ <note label="<x:commandSortHeader>">
+ <code>all standard commandLink attributes allowed</code><br/>
+ <code>columnName="unique-column-name"</code><br/>
+ <code>arrow="{true|false}"</code><br/>
+ </note>
</section>
-
+
<!-- Instructions -->
<section>
<title>Instructions</title>
- <p>
- Must be nested inside an extended ExtDataTable<x:dataTable>
- (see web\\example\\simpleSortList.jsp for an example)
- </p>
+ <p>Must be nested inside an extended DataTable <x:dataTable></p>
+ <p>(see examples/simpleSortList.jsp for an example)</p>
</section>
</body>
Modified: myfaces/forrest/trunk/content/xdocs/components/dataList.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/dataList.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/dataList.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/dataList.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Dynamic Lists</title>
- <subtitle><x:dataList></subtitle>
+ <subtitle><x:dataList/></subtitle>
</header>
<body>
<!-- Description -->
@@ -47,39 +47,53 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:dataList id="String"
+ styleClass="CSSClass"
+ var="String"
+ value="List"
+ layout="Constant"
+ rowCountVar="int"
+ rowIndexVar="int">
+ <h:outputText .../>
+</x:dataList>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:dataList id="String"
- styleClass="CSSClass"
- var="String"
- value="List"
- layout="Constant"
- rowCountVar="int"
- rowIndexVar="int">
- <h:outputText .../>
- </x:dataList>
- </p>
+ <note label="<x:dataList/>">
+ <code>value - the content of the list, supported types see JSF Spec 4.1.3.</code><br/>
+ <code>var - a parameter name, under which the current value is set.</code><br/>
+ <code>rows - the row count.</code><br/>
+ <code>first - the first element of the list.</code><br/>
+ <code>
+ layout - [simple|unorderedList|orderedList],
+ simple = for each dataRow all children are simply rendered,
+ unorderedList = the list is rendered as HTML unordered list (= bullet list),
+ orderedList = the list is rendered as HTML ordered list,
+ Default: simple.
+ </code>
+ <br/>
+ <code>
+ rowIndexVar - a parameter name, under which the current rowIndex
+ is set in request scope similar to the var parameter.
+ </code>
+ <br/>
+ <code>
+ rowCountVar - a parameter name, under which the rowCount is set
+ in request scope similar to the var parameter.
+ </code>
+ <br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- value - the content of the list, supported types see JSF Spec 4.1.3.
- var - a parameter name, under which the current value is set.
- rows - the row count.
- first - the first element of the list.
- layout - simple|unorderedList|orderedList
- simple = for each dataRow all children are simply rendered
- unorderedList = the list is rendered as HTML unordered list (= bullet list)
- orderedList = the list is rendered as HTML ordered list
- Default: simple
- rowIndexVar - a parameter name, under which the current rowIndex
- is set in request scope similar to the var parameter.
- rowCountVar - a parameter name, under which the rowCount is set
- in request scope similar to the var parameter.
-
see examples/dataList.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml Mon Jul 11 14:57:41 2005
@@ -9,7 +9,7 @@
<!-- component name -->
<header>
<title>DataScroller</title>
- <subtitle><x:dataScroller></subtitle>
+ <subtitle><x:dataScroller/></subtitle>
</header>
<body>
<section>
@@ -57,23 +57,48 @@
<section>
<title>Usage</title>
<source>
-<x:dataScroller[ user-role-support-attributes ]
- [for="reference to UIData"]
- [fastStep="values {ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel}"]
- [pageIndexVar="A parameter name, under which the actual page index is set in request scope
- similar to the var parameter."]
- [pageCountVar="A parameter name, under which the actual page count is set in request scope
- similar to the var parameter."]>
+<x:dataScroller [ user-role-support-attributes ]
+ [for="reference to UIData"]
+ [fastStep="values {ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel}"]
+ [pageIndexVar="A parameter name, under which the actual page index is set in request scope
+ similar to the var parameter."]
+ [pageCountVar="A parameter name, under which the actual page count is set in request scope
+ similar to the var parameter."]>
Nested Facets: first, previous, next, last, fastforward, fastrewind
</x:dataScroller>
</source>
</section>
+ <!-- Syntax -->
+ <section>
+ <title>Syntax</title>
+ <note label="<x:dataScroller>">
+ <code>user-role-support-attributes</code><br/>
+ <code>for="reference to UIData"</code><br/>
+ <code>fastStep="values {ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel}"</code><br/>
+ <code>
+ pageIndexVar="A parameter name, under which the actual page index is set in request scope
+ similar to the var parameter."
+ </code>
+ <br/>
+ <code>
+ pageCountVar="A parameter name, under which the actual page count is set in request scope
+ similar to the var parameter."
+ </code>
+ <br/>
+ </note>
+ </section>
+
<!-- Additional Information -->
<section>
<title>Additional Information</title>
- <p>DataScroller must be nested inside of an UIData component, or attribute "for" must be given so that corresponding uiData can be found.</p>
- <p>The scope of pageIndexVar and pageCountVar is limited, and only direct children of DataScroller may see them.</p>
+ <p>
+ DataScroller must be nested inside of an UIData component,
+ or attribute "for" must be given so that corresponding uiData can be found.
+ <br/>
+ The scope of pageIndexVar and pageCountVar is limited, and only
+ direct children of DataScroller may see them.
+ </p>
</section>
</body>
Modified: myfaces/forrest/trunk/content/xdocs/components/extDataTable.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/extDataTable.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/extDataTable.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/extDataTable.xml Mon Jul 11 14:57:41 2005
@@ -11,7 +11,7 @@
<!-- ex. JSCook Menu -->
<title>DataTable</title>
<!-- ex. <x:jsCookMenu> -->
- <subtitle><x:dataTable></subtitle>
+ <subtitle><x:dataTable/></subtitle>
</header>
<body>
<!-- Description -->
@@ -19,8 +19,12 @@
<title>Description</title>
<p>
The MyFacesDataTable extends the standard JSF DataTable by two important features:
- Possiblity to save the state of the DataModel.
- Support for clickable sort headers (see SortHeader component).
+ </p>
+ <ul>
+ <li>Possiblity to save the state of the DataModel.</li>
+ <li>Support for clickable sort headers (see SortHeader component).</li>
+ </ul>
+ <p>
Extended data_table that adds some additional features to the standard
data_table action: see attribute descriptions for preserveDataModel,
sortColumn, sortAscending and preserveSort.
@@ -58,51 +62,67 @@
</table>
</section>
- <!-- Syntax-->
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:dataTable [ all standard dataTable attributes allowed ]
+ [ preserveDataModel="{true|false}" ]
+ [ sortColumn="value-binding" ]
+ [ sortAscending="value-binding" ]
+ [ preserveSort="{true|false}" ] >
+ standard dataTable body (<h:column> tags and optional "header" and "footer" facets)
+ </x:command_sortheader>
+<x:dataTable>
+ </source>
+ </section>
+
+ <!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:dataTable [ all standard dataTable attributes allowed ]
- [ preserveDataModel="{true|false}" ]
- [ sortColumn="value-binding" ]
- [ sortAscending="value-binding" ]
- [ preserveSort="{true|false}" ] >
- standard dataTable body (<h:column> tags and optional "header" and "footer" facets)
- </x:command_sortheader>
- <x:dataTable>
- </p>
+ <note label="<x:dataTable>">
+ <code>all standard dataTable attributes allowed</code><br/>
+ <code>preserveDataModel="{true|false}"</code><br/>
+ <code>sortColumn="value-binding"</code><br/>
+ <code>sortAscending="value-binding"</code><br/>
+ <code>preserveSort="{true|false}"</code><br/>
+ </note>
</section>
-
+
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- Saving the state of the DataModel - the preserveDataModel attribute
+ <strong>Saving the state of the DataModel - the preserveDataModel attribute</strong><br/>
When this attribute is "true", the data behind the current DataModel is saved after the render response phase
and restored in the restore component tree phase.
-
- Why and when use this feature?
+ </p>
+ <p>
+ <strong>Why and when use this feature?</strong><br/>
Whenever you use a DataModel backed by a database connection you could run into
problems, when the data in the database has changed since the last request. All Lifecycle phases prior to the render
response phase iterate the DataModel and assume that the DataModel is unchanged since the last request. At least the
row count must not have changed, because all children of UIData that are bound to the DataModel rely on it. But even if
you can assure that row count never changes, a change in the data can have unintentional sideeffects.
-
+ <br/>
Using the preserveDataModel feature prevents such problems. The DataModel (to be more exact: the currently visible
part of the DataModel given by the first and the rows attribute) is freezed right after rendering and you can be sure that
all lifecycle actions during the next request happen on exactly the same data.
-
- What data types are supported?
+ </p>
+ <p>
+ <strong>What data types are supported?</strong><br/>
To be able to save the state of the DataModel the row objects must be serializable. All
standard DataModel types are supported, except ResultSet, which will follow in one of the next releases,
-
- Is updating the model supported?
+ </p>
+ <p>
+ <strong>Is updating the model supported?</strong><br/>
Yes. Just make your bean property that is bound to the DataTable component
writable, i.e. give it a setter method.
-
- Attention: To minimize the effort for saving the state of the DataModel only the visible rows are saved and restored.
- During the update model phase the setter will be called with an Array or List, that contains only these restored rows.
</p>
+ <warning label="Attention">
+ To minimize the effort for saving the state of the DataModel only the visible rows are saved and restored.
+ During the update model phase the setter will be called with an Array or List, that contains only these restored rows.
+ </warning>
</section>
</body>
Modified: myfaces/forrest/trunk/content/xdocs/components/fileUpload.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/fileUpload.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/fileUpload.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/fileUpload.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>File Upload</title>
- <subtitle><x:fileUpload></subtitle>
+ <subtitle><x:fileUpload/></subtitle>
</header>
<body>
<!-- Description -->
@@ -13,7 +13,8 @@
<title>Description</title>
<p>
Renders a HTML input with type="file".
-
+ </p>
+ <p>
You must enable the MultiPart Filter to make this component
work (see web.xml). Also, don't forget to set the form's attribute
"enctype" to "multipart/form-data".
@@ -61,21 +62,27 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:inputFileUpload [{all standard UIInput and HTML input attributes}]
+ [accept="mime-type"] />
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:inputFileUpload [{all standard UIInput and HTML input attributes}]
- [accept="mime-type"] />
- </p>
+ <note label="<x:inputFileUpload>">
+ <code>accept - a file filter String.</code><br/>
+ <code>storage - a String defines the storage method.</code><br/>
+ <code>value - the holder of the value.</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- accept - a file filter String.
- storage - a String defines the storage method.
- value - the holder of the value.
see "examples/fileupload.jsp" for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/forceId.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/forceId.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/forceId.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/forceId.xml Mon Jul 11 14:57:41 2005
@@ -37,27 +37,29 @@
<table>
<tr>
<td>attribute forceId</td>
- <td>On all MyFaces extended and custom components (all components
+ <td>
+ On all MyFaces extended and custom components (all components
in the extended taglib, usually prefixed with an 'x')
the forceId attribute can be set to the desired id-value.
</td>
</tr>
</table>
</section>
- <!-- Syntax -->
+ <!-- Usage -->
<section>
- <title>Syntax</title>
- <p>
- <(anyComponent) forceId="yourIdValue"/>
- </p>
+ <title>Usage</title>
+ <source>
+<(anyCustomComponent) forceId="yourIdValue"/>
+ </source>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- An example: if you want to use the panelGroup
- control with a predefined id, you include the markup:
- <x:panelGroup forceId="yourIdValue" />
+ An example:<br/>
+ if you want to use the panelGroup control with a predefined id,
+ you include the markup
+ <code><x:panelGroup forceId="yourIdValue"/></code>
into your JSP-file.
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/htmlEditor.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/htmlEditor.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/htmlEditor.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/htmlEditor.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Html Editor</title>
- <subtitle><x:inputHtml></subtitle>
+ <subtitle><x:inputHtml/></subtitle>
</header>
<body>
<!-- Description -->
@@ -13,7 +13,10 @@
<title>Description</title>
<p>
An inline HTML based word processor based on the Kupu library.
- See http://kupu.oscom.org
+ <br/>
+ See <link href="http://kupu.oscom.org">http://kupu.oscom.org</link>.
+ </p>
+ <p>
Right now, the support is limited to one editor per page
(but you can use tabs to have multiple editors, but only one
rendered at a time).
@@ -50,55 +53,96 @@
</tr>
</table>
</section>
- <!-- Syntax -->
+ <!-- Usage -->
<section>
- <title>Syntax</title>
- <p>
- <x:inputHtml value="String"
- style="CSSClass"
- fallback=""
- type="Constant"
- allowExternalLinks="Boolean"
- addKupuLogo="Boolean"
- showAllToolBoxes="Boolean"
- allowEditSource="Boolean"
- showPropertiesToolBox="Boolean"
- showLinksToolBox="Boolean"
- showImagesToolBox="Boolean"
- showTablesToolBox="Boolean"
- showDebugToolBox="Boolean"
- showCleanupExpressionsToolBox="Boolean"/>
- </p>
+ <title>Usage</title>
+ <source>
+<x:inputHtml value="String"
+ style="CSSClass"
+ fallback="{true|false}"
+ type="Constant"
+ allowExternalLinks="{true|false}"
+ addKupuLogo="{true|false}"
+ showAllToolBoxes="{true|false}"
+ allowEditSource="{true|false}"
+ showPropertiesToolBox="{true|false}"
+ showLinksToolBox="{true|false}"
+ showImagesToolBox="{true|false}"
+ showTablesToolBox="{true|false}"
+ showDebugToolBox="{true|false}"
+ showCleanupExpressionsToolBox="{true|false}"/>
+ </source>
</section>
- <!-- Instructions -->
+ <!-- Syntax -->
<section>
- <title>Instructions</title>
- <p>
- fallback - Use a text area instead of the javascript HTML editor.
- Default is false. Use with caution.
- type - The type of the value. It can be either fragment for an
+ <title>Syntax</title>
+ <note label="<x:inputHtml>">
+ <code>
+ fallback - Use a text area instead of the javascript HTML editor.
+ Default is false. Use with caution.
+ </code>
+ <br/>
+ <code>
+ type - The type of the value. It can be either fragment for an
HTML fragment (default) or document for a full HTML document,
with head, title, body, ... tags.
- allowEditSource - Allows the user to edit the HTML source code.
+ </code>
+ <br/>
+ <code>
+ allowEditSource - Allows the user to edit the HTML source code.
Default is true.
- allowExternalLinks - Allows the user to insert external links.
+ </code>
+ <br/>
+ <code>
+ allowExternalLinks - Allows the user to insert external links.
Default is true.
- addKupuLogo - Show the Kupu Logo in the buttons bar. Default is true.
- showAllToolBoxes - Shortcut to avoid setting all the showXXToolBox
+ </code>
+ <br/>
+ <code>
+ addKupuLogo - Show the Kupu Logo in the buttons bar. Default is true.
+ </code>
+ <br/>
+ <code>
+ showAllToolBoxes - Shortcut to avoid setting all the showXXToolBox
to true. Default is false.
- showPropertiesToolBox - Show the Properties tool box next to the text.
+ </code>
+ <br/>
+ <code>
+ showPropertiesToolBox - Show the Properties tool box next to the text.
Default is false.
- showLinksToolBox - Show the Links tool box next to the text.
+ </code>
+ <br/>
+ <code>
+ showLinksToolBox - Show the Links tool box next to the text.
Default is false.
- showImagesToolBox - Show the Images tool box next to the text.
+ </code>
+ <br/>
+ <code>
+ showImagesToolBox - Show the Images tool box next to the text.
Default is false.
- showTablesToolBox - Show the Tables tool box next to the text.
+ </code>
+ <br/>
+ <code>
+ showTablesToolBox - Show the Tables tool box next to the text.
Default is false.
- showCleanupExpressionsToolBox - Show the Cleanup Expressions tool box next to the text.
+ </code>
+ <br/>
+ <code>
+ showCleanupExpressionsToolBox - Show the Cleanup Expressions tool box next to the text.
Default is false.
- showDebugToolBox - Show the Debug tool box next to the text.
+ </code>
+ <br/>
+ <code>
+ showDebugToolBox - Show the Debug tool box next to the text.
Default is false.
-
+ </code>
+ <br/>
+ </note>
+ </section>
+ <!-- Instructions -->
+ <section>
+ <title>Instructions</title>
+ <p>
see examples/inputHtml.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/inputDate.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/inputDate.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/inputDate.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/inputDate.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Date</title>
- <subtitle><x:inputDate></subtitle>
+ <subtitle><x:inputDate/></subtitle>
</header>
<body>
<!-- Description -->
@@ -46,21 +46,29 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:inputDate type="{date|time|both}"
+ popupCalendar="{true|false}"/>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:inputDate type="Constant"
- popupCalendar="Boolean"/>
- </p>
+ <note label="<x:inputDate>">
+ <code>
+ type - defines the content type. One of these constants (date | time | both).
+ </code>
+ <br/>
+ <code>popupCalendar - if true the value can be set using a popup inputCalendar component.</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- type - defines the content type.
- one of these constants (date | time | both).
- popupCalendar - if true the value can be set using a inputCalendar component.
see examples/date.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/javascriptListener.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/javascriptListener.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/javascriptListener.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/javascriptListener.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Javascript Listener</title>
- <subtitle><x:jsValueChangeListener></subtitle>
+ <subtitle><x:jsValueChangeListener/></subtitle>
</header>
<body>
<!-- Description -->
@@ -49,22 +49,28 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:jsValueChangeListener for="Bean"
+ property="Bean"
+ expressionValue="{true|false}" />
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:jsValueChangeListener for="Bean"
- property="Bean"
- expressionValue="Boolean" />
- </p>
+ <note label="<x:jsValueChangeListener>">
+ <code>for - the control to observe.</code><br/>
+ <code>property - the property to observe.</code><br/>
+ <code>expressionValue - the condition to evaluate.</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- for - the control to observe.
- property - the property to observe.
- expressionValue - the condition to evaluate.
see examples/jslistener.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/jscookmenu.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/jscookmenu.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/jscookmenu.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/jscookmenu.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>JSCook Menu</title>
- <subtitle><x:jscookMenu/></subtitle>
+ <subtitle><x:jscookMenu/></subtitle>
</header>
<body>
<!-- Description -->
@@ -14,8 +14,7 @@
<p>
Renders a Javascript Menu based on the excellent
<link href="http://www.cs.ucla.edu/~heng/JSCookMenu">JSCookMenu</link>
- by Heng Yuan.
- Renders the nested NavigationMenuItem(s) as Javascript Menu.
+ by Heng Yuan, the nested NavigationMenuItem(s) are rendered as Javascript Menu.
</p>
</section>
<!-- screen shot -->
@@ -57,46 +56,54 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:jscookMenu [ user-role-support-attributes ]
+ [layout="values {hbr, hbl, hur, hul, vbr, vbl, vur, vul}"]
+ [theme="values {ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel}"]
+ Nested <x:navigationMenuItem> or <x:navigationMenuItems> tags (menu items)
+</x:jscookMenu>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:jscookMenu [ user-role-support-attributes ]
- [layout="values {hbr, hbl, hur, hul, vbr, vbl, vur, vul}"]
- [theme="values {ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel}"]
- Nested <x:navigationMenuItem> or <x:navigationMenuItems> tags (menu items)
- </x:jscookMenu>
- <x:navigationMenuItem> [ select-item-attributes ]
- [action="action to be invoked"]
- [icon="src attribute for the icon to display"]
- </x:navigationMenuItem>
- <x:navigationMenuItems> [ select-items-attributes ]
- </x:navigationMenuItems>
- </p>
+ <note label="<x:jscookMenu>">
+ <code>layout - hbr, hbl, hur, hul, vbr, vbl, vur, vul.</code><br/>
+ <code>theme - ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel.</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
If you want to use jscookMenu in your application, you will have to:
- Add jscookmenu directory containing css and scripting code to
- your web directory (you can find it in the examples application).
- Add scripts and stylesheets for the theme you would like to use
- to html-header (see also inc/header.inc in the examples application)
-
- <!-- JSCook Menu -->
- <script language="JavaScript" src="jscookmenu/JSCookMenu.js" type="text/javascript">
- <script language="JavaScript" src="jscookmenu/ThemeOffice/theme.js"/>
- <link rel="stylesheet" href="jscookmenu/ThemeOffice/theme.css" type="text/css"/>
- <script language="JavaScript" src="jscookmenu/ThemeMiniBlack/theme.js"/>
- <link rel="stylesheet" href="jscookmenu/ThemeMiniBlack/theme.css" type="text/css"/>
- <script language="JavaScript" src="jscookmenu/ThemeIE/theme.js"/>
- <link rel="stylesheet" href="jscookmenu/ThemeIE/theme.css" type="text/css"/>
- <script language="JavaScript" src="jscookmenu/ThemePanel/theme.js"/>
- <link rel="stylesheet" href="jscookmenu/ThemePanel/theme.css" type="text/css"/>
-
- layout - hbr, hbl, hur, hul, vbr, vbl, vur, vul.
- theme - ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel.
+ </p>
+ <ul>
+ <li>
+ Add jscookmenu directory containing css and scripting code to
+ your web directory (you can find it in the examples application).
+ </li>
+ <li>
+ Add scripts and stylesheets for the theme you would like to use
+ to html-header (see also inc/header.inc in the examples application)
+ </li>
+ </ul>
+ <source>
+<!-- JSCook Menu -->
+<script language="JavaScript" src="jscookmenu/JSCookMenu.js" type="text/javascript">
+<script language="JavaScript" src="jscookmenu/ThemeOffice/theme.js"/>
+<link rel="stylesheet" href="jscookmenu/ThemeOffice/theme.css" type="text/css"/>
+<script language="JavaScript" src="jscookmenu/ThemeMiniBlack/theme.js"/>
+<link rel="stylesheet" href="jscookmenu/ThemeMiniBlack/theme.css" type="text/css"/>
+<script language="JavaScript" src="jscookmenu/ThemeIE/theme.js"/>
+<link rel="stylesheet" href="jscookmenu/ThemeIE/theme.css" type="text/css"/>
+<script language="JavaScript" src="jscookmenu/ThemePanel/theme.js"/>
+<link rel="stylesheet" href="jscookmenu/ThemePanel/theme.css" type="text/css"/>
+ </source>
+ <p>
see examples/jscookmenu.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/newspaperTable.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/newspaperTable.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/newspaperTable.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/newspaperTable.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Newspaper Table</title>
- <subtitle><x:newspaperTable></subtitle>
+ <subtitle><x:newspaperTable/></subtitle>
</header>
<body>
<!-- Description -->
@@ -54,24 +54,33 @@
<section>
<title>Usage</title>
<source>
- <x:newspaperTable newspaperColumns="3" value="#{addressBB.states}" var="state">
- <f:facet name="spacer"><f:verbatim>&#160;</f:verbatim></f:facet>
- <h:column>
- <h:outputText value="#{state.abbr}"/>
- </h:column>
- <h:column>
- <h:outputText value="#{state.name}"/>
- </h:column>
- </x:newspaperTable>
+<x:newspaperTable newspaperColumns="3" value="#{addressBB.states}" var="state">
+ <f:facet name="spacer"><f:verbatim>&#160;</f:verbatim></f:facet>
+ <h:column>
+ <h:outputText value="#{state.abbr}"/>
+ </h:column>
+ <h:column>
+ <h:outputText value="#{state.name}"/>
+ </h:column>
+</x:newspaperTable>
</source>
</section>
-
+
+ <!-- Syntax -->
+ <section>
+ <title>Syntax</title>
+ <note label="<x:newspaperTable>">
+ <code>
+ newspaperColumns - The number of columns to wrap the table over. Default: 1
+ </code>
+ <br/>
+ </note>
+ </section>
+
<!-- Additional Information -->
<section>
<title>Additional Information</title>
<p>
- newspaperColumns - The number of columns to wrap the table over.
- Default: 1
see examples/newspaperTable.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/panelNavigation.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/panelNavigation.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/panelNavigation.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/panelNavigation.xml Mon Jul 11 14:57:41 2005
@@ -11,7 +11,7 @@
<!-- ex. JSCook Menu -->
<title>Panel Navigation</title>
<!-- ex. <x:jsCookMenu> -->
- <subtitle><x:panelNavigation></subtitle>
+ <subtitle><x:panelNavigation/></subtitle>
</header>
<body>
<!-- Description -->
@@ -61,24 +61,40 @@
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:panelNavigation [ standard HTML table attributes ]
+ [itemClass="normal-menu-item-css-class"]
+ [openItemClass="open-menu-item-css-class"]
+ [activeItemClass="active-menu-item-css-class"]
+ [separatorClass="separator-css-class"]
+ [itemStyle="normal-menu-item-css-style"]
+ [openItemStyle="open-menu-item-css-style"]
+ [activeItemStyle="active-menu-item-css-style"]
+ [separatorStyle="separator-css-style"]>
+ Nested <x:commandNavigation> tags (menu items) and output components (separat
+</x:panelNavigation>
+ </source>
+ </section>
+
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:panelNavigation [ standard HTML table attributes ]
- [itemClass="normal-menu-item-css-class"]
- [openItemClass="open-menu-item-css-class"]
- [activeItemClass="active-menu-item-css-class"]
- [separatorClass="separator-css-class"]
- [itemStyle="normal-menu-item-css-style"]
- [openItemStyle="open-menu-item-css-style"]
- [activeItemStyle="active-menu-item-css-style"]
- [separatorStyle="separator-css-style"]>
- Nested <x:commandNavigation> tags (menu items) and output components (separat
- </x:panelNavigation>
- </p>
+ <note label="<x:panelNavigation>">
+ <code>[ standard HTML table attributes ]</code><br/>
+ <code>[itemClass="normal-menu-item-css-class"]</code><br/>
+ <code>[openItemClass="open-menu-item-css-class"]</code><br/>
+ <code>[activeItemClass="active-menu-item-css-class"]</code><br/>
+ <code>[separatorClass="separator-css-class"]</code><br/>
+ <code>[itemStyle="normal-menu-item-css-style"]</code><br/>
+ <code>[openItemStyle="open-menu-item-css-style"]</code><br/>
+ <code>[activeItemStyle="active-menu-item-css-style"]</code><br/>
+ <code>[separatorStyle="separator-css-style"]</code><br/>
+ </note>
</section>
-
+
<!-- Instructions -->
<section>
<title>Instructions</title>
Modified: myfaces/forrest/trunk/content/xdocs/components/panelStack.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/panelStack.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/panelStack.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/panelStack.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Panel Stack</title>
- <subtitle><x:panelStack></subtitle>
+ <subtitle><x:panelStack/></subtitle>
</header>
<body>
<!-- Description -->
@@ -49,20 +49,26 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:panelStack id="String"
+ selectedPanel="String">
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:panelStack id="String"
- selectedPanel="String">
- </p>
+ <note label="<x:panelStack>">
+ <code>selectedPanel - Id of the child to be rendered.</code><br/>
+ <code>id - id of the stack.</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- selectedPanel - Id of the child to be rendered.
- id - id of the stack.
see examples/panelStack.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/popup.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/popup.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/popup.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/popup.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Popup</title>
- <subtitle><x:popup></subtitle>
+ <subtitle><x:popup/></subtitle>
</header>
<body>
<!-- Description -->
@@ -46,47 +46,68 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:popup styleClass="CSSClass"
+ closePopupOnExitingElement="{true|false}"
+ closePopupOnExitingPopup="{true|false}"
+ displayAtDistanceX="int"
+ displayAtDistanceY="int">
+ <h:outputText value="String"/>
+ <f:facet name="String">
+ <h:panelGroup>
+ <h:panelGrid columns="int">
+ <h:outputText value="String"/>
+ </h:panelGrid>
+ </h:panelGroup>
+ </f:facet>
+</x:popup>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:popup styleClass="CSSClass"
- closePopupOnExitingElement="Boolean"
- closePopupOnExitingPopup="Boolean"
- displayAtDistanceX="int"
- displayAtDistanceY="int">
- <h:outputText value="String"/>
- <f:facet name="String">
- <h:panelGroup>
- <h:panelGrid columns="int">
- <h:outputText value="String"/>
- </h:panelGrid>
- </h:panelGroup>
- </f:facet>
- </x:popup>
- </p>
+ <note label="<x:popup>">
+ <code>
+ styleClass - styleClass for popup. Attention! do not try to
+ overwrite position:absolute; and display:none;
+ Provide a padding for Mozilla-based Browsers
+ </code>
+ <br/>
+ <code>
+ style - style for popup. Attention! do not try to overwrite
+ position:absolute; and display:none;
+ Provide a padding for Mozilla-based Browsers
+ </code>
+ <br/>
+ <code>
+ displayAtDistanceX - Pop the panel up in horizontal distance
+ of x pixels from event.
+ </code>
+ <br/>
+ <code>
+ displayAtDistanceX - Pop the panel up in vertical distance of
+ y pixels from event.
+ </code>
+ <br/>
+ <code>
+ closePopupOnExitingElement - Close the popup when the triggering
+ element is left.
+ </code>
+ <br/>
+ <code>
+ closePopupOnExitingPopup - Close the popup when the popup itself
+ is left.
+ </code>
+ <br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- styleClass - styleClass for popup.
- Attention! do not try to overwrite position:absolute;
- and display:none;
- Provide a padding for Mozilla-based Browsers
- style - style for popup.
- Attention! do not try to overwrite position:absolute;
- and display:none;
- Provide a padding for Mozilla-based Browsers
- displayAtDistanceX - Pop the panel up in horizontal distance of
- x pixels from event.
- displayAtDistanceX - Pop the panel up in vertical distance of
- y pixels from event.
- closePopupOnExitingElement - Close the popup when the triggering
- element is left.
- closePopupOnExitingPopup - Close the popup when the popup itself
- is left.
-
see examples/popup.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/rssTicker.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/rssTicker.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/rssTicker.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/rssTicker.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>RSS Ticker</title>
- <subtitle><x:rssTicker></subtitle>
+ <subtitle><x:rssTicker/></subtitle>
</header>
<body>
<!-- Description -->
@@ -54,20 +54,26 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:rssTicker [rssUrl]
+ [ HTML universal attributes ]/>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:rssTicker rssUrl
- [ HTML universal attributes ]/>
- </p>
+ <note label="<x:rssTicker>">
+ <code>rssUrl - URL on which the rss-information is available.</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
Enter the url of a rss-source into attribute rssUrl.
- rssUrl - URL on which the rss-information is available.
</p>
</section>
</body>
Modified: myfaces/forrest/trunk/content/xdocs/components/stylesheet.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/stylesheet.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/stylesheet.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/stylesheet.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Style Sheet</title>
- <subtitle><x:stylesheet></subtitle>
+ <subtitle><x:stylesheet/></subtitle>
</header>
<body>
<!-- Description -->
@@ -49,18 +49,24 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:stylesheet path="String"/>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:stylesheet path="String"/>
- </p>
+ <note label="<x:stylesheet>">
+ <code>path - URL for CSS-file.</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- path - URL for CSS-file.
see examples/css.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/tabbedPane.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/tabbedPane.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/tabbedPane.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/tabbedPane.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Tabbed Pane</title>
- <subtitle><x:tabbedPane></subtitle>
+ <subtitle><x:tabbedPane/></subtitle>
</header>
<body>
<!-- Description -->
@@ -46,35 +46,40 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:panelTabbedPane selectedIndex="int"
+ activeTabStyleClass="CSSClass"
+ inactiveTabStyleClass="CSSClass"
+ disabledTabStyleClass="CSSClass"
+ activeSubStyleClass="CSSClass"
+ inactiveSubStyleClass="CSSClass"
+ tabContentStyleClass="CSSClass">
+ <x:panelTab ...>
+ ...(anyComponents)...
+ </x:panelTab>
+</x:panelTabbedPane>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:panelTabbedPane selectedIndex="int"
- activeTabStyleClass="CSSClass"
- inactiveTabStyleClass="CSSClass"
- disabledTabStyleClass="CSSClass"
- activeSubStyleClass="CSSClass"
- inactiveSubStyleClass="CSSClass"
- tabContentStyleClass="CSSClass">
- <x:panelTab ...>
- ...(anyComponents)...
- </x:panelTab>
- </x:panelTabbedPane>
- </p>
+ <note label="<x:panelTabbedPane>">
+ <code>selectedIndex - Index of tab that is selected by default.</code><br/>
+ <code>activeTabStyleClass - Style class of the active tab cell.</code><br/>
+ <code>inactiveTabStyleClass - Style class of the inactive tab cells.</code><br/>
+ <code>disabledTabStyleClass - Style class of the disabled tab cells.</code><br/>
+ <code>activeSubStyleClass - Style class of the active tab sub cell.</code><br/>
+ <code>inactiveSubStyleClass - Style class of the inactive tab sub cells.</code><br/>
+ <code>tabContentStyleClass - Style class of the active tab content cell.</code><br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- selectedIndex - Index of tab that is selected by default.
- activeTabStyleClass - Style class of the active tab cell.
- inactiveTabStyleClass - Style class of the inactive tab cells.
- disabledTabStyleClass - Style class of the disabled tab cells.
- activeSubStyleClass - Style class of the active tab sub cell.
- inactiveSubStyleClass - Style class of the inactive tab sub cells.
- tabContentStyleClass - Style class of the active tab content cell.
-
see examples/tabbedPane.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/tiles.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/tiles.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/tiles.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/tiles.xml Mon Jul 11 14:57:41 2005
@@ -41,41 +41,40 @@
<!-- Instructions -->
<section>
<title>Instructions</title>
- <ul>
- <li>Configure the JspTilesViewHandler in your faces-config: </li>
- </ul>
- <source>
- <application>
- <view-handler>org.apache.myfaces.application.jsp.JspTilesViewHandlerImpl<view-handler>
- </application>
- </source>
- <ul>
- <li>Add the following lines to your web.xml: </li>
- </ul>
- <source>
- <context-param>
- <param-name>tiles-definitions</param-name>
- <param-value>/WEB-INF/tiles.xml</param-value>
- </context-param>
- </source>
- <ul>
- <li>Define your layout in a tiles-definition file</li>
- </ul>
- <ul>
- <li>When rendering the view, the JspTilesViewHandlerImpl will take the given viewId and compute a tileId by:</li>
- <ul>
- <li>Substituting any extension by ".tiles"</li>
- </ul>
- <ul>
- <li>Appending ".tiles" if path-mapping is used</li>
- </ul>
- </ul>
- <ul>
+ <ol>
+ <li>
+ Configure the JspTilesViewHandler in your faces-config:
+ <source>
+<application>
+ <view-handler>org.apache.myfaces.application.jsp.JspTilesViewHandlerImpl<view-handler>
+</application>
+ </source>
+ </li>
<li>
- Next the ViewHanlder looks up in the tile-definitions for the corresponding definition.
- (eg. for viewId = /page1.jsp the lookup would be /page1.tiles)
+ Add the following lines to your web.xml:
+ <source>
+<context-param>
+ <param-name>tiles-definitions</param-name>
+ <param-value>/WEB-INF/tiles.xml</param-value>
+</context-param>
+ </source>
</li>
+ <li>
+ Define your layout in a tiles-definition file
+ </li>
+ </ol>
+ <p>
+ When rendering the view, the JspTilesViewHandlerImpl will take
+ the given viewId and compute a tileId by:
+ </p>
+ <ul>
+ <li>Substituting any extension by ".tiles"</li>
+ <li>Appending ".tiles" if path-mapping is used</li>
</ul>
+ <p>
+ Next the ViewHandler looks up in the tile-definitions for the corresponding definition.
+ (eg. for viewId = /page1.jsp the lookup would be /page1.tiles)
+ </p>
</section>
</body>
<footer>
Modified: myfaces/forrest/trunk/content/xdocs/components/tree.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/tree.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/tree.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/tree.xml Mon Jul 11 14:57:41 2005
@@ -5,7 +5,7 @@
<!-- component name -->
<header>
<title>Tree</title>
- <subtitle><x:tree></subtitle>
+ <subtitle><x:tree/></subtitle>
</header>
<body>
<!-- Description -->
@@ -46,49 +46,57 @@
</tr>
</table>
</section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+ value="TreeModel"
+ styleClass="CSSClass"
+ nodeClass="CSSClass"
+ selectedNodeClass="CSSClass"
+ expandRoot="{true|false}">
+</x:tree>
+ </source>
+ </section>
<!-- Syntax -->
<section>
<title>Syntax</title>
- <p>
- <x:tree value="TreeModel"
- styleClass="CSSClass"
- nodeClass="CSSClass"
- selectedNodeClass="CSSClass"
- expandRoot="Boolean">
- </x:tree>
- </p>
+ <note label="<x:tree>">
+ <code>value - the tree model.</code><br/>
+ <code>var - a variable to hold current selection.</code><br/>
+ <code>styleClass - CSSClass for tree.</code><br/>
+ <code>nodeClass - CSSClass for tree nodes.</code><br/>
+ <code>selectedNodeClass - CSSClass for selected tree node.</code><br/>
+ <code>headerClass - CSSClass for header.</code><br/>
+ <code>footerClass - CSSClass for footer.</code><br/>
+ <code>rowClasses - CSSClass for rows.</code><br/>
+ <code>columnClasses - CSSClass for columns.</code><br/>
+ <code>iconClass - CSSClass for icons.</code><br/>
+ <code>iconLine - the icon for node with line.</code><br/>
+ <code>iconNoline - the icon for node with no line.</code><br/>
+ <code>iconChildFirst - the icon for first child.</code><br/>
+ <code>iconChildMiddle - the icon for middle child.</code><br/>
+ <code>iconChildLast - the icon for last child.</code><br/>
+ <code>iconNodeOpen - the icon for expanded node.</code><br/>
+ <code>iconNodeOpenFirst - the icon for first expanded node.</code><br/>
+ <code>iconNodeOpenMiddle - the icon for middle expanded node.</code><br/>
+ <code>iconNodeOpenLast - the icon for last expanded node.</code><br/>
+ <code>iconNodeClose - the icon for collapsed node.</code><br/>
+ <code>iconNodeCloseFirst - the icon for first collapsed node.</code><br/>
+ <code>iconNodeCloseMiddle - the icon for middle collapsed node.</code><br/>
+ <code>iconNodeCloseLast - the icon for last collapsed node.</code><br/>
+ <code>expandRoot - if true root node is expanded.</code><br/>
+ <code>
+ expireListeners - Time interval the tree will remain registered
+ as a TreeModelListener without being accessed.
+ </code>
+ <br/>
+ </note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>
- value - the tree model.
- var - a variable to hold current selection.
- styleClass - CSSClass for tree.
- nodeClass - CSSClass for tree nodes.
- selectedNodeClass - CSSClass for selected tree node.
- headerClass - CSSClass for header.
- footerClass - CSSClass for footer.
- rowClasses - CSSClass for rows.
- columnClasses - CSSClass for columns.
- iconClass - CSSClass for icons.
- iconLine - the icon for node with line.
- iconNoline - the icon for node with no line.
- iconChildFirst - the icon for first child.
- iconChildMiddle - the icon for middle child.
- iconChildLast - the icon for last child.
- iconNodeOpen - the icon for expanded node.
- iconNodeOpenFirst - the icon for first expanded node.
- iconNodeOpenMiddle - the icon for middle expanded node.
- iconNodeOpenLast - the icon for last expanded node.
- iconNodeClose - the icon for collapsed node.
- iconNodeCloseFirst - the icon for first collapsed node.
- iconNodeCloseMiddle - the icon for middle collapsed node.
- iconNodeCloseLast - the icon for last collapsed node.
- expandRoot - if true root node is expanded.
- expireListeners - Time interval the tree will remain registered
- as a TreeModelListener without being accessed.
-
see examples/tree.jsp for an example!
</p>
</section>
Modified: myfaces/forrest/trunk/content/xdocs/components/tree2.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/tree2.xml?rev=215888&r1=215887&r2=215888&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/tree2.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/tree2.xml Mon Jul 11 14:57:41 2005
@@ -9,7 +9,7 @@
<!-- component name -->
<header>
<title>Tree2</title>
- <subtitle><x:tree2/></subtitle>
+ <subtitle><x:tree2/></subtitle>
</header>
<body>
<!-- Description -->
@@ -55,51 +55,61 @@
</tr>
</table>
</section>
+
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:tree2 value="TreeModel"
+ var="String"
+ varNodeToggler="String">
+ ...(anyComponent)...
+</x:tree2>
+ </source>
+ </section>
+
<!-- Syntax -->
-<!--
<section>
<title>Syntax</title>
- <note label="<x:tree2>">
+ <note label="<x:tree2>">
<code>id</code><br/>
- <code>clientSideToggle [true|false] (default=true)</code><br/>
+ <code>
+ clientSideToggle [true|false] (default=true) -
+ Perform client-side toggling of expand/collapse
+ state via javascript (default is true.)
+ </code>
+ <br/>
<code>imageLocation</code><br/>
<code>javascriptLocation</code><br/>
- <code>showLines [true|false] (default=true)</code><br/>
- <code>showNav [true|false] (default=true)</code><br/>
- <code>showRootNode [true|false] (default=true)</code><br/>
+ <code>showLines [true|false] (default=true) - Show the connecting lines (default is true.)</code><br/>
+ <code>
+ showNav [true|false] (default=true) -
+ Show the "plus" and "minus" navigation icons (default is true.),
+ Value is ignored if clientSideToggle is true.
+ </code>
+ <br/>
+ <code>
+ showRootNode [true|false] (default=true) -
+ Include the root node when rendering the tree (default is true.)
+ </code>
+ <br/>
<code>styleLocation</code><br/>
- <code>value [value binding expression] (required)</code><br/>
- <code>var</code><br/>
+ <code>value [value binding expression] (required) - the tree model.</code><br/>
+ <code>var - the variable to hold current selection.</code><br/>
<code>varNodeToggler</code><br/>
+ <code>
+ preserveToggle - Preserve changes in client-side toggle information
+ between requests (default is true.)
+ </code>
+ <br/>
</note>
</section>
--->
- <!-- Usage -->
- <section>
- <title>Usage</title>
- <p><x:tree2 value="TreeModel"
- var="String"
- varNodeToggler="String">
- ...(anyComponent)...
- </x:tree2>
- </p>
- </section>
-
+
<!-- Instructions -->
<section>
- <title>Additional Informaiton</title>
+ <title>Instructions</title>
<p>
- value - the tree model.
- var - the variable to hold current selection.
- varNodeToggler - .
- showNav - Show the "plus" and "minus" navigation icons (default is true.)
- Value is ignored if clientSideToggle is true.
- showLines - Show the connecting lines (default is true.)
- clientSideToggle - Perform client-side toggling of expand/collapse
- state via javascript (default is true.)
- showRootNode - Include the root node when rendering the tree (default is true.)
- preserveToggle - Preserve changes in client-side toggle information
- between requests (default is true.)
+ see examples/tree2.jsp for an example!
</p>
</section>
</body>