| <?xml version="1.0" encoding="UTF-8"?> |
| <document url="JSFlow.html"> |
| <!-- |
| WARNING: This file is automatically generated from a jsdoc processor that |
| turns javadoc-type comments of Javascript and special Java files into an xml file, which is |
| then processed by an xsl file to create this document. Do not modify this |
| file, but rather either modify the comments or xsl file. |
| --> |
| <properties> |
| <title>Variable 'flow'</title> |
| </properties> |
| <body> |
| <section href="summary" name="Variable 'flow'"> |
| <p>This variable provides an interface to the chain context and other helpful objects. The primary way to pass information into a script is through the chain context. All interactions with the outside environment is through Commons Chain to help Struts Flow to work in a Servlet, Java Service Faces, Portlet, or any other external context, even if that context isn't web-based. This variable specifically doesn't contain any Struts-related methods to allow Struts Flow to be used outside Struts.</p> |
| <dl> |
| <dt> |
| <strong>Author: </strong> |
| </dt> |
| <dd><a href="mailto:ovidiu@cup.hp.com">Ovidiu Predescu</a></dd> |
| <dt> |
| <strong>Author: </strong> |
| </dt> |
| <dd><a href="snoopdave@users.sourceforge.net">Dave Johnson</a></dd> |
| <dt> |
| <strong>See Also: </strong> |
| </dt> |
| <dd><a href="http://jakarta.apache.org/commons/chain">Jakarta Commons Chain</a></dd> |
| </dl> |
| <table width="100%"> |
| <tr> |
| <th colspan="2">Property Summary</th> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>NativeArray</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#prop_parameters">parameters</a> |
| </code> |
| </strong> |
| <dd>Gets the parameters passed by the Flow container</dd> |
| </td> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>JavaScriptInterpreter</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#prop_interpreter">interpreter</a> |
| </code> |
| </strong> |
| <dd>Gets the interpreter</dd> |
| </td> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>Context</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#prop_context">context</a> |
| </code> |
| </strong> |
| <dd>Gets the chain context</dd> |
| </td> |
| </tr> |
| </table> |
| <br/> |
| <table width="100%"> |
| <tr> |
| <th colspan="2">Function Summary</th> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>Object</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#fn_load">load(java.lang.String filename)</a> |
| </code> |
| </strong> |
| <dd>Load the script file specified as argument.</dd> |
| </td> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>Object</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#fn_resolveToPath">resolveToPath(java.lang.String filename)</a> |
| </code> |
| </strong> |
| <dd/> |
| </td> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>String</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#fn_toString">toString()</a> |
| </code> |
| </strong> |
| <dd>Shows the state of this object</dd> |
| </td> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>void</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#fn_diplayAllContinuations">diplayAllContinuations()</a> |
| </code> |
| </strong> |
| <dd>Displays all continuations for debugging</dd> |
| </td> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>Map</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#fn_jsobjectToMap">jsobjectToMap(org.mozilla.javascript.Scriptable jsobject)</a> |
| </code> |
| </strong> |
| <dd>Converts a JavaScript object to a HashMap</dd> |
| </td> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>Object</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#fn_get">get(java.lang.String id)</a> |
| </code> |
| </strong> |
| <dd>Gets the value from the chain context</dd> |
| </td> |
| </tr> |
| <tr> |
| <td width="5%"> |
| <code>void</code> |
| </td> |
| <td> |
| <strong> |
| <code> |
| <a href="#fn_put">put(java.lang.String id, java.lang.Object o)</a> |
| </code> |
| </strong> |
| <dd>Puts an object in the chain context</dd> |
| </td> |
| </tr> |
| </table> |
| </section> |
| <section name="Properties"> |
| <section href="prop_parameters" name="parameters"> |
| <pre>NativeArray parameters</pre> |
| <p>Gets the parameters passed by the Flow container</p> |
| </section> |
| <section href="prop_interpreter" name="interpreter"> |
| <pre>JavaScriptInterpreter interpreter</pre> |
| <p>Gets the interpreter</p> |
| </section> |
| <section href="prop_context" name="context"> |
| <pre>Context context</pre> |
| <p>Gets the chain context</p> |
| </section> |
| </section> |
| <section name="Functions"> |
| <section href="fn_load" name="load"> |
| <pre>Object load(java.lang.String filename)</pre> |
| <p>Load the script file specified as argument. The path is resolved from the same root as the calling script.</p> |
| <dl> |
| <dt> |
| <strong>Parameters:</strong> |
| </dt> |
| <dd> |
| <code>filename</code> - |
| a <code>String</code> value</dd> |
| </dl> |
| <dl> |
| <dt> |
| <strong>Returns: </strong> |
| </dt> |
| <dd>an <code>Object</code> value</dd> |
| </dl> |
| </section> |
| <section href="fn_resolveToPath" name="resolveToPath"> |
| <pre>Object resolveToPath(java.lang.String filename)</pre> |
| <p/> |
| <dl/> |
| </section> |
| <section href="fn_toString" name="toString"> |
| <pre>String toString()</pre> |
| <p>Shows the state of this object</p> |
| <dl> |
| <dt> |
| <strong>Returns: </strong> |
| </dt> |
| <dd>The string state</dd> |
| </dl> |
| </section> |
| <section href="fn_diplayAllContinuations" name="diplayAllContinuations"> |
| <pre>void diplayAllContinuations()</pre> |
| <p>Displays all continuations for debugging</p> |
| <dl/> |
| </section> |
| <section href="fn_jsobjectToMap" name="jsobjectToMap"> |
| <pre>Map jsobjectToMap(org.mozilla.javascript.Scriptable jsobject)</pre> |
| <p>Converts a JavaScript object to a HashMap</p> |
| <dl/> |
| </section> |
| <section href="fn_get" name="get"> |
| <pre>Object get(java.lang.String id)</pre> |
| <p>Gets the value from the chain context</p> |
| <dl> |
| <dt> |
| <strong>Parameters:</strong> |
| </dt> |
| <dd> |
| <code>id</code> - |
| The object id</dd> |
| </dl> |
| <dl> |
| <dt> |
| <strong>Returns: </strong> |
| </dt> |
| <dd>The object</dd> |
| </dl> |
| </section> |
| <section href="fn_put" name="put"> |
| <pre>void put(java.lang.String id, java.lang.Object o)</pre> |
| <p>Puts an object in the chain context</p> |
| <dl> |
| <dt> |
| <strong>Parameters:</strong> |
| </dt> |
| <dd> |
| <code>id</code> - |
| The id</dd> |
| <dd> |
| <code>o</code> - |
| The object</dd> |
| </dl> |
| <dl/> |
| </section> |
| </section> |
| </body> |
| </document> |
