Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Explain better the possible ajax request attributes

...

The available attributes are:

...

Name

Description

Default value

Short name

method

the request method to use (GET or POST)

...

GET

m

multipart

...

whether form submittion should use content type: multipart/form-data. Implies POST method

...

false

mp

event names

...

a list of event names for which the Ajax call will be executed. For example: click, change, keyup, etc.

...

domready

...

e

form id

...

the id of the form which should be submitted with this Ajax call.

...

 

f

submitting component name

...

the input name of the component which submits the form.

...

 

sc

data type

...

what kind of data is expected in the response of the Ajax call (e.g. XML, JSON, HTML, JSONP).

...

xml

...

dt

...

wicket ajax response

...

a boolean flag which indicates whether the response is <ajax-response> which is handled by wicket-ajax.js or custom response type which can be handled by application's code (e.g. in IAjaxCallListener's success handler).

...

true

...

wr

preconditions

...

a list of JavaScript function bodies which may abort the Ajax call. Return 'false' from any precondition to abort the call.

...

checks that the element is attached to the document

...

pre

channel

...

the name and type of the Ajax channel to use. Channels are used to queue the Ajax requests at the client side. See org.apache.wicket.ajax.AjaxChannel javadoc for more details.

...

channel with name '0', and 'queue' behavior

...

ch

ajax call listeners

...

a list of listeners which are called at the most important points of the lifetime of the Ajax call. See below for more information.

...

empty list

...

bh, ah, sh, fh, ch

extra parameters

...

a map of parameters which should be added to the query string/post data of the Ajax call. The name and value of such parameters should be known at the server side.

...

empty map

...

ep

dynamic extra parameters

...

parameters which values are calculated at the client side and added dynamically to the query string/post data of the Ajax call.

...

empty list

...

dep

request timeout

...

a timeout to abort the request if there is no response.

...

0 (no timeout

...

)

rt

allow default

...

a boolean flag which indicates whether to allow the default behavior of the HTML element which listens for the event. For example: clicking on Ajax checkbox should allow the default behavior to actually check the box.

...

false

...

ad

async

...

a boolean flag that indicates whether the Ajax call should be asynchronous or not.

...

true

...

async

throttling settings

...

settings which define whether the Ajax call should be throttled and for how long. See the javadoc of org.apache.wicket.ajax.attributes.ThrottlingSettings for more information.

...

no throttling

tr

Attributes 'c' (component id) and 'u' (callback url) are automatically set by the Ajax behavior and they are not part of AjaxRequestAttributes.

While constructing the JavaScript that will register the event listener for that Ajax component/behavior these settings are serialized to optimized JSON object which is passed as a parameter to Wicket.Ajax.(get|post|ajax) methods.
For example an AjaxLink contributes JavaScript similar to :

...