myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lu4...@apache.org
Subject svn commit: r655253 [2/2] - in /myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom: aliasbean/ buffer/ calendar/ checkbox/ collapsiblepanel/ column/ creditcardvalidator/ crosstable/ d...
Date Sun, 11 May 2008 06:06:02 GMT
Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/newspaper/AbstractHtmlNewspaperTable.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/newspaper/AbstractHtmlNewspaperTable.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/newspaper/AbstractHtmlNewspaperTable.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/newspaper/AbstractHtmlNewspaperTable.java
Sat May 10 23:06:00 2008
@@ -26,6 +26,11 @@
 
 /**
  * Model for a table in multiple balanced columns.
+ * 
+ * A data table for rendering long skinny tables as short wide 
+ * table by wrapping the table over a specified number of columns. 
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
  *
  * @JSFComponent
  *   name = "t:newspaperTable"
@@ -50,6 +55,7 @@
 
     /**
      * Set the number of columns the table will be divided over.
+     * In other words, the number of columns to wrap the table over. Default: 1
      * 
      * @JSFProperty
      *   defaultValue = "1"
@@ -57,6 +63,9 @@
     public abstract int getNewspaperColumns();
     
     /**
+     * The orientation of the newspaper columns in the newspaper 
+     * table - "horizontal" or "vertical". Default: vertical
+     * 
      * @JSFProperty
      */
     public abstract String getNewspaperOrientation();    

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/panelstack/AbstractHtmlPanelStack.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/panelstack/AbstractHtmlPanelStack.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/panelstack/AbstractHtmlPanelStack.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/panelstack/AbstractHtmlPanelStack.java
Sat May 10 23:06:00 2008
@@ -22,9 +22,13 @@
 
 
 /**
+ * A stack of panels, to switch panels dynamically. 
+ * 
  * Manage a stack of JSF components and allow for one child component to be choosen for rendering.
The behaviour
  * is similar to the CardLayout of Java Swing. Property <code>selectedPanel</code>
defines the id of the child
  * to be rendered. If no child panel is selected or if the selected panel can not be found
the first child is rendered.
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
  *
  * @JSFComponent
  *   name = "t:panelStack"

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/popup/AbstractHtmlPopup.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/popup/AbstractHtmlPopup.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/popup/AbstractHtmlPopup.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/popup/AbstractHtmlPopup.java
Sat May 10 23:06:00 2008
@@ -27,6 +27,10 @@
 import org.apache.myfaces.component.UserRoleUtils;
 
 /**
+ * Renders a popup which displays on a mouse event. 
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFComponent
  *   name = "t:popup"
  *   class = "org.apache.myfaces.custom.popup.HtmlPopup"
@@ -69,31 +73,43 @@
     }
 
     /**
+     * HTML: CSS styling instructions.
+     * 
      * @JSFProperty
      */
     public abstract String getStyle();
 
     /**
+     *  The CSS class for this element. Corresponds to the HTML 'class' attribute.
+     * 
      * @JSFProperty
      */
     public abstract String getStyleClass();
 
     /**
+     * Pop the panel up in horizontal distance of x pixels from event.
+     * 
      * @JSFProperty
      */
     public abstract Integer getDisplayAtDistanceX();
 
     /**
+     * Pop the panel up in vertical distance of y pixels from event.
+     * 
      * @JSFProperty
      */
     public abstract Integer getDisplayAtDistanceY();
 
     /**
+     * Close the popup when the triggering element is left.
+     * 
      * @JSFProperty
      */
     public abstract Boolean getClosePopupOnExitingElement();
 
     /**
+     * Close the popup when the popup itself is left.
+     * 
      * @JSFProperty
      */
     public abstract Boolean getClosePopupOnExitingPopup();

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/radio/AbstractHtmlRadio.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/radio/AbstractHtmlRadio.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/radio/AbstractHtmlRadio.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/radio/AbstractHtmlRadio.java
Sat May 10 23:06:00 2008
@@ -23,6 +23,15 @@
 import org.apache.myfaces.component.UserRoleAware;
 
 /**
+ * This tag is used in conjunction with the extended selectOneRadio 
+ * tag when the "spread" layout is selected. It specifies the 
+ * position within the document that the radio button corresponding 
+ * to a specific SelectItem should be rendered. All HTML pass-through 
+ * attributes for this input are taken from the associated 
+ * selectOneRadio. 
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFComponent
  *   name = "t:radio"
  *   class = "org.apache.myfaces.custom.radio.HtmlRadio"
@@ -46,12 +55,18 @@
     private static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.Radio";
 
     /**
+     * The id of the referenced extended selectOneRadio component. 
+     * This value is resolved to the particular component using 
+     * the standard UIComponent.findComponent() searching algorithm.
+     * 
      * @JSFProperty
      *   required="true"
      */
     public abstract String getFor();
     
     /**
+     * The index of the corresponding SelectItem, where 0 represents the first SelectItem.
+     * 
      * @JSFProperty
      *   defaultValue = "Integer.MIN_VALUE"
      *   required="true"

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/regexprvalidator/RegExprValidator.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/regexprvalidator/RegExprValidator.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/regexprvalidator/RegExprValidator.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/regexprvalidator/RegExprValidator.java
Sat May 10 23:06:00 2008
@@ -29,13 +29,17 @@
 import org.apache.myfaces.validator.ValidatorBase;
 
 /**
+ * A custom validator for reg. expr., based upons Jakarta Commons. 
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFValidator
  *   name = "t:validateRegExpr"
  *   tagClass = "org.apache.myfaces.custom.regexprvalidator.ValidateRegExprTag"
  * 
- * @JSFJspProperty name = "message" returnType = "java.lang.String"
- * @JSFJspProperty name = "detailMessage" returnType = "java.lang.String"
- * @JSFJspProperty name = "summaryMessage" returnType = "java.lang.String" 
+ * @JSFJspProperty name = "message" returnType = "java.lang.String" longDesc = "alternate
validation error detail message format string (use 'message' and 'detailMessage' alternatively)"
+ * @JSFJspProperty name = "detailMessage" returnType = "java.lang.String" longDesc = "alternate
validation error detail message format string (use 'message' and 'detailMessage' alternatively)"
+ * @JSFJspProperty name = "summaryMessage" returnType = "java.lang.String" longDesc = "alternate
validation error summary message format string"
  * @author mwessendorf (latest modification by $Author$)
  * @version $Revision$ $Date$
  */
@@ -97,6 +101,8 @@
 	// -------------------------------------------------------- GETTER & SETTER
 
 	/**
+	 * the pattern, which is the base of the validation
+	 * 
 	 * @JSFProperty
 	 * @return the pattern, on which a value should be validated
 	 */

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/schedule/AbstractHtmlSchedule.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/schedule/AbstractHtmlSchedule.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/schedule/AbstractHtmlSchedule.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/schedule/AbstractHtmlSchedule.java
Sat May 10 23:06:00 2008
@@ -24,7 +24,9 @@
 import org.apache.myfaces.component.UserRoleAware;
 
 /**
- * This class holds all properties specific to the HTML version of the Schedule component.
+ * A schedule component similar to the ones found in Outlook or Evolution
+ * 
+ * AbstractHtmlSchedule class holds all properties specific to the HTML version of the Schedule
component.
  *
  * @JSFComponent
  *   name = "t:schedule"

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectOneCountry/AbstractSelectOneCountry.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectOneCountry/AbstractSelectOneCountry.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectOneCountry/AbstractSelectOneCountry.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectOneCountry/AbstractSelectOneCountry.java
Sat May 10 23:06:00 2008
@@ -36,6 +36,15 @@
 import org.apache.myfaces.shared_tomahawk.renderkit.RendererUtils;
 
 /**
+ * A localized list of countries choose box. The value binds to the 
+ * country ISO 3166 code. This is the same code as for 
+ * java.util.Locale.getCountry(). The official codes list is 
+ * available here : 
+ * 
+ * http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html

+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFComponent
  *   name = "t:selectOneCountry"
  *   class = "org.apache.myfaces.custom.selectOneCountry.SelectOneCountry"
@@ -54,11 +63,15 @@
     }
 
     /**
+     * Integer equals to the maximum number of characters in the country name.
+     * 
      * @JSFProperty
      */
     public abstract Integer getMaxLength();
     
     /**
+     * Integer equals to the maximum number of characters in the country name.
+     * 
      * @JSFProperty
      */
     public abstract String getEmptySelection();

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectOneLanguage/AbstractSelectOneLanguage.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectOneLanguage/AbstractSelectOneLanguage.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectOneLanguage/AbstractSelectOneLanguage.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectOneLanguage/AbstractSelectOneLanguage.java
Sat May 10 23:06:00 2008
@@ -35,6 +35,15 @@
 import org.apache.myfaces.shared_tomahawk.renderkit.RendererUtils;
 
 /**
+ * A localized list of languages choose box. The value binds to the 
+ * language ISO 639 code (lowercase). This is the same code as 
+ * for java.util.Locale.getLanguage(). The official codes 
+ * list is available here : 
+ * 
+ * http://www.loc.gov/standards/iso639-2/englangn.html 
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFComponent
  *   name = "t:selectOneLanguage"
  *   class = "org.apache.myfaces.custom.selectOneLanguage.SelectOneLanguage"
@@ -57,11 +66,15 @@
     }
 
     /**
+     * Integer equals to the maximum number of characters in the language name.
+     * 
      * @JSFProperty
      */
     public abstract Integer getMaxLength();
     
     /**
+     * Label and value to be used when displaying an empty selection
+     * 
      * @JSFProperty
      */
     public abstract String getEmptySelection();

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectitems/AbstractUISelectItems.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectitems/AbstractUISelectItems.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectitems/AbstractUISelectItems.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/selectitems/AbstractUISelectItems.java
Sat May 10 23:06:00 2008
@@ -30,6 +30,10 @@
 import javax.faces.model.SelectItemGroup;
 
 /**
+ * An extended version of the standard UISelectItems. Populates the 
+ * SelectItem collection from the given value automatically using 
+ * the itemLabel and itemValue attributes.
+ * 
  * @JSFComponent
  *   name = "t:selectItems"
  *   class = "org.apache.myfaces.custom.selectitems.UISelectItems"
@@ -44,16 +48,22 @@
     public static final String COMPONENT_TYPE = "org.apache.myfaces.UISelectItems";
     
     /**
+     * name of the iterator
+     * 
      * @JSFProperty
      */
 	public abstract String getVar();
 	
 	/**
+	 * name of the selectitem
+	 * 
 	 * @JSFProperty
 	 */
 	public abstract Object getItemLabel();
 
     /**
+     * value of the selectitem
+     * 
      * @JSFProperty
      */
 	public abstract Object getItemValue();

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/sortheader/AbstractHtmlCommandSortHeader.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/sortheader/AbstractHtmlCommandSortHeader.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/sortheader/AbstractHtmlCommandSortHeader.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/sortheader/AbstractHtmlCommandSortHeader.java
Sat May 10 23:06:00 2008
@@ -29,6 +29,23 @@
 import org.apache.myfaces.component.html.ext.HtmlDataTable;
 
 /**
+ * Clickable sort column header. 
+ * 
+ * Must be nested inside an extended data_table tag. This tag is 
+ * derived from the standard command_link tag and has the additional 
+ * attributes columnName and arrow. 
+ * 
+ * Note: In contrast to normal command links, the default for the 
+ * "immediate" attribute is "true". This is desirable as it avoids 
+ * validating all input fields in the enclosing form when the column 
+ * sort order changes. HOWEVER when the table contains input 
+ * components "immediate" must be set to false; otherwise input 
+ * fields will render blank after a sort, or will show their old 
+ * values (ie will not appear to sort though output fields in the 
+ * table will sort) when sort ordering is changed. 
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFComponent
  *   name = "t:commandSortHeader"
  *   class = "org.apache.myfaces.custom.sortheader.HtmlCommandSortHeader"
@@ -105,17 +122,32 @@
     }
 
     /**
+     * The name of this column. This name must uniquely identify this 
+     * column among all other (sortable) columns in the same 
+     * data_table. The sortColumn attribute of the embedding 
+     * data_table reflects the current sort column (see extended 
+     * data_table).
+     * 
      * @JSFProperty
      *   required="true"
      */
     public abstract String getColumnName();
 
     /**
+     * The property name associated with this column. This name must 
+     * be one of the properties of the row object by which the sorting 
+     * should be performed. The sortProperty attribute of the 
+     * embedding data_table reflects the current sort property 
+     * (see extended data_table).
+     * 
      * @JSFProperty
      */
     public abstract String getPropertyName();
 
     /**
+     * Indicates whether an arrow, that shows the sort direction 
+     * should be rendered. Default: false
+     * 
      * @JSFProperty
      *   defaultValue = "false"
      */

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/stylesheet/AbstractStylesheet.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/stylesheet/AbstractStylesheet.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/stylesheet/AbstractStylesheet.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/stylesheet/AbstractStylesheet.java
Sat May 10 23:06:00 2008
@@ -25,6 +25,8 @@
 
 
 /**
+ * Renders the path to a common CSS-file
+ * 
  * @JSFComponent
  *   name = "t:stylesheet"
  *   class = "org.apache.myfaces.custom.stylesheet.Stylesheet"
@@ -42,12 +44,16 @@
 	private static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.Stylesheet";
 
 	/**
+	 * URL for CSS-file.
+	 * 
 	 * @JSFProperty
 	 *   required="true"
 	 */
 	public abstract String getPath();
 
 	/**
+	 * Inline the stylesheet file content as in contrast to referencing it as .
+	 * 
 	 * @JSFProperty
 	 *   defaultValue = "false"
 	 * @return true if the styles are inlined to the jsp file
@@ -55,6 +61,11 @@
 	public abstract boolean isInline();
 
 	/**
+	 * true|false. 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.
+	 * 
 	 * @JSFProperty
 	 *   defaultValue = "false"
 	 * @return true if the stylesheet should be filtered before sending to the browser
@@ -62,6 +73,35 @@
 	public abstract boolean isFiltered();
 
     /**
+     * Define the target media of the styles:
+     *     <dl>
+     *       <dt>screen</dt>
+     *       <dd>Intended for non-paged computer screens.</dd>
+     *       <dt>tty</dt>
+     *       <dd>Intended for media using a fixed-pitch character grid, such
+     *         as teletypes, terminals, or portable devices with limited
+     *         display capabilities.</dd>
+     *       <dt>tv</dt>
+     *       <dd>Intended for television-type devices (low resolution,
+     *         color, limited scrollability).</dd>
+     *       <dt>projection</dt>
+     *       <dd>Intended for projectors.</dd>
+     *       <dt>handheld</dt>
+     *       <dd>Intended for handheld devices (small screen, monochrome,
+     *         bitmapped graphics, limited bandwidth).</dd>
+     *       <dt>print</dt>
+     *       <dd>Intended for paged, opaque material and for documents
+     *         viewed on screen in print preview mode.</dd>
+     *       <dt>braille</dt>
+     *       <dd>Intended for braille tactile feedback devices.</dd>
+     *       <dt>aural</dt>
+     *       <dd>Intended for speech synthesizers.</dd>
+     *       <dt>all</dt>
+     *       <dd>Suitable for all devices.</dd>
+     *     </dl>
+     *     Could be a comma separated list.
+     *     See also http://www.w3.org/TR/REC-html40/types.html#type-media-descriptors
+     * 
      * @JSFProperty
      */
 	public abstract String getMedia();

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/swapimage/AbstractHtmlSwapImage.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/swapimage/AbstractHtmlSwapImage.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/swapimage/AbstractHtmlSwapImage.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/swapimage/AbstractHtmlSwapImage.java
Sat May 10 23:06:00 2008
@@ -26,6 +26,8 @@
 import org.apache.myfaces.component.UserRoleUtils;
 
 /**
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFComponent
  *   name = "t:swapImage"
  *   class = "org.apache.myfaces.custom.swapimage.HtmlSwapImage"
@@ -44,84 +46,124 @@
     private static final boolean DEFAULT_ISMAP = false;
 
     /**
+     * HTML: Specifies the width of the border of this element, in pixels. Deprecated in
HTML 4.01.
+     * 
      * @JSFProperty
      *   defaultValue="Integer.MIN_VALUE"
      */
     public abstract String getBorder();
 
     /**
+     * HTML: The amount of white space to be inserted to the left and 
+     * right of this element, in undefined units. 
+     * Deprecated in HTML 4.01.
+     * 
      * @JSFProperty
      */
     public abstract String getHspace();
     
     /**
+     *  HTML: The amount of white space to be inserted above and 
+     *  below this element, in undefined units. 
+     *  Deprecated in HTML 4.01.
+     * 
      * @JSFProperty
      */
     public abstract String getVspace();
     
     /**
+     * the url of the image displayed onmouseover
+     * 
      * @JSFProperty
      *   required="true"
      */
     public abstract String getSwapImageUrl();
 
     /**
+     * activeImage will be rendered if: swapImage is a direct 
+     * child of commandNavigation and the commandNavigation.isActive
+     * 
      * @JSFProperty
      */
     public abstract String getActiveImageUrl();
 
     /**
+     * HTML: Specifies alternative text that can be used by a browser 
+     * that can't show this element.
+     * 
      * @JSFProperty
      */
     public abstract String getAlt();
 
     /**
+     * HTML: Overrides the natural height of this image, by specifying 
+     * height in pixels.
+     * 
      * @JSFProperty
      */
     public abstract String getHeight();
 
     /**
+     * HTML: Specifies server-side image map handling for this image.
+     * 
      * @JSFProperty
      *   defaultValue = "false"
      */
     public abstract boolean isIsmap();
 
     /**
+     * HTML: A link to a long description of the image.
+     * 
      * @JSFProperty
      */
     public abstract String getLongdesc();
 
     /**
+     * HTML: Script to be invoked when the element is clicked.
+     * 
      * @JSFProperty
      */
     public abstract String getOnclick();
 
     /**
+     * HTML: Script to be invoked when the element is double-clicked.
+     * 
      * @JSFProperty
      */
     public abstract String getOndblclick();
 
     /**
+     * HTML: Script to be invoked when a key is pressed down over this element.
+     * 
      * @JSFProperty
      */
     public abstract String getOnkeydown();
 
     /**
+     * HTML: Script to be invoked when a key is pressed over this element.
+     * 
      * @JSFProperty
      */
     public abstract String getOnkeypress();
 
     /**
+     * HTML: Script to be invoked when a key is released over this element.
+     * 
      * @JSFProperty
      */
     public abstract String getOnkeyup();
 
     /**
+     * HTML: Specifies an image map to use with this image.
+     * 
      * @JSFProperty
      */
     public abstract String getUsemap();
 
     /**
+     * HTML: Overrides the natural width of this image, by 
+     * specifying width in pixels.
+     * 
      * @JSFProperty
      */
     public abstract String getWidth();

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tabbedpane/AbstractHtmlPanelTab.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tabbedpane/AbstractHtmlPanelTab.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tabbedpane/AbstractHtmlPanelTab.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tabbedpane/AbstractHtmlPanelTab.java
Sat May 10 23:06:00 2008
@@ -30,6 +30,10 @@
 import javax.faces.el.ValueBinding;
 
 /**
+ * TODO: Document this component.
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFComponent
  *   name = "t:panelTab"
  *   class = "org.apache.myfaces.custom.tabbedpane.HtmlPanelTab"
@@ -51,11 +55,15 @@
     private static final boolean DEFAULT_DISABLED = false;
 
     /**
+     * Label of this tab.
+     * 
      * @JSFProperty
      */
     public abstract String getLabel();
 
     /**
+     * HTML: When true, this element cannot receive focus.
+     * 
      * @JSFProperty
      *   defaultValue = "false"
      */

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tabbedpane/AbstractHtmlPanelTabbedPane.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tabbedpane/AbstractHtmlPanelTabbedPane.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tabbedpane/AbstractHtmlPanelTabbedPane.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tabbedpane/AbstractHtmlPanelTabbedPane.java
Sat May 10 23:06:00 2008
@@ -39,6 +39,10 @@
 import org.apache.myfaces.component.UserRoleAware;
 
 /**
+ * TODO: Document this component.
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFComponent
  *   name = "t:panelTabbedPane"
  *   class = "org.apache.myfaces.custom.tabbedpane.HtmlPanelTabbedPane"
@@ -227,11 +231,17 @@
     public abstract String getActiveTabVar();
     
     /**
+     * Boolean Variable that is set in request scope when 
+     * rendering a panelTab. True means that the currently 
+     * rendered panelTab is active.
+     * 
      * @JSFProperty
      */
     public abstract Boolean getActivePanelTabVar();
 
     /**
+     * Index of tab that is selected by default.
+     * 
      * @JSFProperty
      *   defaultValue = "0"
      */
@@ -240,36 +250,50 @@
     public abstract void setSelectedIndex(int selectedIndex);
 
     /**
+     * Style class of the active tab cell.
+     * 
      * @JSFProperty
      */
     public abstract String getActiveTabStyleClass();
 
     /**
+     * Style class of the inactive tab cells.
+     * 
      * @JSFProperty
      */
     public abstract String getInactiveTabStyleClass();
 
     /**
+     * Style class of the active tab sub cell.
+     * 
      * @JSFProperty
      */
     public abstract String getActiveSubStyleClass();
 
     /**
+     * Style class of the inactive tab sub cells.
+     * 
      * @JSFProperty
      */
     public abstract String getInactiveSubStyleClass();
 
     /**
+     * Style class of the active tab content cell.
+     * 
      * @JSFProperty
      */
     public abstract String getTabContentStyleClass();
 
     /**
+     * Style class of the disabled tab cells.
+     * 
      * @JSFProperty
      */
     public abstract String getDisabledTabStyleClass();
 
     /**
+     * Toggle client-side/server-side tab switches.
+     * 
      * @JSFProperty
      *   defaultValue = "false"
      */

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/AbstractHtmlTreeCheckbox.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/AbstractHtmlTreeCheckbox.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/AbstractHtmlTreeCheckbox.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/AbstractHtmlTreeCheckbox.java
Sat May 10 23:06:00 2008
@@ -19,10 +19,19 @@
 package org.apache.myfaces.custom.tree;
 
 import javax.faces.component.UISelectItem;
-import javax.faces.context.FacesContext;
-import javax.faces.el.ValueBinding;
 
 /**
+ * Renders a HTML input of type "treeCheckbox". 
+ * 
+ * The associated comes from the treeCheckbox itemLabel and itemValue. 
+ * The selected items come from an extended selectManyCheckbox 
+ * component with layout "spread". The selectManyCheckbox is 
+ * referenced by the "for" attribute. 
+ * 
+ * All HTML pass-through attributes for this input are taken from 
+ * the associated selectManyCheckbox. 
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
  * 
  * @JSFComponent
  *   name = "t:treeCheckbox"
@@ -48,6 +57,8 @@
     private static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.HtmlTreeCheckbox";
         
     /**
+     * id of the referenced extended selectManyCheckbox component
+     * 
      * @JSFProperty
      * @return The for attribute.
      */

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTree.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTree.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTree.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTree.java
Sat May 10 23:06:00 2008
@@ -39,6 +39,8 @@
 
 
 /**
+ * A tree data component. 
+ * Unless otherwise specified, all attributes accept static values or EL expressions. h
  * <p/>
  * Tree implementation based on javax.swing.JTree.
  * </p>
@@ -475,6 +477,9 @@
 
 
     /**
+     * Time interval the tree will remain registered as a TreeModelListener 
+     * without being accessed
+     * 
      * @JSFProperty
      */
     public long getExpireListeners()

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTreeColumn.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTreeColumn.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTreeColumn.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree/HtmlTreeColumn.java
Sat May 10 23:06:00 2008
@@ -21,6 +21,12 @@
 import javax.faces.component.UIColumn;
 
 /**
+ * Renders a HTML input of type "treeColumn". 
+ * <p>
+ * This tag outlines the column where the tree structure will be 
+ * render as part of the tree table. Unless otherwise specified, 
+ * all attributes accept static values or EL expressions.
+ * </p>
  * <p>
  * Tree column model. This column is used to provide the place holder for the
  * tree.  This is used in conjunction with the table format display.

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree2/AbstractHtmlTree.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree2/AbstractHtmlTree.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree2/AbstractHtmlTree.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/tree2/AbstractHtmlTree.java
Sat May 10 23:06:00 2008
@@ -32,6 +32,17 @@
  * Represents "tree data" in an HTML format.  Also provides a mechanism for maintaining expand/collapse
  * state of the nodes in the tree.
  *
+ * A component that provides an HTML-based tree from data supplied by a 
+ * backing bean. The tree is highly customizable and allows for 
+ * fine-grained control over the appearance of each of the nodes 
+ * depending on their type. 
+ * 
+ * Almost any type of JSF component (text, image, checkbox, etc.) can 
+ * be rendered inside the nodes and there is an option for client-side 
+ * or server-side toggling of the expand/collapse state. 
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions.
+ * 
  * @JSFComponent
  *   name = "t:tree2"
  *   class = "org.apache.myfaces.custom.tree2.HtmlTree"
@@ -55,7 +66,8 @@
     private boolean _clientSideToggleSet;
 
     /**
-     * Gets 
+     * Perform client-side toggling of expand/collapse state via javascript (default is true.)
+     * 
      * @JSFProperty
      *   defaultValue = "true"
      * @return  the new clientSideToggle value
@@ -174,24 +186,34 @@
     }
         
     /**
+     * Show the "plus" and "minus" navigation icons (default is true.) 
+     * Value is ignored if clientSideToggle is true.
+     * 
      * @JSFProperty
      *   defaultValue = "true"
      */
     public abstract boolean isShowNav();
 
     /**
+     * Show the connecting lines (default is true.)
+     * 
      * @JSFProperty
      *   defaultValue = "true"
      */
     public abstract boolean isShowLines();
 
     /**
+     * Include the root node when rendering the tree (default is true.)
+     * 
      * @JSFProperty
      *   defaultValue = "true"
      */
     public abstract boolean isShowRootNode();
 
     /**
+     * Preserve changes in client-side toggle information between 
+     * requests (default is true.)
+     * 
      * @JSFProperty
      *   defaultValue = "true"
      */

Modified: myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/updateactionlistener/UpdateActionListenerTag.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/updateactionlistener/UpdateActionListenerTag.java?rev=655253&r1=655252&r2=655253&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/updateactionlistener/UpdateActionListenerTag.java
(original)
+++ myfaces/myfaces-build-tools/branches/builder_plugin/bigtest/tomahawk_trunk/core/src/main/java/org/apache/myfaces/custom/updateactionlistener/UpdateActionListenerTag.java
Sat May 10 23:06:00 2008
@@ -29,6 +29,14 @@
 import javax.servlet.jsp.tagext.TagSupport;
 
 /**
+ * Registers an org.apache.myfaces.custom.updateactionlistener.UpdateActionListener 
+ * at the parent component (which must be an ActionSource). 
+ * 
+ * When the parent's action fires the specified value is evaluated, 
+ * then written into the specified property. 
+ * 
+ * Unless otherwise specified, all attributes accept static values or EL expressions. 
+ * 
  * JSF 1.2 introduces a "setPropertyActionListener" with the same functionality like this.

  *
  * @JSFJspTag
@@ -52,6 +60,9 @@
     }
 
     /**
+     * A value-binding that specifies a property to be updated when 
+     * the parent's action occurs.
+     * 
      * @JSFJspAttribute
      *   required="true"
      */
@@ -61,6 +72,10 @@
     }
 
     /**
+     *  A literal value or value-binding that specifies what 
+     *  will be assigned to the destination specified by the 
+     *  property attribute.
+     * 
      * @JSFJspAttribute
      *   required="true"
      */
@@ -70,6 +85,11 @@
     }
 
     /**
+     * The name of a registered Converter object which will be 
+     * invoked to convert the value into an appropriate datatype 
+     * for assigning to the specified property. If not specified 
+     * then an appropriate converter will be selected automatically.
+     * 
      * @JSFJspAttribute
      */
     public void setConverter(String converter)



Mime
View raw message