JQueryAjaxSettings (DukeScript Libraries 1.0-SNAPSHOT API)

java.lang.Object
- net.java.html.lib.Objs
- - net.java.html.lib.jquery.JQueryAjaxSettings

public class JQueryAjaxSettings
extends Objs

Nested Class Summary
- Nested classes/interfaces inherited from class net.java.html.lib.Objs
  Objs.Constructor<T extends Objs>, Objs.Property<T>

Field Summary

Fields
Modifier and Type	Field and Description
`Objs.Property<Object>`	`accepts` The content type sent in the request header that tells the server what kind of response it will accept in return.
`Objs.Property<Boolean>`	`async` By default, all requests are sent asynchronously (i.e. this is set to true by default).
`Objs.Property<Boolean>`	`cache` If set to false, it will force requested pages not to be cached by the browser.
`Objs.Property<Objs>`	`contents` An object of string/regular-expression pairs that determine how jQuery will parse the response, given its content type.
`Objs.Property<Object>`	`contentType`
`Objs.Property<Object>`	`context` This object will be made the context of all Ajax-related callbacks.
`Objs.Property<Objs>`	`converters` An object containing dataType-to-dataType converters.
`Objs.Property<Boolean>`	`crossDomain` If you wish to force a crossDomain request (such as JSONP) on the same domain, set the value of crossDomain to true.
`Objs.Property<Object>`	`data` Data to be sent to the server.
`Objs.Property<String>`	`dataType` The type of data that you're expecting back from the server.
`Objs.Property<Boolean>`	`global` Whether to trigger global Ajax event handlers for this request.
`Objs.Property<Objs>`	`headers` An object of additional header key/value pairs to send along with requests using the XMLHttpRequest transport.
`Objs.Property<Boolean>`	`ifModified` Allow the request to be successful only if the response has changed since the last request.
`Objs.Property<Boolean>`	`isLocal` Allow the current environment to be recognized as "local," (e.g. the filesystem), even if jQuery does not recognize it as such by default.
`Objs.Property<Object>`	`jsonp` Override the callback function name in a jsonp request.
`Objs.Property<Object>`	`jsonpCallback` Specify the callback function name for a JSONP request.
`Objs.Property<String>`	`method` The HTTP method to use for the request (e.g.
`Objs.Property<String>`	`mimeType` A mime type to override the XHR mime type.
`Objs.Property<String>`	`password` A password to be used with XMLHttpRequest in response to an HTTP access authentication request.
`Objs.Property<Boolean>`	`processData` By default, data passed in to the data option as an object (technically, anything other than a string) will be processed and transformed into a query string, fitting to the default content-type "application/x-www-form-urlencoded".
`Objs.Property<String>`	`scriptCharset` Only applies when the "script" transport is used (e.g., cross-domain requests with "jsonp" or "script" dataType and "GET" type).
`Objs.Property<Objs>`	`statusCode` An object of numeric HTTP codes and functions to be called when the response has the corresponding code. f the request is successful, the status code functions take the same parameters as the success callback; if it results in an error (including 3xx redirect), they take the same parameters as the error callback.
`Objs.Property<Number>`	`timeout` Set a timeout (in milliseconds) for the request.
`Objs.Property<Boolean>`	`traditional` Set this to true if you wish to use the traditional style of param serialization.
`Objs.Property<String>`	`type` The type of request to make ("POST" or "GET"), default is "GET".
`Objs.Property<String>`	`url` A string containing the URL to which the request is sent.
`Objs.Property<String>`	`username` A username to be used with XMLHttpRequest in response to an HTTP access authentication request.
`Objs.Property<Object>`	`xhr` Callback for creating the XMLHttpRequest object.
`Objs.Property<Objs>`	`xhrFields` An object of fieldName-fieldValue pairs to set on the native XHR object.

Fields inherited from class net.java.html.lib.Objs
prototype

Constructor Summary

Constructors
Modifier Constructor and Description

protected JQueryAjaxSettings(Objs.Constructor<?> c, Object js)

Constructors
Modifier	Constructor and Description
`protected`	`JQueryAjaxSettings(Objs.Constructor<?> c, Object js)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JQueryAjaxSettings`	`$as(Object obj)`
`Boolean`	`async()`
`Object`	`beforeSend(JQueryXHR jqXHR, JQueryAjaxSettings settings)` A pre-request callback function that can be used to modify the jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object before it is sent.
`Boolean`	`cache()`
`Object`	`complete(JQueryXHR jqXHR, String textStatus)` A function to be called when the request finishes (after success and error callbacks are executed).
`Boolean`	`crossDomain()`
`Object`	`dataFilter(Object data, Object ty)` A function to be used to handle the raw response data of XMLHttpRequest.This is a pre-filtering function to sanitize the response.
`String`	`dataType()`
`Object`	`error(JQueryXHR jqXHR, String textStatus, String errorThrown)` A function to be called if the request fails.
`Boolean`	`global()`
`Boolean`	`ifModified()`
`Boolean`	`isLocal()`
`String`	`method()`
`String`	`mimeType()`
`String`	`password()`
`Boolean`	`processData()`
`String`	`scriptCharset()`
`Object`	`success(Object data, String textStatus, JQueryXHR jqXHR)` A function to be called if the request succeeds.
`Number`	`timeout()`
`Boolean`	`traditional()`
`String`	`type()`
`String`	`url()`
`String`	`username()`

Methods inherited from class net.java.html.lib.Objs
$as, $cast, $delete, $get, $js, $set, create, create, defineProperties, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, newObject, newObject, preventExtensions, propertyIsEnumerable, seal, toLocaleString, toString, valueOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - accepts
```
public Objs.Property<Object> accepts
```
    The content type sent in the request header that tells the server what kind of response it will accept in return. If the accepts setting needs modification, it is recommended to do so once in the $.ajaxSetup() method.
  - async
```
public Objs.Property<Boolean> async
```
    By default, all requests are sent asynchronously (i.e. this is set to true by default). If you need synchronous requests, set this option to false. Cross-domain requests and dataType: "jsonp" requests do not support synchronous operation. Note that synchronous requests may temporarily lock the browser, disabling any actions while the request is active. As of jQuery 1.8, the use of async: false with jqXHR ($.Deferred) is deprecated; you must use the success/error/complete callback options instead of the corresponding methods of the jqXHR object such as jqXHR.done() or the deprecated jqXHR.success().
  - cache
```
public Objs.Property<Boolean> cache
```
    If set to false, it will force requested pages not to be cached by the browser. Note: Setting cache to false will only work correctly with HEAD and GET requests. It works by appending "_={timestamp}" to the GET parameters. The parameter is not needed for other types of requests, except in IE8 when a POST is made to a URL that has already been requested by a GET.
  - contents
```
public Objs.Property<Objs> contents
```
    An object of string/regular-expression pairs that determine how jQuery will parse the response, given its content type. (version added: 1.5)
  - contentType
```
public Objs.Property<Object> contentType
```
  - context
```
public Objs.Property<Object> context
```
    This object will be made the context of all Ajax-related callbacks. By default, the context is an object that represents the ajax settings used in the call ($.ajaxSettings merged with the settings passed to $.ajax).
  - converters
```
public Objs.Property<Objs> converters
```
    An object containing dataType-to-dataType converters. Each converter's value is a function that returns the transformed value of the response. (version added: 1.5)
  - crossDomain
```
public Objs.Property<Boolean> crossDomain
```
    If you wish to force a crossDomain request (such as JSONP) on the same domain, set the value of crossDomain to true. This allows, for example, server-side redirection to another domain. (version added: 1.5)
  - data
```
public Objs.Property<Object> data
```
    Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests. See processData option to prevent this automatic processing. Object must be Key/Value pairs. If value is an Array, jQuery serializes multiple values with same key based on the value of the traditional setting (described below).
  - dataType
```
public Objs.Property<String> dataType
```
    The type of data that you're expecting back from the server. If none is specified, jQuery will try to infer it based on the MIME type of the response (an XML MIME type will yield XML, in 1.4 JSON will yield a JavaScript object, in 1.4 script will execute the script, and anything else will be returned as a string).
  - global
```
public Objs.Property<Boolean> global
```
    Whether to trigger global Ajax event handlers for this request. The default is true. Set to false to prevent the global handlers like ajaxStart or ajaxStop from being triggered. This can be used to control various Ajax Events.
  - headers
```
public Objs.Property<Objs> headers
```
    An object of additional header key/value pairs to send along with requests using the XMLHttpRequest transport. The header X-Requested-With: XMLHttpRequest is always added, but its default XMLHttpRequest value can be changed here. Values in the headers setting can also be overwritten from within the beforeSend function. (version added: 1.5)
  - ifModified
```
public Objs.Property<Boolean> ifModified
```
    Allow the request to be successful only if the response has changed since the last request. This is done by checking the Last-Modified header. Default value is false, ignoring the header. In jQuery 1.4 this technique also checks the 'etag' specified by the server to catch unmodified data.
  - isLocal
```
public Objs.Property<Boolean> isLocal
```
    Allow the current environment to be recognized as "local," (e.g. the filesystem), even if jQuery does not recognize it as such by default. The following protocols are currently recognized as local: file, *-extension, and widget. If the isLocal setting needs modification, it is recommended to do so once in the $.ajaxSetup() method. (version added: 1.5.1)
  - jsonp
```
public Objs.Property<Object> jsonp
```
    Override the callback function name in a jsonp request. This value will be used instead of 'callback' in the 'callback=?' part of the query string in the url. So {jsonp:'onJSONPLoad'} would result in 'onJSONPLoad=?' passed to the server. As of jQuery 1.5, setting the jsonp option to false prevents jQuery from adding the "?callback" string to the URL or attempting to use "=?" for transformation. In this case, you should also explicitly set the jsonpCallback setting. For example, { jsonp: false, jsonpCallback: "callbackName" }
  - jsonpCallback
```
public Objs.Property<Object> jsonpCallback
```
    Specify the callback function name for a JSONP request. This value will be used instead of the random name automatically generated by jQuery. It is preferable to let jQuery generate a unique name as it'll make it easier to manage the requests and provide callbacks and error handling. You may want to specify the callback when you want to enable better browser caching of GET requests. As of jQuery 1.5, you can also use a function for this setting, in which case the value of jsonpCallback is set to the return value of that function.
  - method
```
public Objs.Property<String> method
```
    The HTTP method to use for the request (e.g. "POST", "GET", "PUT"). (version added: 1.9.0)
  - mimeType
```
public Objs.Property<String> mimeType
```
    A mime type to override the XHR mime type. (version added: 1.5.1)
  - password
```
public Objs.Property<String> password
```
    A password to be used with XMLHttpRequest in response to an HTTP access authentication request.
  - processData
```
public Objs.Property<Boolean> processData
```
    By default, data passed in to the data option as an object (technically, anything other than a string) will be processed and transformed into a query string, fitting to the default content-type "application/x-www-form-urlencoded". If you want to send a DOMDocument, or other non-processed data, set this option to false.
  - scriptCharset
```
public Objs.Property<String> scriptCharset
```
    Only applies when the "script" transport is used (e.g., cross-domain requests with "jsonp" or "script" dataType and "GET" type). Sets the charset attribute on the script tag used in the request. Used when the character set on the local page is not the same as the one on the remote script.
  - statusCode
```
public Objs.Property<Objs> statusCode
```
    An object of numeric HTTP codes and functions to be called when the response has the corresponding code. f the request is successful, the status code functions take the same parameters as the success callback; if it results in an error (including 3xx redirect), they take the same parameters as the error callback. (version added: 1.5)
  - timeout
```
public Objs.Property<Number> timeout
```
    Set a timeout (in milliseconds) for the request. This will override any global timeout set with $.ajaxSetup(). The timeout period starts at the point the $.ajax call is made; if several other requests are in progress and the browser has no connections available, it is possible for a request to time out before it can be sent. In jQuery 1.4.x and below, the XMLHttpRequest object will be in an invalid state if the request times out; accessing any object members may throw an exception. In Firefox 3.0+ only, script and JSONP requests cannot be cancelled by a timeout; the script will run even if it arrives after the timeout period.
  - traditional
```
public Objs.Property<Boolean> traditional
```
    Set this to true if you wish to use the traditional style of param serialization.
  - type
```
public Objs.Property<String> type
```
    The type of request to make ("POST" or "GET"), default is "GET". Note: Other HTTP request methods, such as PUT and DELETE, can also be used here, but they are not supported by all browsers.
  - url
```
public Objs.Property<String> url
```
    A string containing the URL to which the request is sent.
  - username
```
public Objs.Property<String> username
```
    A username to be used with XMLHttpRequest in response to an HTTP access authentication request.
  - xhr
```
public Objs.Property<Object> xhr
```
    Callback for creating the XMLHttpRequest object. Defaults to the ActiveXObject when available (IE), the XMLHttpRequest otherwise. Override to provide your own implementation for XMLHttpRequest or enhancements to the factory.
  - xhrFields
```
public Objs.Property<Objs> xhrFields
```
    An object of fieldName-fieldValue pairs to set on the native XHR object. For example, you can use it to set withCredentials to true for cross-domain requests if needed. In jQuery 1.5, the withCredentials property was not propagated to the native XHR and thus CORS requests requiring it would ignore this flag. For this reason, we recommend using jQuery 1.5.1+ should you require the use of it. (version added: 1.5.1)
- Constructor Detail
  - JQueryAjaxSettings
```
protected JQueryAjaxSettings(Objs.Constructor<?> c,
                             Object js)
```
- Method Detail
  - $as
```
public static JQueryAjaxSettings $as(Object obj)
```
  - async
```
public Boolean async()
```
  - cache
```
public Boolean cache()
```
  - crossDomain
```
public Boolean crossDomain()
```
  - dataType
```
public String dataType()
```
  - global
```
public Boolean global()
```
  - ifModified
```
public Boolean ifModified()
```
  - isLocal
```
public Boolean isLocal()
```
  - method
```
public String method()
```
  - mimeType
```
public String mimeType()
```
  - password
```
public String password()
```
  - processData
```
public Boolean processData()
```
  - scriptCharset
```
public String scriptCharset()
```
  - timeout
```
public Number timeout()
```
  - traditional
```
public Boolean traditional()
```
  - type
```
public String type()
```
  - url
```
public String url()
```
  - username
```
public String username()
```
  - beforeSend
```
public Object beforeSend(JQueryXHR jqXHR,
                         JQueryAjaxSettings settings)
```
    A pre-request callback function that can be used to modify the jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object before it is sent. Use this to set custom headers, etc. The jqXHR and settings objects are passed as args. This is an Ajax Event. Returning false in the beforeSend function will cancel the request. As of jQuery 1.5, the beforeSend option will be called regardless of the type of request.
  - complete
```
public Object complete(JQueryXHR jqXHR,
                       String textStatus)
```
    A function to be called when the request finishes (after success and error callbacks are executed). The function gets passed two args: The jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object and a string categorizing the status of the request ("success", "notmodified", "error", "timeout", "abort", or "parsererror"). As of jQuery 1.5, the complete setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event.
  - dataFilter
```
public Object dataFilter(Object data,
                         Object ty)
```
    A function to be used to handle the raw response data of XMLHttpRequest.This is a pre-filtering function to sanitize the response. You should return the sanitized data. The function accepts two args: The raw data returned from the server and the 'dataType' parameter.
  - error
```
public Object error(JQueryXHR jqXHR,
                    String textStatus,
                    String errorThrown)
```
    A function to be called if the request fails. The function receives three args: The jqXHR (in jQuery 1.4.x, XMLHttpRequest) object, a string describing the type of error that occurred and an optional exception object, if one occurred. Possible values for the second argument (besides null) are "timeout", "error", "abort", and "parsererror". When an HTTP error occurs, errorThrown receives the textual portion of the HTTP status, such as "Not Found" or "Internal Server Error." As of jQuery 1.5, the error setting can accept an array of functions. Each function will be called in turn. Note: This handler is not called for cross-domain script and cross-domain JSONP requests. This is an Ajax Event.
  - success
```
public Object success(Object data,
                      String textStatus,
                      JQueryXHR jqXHR)
```
    A function to be called if the request succeeds. The function gets passed three args: The data returned from the server, formatted according to the dataType parameter; a string describing the status; and the jqXHR (in jQuery 1.4.x, XMLHttpRequest) object. As of jQuery 1.5, the success setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event.

Class JQueryAjaxSettings

Nested Class Summary

Nested classes/interfaces inherited from class net.java.html.lib.Objs

Field Summary

Fields inherited from class net.java.html.lib.Objs

Constructor Summary

Method Summary

Methods inherited from class net.java.html.lib.Objs

Methods inherited from class java.lang.Object

Field Detail

accepts

async

cache

contents

contentType

context

converters

crossDomain

data

dataType

global

headers

ifModified

isLocal

jsonp

jsonpCallback

method

mimeType

password

processData

scriptCharset

statusCode

timeout

traditional

type

url

username

xhr

xhrFields

Constructor Detail

JQueryAjaxSettings

Method Detail

$as

async

cache

crossDomain

dataType

global

ifModified

isLocal

method

mimeType

password

processData

scriptCharset

timeout

traditional

type

url

username

beforeSend

complete

dataFilter

error

success