org.odlabs.wiquery.core.jqueryplugins

Class JQueryCookieOption

java.lang.Object

org.odlabs.wiquery.core.jqueryplugins.JQueryCookieOption

All Implemented Interfaces:

Serializable, IComplexOption

public class JQueryCookieOption
extends Object
implements IComplexOption

$Id: JQueryCookieOption

Bean storing jQuery cookie options (only the value of cookie won't be stored into the options)

Warning : You must import the CookieJavaScriptResourceReference to enable the cookie option

Since:

1.0

Author:

Julien Roche

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JQueryCookieOption(String name) Constructeur

Method Summary

Methods

Modifier and Type	Method and Description
JsStatement	deleteCookie() Method to delete the cookie This will return the element back to its pre-init state.
void	deleteCookie(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to delete the cookie within the ajax request
JsStatement	getCookie() Method to retrieve the cookie This will return the element back to its pre-init state.
String	getDomain()
DateOption	getExpires()
CharSequence	getJavascriptOption() Method retrieving the javascript representation of this complex option
String	getName()
protected Options	getOptions() Method retrieving the options
String	getPath()
String	getValue()
boolean	isSecure()
JsStatement	setCookie() Method to set the cookie This will return the element back to its pre-init state.
void	setCookie(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to set the cookie within the ajax request
JQueryCookieOption	setDomain(String domain) Set's the domain name (example: server.domain.net)
JQueryCookieOption	setExpires(DateOption expires) Set's with a Number or a Date the time of validation of the cookie
JQueryCookieOption	setPath(String path) Set's the path ("/" or "http://server.domain.net" for examples)
JQueryCookieOption	setSecure(boolean secure) Set's the transaction security status (must we enable the SSL protocol ?)
JQueryCookieOption	setValue(String value) Set's the value of the cookie

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JQueryCookieOption

public JQueryCookieOption(String name)

Constructeur

Parameters:

name - Name of the cookie

Method Detail

getJavascriptOption

public CharSequence getJavascriptOption()

Method retrieving the javascript representation of this complex option

Specified by:

getJavascriptOption in interface IComplexOption

Returns:

the javascript

See Also:

IComplexOption.getJavascriptOption()

getOptions

protected Options getOptions()

Method retrieving the options

Returns:

the options

setDomain

public JQueryCookieOption setDomain(String domain)

Set's the domain name (example: server.domain.net)

Parameters:

domain -

getDomain

public String getDomain()

Returns:

the domain option value

setExpires

public JQueryCookieOption setExpires(DateOption expires)

Set's with a Number or a Date the time of validation of the cookie

Parameters:

expires -

getExpires

public DateOption getExpires()

Returns:

the expires option value

getName

public String getName()

Returns:

the name option value

setPath

public JQueryCookieOption setPath(String path)

Set's the path ("/" or "http://server.domain.net" for examples)

Parameters:

path -

getPath

public String getPath()

Returns:

the path option value

setSecure

public JQueryCookieOption setSecure(boolean secure)

Set's the transaction security status (must we enable the SSL protocol ?)

Parameters:

secure -

isSecure

public boolean isSecure()

Returns:

the secure option value

setValue

public JQueryCookieOption setValue(String value)

Set's the value of the cookie

Parameters:

value -

getValue

public String getValue()

Returns:

the value

deleteCookie

public JsStatement deleteCookie()

Method to delete the cookie This will return the element back to its pre-init state.

Returns:

the associated JsStatement

deleteCookie

public void deleteCookie(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to delete the cookie within the ajax request

Parameters:

ajaxRequestTarget -

getCookie

public JsStatement getCookie()

Method to retrieve the cookie This will return the element back to its pre-init state.

Returns:

the associated JsStatement

setCookie

public JsStatement setCookie()

Method to set the cookie This will return the element back to its pre-init state.

Returns:

the associated JsStatement

setCookie

public void setCookie(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to set the cookie within the ajax request

Parameters:

ajaxRequestTarget -