Module wicket.bootstrap.core

Package de.agilecoders.wicket.core.settings

Class BootstrapSettings

java.lang.Object

de.agilecoders.wicket.core.settings.BootstrapSettings

All Implemented Interfaces:

IBootstrapSettings

public class BootstrapSettings
extends Object
implements IBootstrapSettings

#### Description Default IBootstrapSettings implementation

See Also:

• IBootstrapSettings

Field Summary

Fields inherited from interface de.agilecoders.wicket.core.settings.IBootstrapSettings

CSS_CDN_PATTERN, CSS_RTL_CDN_PATTERN, JS_CDN_PATTERN, MODERNIZR_CDN_PATTERN, MODERNIZR_VERSION, POPPER_JS_CDN_PATTERN, POPPER_VERSION, VERSION

Constructor Summary

Constructors

Constructor	Description
BootstrapSettings()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	autoAppendResources()
boolean	deferJavascript()
ActiveThemeProvider	getActiveThemeProvider()
ResourceReference	getCssResourceReference()
String	getJsResourceFilterName()
ResourceReference	getJsResourceReference()
ResourceReference	getModernizrResourceReference()
String	getModernizrVersion()
ResourceReference	getPopperJsResourceReference()
String	getPopperJsVersion()
ThemeProvider	getThemeProvider()
String	getVersion()
BootstrapSettings	setActiveThemeProvider(ActiveThemeProvider activeThemeProvider)	The ActiveThemeProvider provides access to the active theme
IBootstrapSettings	setAutoAppendResources(boolean value)	set value to true, if bootstrap resources should be added to each page automatically
IBootstrapSettings	setCssResourceReference(ResourceReference reference)
IBootstrapSettings	setCssRtlResourceReference(ResourceReference reference)
IBootstrapSettings	setDeferJavascript(boolean defer)	if true, the <script/> tag for the bootstrap javascript will get the defer="defer" attribute
IBootstrapSettings	setJsResourceFilterName(String name)	sets the filter name for all bootstrap js resource references
BootstrapSettings	setJsResourceReference(ResourceReference bootstrapJavaScriptReference)
BootstrapSettings	setModernizrResourceReference(ResourceReference modernizrJavaScriptReference)
IBootstrapSettings	setModernizrVersion(String version)
IBootstrapSettings	setPopperJsResourceReference(ResourceReference popperJsResourceReference)
IBootstrapSettings	setPopperJsVersion(String version)
BootstrapSettings	setThemeProvider(ThemeProvider themeProvider)	The ThemeProvider instance provides access to all available themes.
IBootstrapSettings	setUpdateSecurityManager(boolean activate)	if true, all necessary exceptions will be added to security manager to allow fonts and less files.
IBootstrapSettings	setVersion(String version)
boolean	updateSecurityManager()	if true, all necessary exceptions will be added to security manager to allow fonts and less files.
boolean	useCdnResources()
IBootstrapSettings	useCdnResources(boolean useCdnResources)
final boolean	useWebjars()

Methods inherited from class java.lang.Object

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

Constructor Details

BootstrapSettings

public BootstrapSettings()

Constructor.

Method Details

setVersion

public IBootstrapSettings setVersion(String version)

Specified by:

setVersion in interface IBootstrapSettings

Parameters:

version - The version of Bootstrap. CDN resources use it to construct their urls

Returns:

same instance for chaining

setModernizrVersion

public IBootstrapSettings setModernizrVersion(String version)

Specified by:

setModernizrVersion in interface IBootstrapSettings

Parameters:

version - The version of modernizr. CDN resources use it to construct their urls

Returns:

same instance for chaining

setPopperJsVersion

public IBootstrapSettings setPopperJsVersion(String version)

Specified by:

setPopperJsVersion in interface IBootstrapSettings

Parameters:

version - The version of popper.js. CDN resources use it to construct their urls

Returns:

same instance for chaining

getVersion

public String getVersion()

Specified by:

getVersion in interface IBootstrapSettings

Returns:

The version of Bootstrap. CDN resources use it to construct their urls

deferJavascript

public boolean deferJavascript()

Specified by:

deferJavascript in interface IBootstrapSettings

Returns:

the deferJavascript flag

getModernizrVersion

public String getModernizrVersion()

Specified by:

getModernizrVersion in interface IBootstrapSettings

Returns:

The version of modernizr. CDN resources use it to construct their urls

getPopperJsVersion

public String getPopperJsVersion()

Specified by:

getPopperJsVersion in interface IBootstrapSettings

Returns:

The version of popper.js. CDN resources use it to construct their urls

autoAppendResources

public boolean autoAppendResources()

Specified by:

autoAppendResources in interface IBootstrapSettings

Returns:

True, if bootstrap resources should be added to each page automatically

getCssResourceReference

public ResourceReference getCssResourceReference()

Specified by:

getCssResourceReference in interface IBootstrapSettings

Returns:

the base bootstrap css resource reference

getJsResourceReference

public ResourceReference getJsResourceReference()

Specified by:

getJsResourceReference in interface IBootstrapSettings

Returns:

the base bootstrap JavaScript resource reference

getModernizrResourceReference

public ResourceReference getModernizrResourceReference()

Specified by:

getModernizrResourceReference in interface IBootstrapSettings

Returns:

the modernizr JavaScript resource reference

getPopperJsResourceReference

public ResourceReference getPopperJsResourceReference()

Specified by:

getPopperJsResourceReference in interface IBootstrapSettings

Returns:

the popper.js JavaScript resource reference

getJsResourceFilterName

public String getJsResourceFilterName()

Specified by:

getJsResourceFilterName in interface IBootstrapSettings

Returns:

javascript resource filter name

setAutoAppendResources

public IBootstrapSettings setAutoAppendResources(boolean value)

Description copied from interface: IBootstrapSettings

set value to true, if bootstrap resources should be added to each page automatically

Specified by:

setAutoAppendResources in interface IBootstrapSettings

Parameters:

value - true, if bootstrap resources should be added to each page automatically

Returns:

same instance for chaining

getActiveThemeProvider

public ActiveThemeProvider getActiveThemeProvider()

Specified by:

getActiveThemeProvider in interface IBootstrapSettings

Returns:

The ActiveThemeProvider instance

getThemeProvider

public ThemeProvider getThemeProvider()

Specified by:

getThemeProvider in interface IBootstrapSettings

Returns:

The ThemeProvider instance

updateSecurityManager

public boolean updateSecurityManager()

Description copied from interface: IBootstrapSettings

if true, all necessary exceptions will be added to security manager to allow fonts and less files. (default is true)

Specified by:

updateSecurityManager in interface IBootstrapSettings

Returns:

true, if security manger should be updated while installing these settings

setCssResourceReference

public IBootstrapSettings setCssResourceReference(ResourceReference reference)

Specified by:

setCssResourceReference in interface IBootstrapSettings

Parameters:

reference - a reference to the base bootstrap css library. Defaults to the embedded bootstrap.css

Returns:

same instance for chaining

setCssRtlResourceReference

public IBootstrapSettings setCssRtlResourceReference(ResourceReference reference)

Specified by:

setCssRtlResourceReference in interface IBootstrapSettings

Parameters:

reference - a reference to the RTL (right-to-left) bootstrap css library. Defaults to the embedded bootstrap.rtl.css

Returns:

same instance for chaining

setJsResourceReference

public BootstrapSettings setJsResourceReference(ResourceReference bootstrapJavaScriptReference)

Specified by:

setJsResourceReference in interface IBootstrapSettings

Parameters:

bootstrapJavaScriptReference - a reference to the base bootstrap JavaScript library. Defaults to the embedded bootstrap.js

Returns:

same instance for chaining

setJsResourceFilterName

public IBootstrapSettings setJsResourceFilterName(String name)

Description copied from interface: IBootstrapSettings

sets the filter name for all bootstrap js resource references

Specified by:

setJsResourceFilterName in interface IBootstrapSettings

Parameters:

name - javascript resource filter name

Returns:

same instance for chaining

setModernizrResourceReference

public BootstrapSettings setModernizrResourceReference(ResourceReference modernizrJavaScriptReference)

Specified by:

setModernizrResourceReference in interface IBootstrapSettings

Parameters:

modernizrJavaScriptReference - a reference to the Modernizr library. Defaults to the embedded modernizr.js

Returns:

same instance for chaining

setPopperJsResourceReference

public IBootstrapSettings setPopperJsResourceReference(ResourceReference popperJsResourceReference)

Specified by:

setPopperJsResourceReference in interface IBootstrapSettings

Parameters:

popperJsResourceReference - a reference to the Popper.js library. Defaults to the embedded popper.js.

Returns:

same instance for chaining

setUpdateSecurityManager

public IBootstrapSettings setUpdateSecurityManager(boolean activate)

Description copied from interface: IBootstrapSettings

if true, all necessary exceptions will be added to security manager to allow fonts and less files. (default is true)

Specified by:

setUpdateSecurityManager in interface IBootstrapSettings

Parameters:

activate - true, if security manger should be updated while installing these settings

Returns:

same instance for chaining

setDeferJavascript

public IBootstrapSettings setDeferJavascript(boolean defer)

Description copied from interface: IBootstrapSettings

if true, the <script/> tag for the bootstrap javascript will get the defer="defer" attribute

Specified by:

setDeferJavascript in interface IBootstrapSettings

Returns:

same instance for chaining

setActiveThemeProvider

public BootstrapSettings setActiveThemeProvider(ActiveThemeProvider activeThemeProvider)

Description copied from interface: IBootstrapSettings

The ActiveThemeProvider provides access to the active theme

Specified by:

setActiveThemeProvider in interface IBootstrapSettings

Parameters:

activeThemeProvider - The ActiveThemeProvider instance

Returns:

same instance for chaining

setThemeProvider

public BootstrapSettings setThemeProvider(ThemeProvider themeProvider)

Description copied from interface: IBootstrapSettings

The ThemeProvider instance provides access to all available themes.

Specified by:

setThemeProvider in interface IBootstrapSettings

Parameters:

themeProvider - The ThemeProvider instance

Returns:

same instance for chaining

useCdnResources

public boolean useCdnResources()

Specified by:

useCdnResources in interface IBootstrapSettings

Returns:

true, if the resources for the themes should be loaded from a CDN network

useWebjars

public final boolean useWebjars()

Specified by:

useWebjars in interface IBootstrapSettings

Returns:

true, if wicket bootstrap uses the webjars library. If you don't want to use the webjars libraries, please set bootstrap css/js, modernizr reference to your own instance or call IBootstrapSettings.useCdnResources(boolean). Some components uses webjars references internally, so if you want to use them, please override the provided newXYHeaderItem() methods.

useCdnResources

public IBootstrapSettings useCdnResources(boolean useCdnResources)

Specified by:

useCdnResources in interface IBootstrapSettings

Parameters:

useCdnResources - a flag indicating whether the resources for the themes should be loaded from a CDN network

Returns:

this instance