org.wicketstuff.jslibraries

Class JSLib

java.lang.Object

org.wicketstuff.jslibraries.JSLib

public class JSLib
extends Object

The reason for this is the common use-case of fetching 'standard'-libs from Google or Yahoo instead of the local app if possible, for caching and parallelization reasons.

Usage:

JSLib.getHeaderContributor(VersionDescriptor.exactVersion(Library.JQUERY, 1,3,1)) will serve the appropriate Script as bundled with this project, in either readable or minimized (if Wicket is in 'deployment'-configuration-type) form.

JSLib.getHeaderContributor(VersionDescriptor.exactVersion(Library.JQUERY, 1,3,1), CDN.ANY) will serve it from the any CDN where it is available, falling back to the local version if necessary.

JSLib.getHeaderContributor(VersionDescriptor.exactVersion(Library.JQUERY, 1,3,1), true, CDN.GOOGLE) will serve it from Google (or the local Version as fallback) in minimized form, no matter what Wicket´s configuration is.

Component Developers should not select providers.

Application Developers can set the providers they want to use on a per Application basis by using
JSLib.setOverrideProviders(Application.get(), LocalProvider.DEFAULT); for Local use only, or
JSLib.setOverrideProviders(Application.get(), CDN.GOOGLE); or even
JSLib.setOverrideProviders(Application.get(), CDN.ANY);

Method Summary

Methods

Modifier and Type	Method and Description
static org.apache.wicket.markup.html.IHeaderContributor	getHeaderContribution(VersionDescriptor versionDescriptor) Get a header contributor for the given VersionDescriptor.
static org.apache.wicket.markup.html.IHeaderContributor	getHeaderContribution(VersionDescriptor versionDescriptor, boolean production, Provider... providers)
static org.apache.wicket.markup.html.IHeaderContributor	getHeaderContribution(VersionDescriptor versionDescriptor, Provider... providers)
static void	setOverrideProviders(org.apache.wicket.Application app, Provider... providers) Not to be used by Component authors.

Methods inherited from class java.lang.Object

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

Method Detail

setOverrideProviders

public static void setOverrideProviders(org.apache.wicket.Application app,
                        Provider... providers)

Not to be used by Component authors. This should be used as an application-wide setting for which providers to use. If set, it will be applied instead of the providers passed

Parameters:

app -

providers -

getHeaderContribution

public static org.apache.wicket.markup.html.IHeaderContributor getHeaderContribution(VersionDescriptor versionDescriptor)

Get a header contributor for the given VersionDescriptor. This method should be used by component authors if they want to offer maximum flexibility in reuse of their components.

Parameters:

versionDescriptor -

Returns:

matching HeaderContributor from the first matching provider

getHeaderContribution

public static org.apache.wicket.markup.html.IHeaderContributor getHeaderContribution(VersionDescriptor versionDescriptor,
                                                                     Provider... providers)

Parameters:

versionDescriptor -

providers - list of alternative providers (might be ignored if setOverrideProviders was used)

Returns:

matching HeaderContributor from the first matching provider

getHeaderContribution

public static org.apache.wicket.markup.html.IHeaderContributor getHeaderContribution(VersionDescriptor versionDescriptor,
                                                                     boolean production,
                                                                     Provider... providers)

Parameters:

versionDescriptor -

production - if true tried to serve minimized versions

providers - list of alternative providers (might be ignored if setOverrideProviders was used

Returns:

matching HeaderContributor from the first matching provider