webwork/src/docs/manual tag-attributes.html,1.4,1.5 tag.jsp,1.10,1.11
[email protected] Thu, 08 Jan 2004 09:13:46 -0800
| Newsgroups | gmane.comp.java.open-symphony.cvs |
|---|---|
| Message-ID | <[email protected]> |
Update of /cvsroot/opensymphony/webwork/src/docs/manual
In directory sc8-pr-cvs1:/tmp/cvs-serv13961/src/docs/manual
Modified Files:
tag-attributes.html tag.jsp
Log Message:
Fix for ww-208
Index: tag-attributes.html
===================================================================
RCS file: /cvsroot/opensymphony/webwork/src/docs/manual/tag-attributes.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- tag-attributes.html 30 Dec 2002 06:55:01 -0000 1.4
+++ tag-attributes.html 8 Jan 2004 17:13:44 -0000 1.5
@@ -7,9 +7,9 @@
<body bgcolor="#FFFFFF" text="#000000">
-<p>This is an exhaustive list of attributes used by WW custom tags. All tags except id are WW
-value expressions or for test attribute a conditional expression which is by its very nature
-made up of value expressions. Since they are value expressions, you have the ability to
+<p>This is an exhaustive list of attributes used by WW custom tags. All tags except id are WW
+value expressions or for test attribute a conditional expression which is by its very nature
+made up of value expressions. Since they are value expressions, you have the ability to
access data in different scopes, objects, etc.</p>
<p><h2>JSP Attributes</h2></p>
@@ -17,121 +17,130 @@
<ol>
<li><em><a name="jsp-cols">cols</a></em> - This attribute specifies the visible width in average character widths. </li>
<li><em><a name="jsp-comparator">comparator</a></em> - This attribute will be the Comparator used to sort the Collection. </li>
- <li><em><a name="jsp-contentName">contentName</a></em> - This attribute is the name of the data map to be used to display the tabs and associate URLs with tabs. </li>
- <li><em><a name="jsp-count">count</a></em> - This attribute indicates how many items there are. </li>
- <li><em><a name="jsp-disabled">disabled</a></em> - This boolean attribute disables the control for user input. </li>
- <li><em><a name="jsp-escape">escape</a></em> - Determines if the contents should be escaped appropriately for valid HTML characters. </li>
- <li><em><a name="jsp-fieldValue">fieldValue</a></em> - This attribute is the value displayed by the control. It equates to the value of the HTML INPUT tag. </li>
- <li><em><a name="jsp-id">id</a></em> - This attribute assigns a name to an element. This name must be unique in a document.
- This attribute is the standard id supported by JSP TagSupport and is therefore always a string.
- You do not need to indicate a string literal as you would for the rest of WW attributes; i.e. - id="'age'".
- Instead you should use id="age". </li>
- <li><em><a name="jsp-label">label</a></em> - This attribute is used to display a description or label associated with a form control. </li>
- <li><em><a name="jsp-labelposition">labelposition</a></em> - This attribute indicates the location of the label with respect
- to the form control. The allowable value is top. The default position is left of the form control. </li>
- <li><em><a name="jsp-list">list</a></em> - This attribute is a list for form controls to use. For radio controls,
- it will provide the options for the control which equates to the HTML LABEL tags. For select controls,
- it will provide the options for the control which equates to the HTML OPTION tags in the SELECT and
- supplies both the NAME and VALUE parameters of the OPTION tag. </li>
- <li><em><a name="jsp-listKey">listKey</a></em> - This attribute indicates where to get the values for the INPUT tag.
- For select and radio controls, it equates to the VALUE parameter of the INPUT tag. </li>
- <li><em><a name="jsp-listValue">listValue</a></em> - This attribute is the value displayed next to the radio control
- or it is the items in the select display. </li>
- <li><em><a name="jsp-maxlength">maxlength</a></em> - This attribute specifies the maximum number of characters the user may enter. </li>
- <li><em><a name="jsp-modelName">modelName</a></em> - This attribute indicates the TableModel for the control to use. </li>
- <li><em><a name="jsp-multiple">multiple</a></em> - This attribute determines if the SELECT supports multiple selections. </li>
- <li><em><a name="jsp-name">name</a></em> - For Action tag, it indicates the name of the action to invoke. For UI tags,
- this attribute assigns the control name. The scope of the name attribute for a control within a FORM element is
- the FORM element. </li>
- <li><em><a name="jsp-onchange">onchange</a></em> - The onchange event occurs when a control loses the input focus and
- its value has been modified since gaining focus. </li>
- <li><em><a name="jsp-onkeyup">onkeyup</a></em> - The onkeyup event occurs when a key is released over an element. </li>
- <li><em><a name="jsp-page">page</a></em> - This attribute points to a JSP page to include. </li>
- <li><em><a name="jsp-readonly">readonly</a></em> - This boolean attribute prohibits changes to the control. </li>
- <li><em><a name="jsp-rows">rows</a></em> - This attribute specifies the number of visible text lines. </li>
- <li><em><a name="jsp-separator">separator</a></em> - This attribute is the character the StringTokenizer will use to create tokens. </li>
- <li><em><a name="jsp-size">size</a></em> - This attribute tells the user agent the initial width of the control.
- For SELECT controls, this specifies the number of rows in the list that should be visible at the same time. </li>
- <li><em><a name="jsp-sortable">sortable</a></em> - This attribute indicates if table should be sorted. </li>
- <li><em><a name="jsp-sortColumn">sortColumn</a></em> - This attribute indicates which column should be sorted on creation.</li>
- <li><em><a name="jsp-sortOrder">sortOrder</a></em> - This attribute indicates the sort order on creation. </li>
- <li><em><a name="jsp-source">source</a></em> - This attribute is the source the tag will use to perform work on.
- It may be Enumeration, Iterator, or a Collection. </li>
- <li><em><a name="jsp-start">start</a></em> - This attribute indicates the index to start reading. </li>
- <li><em><a name="jsp-status">status</a></em> - This attribute indicates the name of the IteratorStatus object
- to be exposed. An IteratorStatus allows one to get information about the status of the iteration, such
- as the size, current index, and whether any more items are available. </li>
- <li><em><a name="jsp-tabAlign">tabAlign</a></em> - This attribute specifies the alignment of the tabs. For tabbedpane,
- the default is the CENTER of the control. </li>
- <li><em><a name="jsp-tabindex">tabindex</a></em> - This attribute specifies the position of the current element in the
- tabbing order for the current document. </li>
- <li><em><a name="jsp-template">template</a></em> - This attribute is the JSP the tag will use to render itself.
- Each control has a default template. </li>
- <li><em><a name="jsp-test">test</a></em> - This attribute is the conditional expression evaluated by WW's parser.
- It returns boolean true or false. </li>
- <li><em><a name="jsp-theme">theme</a></em> - This attribute points to a directory of UI tags. This directory
- will be used to retrieve a UI tag's respective template. It allows you to group together templates
- that together represent a "theme". The default theme is xhtml. </li>
- <li><em><a name="jsp-val">val</a></em> - This attribute is the list of values the generator should use to create tokens. </li>
- <li><em><a name="jsp-value">value</a></em> - This attribute is used to pass data to the tag. The tag will use the value as it sees fit. </li>
+ <li><em><a name="jsp-contentName">contentName</a></em> - This attribute is the name of the data map to be used to display the tabs and associate URLs with tabs. </li>
+ <li><em><a name="jsp-count">count</a></em> - This attribute indicates how many items there are. </li>
+ <li><em><a name="jsp-disabled">disabled</a></em> - This boolean attribute disables the control for user input. </li>
+ <li><em><a name="jsp-encode">encode</a></em> - Determines if the url should be encoded to include session tokens and suchlike. </li>
+ <li><em><a name="jsp-escape">escape</a></em> - Determines if the contents should be escaped appropriately for valid HTML characters. </li>
+ <li><em><a name="jsp-fieldValue">fieldValue</a></em> - This attribute is the value displayed by the control. It equates to the value of the HTML INPUT tag. </li>
+ <li><em><a name="jsp-id">id</a></em> - This attribute assigns a name to an element. This name must be unique in a document.
+ This attribute is the standard id supported by JSP TagSupport and is therefore always a string.
+ You do not need to indicate a string literal as you would for the rest of WW attributes; i.e. - id="'age'".
+ Instead you should use id="age". </li>
+ <li><em><a name="jsp-label">includeParams</a></em> - The includeParams attribute may have the value 'none', 'get' or 'all'.
+ It is used when the url tag is used without a value or page attribute. Its value is looked up on the ValueStack.
+ If no includeParams is specified then 'get' is used.<br>
+ * none - include no parameters in the URL<br>
+ * get - include only GET parameters in the URL (default)<br>
+ * all - include both GET and POST parameters in the URL
+ </li>
+ <li><em><a name="jsp-label">includeContext</a></em> - Determines whether the context path should be prepended to absolute urls or not. Default is true. </li>
+ <li><em><a name="jsp-label">label</a></em> - This attribute is used to display a description or label associated with a form control. </li>
+ <li><em><a name="jsp-labelposition">labelposition</a></em> - This attribute indicates the location of the label with respect
+ to the form control. The allowable value is top. The default position is left of the form control. </li>
+ <li><em><a name="jsp-list">list</a></em> - This attribute is a list for form controls to use. For radio controls,
+ it will provide the options for the control which equates to the HTML LABEL tags. For select controls,
+ it will provide the options for the control which equates to the HTML OPTION tags in the SELECT and
+ supplies both the NAME and VALUE parameters of the OPTION tag. </li>
+ <li><em><a name="jsp-listKey">listKey</a></em> - This attribute indicates where to get the values for the INPUT tag.
+ For select and radio controls, it equates to the VALUE parameter of the INPUT tag. </li>
+ <li><em><a name="jsp-listValue">listValue</a></em> - This attribute is the value displayed next to the radio control
+ or it is the items in the select display. </li>
+ <li><em><a name="jsp-maxlength">maxlength</a></em> - This attribute specifies the maximum number of characters the user may enter. </li>
+ <li><em><a name="jsp-modelName">modelName</a></em> - This attribute indicates the TableModel for the control to use. </li>
+ <li><em><a name="jsp-multiple">multiple</a></em> - This attribute determines if the SELECT supports multiple selections. </li>
+ <li><em><a name="jsp-name">name</a></em> - For Action tag, it indicates the name of the action to invoke. For UI tags,
+ this attribute assigns the control name. The scope of the name attribute for a control within a FORM element is
+ the FORM element. </li>
+ <li><em><a name="jsp-onchange">onchange</a></em> - The onchange event occurs when a control loses the input focus and
+ its value has been modified since gaining focus. </li>
+ <li><em><a name="jsp-onkeyup">onkeyup</a></em> - The onkeyup event occurs when a key is released over an element. </li>
+ <li><em><a name="jsp-page">page</a></em> - This attribute points to a JSP page to include. </li>
+ <li><em><a name="jsp-readonly">readonly</a></em> - This boolean attribute prohibits changes to the control. </li>
+ <li><em><a name="jsp-rows">rows</a></em> - This attribute specifies the number of visible text lines. </li>
+ <li><em><a name="jsp-separator">separator</a></em> - This attribute is the character the StringTokenizer will use to create tokens. </li>
+ <li><em><a name="jsp-size">size</a></em> - This attribute tells the user agent the initial width of the control.
+ For SELECT controls, this specifies the number of rows in the list that should be visible at the same time. </li>
+ <li><em><a name="jsp-sortable">sortable</a></em> - This attribute indicates if table should be sorted. </li>
+ <li><em><a name="jsp-sortColumn">sortColumn</a></em> - This attribute indicates which column should be sorted on creation.</li>
+ <li><em><a name="jsp-sortOrder">sortOrder</a></em> - This attribute indicates the sort order on creation. </li>
+ <li><em><a name="jsp-source">source</a></em> - This attribute is the source the tag will use to perform work on.
+ It may be Enumeration, Iterator, or a Collection. </li>
+ <li><em><a name="jsp-start">start</a></em> - This attribute indicates the index to start reading. </li>
+ <li><em><a name="jsp-status">status</a></em> - This attribute indicates the name of the IteratorStatus object
+ to be exposed. An IteratorStatus allows one to get information about the status of the iteration, such
+ as the size, current index, and whether any more items are available. </li>
+ <li><em><a name="jsp-tabAlign">tabAlign</a></em> - This attribute specifies the alignment of the tabs. For tabbedpane,
+ the default is the CENTER of the control. </li>
+ <li><em><a name="jsp-tabindex">tabindex</a></em> - This attribute specifies the position of the current element in the
+ tabbing order for the current document. </li>
+ <li><em><a name="jsp-template">template</a></em> - This attribute is the JSP the tag will use to render itself.
+ Each control has a default template. </li>
+ <li><em><a name="jsp-test">test</a></em> - This attribute is the conditional expression evaluated by WW's parser.
+ It returns boolean true or false. </li>
+ <li><em><a name="jsp-theme">theme</a></em> - This attribute points to a directory of UI tags. This directory
+ will be used to retrieve a UI tag's respective template. It allows you to group together templates
+ that together represent a "theme". The default theme is xhtml. </li>
+ <li><em><a name="jsp-val">val</a></em> - This attribute is the list of values the generator should use to create tokens. </li>
+ <li><em><a name="jsp-value">value</a></em> - This attribute is used to pass data to the tag. The tag will use the value as it sees fit. </li>
</ol>
<p><h2>VXML Attributes</h2></p>
<ol>
- <li><em><a name="vxml-action">action</a></em> - This attribute specifies the action value of a component.
+ <li><em><a name="vxml-action">action</a></em> - This attribute specifies the action value of a component.
When used in a filled component, the filled when build the appropriate submit to the value of the action URL. </li>
- <li><em><a name="vxml-actionaudio">actionaudio</a></em> - This attribute specifies the actionaudio value of a component.
+ <li><em><a name="vxml-actionaudio">actionaudio</a></em> - This attribute specifies the actionaudio value of a component.
If the actionaudio is specified, the component's fetchaudio attribute will be set. </li>
- <li><em><a name="vxml-bargein">bargein</a></em> - This attribute specifies the bargein value of a prompt.
- Valid values are true or false. </li>
- <li><em><a name="vxml-cond">cond</a></em> - This attribute specifies the cond value of the component. </li>
- <li><em><a name="vxml-count">count</a></em> - This attribute specifies the count value of the component. </li>
- <li><em><a name="vxml-id">id</a></em> - This attribute assigns a name to an element.
- This name must be unique in a document. This attribute is the standard id supported by JSP
- TagSupport and is therefore always a string. You do not need to indicate a string literal
- as you would for the rest of WW attributes; i.e. - id="'age'". Instead you should use id="age". </li>
- <li><em><a name="vxml-expr">expr</a></em> - This attribute specifies the ECMAScript expression to evaluate for the component. </li>
- <li><em><a name="vxml-fetchhint">fetchhint</a></em> - This attribute specifies the fetchhint value for the component.
- Valid values are safe and prefetch. </li>
- <li><em><a name="vxml-fetchtimeout">fetchtimeout</a></em> - This attribute specifies the fetchtimeout value for the component. </li>
- <li><em><a name="vxml-labelposition">labelposition</a></em> - This attribute indicates the location of the label with respect
- to the form control. The allowable value is top. The default position is left of the form control. </li>
- <li><em><a name="vxml-label">label</a></em> - This attribute specifies the label value of the log component. </li>
- <li><em><a name="vxml-lang">lang</a></em> - This attribute specifies the xml:lang value of the component. </li>
- <li><em><a name="vxml-maxage">maxage</a></em> - This attribute specifies the maxage value of the component. </li>
- <li><em><a name="vxml-maxstale">maxstale</a></em> - This attribute specifies the maxstale value of the component. </li>
- <li><em><a name="vxml-modal">modal</a></em> - This attribute specifies the modal value of the field, relative to active
- grammars outside the scope of the field. </li>
- <li><em><a name="vxml-mode">mode</a></em> - This attribute specifies the mode value of the grammar,
- which can be either voice (default) or dtmf. </li>
- <li><em><a name="vxml-model">model</a></em> - This attribute specifies the model of the component. </li>
- <li><em><a name="vxml-name">name</a></em> - This attribute specifies the name of the control,
- which must be a valid ECMAScript variable name in VoiceXML. </li>
- <li><em><a name="vxml-namelist">namelist</a></em> - This attribute specifies the namelist of the control,
- which must be a valid space-separated list of ECMAScript variables to use when sending the request
- to the URI using HTTP parameters (either GET parameters or POST data). </li>
- <li><em><a name="vxml-persona">persona</a></em> - This attribute specifies the persona of the audio.
- If specified, the name of the persona will be appended to the prefix of the url to form the URL path.
- Example: <persona>/test.wav. </li>
- <li><em><a name="vxml-slot">slot</a></em> - This attribute specifies the slot value of the field.
- In form-level grammars, the slot determines which field the grammar result should fill
- (can be more than one). This is mainly used in mixed-initiative style dialogs. </li>
- <li><em><a name="vxml-src">src</a></em> - This attribute specifies the URL source of the component. </li>
- <li><em><a name="vxml-timeout">timeout</a></em> - This attribute specifies the prompt timeout value for a prompt. </li>
- <li><em><a name="vxml-tts">tts</a></em> - This attribute specifies the alternate text-to-speech to play
- if the audio src cannot be found. </li>
- <li><em><a name="vxml-templateheader">templateheader</a></em> - This attribute is the JSP the tag will use
- to render itself (header). Each control has a default header template. </li>
- <li><em><a name="vxml-templatefooter">templatefooter</a></em> - This attribute is the JSP the tag will use to
- render itself (footer). Each control has a default footer template. </li>
- <li><em><a name="vxml-theme">theme</a></em> - This attribute points to a directory of VUI tags.
- This directory will be used to retrieve a UI tag's respective template.
- It allows you to group together templates that together represent a "theme".
- The default theme is vui.</li>
- <li><em><a name="vxml-type">type</a></em> - This attribute specifies the type value when specifying built-in grammars for a field. </li>
- <li><em><a name="vxml-weight">weight</a></em> - This attribute specifies the weight value of the grammar.
- The default weight if not specified is usually browser-dependent, but most likely 1.0. </li>
+ <li><em><a name="vxml-bargein">bargein</a></em> - This attribute specifies the bargein value of a prompt.
+ Valid values are true or false. </li>
+ <li><em><a name="vxml-cond">cond</a></em> - This attribute specifies the cond value of the component. </li>
+ <li><em><a name="vxml-count">count</a></em> - This attribute specifies the count value of the component. </li>
+ <li><em><a name="vxml-id">id</a></em> - This attribute assigns a name to an element.
+ This name must be unique in a document. This attribute is the standard id supported by JSP
+ TagSupport and is therefore always a string. You do not need to indicate a string literal
+ as you would for the rest of WW attributes; i.e. - id="'age'". Instead you should use id="age". </li>
+ <li><em><a name="vxml-expr">expr</a></em> - This attribute specifies the ECMAScript expression to evaluate for the component. </li>
+ <li><em><a name="vxml-fetchhint">fetchhint</a></em> - This attribute specifies the fetchhint value for the component.
+ Valid values are safe and prefetch. </li>
+ <li><em><a name="vxml-fetchtimeout">fetchtimeout</a></em> - This attribute specifies the fetchtimeout value for the component. </li>
+ <li><em><a name="vxml-labelposition">labelposition</a></em> - This attribute indicates the location of the label with respect
+ to the form control. The allowable value is top. The default position is left of the form control. </li>
+ <li><em><a name="vxml-label">label</a></em> - This attribute specifies the label value of the log component. </li>
+ <li><em><a name="vxml-lang">lang</a></em> - This attribute specifies the xml:lang value of the component. </li>
+ <li><em><a name="vxml-maxage">maxage</a></em> - This attribute specifies the maxage value of the component. </li>
+ <li><em><a name="vxml-maxstale">maxstale</a></em> - This attribute specifies the maxstale value of the component. </li>
+ <li><em><a name="vxml-modal">modal</a></em> - This attribute specifies the modal value of the field, relative to active
+ grammars outside the scope of the field. </li>
+ <li><em><a name="vxml-mode">mode</a></em> - This attribute specifies the mode value of the grammar,
+ which can be either voice (default) or dtmf. </li>
+ <li><em><a name="vxml-model">model</a></em> - This attribute specifies the model of the component. </li>
+ <li><em><a name="vxml-name">name</a></em> - This attribute specifies the name of the control,
+ which must be a valid ECMAScript variable name in VoiceXML. </li>
+ <li><em><a name="vxml-namelist">namelist</a></em> - This attribute specifies the namelist of the control,
+ which must be a valid space-separated list of ECMAScript variables to use when sending the request
+ to the URI using HTTP parameters (either GET parameters or POST data). </li>
+ <li><em><a name="vxml-persona">persona</a></em> - This attribute specifies the persona of the audio.
+ If specified, the name of the persona will be appended to the prefix of the url to form the URL path.
+ Example: <persona>/test.wav. </li>
+ <li><em><a name="vxml-slot">slot</a></em> - This attribute specifies the slot value of the field.
+ In form-level grammars, the slot determines which field the grammar result should fill
+ (can be more than one). This is mainly used in mixed-initiative style dialogs. </li>
+ <li><em><a name="vxml-src">src</a></em> - This attribute specifies the URL source of the component. </li>
+ <li><em><a name="vxml-timeout">timeout</a></em> - This attribute specifies the prompt timeout value for a prompt. </li>
+ <li><em><a name="vxml-tts">tts</a></em> - This attribute specifies the alternate text-to-speech to play
+ if the audio src cannot be found. </li>
+ <li><em><a name="vxml-templateheader">templateheader</a></em> - This attribute is the JSP the tag will use
+ to render itself (header). Each control has a default header template. </li>
+ <li><em><a name="vxml-templatefooter">templatefooter</a></em> - This attribute is the JSP the tag will use to
+ render itself (footer). Each control has a default footer template. </li>
+ <li><em><a name="vxml-theme">theme</a></em> - This attribute points to a directory of VUI tags.
+ This directory will be used to retrieve a UI tag's respective template.
+ It allows you to group together templates that together represent a "theme".
+ The default theme is vui.</li>
+ <li><em><a name="vxml-type">type</a></em> - This attribute specifies the type value when specifying built-in grammars for a field. </li>
+ <li><em><a name="vxml-weight">weight</a></em> - This attribute specifies the weight value of the grammar.
+ The default weight if not specified is usually browser-dependent, but most likely 1.0. </li>
</ol>
Index: tag.jsp
===================================================================
RCS file: /cvsroot/opensymphony/webwork/src/docs/manual/tag.jsp,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- tag.jsp 30 Dec 2002 06:55:01 -0000 1.10
+++ tag.jsp 8 Jan 2004 17:13:44 -0000 1.11
@@ -816,6 +816,18 @@
<td><a href="tag-attributes.html#jsp-value">value</a></td>
<td>F</td>
</tr>
+ <tr>
+ <td><a href="tag-attributes.html#jsp-includeContext">includeContext</a></td>
+ <td>F</td>
+ </tr>
+ <tr>
+ <td><a href="tag-attributes.html#jsp-encode">encode</a></td>
+ <td>F</td>
+ </tr>
+ <tr>
+ <td><a href="tag-attributes.html#jsp-includeParams">includeParams</a></td>
+ <td>F</td>
+ </tr>
</table>
<p>In this example, the form action value will be an url hiturl.action that is encoded. </p>
-------------------------------------------------------
This SF.net email is sponsored by: Perforce Software.
Perforce is the Fast Software Configuration Management System offering
advanced branching capabilities and atomic changes on 50+ platforms.
Free Eval! http://www.perforce.com/perforce/loadprog.html