svn commit: r688442 - /myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/dialog/AbstractModalDialog.java

[lu...@apache.org]

Author: lu4242
Date: Sat Aug 23 20:29:18 2008
New Revision: 688442

URL: http://svn.apache.org/viewvc?rev=688442&view=rev
Log:
fix html documentation

Modified:
    myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/dialog/AbstractModalDialog.java

Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/dialog/AbstractModalDialog.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/dialog/AbstractModalDialog.java?rev=688442&r1=688441&r2=688442&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/dialog/AbstractModalDialog.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/dialog/AbstractModalDialog.java Sat Aug 23 20:29:18 2008
@@ -31,27 +31,32 @@
  * the new window appears on top of the original. The original window does not respond to 
  * keys or clicks; only the new window can be accessed by the user. When the popup window
  * is closed then the original window is again accessable.
+ * </p>
  * <p>
  * When this component has a child facet named "titleBar" then the contents of that facet
  * are rendered at the top of the popup window. This facet is intended to allow users to
  * define their own custom window "decoration".
+ * </p>
  * <p>
  * When this component has no "titleBar" facet, but does have a "dialogTitle" property,
  * then a default window decoration is generated. It consists of a table row with two
  * cells. The left cell contains the dialogTitle text. If property renderCloseButton is
  * true, then the right cell holds a "close" icon. Styles are defined for the row and
  * cells so that the look-and-feel can be customised.
+ * </p>
  * <p>
  * The new window can optionally load a page from the server when it is displayed. If
  * one of viewId or contentURL is defined, then an internal frame is inserted after the
  * titleBar, and the specified contents is immediately loaded into the popup window when
  * it is displayed.
+ * </p>
  * <p>
  * The rest of the child components (ie other than titleBar) are displayed after the
  * titlebar (and after the contents of viewId or contentURL if it is defined).
+ * </p>
  * <p>
  * This component internally uses the Dojo modal window widget.
- * <p>  
+ * </p>
  * 
  * @JSFComponent
  *   name = "s:modalDialog"
@@ -77,8 +82,10 @@
      * <p>
      * This id can be useful for controlling the dialog with javascript. However in most
      * cases it is not necessary.
+     * </p>
      * <p>
      * If this is property is not defined then an id will be automatically generated.
+     * </p>
      * 
      * @JSFProperty
      */
@@ -90,9 +97,10 @@
      * <p>
      * For example, if this is "myDialog" then a javascript object with name
      * "myDialog" will be defined. This exposes the following methods:
+     * </p>
      * <ul>
-     * <li>myDialog.show() will display the modal dialog window
-     * <li>myDialog.hide() will hide it (though this is not normally needed). 
+     * <li>myDialog.show() will display the modal dialog window</li>
+     * <li>myDialog.hide() will hide it (though this is not normally needed).</li> 
      * </ul>
      * 
      * @JSFProperty
@@ -108,12 +116,14 @@
      * If the standard title-bar is displayed (ie no custom titleBar facet exists,
      * and property dialogTitle is defined) then the standard close-button in that
      * bar is automatically included.
+     * </p>
      * <p>
      * If the child components of this component (which will appear in the popup)
      * include other items that should cause the window to close (ie a button) then
      * their ids should be defined via this property. This component will then
      * automatically wire them up to the necessary functions to cause the popup
      * to be closed when they are activated.
+     * </p>
      * 
      * @JSFProperty
      */
@@ -125,14 +135,17 @@
      * Optional; when not defined (or defined as an EL expression, but that expression returns null)
      * then the popup dialog will be opened with no content. Presumably custom javascript in the
      * calling page will arrange to populate the window content appropriately.
+     * </p>
      * <p>
      * The modalDialog component treats this as a <i>url</i> relative to the webapp base. The value
      * should not start with a slash.
+     * </p>
      * <p> 
      * Note that technically this value is not a viewId. A viewId is the internal path to the
      * page definition (eg "foo.jsp" or "foo.xhtml"). What the browser accesses is a URL (which
      * contains the path that triggers the facelets servlet, eg "foo.faces" or "foo.jsf" or
-     * "/faces/foo". 
+     * "/faces/foo".
+     * </p>
      * The valueIt should not start with a slash.
      * 
      * @JSFProperty
@@ -143,6 +156,7 @@
      * The URL to show within the content area of the dialog.
      * <p>
      * This may be:
+     * </p>
      * <ul>
      * <li>an absolute url ("http://..")</li>
      * <li>a url relative to the current webapp</li>
@@ -170,7 +184,7 @@
      * <p>
      * This value is also used as a base for defining style classes for parts of the
      * standard window "title bar" decoration.
-     * 
+     * </p>
      * 
      * @JSFProperty
      */
@@ -188,6 +202,7 @@
      * (ie the "window decoration").
      * <p>
      * Ignored if there is a "titleBar" facet as a child.
+     * </p>
      * 
      * @JSFProperty
      */
@@ -199,8 +214,10 @@
      * <p>
      * Ignored if there is a "titleBar" facet as a child, or dialogTitle is
      * not defined. 
+     * </p>
      * <p>
      * Defaults to true.
+     * </p>
      * 
      * @JSFProperty
      */