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 2006/01/01 22:43:10 UTC
svn commit: r360558 [2/3] - in /myfaces/tomahawk/trunk: ./ src/site/
src/site/apt/ src/site/fml/ src/site/resources/ src/site/resources/css/
src/site/resources/images/ src/site/xdoc/
Added: myfaces/tomahawk/trunk/src/site/xdoc/dataList.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/dataList.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/dataList.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/dataList.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ Similar to dataTable, but does not render a table. Instead the layout
+ attribute controls how each dataRow is rendered.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/datalist.png" alt="datalist"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Data</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.List</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.datalist.HtmlDataList</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.datalist.HtmlListRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.datalist.HtmlDataListTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t:dataList id="String"
+ styleClass="CSSClass1"
+ itemStyleClass="CSSClass2"
+ var="String"
+ value="List"
+ layout="Constant"
+ rowCountVar="int"
+ rowIndexVar="int">
+ <h:outputText .../>
+</t:dataList>
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:dataList/></h3>
+ <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>
+ styleClass - The CSS class used to style the list
+ </code>
+ <br/>
+ <code>
+ itemStyleClass - The CSS class used to style each element of the list (not applicable
+ when layout = 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/>
+ </blockquote>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ see examples/dataList.jsp for an example!
+ </p>
+ </section>
+ </body>
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/dataList.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/dataList.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/dataScroller.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/dataScroller.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/dataScroller.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/dataScroller.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <!--
+This is a standard template meant to be used for the documentation of all custom
+components.
+--><document>
+ <body>
+ <section name="Description">
+
+ <p>
+A component to run over the pages of an UIData (eg. <h:dataTable>).
+ </p>
+ <p>
+Renders a DataScroller, which should work with any UIData. The facets are getting rendered in the following order: first, fastrewind, previous, next, fastforward, last
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/datascroller.png" alt="DataScroller"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Panel</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.DataScroller</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.datascroller.HtmlDataScroller</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.datascroller.HtmlDataScrollerRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.datascroller.HtmlDataScrollerTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t: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
+</t:dataScroller>
+ </source>
+ </section>
+
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:dataScroller></h3>
+ <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/>
+ </blockquote>
+ </section>
+
+ <!-- Additional Information -->
+ <section name="Additional Information">
+
+ <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 "row" attribute must be specified on the corresponding uiData.
+ <br/>
+ The scope of pageIndexVar and pageCountVar is limited, and only
+ direct children of DataScroller may see them.
+ </p>
+ </section>
+
+ </body>
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/dataScroller.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/dataScroller.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/extDataTable.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/extDataTable.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/extDataTable.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/extDataTable.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,201 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <!--
+This is a standard template meant to be used for the documentation of all custom
+components.
+--><document>
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ The MyFacesDataTable extends the standard JSF DataTable by two important features:
+ </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.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/datatable.png" alt="datatable"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Data</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.Table</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.component.html.ext.HtmlDataTable</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.renderkit.html.ext.HtmlTableRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.taglib.html.ext.HtmlDataTableTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t:dataTable [ all standard dataTable attributes allowed ]
+ [ preserveDataModel="{true|false}" ]
+ [ forceIdIndexFormula="value-binding" ]
+ [ sortColumn="value-binding" ]
+ [ sortAscending="value-binding" ]
+ [ preserveSort="{true|false}" ]
+ [ renderedIfEmpty="{true|false}" ]
+ [ rowIndexVar="variable name" ]
+ [ rowCountVar="variable name" ]
+ [ previousRowDataVar="variable name" ]
+ [ rowId="value-binding" ]
+ [ rowStyleClass="css styleclass" ]
+ [ rowStyle="inline css style" ]
+ [ rowOnClick="javascript" ]
+ [ rowOnDblClick="javascript" ]
+ [ rowOnMouseDown="javascript" ]
+ [ rowOnMouseUp="javascript" ]
+ [ rowOnMouseOver="javascript" ]
+ [ rowOnMouseMove="javascript" ]
+ [ rowOnMouseOut="javascript" ]
+ [ rowOnKeyPress="javascript" ]
+ [ rowOnKeyDown="javascript" ]
+ [ rowOnKeyUp="javascript" ] >
+ standard dataTable body (<h:column> tags
+ and optional "header" and "footer" facets)
+ <t:column>
+ <t:columns>
+ <t:command_sortheader/> inside column header or footer
+<t:dataTable>
+ </source>
+ </section>
+
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:dataTable></h3>
+ <code>all standard dataTable attributes allowed</code><br/>
+ <code>preserveDataModel="{true|false}"</code><br/>
+ <code>forceIdIndexFormula="value-binding"</code><br/>
+ <code>sortColumn="value-binding"</code><br/>
+ <code>sortAscending="value-binding"</code><br/>
+ <code>preserveSort="{true|false}"</code><br/>
+ <code>renderedIfEmpty="{true|false}"</code> - Indicates whether this
+ table should be rendered if the underlying DataModel is empty.<br/>
+ <code>rowIndexVar="variable name"</code> - A parameter name, under
+ which the current rowIndex is set in request scope similar to the
+ var parameter.<br/>
+ <code>rowCountVar="variable name"</code> - A parameter name,
+ under which the rowCount is set in request scope similar to the
+ var parameter.<br/>
+ <code>previousRowDataVar="variable name"</code> - A parameter name,
+ under which the previous RowData Object is set in request scope
+ similar to the rowIndexVar and rowCountVar parameters.<br/>
+ <code>rowId="value-binding"</code> - The id to use for <tr>
+ elements that are generated by the table.<br/>
+
+ <code>rowStyleClass="css style class"</code> - the style class to use for <tr>
+ elements that are generated by the table. Can be a value-binding
+ to assign row-data specific style classes<br/>
+ <code>rowStyle="inline css style"</code> - inline style to use for <tr>
+ elements that are generated by the table. Can be a value-binding
+ to assign row-data specific style<br/>
+ <br/>
+ Each event handler must evaluate to a javascript code which is
+ executed on the client side. The event handler are used for the
+ <tr> tag of the row.<br/>
+ You can use value-bindings for row specific event handler.<br/>
+ <code>rowOnClick="javascript"</code><br/>
+ <code>rowOnDblClick="javascript"</code><br/>
+ <code>rowOnMouseDown="javascript"</code><br/>
+ <code>rowOnMouseUp="javascript"</code><br/>
+ <code>rowOnMouseOver="javascript"</code><br/>
+ <code>rowOnMouseMove="javascript"</code><br/>
+ <code>rowOnMouseOut="javascript"</code><br/>
+ <code>rowOnKeyPress="javascript"</code><br/>
+ <code>rowOnKeyDown="javascript"</code><br/>
+ <code>rowOnKeyUp="javascript"</code><br/>
+ </blockquote>
+ </section>
+
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ <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.
+ </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.
+ </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,
+ </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.
+ </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>
+ <p>
+ <strong>Working with a changing data - the forceIdIndexFormula attribute</strong><br/>
+ The default table assumes that your backing data collection is stable between 2 requests.
+ This assumption can be false in several cases: concurrent accesses, unstable backing data collection order, ...
+ If you have components within that table that update your data, you will get unintended behaviors.<br/>
+ This attribute is meant to fix that problem.<br/>
+ The table's components and the backing data objects are linked by the table's components' ids.
+ By default the changing part of those ids is the row number.
+ So if the backing data positions in the list is changed between the 2 requests
+ (like an element inserted in the head of the list), you will update the wrong element in the
+ backing data's collection.<br/>
+ To fix this, you can set the forceIdIndexFormula to an EL that will be unique and stable for each row.
+ That way, even if your backing data list changes between 2 requests, you always update the intended
+ element in the list.<br/>
+ <br/>
+ Example : <t:dataTable value="#{mailDAO.userInbox}" var="email" forceIdIndexFormula="#{email.primaryKey}" ...> ...
+ <br/>
+ <br/>
+ Warning : make sure that the value-binding evaluates to a unique value for each row.
+ </p>
+ </section>
+
+ </body>
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/extDataTable.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/extDataTable.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/extensionsFilter.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/extensionsFilter.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/extensionsFilter.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/extensionsFilter.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+
+<body>
+
+<section name="What is the Extensions Filter for?">
+
+ <p>
+ Some MyFaces components do more than include some HTML in the pages.
+ They may need additional support scripts, style sheets, images, ...<br/>
+ Those resources are included in the MyFaces' jar file and the Extensions Filter add
+ the code and URL needed to provide those resources to the generated HTML.
+ </p>
+ <p>
+ Some other components, like the file upload component (t:inputFileUpload) need to parse
+ Multipart requests.<br/>
+ The extensions filter handles this as well.
+ </p>
+</section>
+<section name="Why is this useful?">
+ <p>
+
+ This design has several benefits :</p>
+ <ol>
+ <li>It provides a clean separation between MyFaces' components and your webapp.</li>
+ <li>You don't have to include additional MyFaces' components related code or resources in your pages or webapp.</li>
+ <li>It provides great flexibility to the MyFaces' team upgrade the components, while keeping transparent backward compatibility.</li>
+ <li>It makes it possible for complex components to use many support resources without any burden on the page developer.</li>
+ <li>It loads only the resources really useful for the rendered components.</li>
+ <li>It handles the MyFaces' resources caching.</li>
+ </ol>
+</section>
+<section name="How does it work?">
+
+<p> When a component needs a resource, is calls one of the org.apache.myfaces.component.html.util.AddResource methods
+ (for example AddResource.addJavaScriptToHeader(InputHtmlRenderer.class, "sarissa.js", context); ).<br/>
+ This method add an attribute to the request so that the filter knows that is must include the given javascript, stylesheet
+ or resource link to the page.<br/>
+ The code for this resource is automatically included in the generated HTML.<br/>
+ The URL for an embedded resource is constructed and always begins by /myfaces/ so that it can be intercepted by the filter
+ when the client need to load the resource.<br/>
+ When the clients fetches the resource, the filter decodes the URL, and serves the proper resource that is
+ embedded in MyFaces' jar.</p>
+</section>
+<section name="How do I configure it?">
+ <p>
+ In your web.xml, map this filter to the path used for the JSF pages (most likely *.jsf)
+ AND to the /faces/* path as in the following example :</p>
+ <source xml:space="preserve">
+
+<filter>
+ <filter-name>MyFacesExtensionsFilter</filter-name>
+ <filter-class>org.apache.myfaces.component.html.util.ExtensionsFilter</filter-class>
+ <init-param>
+ <param-name>maxFileSize</param-name>
+ <param-value>20m</param-value>
+ <description>Set the size limit for uploaded files.
+ Format: 10 - 10 bytes
+ 10k - 10 KB
+ 10m - 10 MB
+ 1g - 1 GB
+ </description>
+ </init-param>
+</filter>
+
+
+<filter-mapping>
+ <filter-name>MyFacesExtensionsFilter</filter-name>
+ <url-pattern>*.jsf</url-pattern>
+</filter-mapping>
+<filter-mapping>
+ <filter-name>MyFacesExtensionsFilter</filter-name>
+ <url-pattern>/faces/*</url-pattern>
+</filter-mapping>
+ </source>
+</section>
+<section name="Under what circumstances am I *required* to use the extensions filter?">
+ <p>
+ If you just use standard JSF component, but don't use any MyFaces' extended component (beginning with t:),
+ then you don't need the Extensions Filter.<br/>
+ However, if you use some of the MyFaces' extended components like t:inputFileUpload, t:inputHTtml, t:inputCalendar, ...
+ then you most likely need to have this filter configured in your webapp.
+</p>
+</section>
+<section name="Does this impact performance?">
+ <p>
+ The filter hasn't any significant impact the response time.<br/>
+ However, as the filter has to cache the whole response in memory before writing it out to the client, it slightly increases the memory usage.
+</p></section>
+</body>
+
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/extensionsFilter.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/extensionsFilter.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/fileUpload.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/fileUpload.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/fileUpload.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/fileUpload.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <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".
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <p>Not available</p> <!-- replace with either a figure or Not Available -->
+ <!--
+ <figure src="jscookmenu.png" alt="jscookmenu"/>
+ -->
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">since</td>
+ <td colspan="1" rowspan="1">0.3.2 (former <t:file_upload>)</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">author</td>
+ <td colspan="1" rowspan="1">Manfred Geiler, Sylvain Vieujot</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Input</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.FileUpload</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.fileupload.HtmlInputFileUpload</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.fileupload.HtmlFileUploadRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.fileupload.HtmlInputFileUploadTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t:inputFileUpload [{all standard UIInput and HTML input attributes}]
+ [accept="mime-type"] />
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:inputFileUpload></h3>
+ <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/>
+ </blockquote>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ see "examples/fileupload.jsp" for an example!
+ </p>
+ </section>
+ </body>
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/fileUpload.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/fileUpload.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/forceId.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/forceId.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/forceId.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/forceId.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <!--
+This is a standard template meant to be used for the documentation of all custom
+components.
+--><document>
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ The forceId attribute allows you to set
+ the id of a component to a fixed value.
+ This can be useful if you want to heavily use
+ (or reuse your preexisting) JavaScript libraries
+ or CSS-styles.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <p>Not available</p> <!-- replace with either a figure or Not Available -->
+ <!--
+ <figure src="jscookmenu.png" alt="jscookmenu"/>
+ -->
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">attribute forceId</td>
+ <td colspan="1" rowspan="1">
+ On all MyFaces extended and custom components (all components
+ in the extended taglib, usually prefixed with an 't')
+ the forceId attribute can be set to the desired id-value.
+ </td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<(anyCustomComponent) forceId="yourIdValue"/>
+ </source>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ An example:<br/>
+ if you want to use the panelGroup control with a predefined id of "foo",
+ you include the markup
+ <code><t:panelGroup id="foo" forceId="true"/></code>
+ into your JSP-file.
+ </p>
+ </section>
+ </body>
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/forceId.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/forceId.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/htmlEditor.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/htmlEditor.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/htmlEditor.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/htmlEditor.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,148 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ An inline HTML based word processor based on the Kupu library.
+ <br/>
+ See <a href="http://kupu.oscom.org">http://kupu.oscom.org</a>.
+ </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).
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/inputhtml.png" alt="inputhtml"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Input</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.InputHtml</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.inputHtml.InputHtml</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.inputHtml.InputHtmlRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.inputHtml.InputHtmlTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t: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>
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:inputHtml></h3>
+ <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.
+ </code>
+ <br/>
+ <code>
+ allowEditSource - Allows the user to edit the HTML source code.
+ Default is true.
+ </code>
+ <br/>
+ <code>
+ allowExternalLinks - Allows the user to insert external links.
+ Default is true.
+ </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.
+ </code>
+ <br/>
+ <code>
+ showPropertiesToolBox - Show the Properties tool box next to the text.
+ Default is false.
+ </code>
+ <br/>
+ <code>
+ showLinksToolBox - Show the Links tool box next to the text.
+ Default is false.
+ </code>
+ <br/>
+ <code>
+ showImagesToolBox - Show the Images tool box next to the text.
+ Default is false.
+ </code>
+ <br/>
+ <code>
+ showTablesToolBox - Show the Tables tool box next to the text.
+ Default is false.
+ </code>
+ <br/>
+ <code>
+ showCleanupExpressionsToolBox - Show the Cleanup Expressions tool box next to the text.
+ Default is false.
+ </code>
+ <br/>
+ <code>
+ showDebugToolBox - Show the Debug tool box next to the text.
+ Default is false.
+ </code>
+ <br/>
+ </blockquote>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ see examples/inputHtml.jsp for an example!
+ </p>
+ </section>
+ </body>
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/htmlEditor.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/htmlEditor.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/htmlTag.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/htmlTag.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/htmlTag.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/htmlTag.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ Renders any HTML tag as specified in value attribute.
+ </p>
+
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <p>Not available</p> <!-- replace with either a figure or Not Available -->
+ <!--
+ <figure src="jscookmenu.png" alt="jscookmenu"/>
+ -->
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">since</td>
+ <td colspan="1" rowspan="1">1.1.0</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">author</td>
+ <td colspan="1" rowspan="1">Sylvain Vieujot</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Output</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">"org.apache.myfaces.HtmlTagRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.htmlTag.HtmlTag</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.htmlTag.HtmlTagRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.htmlTag.HtmlTagTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t:htmlTag [{all standard UIOutput attributes}] />
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:htmlTag></h3>
+ <code>value - the tag to output.</code><br/>
+ </blockquote>
+ </section>
+ <!-- Instructions -->
+ <section name="Example">
+
+ <p>
+<t:htmlTag value="br" />
+ </p>
+ <p>
+OR<br/>
+<t:htmlTag value="div" >
+[Other JSF tags/content]
+</t:htmlTag>
+ </p>
+ </section>
+ </body>
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/htmlTag.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/htmlTag.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/index.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/index.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/index.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+
+<body>
+
+ <section name="Custom Components">
+
+ <p>
+ See also the component section of our <a href="http://wiki.apache.org/myfaces/MyFacesComponents">WIKI</a>
+ (might be more complete than the information here).
+ </p>
+ <p>
+ MyFaces provides a series of JSF components that go beyond the JSF specification. These components are 100% compatible
+ with the Sun JSF 1.1 Reference Implementation (RI) or any other JSF 1.1 compatible implementation. Of course the custom
+ components can also be used with the Apache MyFaces JSF implementation.
+ </p>
+ </section>
+ <section name="Extended Components and Other "Goodies"">
+
+ <p>
+ In addition to custom components not found in the JSF specification, the MyFaces components bundle also includes an
+ "extended" version of some of the default components. These are basically components that exist in either the core or
+ html tag libraries but additional functionality has been addded that goes beyond the specification.
+ </p>
+ <ul>
+ <li>Example: <t:inputText> - This is similar to the <h:inputText> component but it provides additional attributes
+ such as <code>forceId</code>. When this attribute is <code>true</code> the HTML generated will used the id
+ specified by the <code>id</code> attribute instead of the one normally generated by following the JSF specification.
+ </li>
+ </ul>
+ <ul>
+ <li>Converters - MyFaces components project contains several custom objects that do not implement <code>UIComponent</code>.
+ Some of these include objects that implement the <code>Converter</code> interface.
+ </li>
+ </ul>
+ <ul>
+ <li>Tiles Support - MyFaces provides a custom solution to allow use to use Tiles together with JSF.
+ </li>
+ </ul>
+ </section>
+
+ <section name="Requirements and Setup">
+
+ <ul>
+ <li>
+ Put the <code>tomahawk.jar</code> in your <code>WEB-INF/lib</code> directory (or in the classpath of your
+ application server.)
+ </li>
+ </ul>
+ <blockquote><h3>Note</h3>
+ If you are using the MyFaces implementation you can choose to use the <code>myfaces-all.jar</code> instead. It is basically
+ a single jar file containing the JSF 1.1 API, JSF 1.1 Implementation and the MyFaces custom components.
+ </blockquote>
+ <ul>
+ <li>
+ Install the <a href="extensionsFilter.html">MyFaces Extensions filter</a>
+ </li>
+ </ul>
+ <ul>
+ <li>
+ Add the following to your JSP page in order to use one of the MyFaces custom components: <br/><br/>
+ <code><%@ taglib uri="http://myfaces.apache.org/tomahawk" prefix="t"%></code>
+ </li>
+ </ul>
+ <ul>
+ <li>
+ That's it! You're good to go. Please see additional documentation for specific issues regarding the MyFaces API and
+ implementation packages.
+ </li>
+ </ul>
+ </section>
+
+</body>
+
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/index.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/inputDate.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/inputDate.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/inputDate.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/inputDate.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ An input text control for dates.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/inputdate.png" alt="inputdate"/></div>
+ <p/>
+ <!-- <figure src="images/inputdate2.png" alt="inputdate2"/> -->
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Input</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.Date</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.date.HtmlInputDate</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.date.HtmlDateRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.date.HtmlInputDateTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t:inputDate type="{date|time|both|short_time|full}"
+ popupCalendar="{true|false}"/>
+ ampm="{true|false}"/>
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:inputDate></h3>
+ <code>
+ type - defines the content type. One of these constants (date | time | both | full | short_time).
+ </code>
+ <br/>
+ <code>popupCalendar - if true the value can be set using a popup inputCalendar component.</code><br/>
+ <code>
+ ampm - If true, use 12hr times with AM/PM selector; if false, use 24hr time. Default false.
+ </code>
+ <br/>
+ </blockquote>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ see examples/date.jsp for an example!
+ </p>
+ </section>
+ </body>
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/inputDate.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/inputDate.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/javascriptListener.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/javascriptListener.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/javascriptListener.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/javascriptListener.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ This component replicates the 'Value Change Listener' functionality on the client side. It can be used
+ when the user would like a change in the value of one control to trigger off changes in the states of
+ other controls. One or more Javascript Listeners can be nested within the source control (a control
+ belonging to the 'javax.faces.Input' family). When the value of the source control is modified, the
+ listeners are triggered and the states of the target controls modified.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <p>Not Available</p> <!-- replace with either a figure or Not Available -->
+ <!--
+ <figure src="jscookmenu.png" alt="jscookmenu"/>
+ -->
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Output</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.JsValueChangeListener</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.jslistener.JsValueChangeListener</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.JsValueChangeListener</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.jslistener.JsValueChangeListenerTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+ <t:jsValueChangeListener for="id"
+ property="property"
+ expressionValue="{true|false}"
+ bodyTagEvent="eventName" />
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:jsValueChangeListener></h3>
+ <code>for - the id of the target control</code><br/>
+ <code>expressionValue - the javascript expression to evaluate. The keyword '$srcElem' resolves to
+ the source control and the keyword '$destElem' resolves to the target control </code><br/>
+ <code>property(optional) - The result of the evaluated expression is assigned to the specified property
+ of the target control</code><br/>
+ <code>bodyEventTag(optional) - Events are triggered by the 'onchange' event of the source control. Here,
+ an additional event can be specified (onload?)</code><br/>
+ </blockquote>
+ </section>
+
+ <!-- Examples -->
+ <section name="Examples">
+
+ <p>
+ Some examples will throw more light on the usage of this component.
+ </p>
+
+ <p>
+ <strong>Example 1</strong><br/>
+ Suppose we have two text fields on a page. We would like to keep the value of the second text field
+ in sync with the value of the first. This can be accomplised with the following code:
+ </p>
+ <source xml:space="preserve">
+ <h:inputText id="text1">
+ <t:jsValueChangeListener for="text2" property="value"
+ expressionValue="$srcElem.value" />
+ </h:inputText>
+ <h:inputText id="text2"/>
+ </source>
+ <p>
+ When the value of text1 changes, the 'onchange' event is triggered. The javascript expression specified by
+ 'expressionValue' is evaluated, and the result is assigned to the specified property (in this case, 'value')
+ of the target control.
+ </p>
+
+ <p>
+ <strong>Example 2</strong><br/>
+ Sometimes, the evalution of the javascript expression itself causes the desired side-effect. In this case,
+ it is not necessary to specify the 'property' attribute for the target control. In this example, we have
+ a combo-box, and we want the selection of a specific value in the combo-box to cause a text box to be hidden.
+ </p>
+ <source xml:space="preserve">
+ <h:selectOneMenu id="selone_menu_colors" value="red" styleClass="selectOneMenu">
+ <f:selectItems value="#{carconf.colors}" />
+ <t:jsValueChangeListener for="selone_menu_subcolors"
+ expressionValue="($srcElem.options[$srcElem.selectedIndex].value=='black')?
+ $destElem.style.display='inline':$destElem.style.display='none';"/>
+ </h:selectOneMenu>
+ <h:inputText id="selone_menu_subcolors"/>
+ </source>
+ <p>
+ The evaluation of the expression causes the text box to be hidden when the appropriate value is selected.
+ </p>
+
+ </section>
+
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ see examples/jslistener.jsp for an example!
+ </p>
+ </section>
+ </body>
+
+
+</document>
\ No newline at end of file
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/javascriptListener.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/javascriptListener.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/jscookmenu.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/jscookmenu.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/jscookmenu.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/jscookmenu.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ Renders a Javascript Menu based on the excellent
+ <a href="http://www.cs.ucla.edu/~heng/JSCookMenu">JSCookMenu</a>
+ by Heng Yuan, the nested NavigationMenuItem(s) are rendered as Javascript Menu.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/jscookmenu.png" alt="jscookmenu"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">since</td>
+ <td colspan="1" rowspan="1">1.0.5</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">author</td>
+ <td colspan="1" rowspan="1">MyFaces Team</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Command</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.JSCookMenu</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.navmenu.jscookmenu.HtmlCommandJSCookMenu</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.navmenu.jscookmenu.HtmlJSCookMenuRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.navmenu.jscookmenu.HtmlJSCookMenuTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t:jscookMenu [ user-role-support-attributes ]
+ [layout="values {hbr, hbl, hur, hul, vbr, vbl, vur, vul}"]
+ [theme="values {ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel}"]
+ Nested <t:navigationMenuItem> or <t:navigationMenuItems> tags (menu items)
+</t:jscookMenu>
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:jscookMenu></h3>
+ <code>layout - hbr, hbl, hur, hul, vbr, vbl, vur, vul.</code><br/>
+ <code>theme - ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel.</code><br/>
+ </blockquote>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ If you want to use jscookMenu in your application, you will have to:
+ </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 xml:space="preserve">
+<!-- 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>
+ </body>
+
+
+</document>
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/jscookmenu.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/jscookmenu.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/newspaperTable.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/newspaperTable.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/newspaperTable.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/newspaperTable.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ The newspaperTable tag allows a long, narrow table to be wrapped
+ so that it becomes a short, wide table. This allows more information
+ to be shown on a single screen. This is commonly used to present
+ checkboxes for a long list of items.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/newspaperTable.png" alt="Newspaper Table"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Data</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.HtmlNewspaperTable</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.newspaper.HtmlNewspaperTable</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.newspaper.HtmlNewspaperTableRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.newspaper.HtmlNewspaperTableTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t: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>
+</t:newspaperTable>
+ </source>
+ </section>
+
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:newspaperTable></h3>
+ <code>
+ newspaperColumns - The number of columns to wrap the table over. Default: 1
+ </code>
+ <br/>
+ </blockquote>
+ </section>
+
+ <!-- Additional Information -->
+ <section name="Additional Information">
+
+ <p>
+ see examples/newspaperTable.jsp for an example!
+ </p>
+ </section>
+
+ </body>
+
+
+</document>
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/newspaperTable.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/newspaperTable.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <!--
+This is a standard template meant to be used for the documentation of all custom
+components.
+--><document>
+
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ Renders a vertical menu structure with support for nested menu items.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/panelnavigation.png" alt="panelnavigation"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">since</td>
+ <td colspan="1" rowspan="1">0.1.0 (former <t:navigation>)</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">author</td>
+ <td colspan="1" rowspan="1">MyFaces Team</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Panel</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.Navigation</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.navigation.HtmlPanelNavigation</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.navigation.HtmlNavigationRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.navigation.HtmlPanelNavigationTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t: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 <t:commandNavigation> tags (menu items) and output components (separat
+</t:panelNavigation>
+ </source>
+ </section>
+
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:panelNavigation></h3>
+ <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/>
+ </blockquote>
+ </section>
+
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ Body content must be a combination of <t:commandNavigation> tags
+ and standard output tags. Output tags are rendered as separators
+ and can be used to divide the menu into sections.
+ </p>
+ </section>
+
+ </body>
+
+
+</document>
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation2.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation2.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation2.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation2.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <!--
+This is a standard template meant to be used for the documentation of all custom
+components.
+--><document>
+
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ PanelNavigation2 is the successor of PanelNavigation.
+ The menu is rendered as unordered List instead of a Table. Morever the menu-tree
+ can be dynamically build using NavigationMenuItem(s). If you want to explore
+ the features of panelNavigation2 visit the http://www.irian.at/myfaces/home.jsf.
+ </p>
+ <p>
+ Many thanks to Swiss Federal Institute of Intellectual Property & Marc Bouquet
+ for helping to develop this component.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/panelnavigation2.png" alt="panelnavigation2"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">since</td>
+ <td colspan="1" rowspan="1">0.1.0 (former <t:navigation>)</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">author</td>
+ <td colspan="1" rowspan="1">MyFaces Team</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Panel</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.NavigationMenu</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.navmenu.htmlnavmenu.HtmlPanelNavigationMenu</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.navmenu.htmlnavmenu.HtmlNavigationMenuRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.navmenu.htmlnavmenu.HtmlPanelNavigationMenuTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t:panelNavigation2 [ 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 <t:commandNavigation2> tags (menu items) and output components
+ <t:navigationMenuItem> tags (NavigationMenuItem)
+ <t:navigationMenuItems> tags (NavigationMenuItem(s))
+ </t:panelNavigation>
+ </source>
+ </section>
+
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:panelNavigation2></h3>
+ <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/>
+ </blockquote>
+ </section>
+
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ See PanelNavigation Examples http://www.irian.at/myfaces/home.jsf.
+ </p>
+ </section>
+
+ </body>
+
+
+</document>
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation2.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/panelNavigation2.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/panelStack.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/panelStack.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/panelStack.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/panelStack.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ A stack of panels, to switch panels dynamically.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <p>Not available</p> <!-- replace with either a figure or Not Available -->
+ <!--
+ <figure src="jscookmenu.png" alt="jscookmenu"/>
+ -->
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Panel</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.PanelStack</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.panelstack.HtmlPanelStack</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.panelstack.HtmlPanelStackRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.panelstack.PanelStackTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t:panelStack id="String"
+ selectedPanel="String">
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:panelStack></h3>
+ <code>selectedPanel - Id of the child to be rendered.</code><br/>
+ <code>id - id of the stack.</code><br/>
+ </blockquote>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ see examples/panelStack.jsp for an example!
+ </p>
+ </section>
+ </body>
+
+
+</document>
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/panelStack.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/panelStack.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/tomahawk/trunk/src/site/xdoc/popup.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/src/site/xdoc/popup.xml?rev=360558&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/src/site/xdoc/popup.xml (added)
+++ myfaces/tomahawk/trunk/src/site/xdoc/popup.xml Sun Jan 1 13:42:11 2006
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <document>
+
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ Renders a popup which displays on a mouse event.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <div><img src="images/popup.png" alt="popup"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">javax.faces.Panel</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.Popup</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.popup.HtmlPopup</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.popup.HtmlPopupRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.popup.HtmlPopupTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<t: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>
+</t:popup>
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><t:popup></h3>
+ <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/>
+ </blockquote>
+ </section>
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ see examples/popup.jsp for an example!
+ </p>
+ </section>
+ </body>
+
+
+</document>
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/popup.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/tomahawk/trunk/src/site/xdoc/popup.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL