org.odlabs.wiquery.core.commons

Class WiQuerySettings

java.lang.Object

org.odlabs.wiquery.core.commons.WiQuerySettings

All Implemented Interfaces:

Serializable

public class WiQuerySettings
extends Object
implements Serializable

$Id: WiQuerySettings.java 1010 2011-05-13 15:22:25Z hielke.hoeve@gmail.com $

Bean to get the wiQuery settings

Since:

1.1

Author:

Julien Roche

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WiQuerySettings() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addListener(WiQueryPluginRenderingListener listener) Method adding a WiQueryPluginRenderingListener
static WiQuerySettings	get() Get WiQuerySettings for current thread.
org.apache.wicket.markup.html.resources.JavascriptResourceReference	getJQueryCoreResourceReference()
ListIterator<WiQueryPluginRenderingListener>	getListeners()
boolean	isAutoImportJQueryResource()
boolean	isAutoImportJQueryUIResource()
boolean	isEmbedGeneratedStatements()
boolean	isEnableResourcesMerging()
boolean	isEnableWiqueryResourceManagement()
boolean	isMinifiedResources() When true wiquery delivers minimized versions js/css files, when false wiquery delivers normal (non-minimized) versions.
void	setAutoImportJQueryResource(boolean autoImportJQueryResource) Set the autoImportJQueryResource option
void	setAutoImportJQueryUIResource(boolean autoImportJQueryUIResource) If set to false, no jQueryUI resources are contributed by the framework, which means the user is responsible to add required resources (javascript and css files) for jQueryUI to work.
void	setEmbedGeneratedStatements(boolean embedGeneratedStatements) If set to false (default), the generated JavaScript statements will be loaded using a dynamic resource named xxxxxxxx-wiquery-gen.js.
void	setEnableResourcesMerging(boolean enableResourcesMerging) Set the enableResourcesMerging option
void	setEnableWiqueryResourceManagement(boolean enableWiqueryResourceManagement) If set to false, all resource contributions by Wiquery are disabled.
void	setJQueryCoreResourceReference(org.apache.wicket.markup.html.resources.JavascriptResourceReference jQueryCoreResourceReference) Set the jQuery core to use
void	setMinifiedResources(boolean minifiedResources) Sets the minifiedResources option

Methods inherited from class java.lang.Object

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

Constructor Detail

WiQuerySettings

public WiQuerySettings()

Default constructor

Method Detail

get

public static WiQuerySettings get()

Get WiQuerySettings for current thread.

Returns:

The settings

addListener

public boolean addListener(WiQueryPluginRenderingListener listener)

Method adding a WiQueryPluginRenderingListener

Parameters:

listener -

Returns:

the state

getListeners

public ListIterator<WiQueryPluginRenderingListener> getListeners()

Returns:

the list of listener from the listeners option

isAutoImportJQueryResource

public boolean isAutoImportJQueryResource()

Returns:

the state of the autoImportJQueryResource option

isEnableResourcesMerging

public boolean isEnableResourcesMerging()

Returns:

the state of the enableResourcesMerging option

isEmbedGeneratedStatements

public boolean isEmbedGeneratedStatements()

Returns:

the state of the embedGeneratedStatements option

isMinifiedResources

public boolean isMinifiedResources()

When true wiquery delivers minimized versions js/css files, when false wiquery delivers normal (non-minimized) versions. The default value depends on whether an IJavascriptCompressor is used or not.

This setting also enables the WiQueryYUICompressedStyleSheetResource to be used.

Always provide the normal (non-minimized) version, wiquery will reference to the minimized version when WiQuerySettings#isCompressedJavascript() is true.

The filename format for the 2 versions is:

• Normal version: foo.js / foo.css
• Minimized version: foo.min.js / foo.min.css

Returns:

the state of the minifiedResources option.

setAutoImportJQueryResource

public void setAutoImportJQueryResource(boolean autoImportJQueryResource)

Set the autoImportJQueryResource option

Parameters:

autoImportJQueryResource -

setEnableResourcesMerging

public void setEnableResourcesMerging(boolean enableResourcesMerging)

Set the enableResourcesMerging option

Parameters:

enableResourcesMerging -

setEmbedGeneratedStatements

public void setEmbedGeneratedStatements(boolean embedGeneratedStatements)

If set to false (default), the generated JavaScript statements will be loaded using a dynamic resource named xxxxxxxx-wiquery-gen.js. To embed the code in your HTML page, set this option to true.

Parameters:

embedGeneratedStatements -

getJQueryCoreResourceReference

public org.apache.wicket.markup.html.resources.JavascriptResourceReference getJQueryCoreResourceReference()

Returns:

the JavascriptResourceReference where we can find the jQuery core

setJQueryCoreResourceReference

public void setJQueryCoreResourceReference(org.apache.wicket.markup.html.resources.JavascriptResourceReference jQueryCoreResourceReference)

Set the jQuery core to use

Parameters:

jQueryCoreResourceReference -

setMinifiedResources

public void setMinifiedResources(boolean minifiedResources)

Sets the minifiedResources option

Parameters:

minifiedResources -

See Also:

isMinifiedResources()

isAutoImportJQueryUIResource

public boolean isAutoImportJQueryUIResource()

setAutoImportJQueryUIResource

public void setAutoImportJQueryUIResource(boolean autoImportJQueryUIResource)

If set to false, no jQueryUI resources are contributed by the framework, which means the user is responsible to add required resources (javascript and css files) for jQueryUI to work. Useful if one wants to manage resources globally or use a CDN network to load resources.

Warning: If version does not match to the version contributed by the framework, functionality may be harmed!

Parameters:

autoImportJQueryUIResource - true to let the framework import required resources. false to disable automatic resources contribution by the framework.

See Also:

setEnableWiqueryResourceManagement(boolean)

isEnableWiqueryResourceManagement

public boolean isEnableWiqueryResourceManagement()

setEnableWiqueryResourceManagement

public void setEnableWiqueryResourceManagement(boolean enableWiqueryResourceManagement)

If set to false, all resource contributions by Wiquery are disabled. No jQuery or jQueryUI resource are contributed by the framework, nor any resources from plugins. Useful if one wants to manage resources globally or use a CDN network to load resources.

Warning: By setting this to false the frameworks functionality (or parts of it) is not guaranteed anymore! Activate only if you know what you do and import required resources manually.

Sets internally setAutoImportJQueryResource(boolean) and setAutoImportJQueryUIResource(boolean) to the given value.

Parameters:

enableWiqueryResourceManagement - false disables all resources contributions by the framework. true enables it (default).

See Also:

setAutoImportJQueryResource(boolean), setAutoImportJQueryUIResource(boolean)