http://git-wip-us.apache.org/repos/asf/struts/blob/742b4a89/core/src/site/resources/tags/ajax/autocompleter.html ---------------------------------------------------------------------- diff --git a/core/src/site/resources/tags/ajax/autocompleter.html b/core/src/site/resources/tags/ajax/autocompleter.html index c26d935..f902a17 100644 --- a/core/src/site/resources/tags/ajax/autocompleter.html +++ b/core/src/site/resources/tags/ajax/autocompleter.html @@ -1,664 +1,664 @@ - - - - autocompleter - - - -

Tag Name: autocompleter

-

Description

-

- - Renders a combobox with autocomplete and AJAX capabilities - -

- -

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Dynamic Attributes Allowed:

false
 

Name

Required

Default

Evaluated

Type

Description

accesskeyfalsefalseStringSet the html accesskey attribute on rendered html element
afterNotifyTopicsfalsefalseStringComma delimmited list of topics that will published after the request(if the request succeeds)
autoCompletefalsefalsefalseBooleanWhether autocompleter should make suggestion on the textbox
beforeNotifyTopicsfalsefalseStringComma delimmited list of topics that will published before the request
cssClassfalsefalseStringThe css class to use for element
cssErrorClassfalsefalseStringThe css error class to use for element
cssErrorStylefalsefalseStringThe css error style definitions for element to use
cssStylefalsefalseStringThe css style to use for element
dataFieldNamefalseValue specified in 'name'falseStringName of the field in the returned JSON object that contains the data array
delayfalse100falseIntegerDelay before making the search
disabledfalsefalsefalseBooleanEnable or disable autocompleter
dropdownHeightfalse120falseIntegerDropdown's height in pixels
dropdownWidthfalsesame as textboxfalseIntegerDropdown's width
emptyOptionfalsefalseStringDecide if an empty option is to be inserted. Default false.
errorNotifyTopicsfalsefalseStringComma delimmited list of topics that will published after the request(if the request fails)
errorPositionfalsefalseStringDefine error position of form element (top|bottom)
forceValidOptionfalsefalsefalseBooleanForce selection to be one of the options
formFilterfalsefalseStringFunction name used to filter the fields of the form
formIdfalsefalseStringForm id whose fields will be serialized and passed as parameters
headerKeyfalsefalseStringSet the header key for the header option.
headerValuefalsefalseStringSet the header value for the header option.
hreffalsefalseStringThe URL used to load the options
iconPathfalsefalseStringPath to icon used for the dropdown
idfalsefalseStringThe id to use for the element
indicatorfalsefalseStringId of element that will be shown while request is made
javascriptTooltipfalsefalsefalseBooleanUse JavaScript to generate tooltips
keyfalsefalseStringSet the key (name, value, label) for this particular component
keyNamefalsefalseStringName of the field to which the selected key will be assigned
keyValuefalsefalseStringInitial key value
labelfalsefalseStringLabel expression used for rendering an element specific label
labelSeparatorfalse:falseStringString that will be appended to the label
labelpositionfalsefalseStringDefine label position of form element (top/left)
listfalsefalseStringIteratable source to populate from.
listKeyfalsefalseStringSet the key used to retrive the option key.
listValuefalsefalseStringSet the value used to retrive the option value.
listenTopicsfalsefalseStringTopic that will trigger a reload
loadMinimumCountfalse3falseIntegerMinimum number of characters that will force the content to be loaded
loadOnTextChangefalsetruefalseBooleanOptions will be reloaded everytime a character is typed on the textbox
maxLengthfalsefalseIntegerDeprecated. Use maxlength instead.
maxlengthfalsefalseIntegerHTML maxlength attribute
namefalsefalseStringThe name to set for element
notifyTopicsfalsefalseStringTopics that will be published when content is reloaded
onblurfalsefalseString Set the html onblur attribute on rendered html element
onchangefalsefalseStringSet the html onchange attribute on rendered html element
onclickfalsefalseStringSet the html onclick attribute on rendered html element
ondblclickfalsefalseStringSet the html ondblclick attribute on rendered html element
onfocusfalsefalseStringSet the html onfocus attribute on rendered html element
onkeydownfalsefalseStringSet the html onkeydown attribute on rendered html element
onkeypressfalsefalseStringSet the html onkeypress attribute on rendered html element
onkeyupfalsefalseStringSet the html onkeyup attribute on rendered html element
onmousedownfalsefalseStringSet the html onmousedown attribute on rendered html element
onmousemovefalsefalseStringSet the html onmousemove attribute on rendered html element
onmouseoutfalsefalseStringSet the html onmouseout attribute on rendered html element
onmouseoverfalsefalseStringSet the html onmouseover attribute on rendered html element
onmouseupfalsefalseStringSet the html onmouseup attribute on rendered html element
onselectfalsefalseStringSet the html onselect attribute on rendered html element
preloadfalsetruefalseBooleanLoad options when page is loaded
readonlyfalsefalsefalseBooleanWhether the input is readonly
requiredLabelfalsefalsefalseBooleanIf set to true, the rendered element will indicate that input is required
requiredPositionfalsefalseStringDefine required position of required form element (left|right)
resultsLimitfalse30falseIntegerLimit how many results are shown as autocompletion options, set to -1 for unlimited results
searchTypefalsestringstartfalseStringhow the search must be performed, options are: 'startstring', 'startword' and 'substring'
showDownArrowfalsetruefalseBooleanShow or hide the down arrow button
sizefalsefalseIntegerHTML size attribute
tabindexfalsefalseStringSet the html tabindex attribute on rendered html element
templatefalsefalseStringThe template (other than default) to use for rendering the element
templateCssPathfalsefalseStringTemplate css path
templateDirfalsefalseStringThe template directory.
titlefalsefalseStringSet the html title attribute on rendered html element
tooltipfalsefalseStringSet the tooltip of this particular component
tooltipConfigfalsefalseStringDeprecated. Use individual tooltip configuration attributes instead.
tooltipCssClassfalseStrutsTTClassicfalseStringCSS class applied to JavaScrip tooltips
tooltipDelayfalseClassicfalseStringDelay in milliseconds, before showing JavaScript tooltips
tooltipIconPathfalsefalseStringIcon path used for image that will have the tooltip
transportfalseXMLHTTPTransportfalseStringTransport used by Dojo to make the request
typefalsetextfalseStringSpecifies the html5 type element to display. e.g. text, email, url
valuefalsefalseStringPreset the value of input element
valueNotifyTopicsfalsefalseStringComma delimmited list of topics that will published when a value is selected
- - - - + + + + autocompleter + + + +

Tag Name: autocompleter

+

Description

+

+ + Renders a combobox with autocomplete and AJAX capabilities + +

+ +

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Dynamic Attributes Allowed:

false
 

Name

Required

Default

Evaluated

Type

Description

accesskeyfalsefalseStringSet the html accesskey attribute on rendered html element
afterNotifyTopicsfalsefalseStringComma delimmited list of topics that will published after the request(if the request succeeds)
autoCompletefalsefalsefalseBooleanWhether autocompleter should make suggestion on the textbox
beforeNotifyTopicsfalsefalseStringComma delimmited list of topics that will published before the request
cssClassfalsefalseStringThe css class to use for element
cssErrorClassfalsefalseStringThe css error class to use for element
cssErrorStylefalsefalseStringThe css error style definitions for element to use
cssStylefalsefalseStringThe css style to use for element
dataFieldNamefalseValue specified in 'name'falseStringName of the field in the returned JSON object that contains the data array
delayfalse100falseIntegerDelay before making the search
disabledfalsefalsefalseBooleanEnable or disable autocompleter
dropdownHeightfalse120falseIntegerDropdown's height in pixels
dropdownWidthfalsesame as textboxfalseIntegerDropdown's width
emptyOptionfalsefalseStringDecide if an empty option is to be inserted. Default false.
errorNotifyTopicsfalsefalseStringComma delimmited list of topics that will published after the request(if the request fails)
errorPositionfalsefalseStringDefine error position of form element (top|bottom)
forceValidOptionfalsefalsefalseBooleanForce selection to be one of the options
formFilterfalsefalseStringFunction name used to filter the fields of the form
formIdfalsefalseStringForm id whose fields will be serialized and passed as parameters
headerKeyfalsefalseStringSet the header key for the header option.
headerValuefalsefalseStringSet the header value for the header option.
hreffalsefalseStringThe URL used to load the options
iconPathfalsefalseStringPath to icon used for the dropdown
idfalsefalseStringThe id to use for the element
indicatorfalsefalseStringId of element that will be shown while request is made
javascriptTooltipfalsefalsefalseBooleanUse JavaScript to generate tooltips
keyfalsefalseStringSet the key (name, value, label) for this particular component
keyNamefalsefalseStringName of the field to which the selected key will be assigned
keyValuefalsefalseStringInitial key value
labelfalsefalseStringLabel expression used for rendering an element specific label
labelSeparatorfalse:falseStringString that will be appended to the label
labelpositionfalsefalseStringDefine label position of form element (top/left)
listfalsefalseStringIteratable source to populate from.
listKeyfalsefalseStringSet the key used to retrive the option key.
listValuefalsefalseStringSet the value used to retrive the option value.
listenTopicsfalsefalseStringTopic that will trigger a reload
loadMinimumCountfalse3falseIntegerMinimum number of characters that will force the content to be loaded
loadOnTextChangefalsetruefalseBooleanOptions will be reloaded everytime a character is typed on the textbox
maxLengthfalsefalseIntegerDeprecated. Use maxlength instead.
maxlengthfalsefalseIntegerHTML maxlength attribute
namefalsefalseStringThe name to set for element
notifyTopicsfalsefalseStringTopics that will be published when content is reloaded
onblurfalsefalseString Set the html onblur attribute on rendered html element
onchangefalsefalseStringSet the html onchange attribute on rendered html element
onclickfalsefalseStringSet the html onclick attribute on rendered html element
ondblclickfalsefalseStringSet the html ondblclick attribute on rendered html element
onfocusfalsefalseStringSet the html onfocus attribute on rendered html element
onkeydownfalsefalseStringSet the html onkeydown attribute on rendered html element
onkeypressfalsefalseStringSet the html onkeypress attribute on rendered html element
onkeyupfalsefalseStringSet the html onkeyup attribute on rendered html element
onmousedownfalsefalseStringSet the html onmousedown attribute on rendered html element
onmousemovefalsefalseStringSet the html onmousemove attribute on rendered html element
onmouseoutfalsefalseStringSet the html onmouseout attribute on rendered html element
onmouseoverfalsefalseStringSet the html onmouseover attribute on rendered html element
onmouseupfalsefalseStringSet the html onmouseup attribute on rendered html element
onselectfalsefalseStringSet the html onselect attribute on rendered html element
preloadfalsetruefalseBooleanLoad options when page is loaded
readonlyfalsefalsefalseBooleanWhether the input is readonly
requiredLabelfalsefalsefalseBooleanIf set to true, the rendered element will indicate that input is required
requiredPositionfalsefalseStringDefine required position of required form element (left|right)
resultsLimitfalse30falseIntegerLimit how many results are shown as autocompletion options, set to -1 for unlimited results
searchTypefalsestringstartfalseStringhow the search must be performed, options are: 'startstring', 'startword' and 'substring'
showDownArrowfalsetruefalseBooleanShow or hide the down arrow button
sizefalsefalseIntegerHTML size attribute
tabindexfalsefalseStringSet the html tabindex attribute on rendered html element
templatefalsefalseStringThe template (other than default) to use for rendering the element
templateCssPathfalsefalseStringTemplate css path
templateDirfalsefalseStringThe template directory.
titlefalsefalseStringSet the html title attribute on rendered html element
tooltipfalsefalseStringSet the tooltip of this particular component
tooltipConfigfalsefalseStringDeprecated. Use individual tooltip configuration attributes instead.
tooltipCssClassfalseStrutsTTClassicfalseStringCSS class applied to JavaScrip tooltips
tooltipDelayfalseClassicfalseStringDelay in milliseconds, before showing JavaScript tooltips
tooltipIconPathfalsefalseStringIcon path used for image that will have the tooltip
transportfalseXMLHTTPTransportfalseStringTransport used by Dojo to make the request
typefalsetextfalseStringSpecifies the html5 type element to display. e.g. text, email, url
valuefalsefalseStringPreset the value of input element
valueNotifyTopicsfalsefalseStringComma delimmited list of topics that will published when a value is selected
+ + + + http://git-wip-us.apache.org/repos/asf/struts/blob/742b4a89/core/src/site/resources/tags/ajax/bind.html ---------------------------------------------------------------------- diff --git a/core/src/site/resources/tags/ajax/bind.html b/core/src/site/resources/tags/ajax/bind.html index b450b93..a6f8d6a 100644 --- a/core/src/site/resources/tags/ajax/bind.html +++ b/core/src/site/resources/tags/ajax/bind.html @@ -1,240 +1,240 @@ - - - - bind - - - -

Tag Name: bind

-

Description

-

- - Attach event listeners to elements to make AJAX calls - -

- -

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Dynamic Attributes Allowed:

false
 

Name

Required

Default

Evaluated

Type

Description

afterNotifyTopicsfalsefalseStringComma delimmited list of topics that will published after the request(if the request succeeds)
ajaxAfterValidationfalsefalsefalseBooleanMake an asynchronous request if validation succeeds. Only valid is 'validate' is 'true'
beforeNotifyTopicsfalsefalseStringComma delimmited list of topics that will published before the request
errorNotifyTopicsfalsefalseStringComma delimmited list of topics that will published after the request(if the request fails)
errorTextfalsefalseStringThe text to display to the user if the is an error fetching the content
eventsfalsefalseStringComma delimited list of event names to attach to
executeScriptsfalsefalsefalseBooleanJavascript code in the fetched content will be executed
formFilterfalsefalseStringFunction name used to filter the fields of the form.
formIdfalsefalseStringForm id whose fields will be serialized and passed as parameters
handlerfalsefalseStringJavascript function name that will make the request
highlightColorfalsenonefalseStringColor used to perform a highlight effect on the elements specified in the 'targets' attribute
highlightDurationfalse2000falseIntegerDuration of highlight effect in milliseconds. Only valid if 'highlightColor' attribute is set
hreffalsefalseStringThe URL to call to obtain the content. Note: If used with ajax context, the value must be set as an url tag value.
idfalsefalseStringThe id to use for the element
indicatorfalsefalseStringId of element that will be shown while making request
listenTopicsfalsefalseStringTopic that will trigger the remote call
loadingTextfalseLoading...falseStringText to be shown while content is being fetched
notifyTopicsfalsefalseStringComma delimmited list of topics that will published before and after the request, and on errors
separateScriptsfalsetruefalseStringRun scripts in a separate scope, unique for each tag
showErrorTransportTextfalsetruefalseBooleanSet whether errors will be shown or not
showLoadingTextfalsefalsefalseBooleanShow loading text on targets
sourcesfalsefalseStringComma delimited list of ids of the elements to attach to
targetsfalsefalseStringComma delimited list of ids of the elements whose content will be updated
transportfalseXMLHTTPTransportfalseStringTransport used by Dojo to make the request
validatefalsefalsefalseBooleanPerform Ajax validation. 'ajaxValidation' interceptor must be applied to action
- - - - + + + + bind + + + +

Tag Name: bind

+

Description

+

+ + Attach event listeners to elements to make AJAX calls + +

+ +

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Dynamic Attributes Allowed:

false
 

Name

Required

Default

Evaluated

Type

Description

afterNotifyTopicsfalsefalseStringComma delimmited list of topics that will published after the request(if the request succeeds)
ajaxAfterValidationfalsefalsefalseBooleanMake an asynchronous request if validation succeeds. Only valid is 'validate' is 'true'
beforeNotifyTopicsfalsefalseStringComma delimmited list of topics that will published before the request
errorNotifyTopicsfalsefalseStringComma delimmited list of topics that will published after the request(if the request fails)
errorTextfalsefalseStringThe text to display to the user if the is an error fetching the content
eventsfalsefalseStringComma delimited list of event names to attach to
executeScriptsfalsefalsefalseBooleanJavascript code in the fetched content will be executed
formFilterfalsefalseStringFunction name used to filter the fields of the form.
formIdfalsefalseStringForm id whose fields will be serialized and passed as parameters
handlerfalsefalseStringJavascript function name that will make the request
highlightColorfalsenonefalseStringColor used to perform a highlight effect on the elements specified in the 'targets' attribute
highlightDurationfalse2000falseIntegerDuration of highlight effect in milliseconds. Only valid if 'highlightColor' attribute is set
hreffalsefalseStringThe URL to call to obtain the content. Note: If used with ajax context, the value must be set as an url tag value.
idfalsefalseStringThe id to use for the element
indicatorfalsefalseStringId of element that will be shown while making request
listenTopicsfalsefalseStringTopic that will trigger the remote call
loadingTextfalseLoading...falseStringText to be shown while content is being fetched
notifyTopicsfalsefalseStringComma delimmited list of topics that will published before and after the request, and on errors
separateScriptsfalsetruefalseStringRun scripts in a separate scope, unique for each tag
showErrorTransportTextfalsetruefalseBooleanSet whether errors will be shown or not
showLoadingTextfalsefalsefalseBooleanShow loading text on targets
sourcesfalsefalseStringComma delimited list of ids of the elements to attach to
targetsfalsefalseStringComma delimited list of ids of the elements whose content will be updated
transportfalseXMLHTTPTransportfalseStringTransport used by Dojo to make the request
validatefalsefalsefalseBooleanPerform Ajax validation. 'ajaxValidation' interceptor must be applied to action
+ + + +