myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lu4...@apache.org
Subject svn commit: r672986 - in /myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces: component/html/ext/ custom/aliasbean/ custom/buffer/ custom/calendar/ custom/dojo/ custom/jslistener/ custom/navmenu/htmlnavmenu/ custom/navmenu/jscookmenu/ custom/...
Date Tue, 01 Jul 2008 04:13:56 GMT
Author: lu4242
Date: Mon Jun 30 21:13:55 2008
New Revision: 672986

URL: http://svn.apache.org/viewvc?rev=672986&view=rev
Log:
fix documentation comments (correct html tags)

Modified:
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBean.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBeansScope.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/buffer/AbstractBuffer.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/calendar/AbstractHtmlInputCalendar.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/dojo/DojoInitializer.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/jslistener/AbstractJsValueChangeListener.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlCommandNavigationItem.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlPanelNavigationMenu.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/jscookmenu/AbstractHtmlCommandJSCookMenu.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/newspaper/AbstractHtmlNewspaperTable.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/picklist/AbstractHtmlSelectManyPicklist.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/savestate/UISaveState.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/schedule/AbstractHtmlSchedule.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/selectitems/AbstractUISelectItems.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/stylesheet/AbstractStylesheet.java
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTree.java

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java
Mon Jun 30 21:13:55 2008
@@ -51,10 +51,20 @@
 import java.util.StringTokenizer;
 
 /**
+ * The MyFacesDataTable extends the standard JSF DataTable by two
+ * important features:
+ * <br/>
+ * <ul>
+ *   <li>Possiblity to save the state of the DataModel.</li>
+ * 
+ *   <li>Support for clickable sort headers (see SortHeader
+ *   component).</li>
+ * </ul>
+ * <br/>
  * Extended data_table that adds some additional features to the 
  * standard data_table action: see attribute descriptions for 
  * preserveDataModel, sortColumn, sortAscending and preserveSort. 
- * 
+ * <br/>
  * Unless otherwise specified, all attributes accept static values or EL expressions.
  * 
  * @JSFComponent

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBean.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBean.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBean.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBean.java
Mon Jun 30 21:13:55 2008
@@ -46,6 +46,7 @@
  * included one. The included page can use any name it desires for beans it needs to
  * reference, and the including page can then use aliasBean to make those names
  * refer to the beans it wishes to "pass" as parameters.
+ * </p>
  * <p>
  * Suppose you have a block of components you use often but with different beans. You
  * can create a separate JSP page (or equivalent) containing these beans, where the
@@ -54,15 +55,18 @@
  * an alias component mapping each of these "parameters" to whatever beans (or literal
  * values) you really want to apply the block to, then use jsp:include (or equivalent)
  * to include the reusable block of components.
+ * </p>
  * <p>
  * Note, however, that AliasBean does not work for component bindings; JSF1.1
  * just has no mechanism available to set up the alias during the "restore view"
  * phase while the bindings of its children are being re-established, and then
  * remove the alias after the child bindings are done.
+ * </p>
  * <p>
  * As a special case, if this component's direct parent is an AliasBeansScope
  * then the alias (temporary name) is active until the end of the parent
  * component, rather than the end of this component.
+ * </p>
  *
  * @JSFComponent
  *   name = "t:aliasBean"

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBeansScope.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBeansScope.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBeansScope.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/aliasbean/AliasBeansScope.java
Mon Jun 30 21:13:55 2008
@@ -47,6 +47,7 @@
  * empty bodies added as direct children of this component. The scope of the AliasBean
  * tag still starts when the tag begins, but instead of ending when the tag ends
  * the scope of the nested AliasBean tags extends to the end of this component.
+ * </p>
  * 
  * @JSFComponent
  *   name = "t:aliasBeansScope"

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/buffer/AbstractBuffer.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/buffer/AbstractBuffer.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/buffer/AbstractBuffer.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/buffer/AbstractBuffer.java
Mon Jun 30 21:13:55 2008
@@ -29,9 +29,11 @@
  * Property "into" is an EL expression that specifies where to store a String holding
  * the results of rendering all the children of this component; this is assigned to
  * after rendering of this component (and its children) is complete.
+ * </p>
  * <p>
  * Typically, an h:output tag is then used later in the same page to output the buffer
  * contents.
+ * </p>
  * <p>
  * This can be useful with JSF1.1/JSP2.0 to work around the well-known problem where
  * on first render of a page, a component "A" cannot reference a component "B" which is
@@ -39,11 +41,13 @@
  * "B" before "A", but wrapped in a Buffer component. Component A can then be rendered
  * and successfully reference "B" because it now exists. And later in the page, the buffer
  * contents can then be output, preserving the original layout.
+ * </p>
  * <p>
  * This can also be useful when rendering the same data block multiple times within a page.
  * For example, a datatable can be rendered with a datascroller both before and after it;
  * first render the table into a buffer B1, then render the datascroller into a buffer B2,
  * then output buffers B2,B1,B2.
+ * </p>
  * 
  * @JSFComponent
  *   name = "t:buffer"

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/calendar/AbstractHtmlInputCalendar.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/calendar/AbstractHtmlInputCalendar.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/calendar/AbstractHtmlInputCalendar.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/calendar/AbstractHtmlInputCalendar.java
Mon Jun 30 21:13:55 2008
@@ -25,7 +25,7 @@
 import org.apache.myfaces.component.html.ext.HtmlInputText;
 
 /**
- *   <p>
+ *  <p>
  *  Provides a calendar. The calendar can be "inline", or a button can be rendered
  *  that displays the calendar in a "popup window" when clicked. Javascript is
  *  required for the popup window.
@@ -41,11 +41,12 @@
  *  such as currentDayCellClass, dayCellClass, weekRowClass, monthYearRowClass. 
  *  Attributes "styleLocation", "javascriptLocation", "imageLocation" and all
  *  attributes starting with "popup" have no effect on an inline calendar.
+ *  </p>
  *  <ul>
  *  <p>
  *  The appearance of the popup calendar can be controlled via attributes
  *  popupTheme, styleLocation, javascriptLocation and imageLocation:
- *  <ul>
+ *  </p>
  *    <li>popupTheme: When styleLocation is not overridden then this selects one of
the
  *    built-in themes ("WH" or "DB"); the default is "DB". This also selects the prefix
  * used for the names of style classes attached to generated dom elements; all style
@@ -55,7 +56,7 @@
  *  A reference to this theme.css file will automatically be output. Specifying "none" as
the
  *  location prevents the generation of this stylesheet reference; it is assumed that the
  *  necessary style rules will be loaded via some other mechanism. Defaults to a reference
- *  to a location within the tomahawk jarfile which varies based on popupTheme.
+ *  to a location within the tomahawk jarfile which varies based on popupTheme.</li>
  * <li>javascriptLocation: specifies the URL of a directory in which all the necessary
script
  *   files can be found. A reference to scripts "prototype.js", "date.js" and "popcalendar.js"
  *   will automatically be output. Specifying "none" prevents generation of these references;
@@ -66,7 +67,6 @@
  *       varies depending on popupTheme.</li>
  *  </ul>
  *  Other styling attributes (eg dayCellClass, weekRowClass) are ignored for the popup calendar.
- *  </p>
  *  <p>
  *  Unless otherwise specified, all attributes accept static values or EL expressions.
  *  </p>

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/dojo/DojoInitializer.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/dojo/DojoInitializer.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/dojo/DojoInitializer.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/dojo/DojoInitializer.java
Mon Jun 30 21:13:55 2008
@@ -25,7 +25,11 @@
 
 /**
  * Default component for the dojo intializer
- * 
+ * <br/>
+ * This component is purely non visual, and serves for
+ * quick hacking, and prototyping the dojo toolkit within
+ * verbatimed html.
+ * <br/>
  * Dojo initializer helper tag for debugging and communication flags. 
  * This tag encapsules the Dojo DjConfig meta configuration and also 
  * adds the needed dojo required functionality.
@@ -61,6 +65,11 @@
     }
 
     /**
+     * Triggers a standard dojo allowQueryConfig as defined
+     * by the <a href="http://dojotoolkit.org/">Dojo Toolkit</a>.
+     * If someone has additional infos about this tag,
+     * please fill in here.
+     * 
      * @JSFProperty
      */
     public Boolean getAllowQueryConfig() {
@@ -68,6 +77,13 @@
     }
 
     /**
+     * Triggers a standard dojo baseScriptUri as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * <br />
+     * <br />
+     * Allows the alteration of the dojo loading root path
+     * used by require.
+     * 
      * @JSFProperty
      */
     public String getBaseScriptUri() {
@@ -75,6 +91,19 @@
     }
 
     /**
+     * Triggers a standard dojo bindEncoding as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * 
+     * Although this control most of the times is not
+     * needed one usage in plain jsf applications can be
+     * thought of. The changing of the bind encodings, if
+     * you check the parameter list of the control
+     * <b>ioSendTransport</b>
+     * can be used to change this encoding to any encoding
+     * parameter needed. This can be used to change the
+     * internal ajax request encodings of various controls
+     * in a global manner.
+     * 
      * @JSFProperty
      */
     public String getBindEncoding() {
@@ -86,6 +115,15 @@
     }
 
     /**
+     * Triggers a standard dojo debug as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * <br />
+     * <br />
+     * Enables the dojo debugging framework. The usage of
+     * dojo.debug causes output to be displayed in either
+     * the current container or a target container, if one
+     * is set.
+     * 
      * @JSFProperty
      */
     public Boolean getDebug() {
@@ -93,6 +131,12 @@
     }
 
     /**
+     * Triggers a standard dojo debugAtAllCosts as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * <br />
+     * Tries to enforce debugging even if the browser
+     * version does not allow it to work properlys
+     * 
      * @JSFProperty
      */
     public Boolean getDebugAtAllCosts() {
@@ -100,6 +144,17 @@
     }
 
     /**
+     * Triggers a standard dojo debugConsole as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * <br />
+     * <br />
+     * This flag pops up a separate in frame floating
+     * window which receives the debugging output.
+     * <br />
+     * <br />
+     * Note: This flag only works if debugging is enabled
+     * generally via the debug="true" flag set
+     * 
      * @JSFProperty
      */
     public Boolean getDebugConsole() {
@@ -107,6 +162,23 @@
     }
 
     /**
+     * Triggers a standard dojo debugContainerId as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * <br />
+     * <br />
+     * This flag notifies the Dojo toolkit about the id
+     * which should receive the debug output. Dojo has a
+     * full debugging framework in it which allows to turn
+     * on debug output via a logging mechanism @see
+     * dojo.debug() for further references.
+     * <br />
+     * <br />
+     * The debugging output is not limited to the current
+     * container triggering the debugging statement any
+     * container can receive the debugging output this flag
+     * is the flag which has to be set for setting a
+     * different target id for the debugging output.
+     * 
      * @JSFProperty
      */
     public String getDebugContainerId() {
@@ -118,6 +190,11 @@
     }
 
     /**
+     * Triggers a standard dojo development as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * If you can find additional info about this attribute
+     * please fill in here
+     * 
      * @JSFProperty
      */
     public Boolean getExpanded() {
@@ -129,6 +206,19 @@
     }
 
     /**
+     * Triggers a standard dojo ignoreClassNames as defined
+     * by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * <br />
+     * <br />
+     * This attribute turns on the case insensitive
+     * handling of classnames by require and other Dojo
+     * class loader mechanisms.
+     * <br />
+     * <br />
+     * Case sensitivity is by default turned
+     * <b>on</b>.
+     * 
      * @JSFProperty
      */
     public Boolean getIgnoreClassNames() {
@@ -136,6 +226,14 @@
     }
 
     /**
+     * Dojo in its underlying architecture allows various
+     * options of server-client side communication. This
+     * setting allows the alteration of the communication
+     * layer to a different protocol. Currently only in
+     * usage is xmlhttprequest, hence setting this encoding
+     * will not change too much. But different encodings
+     * like iframe are planned for the future.
+     * 
      * @JSFProperty
      */
     public String getIoSendTransport() {
@@ -143,6 +241,20 @@
     }
 
     /**
+     * Triggers a standard dojo parseWidgets as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * 
+     * This parameter is used to turn on or off the dojo
+     * widgeting parsing. The parsing is not used by
+     * MyFaces for various reasons, but can be used by your
+     * own html code.
+     * <br />
+     * <br />
+     * For addititional information regarding the Dojo
+     * Toolkit widget parsing, visit the
+     * <br />
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit Homepage</a>
+     * 
      * @JSFProperty
      */
     public Boolean getParseWidgets() {
@@ -150,6 +262,12 @@
     }
 
     /**
+     * Dojo uses internally back button blockers to avoid
+     * problems with ajax requests causing the back button,
+     * to move out of the back page navigation order.
+     * Sometimes this behavior is not wanted and can be
+     * turned off with this on a global scale;
+     * 
      * @JSFProperty
      */
     public Boolean getPreventBackButtonFix() {
@@ -157,6 +275,9 @@
     }
 
     /**
+     * Triggers a standard dojo provide as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * 
      * @JSFProperty
      */
     public String getProvide() {
@@ -168,6 +289,9 @@
     }
 
     /**
+     * Triggers a standard dojo provide as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * 
      * @JSFProperty
      */
     public String getRequire() {
@@ -175,6 +299,11 @@
     }
 
     /**
+     * Triggers a standard dojo development as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * If you can find additional info about this attribute
+     * please fill in here
+     * 
      * @JSFProperty
      */
     public String getSearchIds() {
@@ -182,6 +311,12 @@
     }
     
     /**
+     * Triggers a standard dojo development as defined by the
+     * <a href="http://dojotoolkit.org/">Dojo Toolkit</a>
+     * If this parameter is set to true. The expanded
+     * debuggable version of dojo is included
+     * if set to false the compressed one is included.
+     * 
      * @JSFProperty
      */
     public Boolean getDevelopment() {

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/jslistener/AbstractJsValueChangeListener.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/jslistener/AbstractJsValueChangeListener.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/jslistener/AbstractJsValueChangeListener.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/jslistener/AbstractJsValueChangeListener.java
Mon Jun 30 21:13:55 2008
@@ -23,8 +23,16 @@
 
 /**
  * Value change listener on client side. 
- * 
+ * <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>
+ * <p>
  * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * </p>
  * 
  * @JSFComponent
  *   name = "t:jsValueChangeListener"
@@ -45,25 +53,36 @@
     private static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.JsValueChangeListener";
 
     /**
+     * for - the id of the target control
+     * 
      * @JSFProperty
      */
     public abstract String getFor();
 
     /**
+     * the javascript expression to evaluate. The keyword '$srcElem' resolves to 
+     * the source control and the keyword '$destElem' resolves to the target control
+     * 
      * @JSFProperty
      *   required="true"
      */
     public abstract String getExpressionValue();
 
     /**
+     * The result of the evaluated expression is assigned to the specified property 
+     * of the target control
+     * 
      * @JSFProperty
      */
     public abstract String getProperty();
 
     /**
-     *  If specified this JavaScript event will be inserted in the 
-     *  body tag. JavaScript code will be the same like it is 
-     *  rendered in the parent component.
+     * Events are triggered by the 'onchange' event of the source control. Here, 
+     * an additional event can be specified (onload?).
+     * 
+     * If specified this JavaScript event will be inserted in the 
+     * body tag. JavaScript code will be the same like it is 
+     * rendered in the parent component.
      * 
      * @JSFProperty
      */

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlCommandNavigationItem.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlCommandNavigationItem.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlCommandNavigationItem.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlCommandNavigationItem.java
Mon Jun 30 21:13:55 2008
@@ -43,7 +43,7 @@
  * Unless otherwise specified, all attributes accept static 
  * values or EL expressions.
  * 
- * Many thanks to the guys from Swiss Federal Institute of Intellectual Property & Marc
Bouquet
+ * Many thanks to the guys from Swiss Federal Institute of Intellectual Property and Marc
Bouquet
  * for helping to develop this component.
  *
  * @JSFComponent

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlPanelNavigationMenu.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlPanelNavigationMenu.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlPanelNavigationMenu.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/htmlnavmenu/AbstractHtmlPanelNavigationMenu.java
Mon Jun 30 21:13:55 2008
@@ -44,7 +44,7 @@
  * 
  * Unless otherwise specified, all attributes accept static values or EL expressions.
  * 
- * Many thanks to the guys from Swiss Federal Institute of Intellectual Property & Marc
Bouquet
+ * Many thanks to the guys from Swiss Federal Institute of Intellectual Property and Marc
Bouquet
  * for helping to develop this component.
  * 
  * @JSFComponent

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/jscookmenu/AbstractHtmlCommandJSCookMenu.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/jscookmenu/AbstractHtmlCommandJSCookMenu.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/jscookmenu/AbstractHtmlCommandJSCookMenu.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/navmenu/jscookmenu/AbstractHtmlCommandJSCookMenu.java
Mon Jun 30 21:13:55 2008
@@ -27,6 +27,12 @@
 /**
  * Renders a Javascript Menu. Nested NavigationMenuItem(s) are rendered 
  * as Javascript Menu. 
+ *
+ * <p>
+ * This component is based based on the excellent
+ * <a href="http://jscook.sourceforge.net/JSCookMenu">JSCookMenu</a>
+ * by Heng Yuan.
+ * </p>
  * 
  * Unless otherwise specified, all attributes accept static values or EL expressions.
  * 

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/newspaper/AbstractHtmlNewspaperTable.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/newspaper/AbstractHtmlNewspaperTable.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/newspaper/AbstractHtmlNewspaperTable.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/newspaper/AbstractHtmlNewspaperTable.java
Mon Jun 30 21:13:55 2008
@@ -27,6 +27,11 @@
 /**
  * Model for a table in multiple balanced columns.
  * 
+ * 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.
+ *  
  * A data table for rendering long skinny tables as short wide 
  * table by wrapping the table over a specified number of columns. 
  * 

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/picklist/AbstractHtmlSelectManyPicklist.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/picklist/AbstractHtmlSelectManyPicklist.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/picklist/AbstractHtmlSelectManyPicklist.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/picklist/AbstractHtmlSelectManyPicklist.java
Mon Jun 30 21:13:55 2008
@@ -22,6 +22,15 @@
 
 /**
  * A picklist component that allows to select items from one list to another
+ * <p>
+ * In other words, is a selection component where a set of items 
+ * can be selected from a list that contains all the available items to a list
+ * that contains the selected items.
+ * </p>
+ * <p>
+ * The component is based on the t:selectManyListbox component, so it contains
+ * the same attributes. Soon, more specific attributes will be added.
+ * </p>
  * 
  * @JSFComponent
  *   name = "t:selectManyPicklist"

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/savestate/UISaveState.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/savestate/UISaveState.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/savestate/UISaveState.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/savestate/UISaveState.java
Mon Jun 30 21:13:55 2008
@@ -30,21 +30,25 @@
  * objects that the managed beans reference:  request, session, application.
  * However a common requirement is a way for a model object to have a scope
  * that is tied to the duration of the current view; that is longer than the
- * request scope but shorter than session scope. 
+ * request scope but shorter than session scope.
+ * </p> 
  * <p>
  * This component simply holds a reference to an arbitrary object (specified
  * by the value property). Because this object is an ordinary component whose
  * scope is the current view, the reference to the model automatically has that
- * same scope. 
+ * same scope.
+ * </p> 
  * <p>
  * When the value is an EL expression, then after the view is restored the
  * recreated target object is stored at the specified location.
+ * </p>
  * <p>
  * The object being saved must either:
+ * </p>
  * <ul>
- * <li>implement java.io.Serializable, or
+ * <li>implement java.io.Serializable, or</li>
  * <li>implement javax.faces.component.StateHolder and have a default
- *   constructor.
+ *   constructor.</li>
  * </ul>
  * <p>
  * Note that the saved object can be "chained" from view to view
@@ -55,7 +59,7 @@
  * and that view has a UISaveState component with the same EL expression
  * then the object will simply be saved into the new view, thus extending
  * its lifetime.
- * <p>
+ * </p>
  * 
  * @JSFComponent
  *   name = "t:saveState"

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/schedule/AbstractHtmlSchedule.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/schedule/AbstractHtmlSchedule.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/schedule/AbstractHtmlSchedule.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/schedule/AbstractHtmlSchedule.java
Mon Jun 30 21:13:55 2008
@@ -25,9 +25,19 @@
 
 /**
  * A schedule component similar to the ones found in Outlook or Evolution
- * 
+ * <p> 
+ * Renders a schedule component, showing appointments and events
+ * in a day, workweek, week or month view, similar to the schedule
+ * part of MS Outlook or Evolution.
+ * </p><p>
+ * The component is backed by an implementation of the
+ * ScheduleModel interface. Creating a custom model can be easily
+ * achieved by implementing this interface, or by overriding
+ * the AbstractScheduleModel class.
+ * </p><p>
  * AbstractHtmlSchedule class holds all properties specific to the HTML version of the Schedule
component.
- *
+ * </p>
+ * 
  * @JSFComponent
  *   name = "t:schedule"
  *   class = "org.apache.myfaces.custom.schedule.HtmlSchedule"
@@ -190,6 +200,8 @@
     public abstract String getUnevenClass();
 
     /**
+     * the css class of the table representing a week in the compact mode (default: week)
+     * 
      * @JSFProperty
      * @return the weekClass
      */

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/selectitems/AbstractUISelectItems.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/selectitems/AbstractUISelectItems.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/selectitems/AbstractUISelectItems.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/selectitems/AbstractUISelectItems.java
Mon Jun 30 21:13:55 2008
@@ -32,7 +32,10 @@
 /**
  * An extended version of the standard UISelectItems. Populates the 
  * SelectItem collection from the given value automatically using 
- * the itemLabel and itemValue attributes.
+ * the itemLabel and itemValue attributes. By using the component 
+ * there is no need to manually create a SelectItem collection 
+ * because component automatically populates SelectItem objects 
+ * from types like Collection, Map and etc..
  * 
  * @JSFComponent
  *   name = "t:selectItems"

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/stylesheet/AbstractStylesheet.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/stylesheet/AbstractStylesheet.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/stylesheet/AbstractStylesheet.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/stylesheet/AbstractStylesheet.java
Mon Jun 30 21:13:55 2008
@@ -48,12 +48,14 @@
      * If this path starts with a slash, then the webapp context path will be prepended to
it.
      * This makes it simple to reference stylesheets at an absolute path within the webapp.
      * A value like "/styles/style.css" becomes "/webappname/styles/style.css".
+     * </p>
      * <p>
      * If this path does not start with a slash, then it is output unaltered. This supports
      * absolute urls ("http://host/path/style.css"). It also supports having css files relative
      * to the current page ("style.css" or "styles/style.css") but this needs to be used
with
      * care as the standard JSF postback/internal-forward navigation style can cause browsers
-     * to use an inappropriate base url when resolving relative references. 
+     * to use an inappropriate base url when resolving relative references.
+     * </p> 
      * 
      * @JSFProperty
      *   required="true"
@@ -65,10 +67,12 @@
      * <p>
      * The file referenced by the path attribute is loaded, and its content is written
      * to the page wrapped in an &lt;script&gt; tag.
+     * </p>
      * <p>
      * When this option is enabled, the path property must contain an absolute path
      * within the current webapp. External urls ("http://*") and paths relative to the
      * current page are not supported.
+     * </p>
      * 
      * @JSFProperty
      *   defaultValue = "false"
@@ -81,6 +85,7 @@
      * When true, any EL expression in the stylesheet will be evaluated and replaced
      * by its string representation on the first access. The stylesheet will be
      * processed only once. Every subsequent request will get a cached view.
+     * </p>
      * 
      * @JSFProperty
      *   defaultValue = "false"

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTree.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTree.java?rev=672986&r1=672985&r2=672986&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTree.java
(original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTree.java
Mon Jun 30 21:13:55 2008
@@ -40,17 +40,17 @@
 
 /**
  * A tree data component. 
- * Unless otherwise specified, all attributes accept static values or EL expressions. h
- * <p/>
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * <p>
  * Tree implementation based on javax.swing.JTree.
  * </p>
- * <p/>
+ * <p>
  * The tree model is assigned by using a value binding named <code>model</code>
  * and is not stored in view state.
  * </p>
- * <p/>
+ * <p>
  * A hierarchy of {@link HtmlTreeNode}objects is used to represent the current
- * expanded state of the tree. The root node is held as a faces named
+ * expanded state of the tree. The root node is held as a faces named * 
  * <code>rootNode</code>.
  * </p>
  *



Mime
View raw message