svn commit: r469656 - in /shale/framework/trunk/shale-dialog-scxml/src: main/java/org/apache/shale/dialog/scxml/DialogStateMapper.java main/java/org/apache/shale/dialog/scxml/impl/DefaultDialogStateMapper.java site/xdoc/index.xml

[ra...@apache.org]

Author: rahul
Date: Tue Oct 31 13:18:18 2006
New Revision: 469656

URL: http://svn.apache.org/viewvc?view=rev&rev=469656
Log:
Website docs for the DialogStateMapper (and related Javadoc improvements). Remove related TODO.
SHALE-306

Modified:
    shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/DialogStateMapper.java
    shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/impl/DefaultDialogStateMapper.java
    shale/framework/trunk/shale-dialog-scxml/src/site/xdoc/index.xml

Modified: shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/DialogStateMapper.java
URL: http://svn.apache.org/viewvc/shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/DialogStateMapper.java?view=diff&rev=469656&r1=469655&r2=469656
==============================================================================
--- shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/DialogStateMapper.java (original)
+++ shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/DialogStateMapper.java Tue Oct 31 13:18:18 2006
@@ -30,7 +30,9 @@
  * JavaServer Faces <code>view identifier</code> used is the same as
  * the dialog state identifier.</p>
  *
- * TODO: Add mention in website docs.
+ * <p>The default behavior can be changed by replacing the application
+ * scoped bean at key {@link Globals#STATE_MAPPER}. The replacement
+ * must implement {@link DialogStateMapper}.</p>
  *
  * @since 1.0.4
  *

Modified: shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/impl/DefaultDialogStateMapper.java
URL: http://svn.apache.org/viewvc/shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/impl/DefaultDialogStateMapper.java?view=diff&rev=469656&r1=469655&r2=469656
==============================================================================
--- shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/impl/DefaultDialogStateMapper.java (original)
+++ shale/framework/trunk/shale-dialog-scxml/src/main/java/org/apache/shale/dialog/scxml/impl/DefaultDialogStateMapper.java Tue Oct 31 13:18:18 2006
@@ -36,6 +36,12 @@
      * <p>The default implementation is an identity transform which
      * returns the dialog state ID as the next JavaServer Faces
      * <code>view identifier</code>.</p>
+     *
+     * @param dialogName The logical name of the dialog this state belongs to
+     * @param stateId The state identifier for the current dialog state
+     * @param context The current {@link FacesContext}
+     * @return The JavaServer Faces <code>view identifier</code> that should
+     *         be rendered
      */
     public String mapStateId(String dialogName, String stateId,
             FacesContext context) {

Modified: shale/framework/trunk/shale-dialog-scxml/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/shale/framework/trunk/shale-dialog-scxml/src/site/xdoc/index.xml?view=diff&rev=469656&r1=469655&r2=469656
==============================================================================
--- shale/framework/trunk/shale-dialog-scxml/src/site/xdoc/index.xml (original)
+++ shale/framework/trunk/shale-dialog-scxml/src/site/xdoc/index.xml Tue Oct 31 13:18:18 2006
@@ -120,6 +120,12 @@
           </li>
 
           <li>View state instances use event guards to wait for postback.
+          The mapping between the &lt;state&gt; <code>id</code> and the
+          JavaServer Faces <code>view identifier</code> is pluggable.
+          The default mapping is an identity transform i.e. the state
+          identifier is reused as the view identifier. See the
+          <a href="apidocs/org/apache/shale/dialog/scxml/DialogStateMapper.html">DialogStateMapper
+          Javadocs</a> for details.
 <source>
 &lt;!-- A "view" state, the default convention maps this state to
     to the JSF view identifier "/logon" --&gt;