Module wicket.bootstrap.core
Interface IBootstrapSettings
- All Known Implementing Classes:
BootstrapSettings
public interface IBootstrapSettings
#### Description
Settings interface for bootstrap settings.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe url to the css resource at a CDN networkstatic final StringThe url to the right-to-left css resource at a CDN networkstatic final StringThe url to the JavaScript resource at a CDN networkstatic final StringThe url to the modernizr JavaScript resource at a CDN networkstatic final StringThe version of modernizrstatic final StringThe url to the Popper.js Javascript resource at a CDN networkstatic final StringThe version of Popper.jsstatic final StringThe version of Bootstrap -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleansetActiveThemeProvider(ActiveThemeProvider themeProvider) TheActiveThemeProviderprovides access to the active themesetAutoAppendResources(boolean value) set value to true, if bootstrap resources should be added to each page automaticallysetCssResourceReference(ResourceReference reference) setCssRtlResourceReference(ResourceReference reference) setDeferJavascript(boolean defer) if true, the <script/> tag for the bootstrap javascript will get the defer="defer" attributesets the filter name for all bootstrap js resource referencessetJsResourceReference(ResourceReference reference) setModernizrResourceReference(ResourceReference reference) setModernizrVersion(String version) setPopperJsResourceReference(ResourceReference popperJsResourceReference) setPopperJsVersion(String version) setThemeProvider(ThemeProvider themeProvider) TheThemeProviderinstance provides access to all available themes.setUpdateSecurityManager(boolean activate) if true, all necessary exceptions will be added to security manager to allow fonts and less files.setVersion(String version) booleanif true, all necessary exceptions will be added to security manager to allow fonts and less files.booleanuseCdnResources(boolean useCdnResources) boolean
-
Field Details
-
VERSION
The version of Bootstrap- See Also:
-
MODERNIZR_VERSION
The version of modernizr- See Also:
-
POPPER_VERSION
The version of Popper.js- See Also:
-
JS_CDN_PATTERN
The url to the JavaScript resource at a CDN network- See Also:
-
MODERNIZR_CDN_PATTERN
The url to the modernizr JavaScript resource at a CDN network- See Also:
-
CSS_CDN_PATTERN
The url to the css resource at a CDN network- See Also:
-
CSS_RTL_CDN_PATTERN
The url to the right-to-left css resource at a CDN network- See Also:
-
POPPER_JS_CDN_PATTERN
The url to the Popper.js Javascript resource at a CDN network- See Also:
-
-
Method Details
-
setVersion
- Parameters:
version- The version of Bootstrap. CDN resources use it to construct their urls- Returns:
- same instance for chaining
-
setModernizrVersion
- Parameters:
version- The version of modernizr. CDN resources use it to construct their urls- Returns:
- same instance for chaining
-
setPopperJsVersion
- Parameters:
version- The version of popper.js. CDN resources use it to construct their urls- Returns:
- same instance for chaining
-
deferJavascript
boolean deferJavascript()- Returns:
- the deferJavascript flag
-
getVersion
String getVersion()- Returns:
- The version of Bootstrap. CDN resources use it to construct their urls
-
getModernizrVersion
String getModernizrVersion()- Returns:
- The version of modernizr. CDN resources use it to construct their urls
-
getPopperJsVersion
String getPopperJsVersion()- Returns:
- The version of popper.js. CDN resources use it to construct their urls
-
autoAppendResources
boolean autoAppendResources()- Returns:
- True, if bootstrap resources should be added to each page automatically
-
getCssResourceReference
ResourceReference getCssResourceReference()- Returns:
- the base bootstrap css resource reference
-
getJsResourceReference
ResourceReference getJsResourceReference()- Returns:
- the base bootstrap JavaScript resource reference
-
getModernizrResourceReference
ResourceReference getModernizrResourceReference()- Returns:
- the modernizr JavaScript resource reference
-
getPopperJsResourceReference
ResourceReference getPopperJsResourceReference()- Returns:
- the popper.js JavaScript resource reference
-
setCssResourceReference
- Parameters:
reference- a reference to the base bootstrap css library. Defaults to the embedded bootstrap.css- Returns:
- same instance for chaining
-
setCssRtlResourceReference
- 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
- Parameters:
reference- a reference to the base bootstrap JavaScript library. Defaults to the embedded bootstrap.js- Returns:
- same instance for chaining
-
setModernizrResourceReference
- Parameters:
reference- a reference to the Modernizr library. Defaults to the embedded modernizr.js- Returns:
- same instance for chaining
-
setPopperJsResourceReference
- Parameters:
popperJsResourceReference- a reference to the Popper.js library. Defaults to the embedded popper.js.- Returns:
- same instance for chaining
-
getJsResourceFilterName
String getJsResourceFilterName()- Returns:
- javascript resource filter name
-
setAutoAppendResources
set value to true, if bootstrap resources should be added to each page automatically- Parameters:
value- true, if bootstrap resources should be added to each page automatically- Returns:
- same instance for chaining
-
setJsResourceFilterName
sets the filter name for all bootstrap js resource references- Parameters:
name- javascript resource filter name- Returns:
- same instance for chaining
-
setUpdateSecurityManager
if true, all necessary exceptions will be added to security manager to allow fonts and less files. (default is true)- Parameters:
activate- true, if security manger should be updated while installing these settings- Returns:
- same instance for chaining
-
setDeferJavascript
if true, the <script/> tag for the bootstrap javascript will get the defer="defer" attribute- Parameters:
defer-- Returns:
- same instance for chaining
-
updateSecurityManager
boolean updateSecurityManager()if true, all necessary exceptions will be added to security manager to allow fonts and less files. (default is true)- Returns:
- true, if security manger should be updated while installing these settings
-
setActiveThemeProvider
TheActiveThemeProviderprovides access to the active theme- Parameters:
themeProvider- TheActiveThemeProviderinstance- Returns:
- same instance for chaining
-
getActiveThemeProvider
ActiveThemeProvider getActiveThemeProvider()- Returns:
- The
ActiveThemeProviderinstance
-
getThemeProvider
ThemeProvider getThemeProvider()- Returns:
- The
ThemeProviderinstance
-
setThemeProvider
TheThemeProviderinstance provides access to all available themes.- Parameters:
themeProvider- TheThemeProviderinstance- Returns:
- same instance for chaining
-
useCdnResources
boolean useCdnResources()- Returns:
- true, if the resources for the themes should be loaded from a CDN network
-
useWebjars
boolean useWebjars()- 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
useCdnResources(boolean). Some components uses webjars references internally, so if you want to use them, please override the providednewXYHeaderItem()methods.
-
useCdnResources
- Parameters:
useCdnResources- a flag indicating whether the resources for the themes should be loaded from a CDN network- Returns:
- this instance
-