Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.wicket.settings
Class Settings

java.lang.Object
  extended by org.apache.wicket.settings.Settings
All Implemented Interfaces:
IApplicationSettings, IDebugSettings, IExceptionSettings, IFrameworkSettings, IMarkupSettings, IPageSettings, IRequestCycleSettings, IRequestLoggerSettings, IResourceSettings, ISecuritySettings, ISessionSettings
public final class Settings
extends java.lang.Object
implements IApplicationSettings, IDebugSettings, IExceptionSettings, IMarkupSettings, IPageSettings, IRequestCycleSettings, IResourceSettings, ISecuritySettings, ISessionSettings, IFrameworkSettings, IRequestLoggerSettings

Contains settings exposed via IXXXSettings interfaces. It is not a good idea to use this class directly, instead use the provided IXXXSettings interfaces.

Author:
Jonathan Locke, Chris Turner, Eelco Hillenius, Juergen Donnerstag, Johan Compagner, Igor Vaynberg (ivaynberg), Martijn Dashorst

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.wicket.settings.IExceptionSettings
IExceptionSettings.UnexpectedExceptionDisplay
 
Nested classes/interfaces inherited from interface org.apache.wicket.settings.IRequestCycleSettings
IRequestCycleSettings.RenderStrategy
 
Field Summary
 
Fields inherited from interface org.apache.wicket.settings.IExceptionSettings
SHOW_EXCEPTION_PAGE, SHOW_INTERNAL_ERROR_PAGE, SHOW_NO_EXCEPTION_PAGE
 
Fields inherited from interface org.apache.wicket.settings.IRequestCycleSettings
ONE_PASS_RENDER, REDIRECT_TO_BUFFER, REDIRECT_TO_RENDER
 
Fields inherited from interface org.apache.wicket.settings.ISecuritySettings
DEFAULT_ENCRYPTION_KEY
 
Constructor Summary
Settings(Application application)
          Create the application settings, carrying out any necessary initializations.
 
Method Summary
 void addComponentResolver(IComponentResolver resolver)
          Adds a component resolver to the list.
 void addResourceFactory(java.lang.String name, IResourceFactory resourceFactory)
          Adds a resource factory to the list of factories to consult when generating resources automatically
 void addResourceFolder(java.lang.String resourceFolder)
          Convenience method that sets the resource search path to a single folder.
 void addResponseFilter(IResponseFilter responseFilter)
          Adds a response filter to the list.
 void addStringResourceLoader(int index, IStringResourceLoader loader)
          Add a string resource loader to the chain of loaders.
 void addStringResourceLoader(IStringResourceLoader loader)
          Add a string resource loader to the chain of loaders.
 java.lang.Class<? extends Page> getAccessDeniedPage()
          Gets the access denied page class.
 boolean getAddLastModifiedTimeToResourceReferenceUrl()
          Returns whether Wicket should add last modified time as resource reference URL parameter.
 IAuthorizationStrategy getAuthorizationStrategy()
          Gets the authorization strategy.
 boolean getAutomaticLinking()
          If true, automatic link resolution is enabled.
 boolean getAutomaticMultiWindowSupport()
          Gets whether Wicket should try to support opening multiple windows for the same session transparently.
 boolean getBufferResponse()
           
 IClassResolver getClassResolver()
          Gets the default resolver to use when finding classes and resources
 java.util.List<IComponentResolver> getComponentResolvers()
          Get the (modifiable) list of IComponentResolvers.
 boolean getComponentUseCheck()
           
 boolean getCompressWhitespace()
           
 CookieValuePersisterSettings getCookieValuePersisterSettings()
          Get the defaults to be used by persistence manager
 ICryptFactory getCryptFactory()
           
 java.lang.String getDefaultAfterDisabledLink()
           
 java.lang.String getDefaultBeforeDisabledLink()
           
 java.lang.String getDefaultMarkupEncoding()
           
 Bytes getDefaultMaximumUploadSize()
          Gets the default maximum size for uploads.
 IDetachListener getDetachListener()
           
 boolean getDisableGZipCompression()
          Whether to disable gzip compression for resources.
 boolean getEnforceMounts()
          Gets whether mounts should be enforced.
 boolean getGatherExtendedBrowserInfo()
          Gets whether Wicket should try to get extensive client info by redirecting to a page that polls for client capabilities.
 java.lang.Class<? extends Page> getInternalErrorPage()
          Gets internal error page class.
 IJavascriptCompressor getJavascriptCompressor()
          Get the javascript compressor to remove comments and whitespace characters from javascripts
 Localizer getLocalizer()
          Get the application's localizer.
 IMarkupCache getMarkupCache()
          The markup cache also loads the markup if not yet available in the cache.
 IMarkupParserFactory getMarkupParserFactory()
           
 int getMaxPageMaps()
          Gets maximum number of page maps allowed in this session
 IPackageResourceGuard getPackageResourceGuard()
          Gets the package resource guard.
 java.lang.Class<? extends Page> getPageExpiredErrorPage()
          Gets the page expired page class.
 IPageFactory getPageFactory()
          Gets the factory to be used when creating pages
 IPageMapEvictionStrategy getPageMapEvictionStrategy()
          Gets the strategy for evicting pages from the page map.
 java.lang.CharSequence getParentFolderPlaceholder()
          Placeholder string for '..' within resource urls (which will be crippled by the browser and not work anymore).
 IPropertiesFactory getPropertiesFactory()
          Get the property factory which will be used to load property files
 boolean getRecordSessionSize()
           
 IRequestCycleSettings.RenderStrategy getRenderStrategy()
          Gets in what way the render part of a request is handled.
 int getRequestsWindowSize()
           
 IResourceFactory getResourceFactory(java.lang.String name)
           
 IResourceFinder getResourceFinder()
          Gets the resource finder to use when searching for resources.
 Duration getResourcePollFrequency()
           
 IResourceStreamLocator getResourceStreamLocator()
           
 ModificationWatcher getResourceWatcher(boolean start)
           
 java.util.List<IResponseFilter> getResponseFilters()
           
 java.lang.String getResponseRequestEncoding()
          In order to do proper form parameter decoding it is important that the response and the following request have the same encoding.
 java.util.List<IStringResourceLoader> getStringResourceLoaders()
           
 boolean getStripComments()
           
 boolean getStripJavascriptCommentsAndWhitespace()
          Deprecated. please us setJavascriptCompressor(IJavascriptCompressor) instead. Will be removed in 1.5
 boolean getStripWicketTags()
          Gets whether to remove wicket tags from the output.
 boolean getStripXmlDeclarationFromOutput()
           
 boolean getThrowExceptionOnMissingResource()
           
 boolean getThrowExceptionOnMissingXmlDeclaration()
           
 Duration getTimeout()
          Gets the time that a request will by default be waiting for the previous request to be handled before giving up.
 IUnauthorizedComponentInstantiationListener getUnauthorizedComponentInstantiationListener()
           
 IExceptionSettings.UnexpectedExceptionDisplay getUnexpectedExceptionDisplay()
           
 boolean getUseDefaultOnMissingResource()
           
 java.lang.String getVersion()
          Gets the Wicket version.
 boolean getVersionPagesByDefault()
           
 boolean isAjaxDebugModeEnabled()
          Returns status of ajax debug mode.
 boolean isDevelopmentUtilitiesEnabled()
          Are all of the panels and pages, etc, from wicket-devutils package enabled?
 boolean isLinePreciseReportingOnAddComponentEnabled()
          Returns status of line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes.
 boolean isLinePreciseReportingOnNewComponentEnabled()
          Returns status of line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes.
 boolean isOutputComponentPath()
           
 boolean isOutputMarkupContainerClassName()
          Returns whether the output of markup container's should be wrapped by comments containing the container's class name.
 boolean isPageIdUniquePerSession()
          Returns whether the page id is unique per session.
 boolean isRequestLoggerEnabled()
           
<C extends Page>
void
setAccessDeniedPage(java.lang.Class<C> accessDeniedPage)
          Sets the access denied page class.
 void setAddLastModifiedTimeToResourceReferenceUrl(boolean value)
          Sets whether Wicket should add last modified time as a parameter to resource reference URL (can help with browsers too aggressively caching certain resources).
 void setAjaxDebugModeEnabled(boolean enable)
          Enables or disables ajax debug mode.
 void setAuthorizationStrategy(IAuthorizationStrategy strategy)
          Sets the authorization strategy.
 void setAutomaticLinking(boolean automaticLinking)
          Application default for automatic link resolution.
 void setAutomaticMultiWindowSupport(boolean automaticMultiWindowSupport)
          Sets whether Wicket should try to support opening multiple windows for the same session transparently.
 void setBufferResponse(boolean bufferResponse)
           
 void setClassResolver(IClassResolver defaultClassResolver)
          Sets the default class resolver to use when finding classes and resources
 void setComponentUseCheck(boolean componentUseCheck)
          Sets componentUseCheck debug settings
 void setCompressWhitespace(boolean compressWhitespace)
          Turns on whitespace compression.
 void setCookieValuePersisterSettings(CookieValuePersisterSettings cookieValuePersisterSettings)
           
 void setCryptFactory(ICryptFactory cryptFactory)
          Sets the factory that will be used to create crypt objects.
 void setDefaultAfterDisabledLink(java.lang.String defaultAfterDisabledLink)
           
 void setDefaultBeforeDisabledLink(java.lang.String defaultBeforeDisabledLink)
           
 void setDefaultMarkupEncoding(java.lang.String encoding)
          Set default encoding for markup files.
 void setDefaultMaximumUploadSize(Bytes defaultMaximumUploadSize)
          Sets the default maximum size for uploads.
 void setDetachListener(IDetachListener detachListener)
          Sets detach listener
 void setDevelopmentUtilitiesEnabled(boolean enable)
          Enables all of the panels and pages, etc, from wicket-devutils package.
 void setDisableGZipCompression(boolean disableGZipCompression)
          Sets whether to disable gzip compression for resources.
 void setEnforceMounts(boolean enforce)
          Sets whether mounts should be enforced.
 void setGatherExtendedBrowserInfo(boolean gatherExtendedBrowserInfo)
          Sets whether Wicket should try to get extensive client info by redirecting to a page that polls for client capabilities.
<C extends Page>
void
setInternalErrorPage(java.lang.Class<C> internalErrorPage)
          Sets internal error page class.
 IJavascriptCompressor setJavascriptCompressor(IJavascriptCompressor compressor)
          Set the javascript compressor implemententation use e.g.
 void setLinePreciseReportingOnAddComponentEnabled(boolean enable)
          Enables line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes.
 void setLinePreciseReportingOnNewComponentEnabled(boolean enable)
          Enables line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes.
 void setLocalizer(Localizer localizer)
          Sets the localizer which will be used to find property values.
 void setMarkupCache(IMarkupCache markupCache)
          Sets a new markup cache which will also be used to load markup if not yet available in the cache.
 void setMarkupParserFactory(IMarkupParserFactory factory)
          Sets the markup parser factory that will be used to generate parsers for markup.
 void setMaxPageMaps(int maxPageMaps)
          Sets maximum number of page maps allowed in this session
 void setOutputComponentPath(boolean outputComponentPath)
          If set to true wicket will output component path in a wicket:path attribute of the component tag.
 void setOutputMarkupContainerClassName(boolean enable)
          Enables wrapping output of markup container in html comments that contain markup container's class name.
 void setPackageResourceGuard(IPackageResourceGuard packageResourceGuard)
          Sets the package resource guard.
<C extends Page>
void
setPageExpiredErrorPage(java.lang.Class<C> pageExpiredErrorPage)
          Sets the page expired page class.
 void setPageFactory(IPageFactory defaultPageFactory)
          Sets the factory to be used when creating pages.
 void setPageIdUniquePerSession(boolean value)
          Sets whether the id of a page should be unique across the entire session.
 void setPageMapEvictionStrategy(IPageMapEvictionStrategy pageMapEvictionStrategy)
          Sets the strategy for evicting pages from the page map.
 void setParentFolderPlaceholder(java.lang.CharSequence sequence)
          Placeholder string for '..' within resource urls (which will be crippled by the browser and not work anymore).
 void setPropertiesFactory(IPropertiesFactory factory)
          Set the property factory which will be used to load property files
 void setRecordSessionSize(boolean record)
          Enable/Disable the recording of the session size for every request.
 void setRenderStrategy(IRequestCycleSettings.RenderStrategy renderStrategy)
          Sets in what way the render part of a request is handled.
 void setRequestLoggerEnabled(boolean enable)
          Enable/Disable the request logger.
 void setRequestsWindowSize(int size)
          Set the window of all the requests that is kept in memory for viewing.
 void setResourceFinder(IResourceFinder resourceFinder)
          Sets the finder to use when searching for resources.
 void setResourcePollFrequency(Duration resourcePollFrequency)
          Sets the resource polling frequency.
 void setResourceStreamLocator(IResourceStreamLocator resourceStreamLocator)
          Sets the resource stream locator for this application
 void setResponseRequestEncoding(java.lang.String responseRequestEncoding)
          In order to do proper form parameter decoding it is important that the response and the following request have the same encoding.
 void setStripComments(boolean stripComments)
          Enables stripping of markup comments denoted in markup by HTML comment tagging.
 void setStripJavascriptCommentsAndWhitespace(boolean value)
          Deprecated. please us setJavascriptCompressor(IJavascriptCompressor) instead. Will be removed in 1.5
 void setStripWicketTags(boolean stripWicketTags)
          Sets whether to remove wicket tags from the output.
 void setStripXmlDeclarationFromOutput(boolean strip)
           
 void setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
           
 void setThrowExceptionOnMissingXmlDeclaration(boolean throwException)
          If true, an exception is thrown if the markup file does not contain a xml declaration
 void setTimeout(Duration timeout)
          Sets the time that a request will by default be waiting for the previous request to be handled before giving up.
 void setUnauthorizedComponentInstantiationListener(IUnauthorizedComponentInstantiationListener unauthorizedComponentInstantiationListener)
           
 void setUnexpectedExceptionDisplay(IExceptionSettings.UnexpectedExceptionDisplay unexpectedExceptionDisplay)
          The exception display type determines how the framework displays exceptions to you as a developer or user.
 void setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)
           
 void setVersionPagesByDefault(boolean pagesVersionedByDefault)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Settings

public Settings(Application application)
Create the application settings, carrying out any necessary initializations.

Parameters:
application - The application that these settings are for
Method Detail

addComponentResolver

public void addComponentResolver(IComponentResolver resolver)
Description copied from interface: IPageSettings
Adds a component resolver to the list.

Specified by:
addComponentResolver in interface IPageSettings
Parameters:
resolver - The IComponentResolver that is added
See Also:
IPageSettings.addComponentResolver(org.apache.wicket.markup.resolver.IComponentResolver)

addResourceFactory

public void addResourceFactory(java.lang.String name,
                               IResourceFactory resourceFactory)
Description copied from interface: IResourceSettings
Adds a resource factory to the list of factories to consult when generating resources automatically

Specified by:
addResourceFactory in interface IResourceSettings
Parameters:
name - The name to give to the factory
resourceFactory - The resource factory to add
See Also:
IResourceSettings.addResourceFactory(java.lang.String, org.apache.wicket.IResourceFactory)

addResourceFolder

public void addResourceFolder(java.lang.String resourceFolder)
Description copied from interface: IResourceSettings
Convenience method that sets the resource search path to a single folder. use when searching for resources. By default, the resources are located on the classpath. If you want to configure other, additional, search paths, you can use this method

Specified by:
addResourceFolder in interface IResourceSettings
Parameters:
resourceFolder - The resourceFolder to set
See Also:
IResourceSettings.addResourceFolder(java.lang.String)

addResponseFilter

public void addResponseFilter(IResponseFilter responseFilter)
Description copied from interface: IRequestCycleSettings
Adds a response filter to the list. Filters are evaluated in the order they have been added.

Specified by:
addResponseFilter in interface IRequestCycleSettings
Parameters:
responseFilter - The IResponseFilter that is added
See Also:
IRequestCycleSettings.addResponseFilter(org.apache.wicket.IResponseFilter)

addStringResourceLoader

public void addStringResourceLoader(IStringResourceLoader loader)
Description copied from interface: IResourceSettings
Add a string resource loader to the chain of loaders.

Specified by:
addStringResourceLoader in interface IResourceSettings
Parameters:
loader - The loader to be added
See Also:
IResourceSettings.addStringResourceLoader(org.apache.wicket.resource.loader.IStringResourceLoader)

addStringResourceLoader

public void addStringResourceLoader(int index,
                                    IStringResourceLoader loader)
Description copied from interface: IResourceSettings
Add a string resource loader to the chain of loaders.

Specified by:
addStringResourceLoader in interface IResourceSettings
Parameters:
index - The position within the array to insert the loader
loader - The loader to be added
See Also:
IResourceSettings.addStringResourceLoader(org.apache.wicket.resource.loader.IStringResourceLoader)

getAccessDeniedPage

public java.lang.Class<? extends Page> getAccessDeniedPage()
Description copied from interface: IApplicationSettings
Gets the access denied page class.

Specified by:
getAccessDeniedPage in interface IApplicationSettings
Returns:
Returns the accessDeniedPage.
See Also:
IApplicationSettings.getAccessDeniedPage()

getAuthorizationStrategy

public IAuthorizationStrategy getAuthorizationStrategy()
Description copied from interface: ISecuritySettings
Gets the authorization strategy.

Specified by:
getAuthorizationStrategy in interface ISecuritySettings
Returns:
Returns the authorizationStrategy.
See Also:
ISecuritySettings.getAuthorizationStrategy()

getAutomaticLinking

public boolean getAutomaticLinking()
Description copied from interface: IMarkupSettings
If true, automatic link resolution is enabled. Disabled by default.

Specified by:
getAutomaticLinking in interface IMarkupSettings
Returns:
Returns the automaticLinking.
See Also:
IMarkupSettings.getAutomaticLinking()

getAutomaticMultiWindowSupport

public boolean getAutomaticMultiWindowSupport()
Description copied from interface: IPageSettings
Gets whether Wicket should try to support opening multiple windows for the same session transparently. If this is true - the default setting -, Wicket tries to detect whether a new window was opened by a user (e.g. in Internet Explorer by pressing ctrl+n or ctrl+click on a link), and if it detects that, it creates a new page map for that window on the fly. As a page map represents the 'history' of one window, each window will then have their own history. If two windows would share the same page map, the non-bookmarkable links on one window could refer to stale state after working a while in the other window.

Currently, Wicket trying to do this is a best effort that is not completely fail safe. When the client does not support cookies, support gets tricky and incomplete. See WebPage's internals for the implementation.

Specified by:
getAutomaticMultiWindowSupport in interface IPageSettings
Returns:
Whether Wicket should try to support multiple windows transparently
See Also:
IPageSettings.getAutomaticMultiWindowSupport()

getBufferResponse

public boolean getBufferResponse()
Specified by:
getBufferResponse in interface IRequestCycleSettings
Returns:
True if this application buffers its responses
See Also:
IRequestCycleSettings.getBufferResponse()

getClassResolver

public IClassResolver getClassResolver()
Description copied from interface: IApplicationSettings
Gets the default resolver to use when finding classes and resources

Specified by:
getClassResolver in interface IApplicationSettings
Returns:
Default class resolver
See Also:
IApplicationSettings.getClassResolver()

getComponentResolvers

public java.util.List<IComponentResolver> getComponentResolvers()
Get the (modifiable) list of IComponentResolvers.

Specified by:
getComponentResolvers in interface IPageSettings
Returns:
List of ComponentResolvers
See Also:
for an example

getComponentUseCheck

public boolean getComponentUseCheck()
Specified by:
getComponentUseCheck in interface IDebugSettings
Returns:
true if componentUseCheck is enabled
See Also:
IDebugSettings.getComponentUseCheck()

getCompressWhitespace

public boolean getCompressWhitespace()
Specified by:
getCompressWhitespace in interface IMarkupSettings
Returns:
Returns the compressWhitespace.
See Also:
IMarkupSettings.getCompressWhitespace()

getCookieValuePersisterSettings

public CookieValuePersisterSettings getCookieValuePersisterSettings()
Description copied from interface: ISecuritySettings
Get the defaults to be used by persistence manager

Specified by:
getCookieValuePersisterSettings in interface ISecuritySettings
Returns:
CookieValuePersisterSettings
See Also:
ISecuritySettings.getCookieValuePersisterSettings()

getCryptFactory

public ICryptFactory getCryptFactory()
Specified by:
getCryptFactory in interface ISecuritySettings
Returns:
crypt factory used to generate crypt objects
See Also:
ISecuritySettings.getCryptFactory()

getDefaultAfterDisabledLink

public java.lang.String getDefaultAfterDisabledLink()
Specified by:
getDefaultAfterDisabledLink in interface IMarkupSettings
Returns:
Returns the defaultAfterDisabledLink.
See Also:
IMarkupSettings.getDefaultAfterDisabledLink()

getDefaultBeforeDisabledLink

public java.lang.String getDefaultBeforeDisabledLink()
Specified by:
getDefaultBeforeDisabledLink in interface IMarkupSettings
Returns:
Returns the defaultBeforeDisabledLink.
See Also:
IMarkupSettings.getDefaultBeforeDisabledLink()

getDefaultMarkupEncoding

public java.lang.String getDefaultMarkupEncoding()
Specified by:
getDefaultMarkupEncoding in interface IMarkupSettings
Returns:
Returns default encoding of markup files. If null, the operating system provided encoding will be used.
See Also:
IMarkupSettings.getDefaultMarkupEncoding()

getDisableGZipCompression

public boolean getDisableGZipCompression()
Description copied from interface: IResourceSettings
Whether to disable gzip compression for resources. You need this on SAP, which gzips things twice.

Specified by:
getDisableGZipCompression in interface IResourceSettings
Returns:
True if we should disable gzip compression
See Also:
IResourceSettings.getDisableGZipCompression()

getEnforceMounts

public boolean getEnforceMounts()
Description copied from interface: ISecuritySettings
Gets whether mounts should be enforced. If true, requests for mounted targets have to done through the mounted paths. If, for instance, a bookmarkable page is mounted to a path, a request to that same page via the bookmarkablePage parameter will be denied.

Specified by:
getEnforceMounts in interface ISecuritySettings
Returns:
Whether mounts should be enforced
See Also:
ISecuritySettings.getEnforceMounts()

getGatherExtendedBrowserInfo

public boolean getGatherExtendedBrowserInfo()
Description copied from interface: IRequestCycleSettings
Gets whether Wicket should try to get extensive client info by redirecting to a page that polls for client capabilities. This method is used by the default implementation of WebRequestCycle.newClientInfo(), so if that method is overridden, there is no guarantee this method will be taken into account.

Specified by:
getGatherExtendedBrowserInfo in interface IRequestCycleSettings
Returns:
Whether to gather extensive client info
See Also:
IRequestCycleSettings.getGatherExtendedBrowserInfo()

getInternalErrorPage

public java.lang.Class<? extends Page> getInternalErrorPage()
Description copied from interface: IApplicationSettings
Gets internal error page class.

Specified by:
getInternalErrorPage in interface IApplicationSettings
Returns:
Returns the internalErrorPage.
See Also:
IApplicationSettings.getInternalErrorPage()

getLocalizer

public Localizer getLocalizer()
Description copied from interface: IResourceSettings
Get the application's localizer.

Specified by:
getLocalizer in interface IResourceSettings
Returns:
The application wide localizer instance
See Also:
IResourceSettings.getLocalizer()

setLocalizer

public void setLocalizer(Localizer localizer)
Description copied from interface: IResourceSettings
Sets the localizer which will be used to find property values.

Specified by:
setLocalizer in interface IResourceSettings
See Also:
IResourceSettings.setLocalizer(org.apache.wicket.Localizer)

getMarkupParserFactory

public IMarkupParserFactory getMarkupParserFactory()
Specified by:
getMarkupParserFactory in interface IMarkupSettings
Returns:
markup parser factory
See Also:
IMarkupSettings.getMarkupParserFactory()

getMaxPageMaps

public final int getMaxPageMaps()
Description copied from interface: ISessionSettings
Gets maximum number of page maps allowed in this session

Specified by:
getMaxPageMaps in interface ISessionSettings
Returns:
Maximum number of page maps
See Also:
ISessionSettings.getMaxPageMaps()

getPackageResourceGuard

public IPackageResourceGuard getPackageResourceGuard()
Description copied from interface: IResourceSettings
Gets the package resource guard.

Specified by:
getPackageResourceGuard in interface IResourceSettings
Returns:
The package resource guard
See Also:
IResourceSettings.getPackageResourceGuard()

getPageExpiredErrorPage

public java.lang.Class<? extends Page> getPageExpiredErrorPage()
Description copied from interface: IApplicationSettings
Gets the page expired page class.

Specified by:
getPageExpiredErrorPage in interface IApplicationSettings
Returns:
Returns the pageExpiredErrorPage.
See Also:
IApplicationSettings.getPageExpiredErrorPage()

getPageFactory

public IPageFactory getPageFactory()
Description copied from interface: ISessionSettings
Gets the factory to be used when creating pages

Specified by:
getPageFactory in interface ISessionSettings
Returns:
The default page factory
See Also:
ISessionSettings.getPageFactory()

getPageMapEvictionStrategy

public IPageMapEvictionStrategy getPageMapEvictionStrategy()
Description copied from interface: ISessionSettings
Gets the strategy for evicting pages from the page map.

Specified by:
getPageMapEvictionStrategy in interface ISessionSettings
Returns:
the strategy for evicting pages from the page map
See Also:
ISessionSettings.getPageMapEvictionStrategy()

getPropertiesFactory

public IPropertiesFactory getPropertiesFactory()
Description copied from interface: IResourceSettings
Get the property factory which will be used to load property files

Specified by:
getPropertiesFactory in interface IResourceSettings
Returns:
PropertiesFactory
See Also:
IResourceSettings.getPropertiesFactory()

getRenderStrategy

public IRequestCycleSettings.RenderStrategy getRenderStrategy()
Description copied from interface: IRequestCycleSettings
Gets in what way the render part of a request is handled.

Specified by:
getRenderStrategy in interface IRequestCycleSettings
Returns:
the render strategy
See Also:
IRequestCycleSettings.getRenderStrategy()

getResourceFactory

public IResourceFactory getResourceFactory(java.lang.String name)
Specified by:
getResourceFactory in interface IResourceSettings
Parameters:
name - Name of the factory to get
Returns:
The IResourceFactory with the given name.
See Also:
IResourceSettings.getResourceFactory(java.lang.String)

getResourceFinder

public IResourceFinder getResourceFinder()
Description copied from interface: IResourceSettings
Gets the resource finder to use when searching for resources.

Specified by:
getResourceFinder in interface IResourceSettings
Returns:
Returns the resourceFinder.
See Also:
IResourceSettings.getResourceFinder()

getResourcePollFrequency

public Duration getResourcePollFrequency()
Specified by:
getResourcePollFrequency in interface IResourceSettings
Returns:
Returns the resourcePollFrequency.
See Also:
IResourceSettings.getResourcePollFrequency()

getResourceStreamLocator

public IResourceStreamLocator getResourceStreamLocator()
Specified by:
getResourceStreamLocator in interface IResourceSettings
Returns:
Resource locator for this application
See Also:
IResourceSettings.getResourceStreamLocator()

getResourceWatcher

public ModificationWatcher getResourceWatcher(boolean start)
Specified by:
getResourceWatcher in interface IResourceSettings
Parameters:
start - boolean if the resource watcher should be started if not already started.
Returns:
Resource watcher with polling frequency determined by setting, or null if no polling frequency has been set.
See Also:
IResourceSettings.getResourceWatcher(boolean)

getResponseFilters

public java.util.List<IResponseFilter> getResponseFilters()
Specified by:
getResponseFilters in interface IRequestCycleSettings
Returns:
an unmodifiable list of added response filters, null if none
See Also:
IRequestCycleSettings.getResponseFilters()

getResponseRequestEncoding

public java.lang.String getResponseRequestEncoding()
Description copied from interface: IRequestCycleSettings
In order to do proper form parameter decoding it is important that the response and the following request have the same encoding. see http://www.crazysquirrel.com/computing/general/form-encoding.jspx for additional information.

Specified by:
getResponseRequestEncoding in interface IRequestCycleSettings
Returns:
The request and response encoding
See Also:
IRequestCycleSettings.getResponseRequestEncoding()

getStringResourceLoaders

public java.util.List<IStringResourceLoader> getStringResourceLoaders()
Specified by:
getStringResourceLoaders in interface IResourceSettings
Returns:
an unmodifiable list of all available string resource loaders
See Also:
IResourceSettings.getStringResourceLoaders()

getStripComments

public boolean getStripComments()
Specified by:
getStripComments in interface IMarkupSettings
Returns:
Returns the stripComments.
See Also:
IMarkupSettings.getStripComments()

getStripWicketTags

public boolean getStripWicketTags()
Description copied from interface: IMarkupSettings
Gets whether to remove wicket tags from the output.

Specified by:
getStripWicketTags in interface IMarkupSettings
Returns:
whether to remove wicket tags from the output
See Also:
IMarkupSettings.getStripWicketTags()

getStripXmlDeclarationFromOutput

public boolean getStripXmlDeclarationFromOutput()
Specified by:
getStripXmlDeclarationFromOutput in interface IMarkupSettings
Returns:
if true, xml declaration will be removed.
See Also:
IMarkupSettings.getStripXmlDeclarationFromOutput()

getThrowExceptionOnMissingResource

public boolean getThrowExceptionOnMissingResource()
Specified by:
getThrowExceptionOnMissingResource in interface IExceptionSettings
Specified by:
getThrowExceptionOnMissingResource in interface IResourceSettings
Returns:
Whether to throw an exception when a missing resource is requested
See Also:
IResourceSettings.getThrowExceptionOnMissingResource()

getTimeout

public Duration getTimeout()
Description copied from interface: IRequestCycleSettings
Gets the time that a request will by default be waiting for the previous request to be handled before giving up.

Specified by:
getTimeout in interface IRequestCycleSettings
Returns:
The time out
See Also:
IRequestCycleSettings.getTimeout()

getUnauthorizedComponentInstantiationListener

public IUnauthorizedComponentInstantiationListener getUnauthorizedComponentInstantiationListener()
Specified by:
getUnauthorizedComponentInstantiationListener in interface ISecuritySettings
Returns:
The listener
See Also:
ISecuritySettings.getUnauthorizedComponentInstantiationListener()

getUnexpectedExceptionDisplay

public IExceptionSettings.UnexpectedExceptionDisplay getUnexpectedExceptionDisplay()
Specified by:
getUnexpectedExceptionDisplay in interface IExceptionSettings
Specified by:
getUnexpectedExceptionDisplay in interface IRequestCycleSettings
Returns:
Returns the unexpectedExceptionDisplay.
See Also:
IRequestCycleSettings.getUnexpectedExceptionDisplay()

getUseDefaultOnMissingResource

public boolean getUseDefaultOnMissingResource()
Specified by:
getUseDefaultOnMissingResource in interface IResourceSettings
Returns:
Whether to use a default value (if available) when a missing resource is requested
See Also:
IResourceSettings.getUseDefaultOnMissingResource()

getVersion

public java.lang.String getVersion()
Description copied from interface: IFrameworkSettings
Gets the Wicket version. The Wicket version is in the same format as the version element in the pom.xml file (project descriptor). The version is generated by maven in the build/release cycle and put in the wicket.properties file located in the root folder of the Wicket jar. The version usually follows one of the following formats:

Specified by:
getVersion in interface IFrameworkSettings
Returns:
the Wicket version
See Also:
IFrameworkSettings.getVersion()

getVersionPagesByDefault

public boolean getVersionPagesByDefault()
Specified by:
getVersionPagesByDefault in interface IPageSettings
Returns:
Returns the pagesVersionedByDefault.
See Also:
IPageSettings.getVersionPagesByDefault()

isAjaxDebugModeEnabled

public boolean isAjaxDebugModeEnabled()
Description copied from interface: IDebugSettings
Returns status of ajax debug mode. See IDebugSettings for details

Specified by:
isAjaxDebugModeEnabled in interface IDebugSettings
Returns:
true if ajax debug mode is enabled, false otherwise
See Also:
IDebugSettings.isAjaxDebugModeEnabled()

setAccessDeniedPage

public <C extends Page> void setAccessDeniedPage(java.lang.Class<C> accessDeniedPage)
Description copied from interface: IApplicationSettings
Sets the access denied page class. The class must be bookmarkable and must extend Page.

Specified by:
setAccessDeniedPage in interface IApplicationSettings
Parameters:
accessDeniedPage - The accessDeniedPage to set.
See Also:
IApplicationSettings.setAccessDeniedPage(java.lang.Class)

setAjaxDebugModeEnabled

public void setAjaxDebugModeEnabled(boolean enable)
Description copied from interface: IDebugSettings
Enables or disables ajax debug mode. See IDebugSettings for details

Specified by:
setAjaxDebugModeEnabled in interface IDebugSettings
See Also:
IDebugSettings.setAjaxDebugModeEnabled(boolean)

setAuthorizationStrategy

public void setAuthorizationStrategy(IAuthorizationStrategy strategy)
Description copied from interface: ISecuritySettings
Sets the authorization strategy.

Specified by:
setAuthorizationStrategy in interface ISecuritySettings
Parameters:
strategy - new authorization strategy
See Also:
ISecuritySettings.setAuthorizationStrategy(org.apache.wicket.authorization.IAuthorizationStrategy)

setAutomaticLinking

public void setAutomaticLinking(boolean automaticLinking)
Description copied from interface: IMarkupSettings
Application default for automatic link resolution. Please

Specified by:
setAutomaticLinking in interface IMarkupSettings
Parameters:
automaticLinking - The automaticLinking to set.
See Also:
IMarkupSettings.setAutomaticLinking(boolean)

setAutomaticMultiWindowSupport

public void setAutomaticMultiWindowSupport(boolean automaticMultiWindowSupport)
Description copied from interface: IPageSettings
Sets whether Wicket should try to support opening multiple windows for the same session transparently. If this is true - the default setting -, Wicket tries to detect whether a new window was opened by a user (e.g. in Internet Explorer by pressing ctrl+n or ctrl+click on a link), and if it detects that, it creates a new page map for that window on the fly. As a page map represents the 'history' of one window, each window will then have their own history. If two windows would share the same page map, the non-bookmarkable links on one window could refer to stale state after working a while in the other window.

Currently, Wicket trying to do this is a best effort that is not completely fail safe. When the client does not support cookies, support gets tricky and incomplete. See WebPage's internals for the implementation.

NOTE: When Wicket is used with SecondLevelCacheSessionStore, this store may disable this feature. See the javadoc of the second level store for details. This feature can be reenabled by calling this method from Application.init()

Specified by:
setAutomaticMultiWindowSupport in interface IPageSettings
Parameters:
automaticMultiWindowSupport - Whether Wicket should try to support multiple windows transparently
See Also:
IPageSettings.setAutomaticMultiWindowSupport(boolean)

setBufferResponse

public void setBufferResponse(boolean bufferResponse)
Specified by:
setBufferResponse in interface IRequestCycleSettings
Parameters:
bufferResponse - True if this application should buffer responses.
See Also:
IRequestCycleSettings.setBufferResponse(boolean)

setClassResolver

public void setClassResolver(IClassResolver defaultClassResolver)
Description copied from interface: IApplicationSettings
Sets the default class resolver to use when finding classes and resources

Specified by:
setClassResolver in interface IApplicationSettings
Parameters:
defaultClassResolver - The default class resolver
See Also:
IApplicationSettings.setClassResolver(org.apache.wicket.application.IClassResolver)

setComponentUseCheck

public void setComponentUseCheck(boolean componentUseCheck)
Description copied from interface: IDebugSettings
Sets componentUseCheck debug settings

Specified by:
setComponentUseCheck in interface IDebugSettings
See Also:
IDebugSettings.setComponentUseCheck(boolean)

setCompressWhitespace

public void setCompressWhitespace(boolean compressWhitespace)
Description copied from interface: IMarkupSettings
Turns on whitespace compression. Multiple occurrences of space/tab characters will be compressed to a single space. Multiple line breaks newline/carriage-return will also be compressed to a single newline.

Compression is currently not HTML aware and so it may be possible for whitespace compression to break pages. For this reason, whitespace compression is off by default and you should test your application thoroughly after turning whitespace compression on.

Spaces are removed from markup at markup load time and there should be no effect on page rendering speed. In fact, your pages should render faster with whitespace compression enabled.

Specified by:
setCompressWhitespace in interface IMarkupSettings
Parameters:
compressWhitespace - The compressWhitespace to set.
See Also:
IMarkupSettings.setCompressWhitespace(boolean)

setCookieValuePersisterSettings

public void setCookieValuePersisterSettings(CookieValuePersisterSettings cookieValuePersisterSettings)
Specified by:
setCookieValuePersisterSettings in interface ISecuritySettings
Parameters:
cookieValuePersisterSettings - The cookieValuePersisterSettings to set.
See Also:
ISecuritySettings.setCookieValuePersisterSettings(org.apache.wicket.markup.html.form.persistence.CookieValuePersisterSettings)

setCryptFactory

public void setCryptFactory(ICryptFactory cryptFactory)
Description copied from interface: ISecuritySettings
Sets the factory that will be used to create crypt objects. The crypt object returned from the first call is cached.

Specified by:
setCryptFactory in interface ISecuritySettings
See Also:
ISecuritySettings.setCryptFactory(org.apache.wicket.util.crypt.ICryptFactory)

setDefaultAfterDisabledLink

public void setDefaultAfterDisabledLink(java.lang.String defaultAfterDisabledLink)
Specified by:
setDefaultAfterDisabledLink in interface IMarkupSettings
Parameters:
defaultAfterDisabledLink - The defaultAfterDisabledLink to set.
See Also:
IMarkupSettings.setDefaultAfterDisabledLink(java.lang.String)

setDefaultBeforeDisabledLink

public void setDefaultBeforeDisabledLink(java.lang.String defaultBeforeDisabledLink)
Specified by:
setDefaultBeforeDisabledLink in interface IMarkupSettings
Parameters:
defaultBeforeDisabledLink - The defaultBeforeDisabledLink to set.
See Also:
IMarkupSettings.setDefaultBeforeDisabledLink(java.lang.String)

setDefaultMarkupEncoding

public void setDefaultMarkupEncoding(java.lang.String encoding)
Description copied from interface: IMarkupSettings
Set default encoding for markup files. If null, the encoding provided by the operating system will be used.

Specified by:
setDefaultMarkupEncoding in interface IMarkupSettings
See Also:
IMarkupSettings.setDefaultMarkupEncoding(java.lang.String)

setDisableGZipCompression

public void setDisableGZipCompression(boolean disableGZipCompression)
Description copied from interface: IResourceSettings
Sets whether to disable gzip compression for resources. You need to set this on some SAP versions, which gzip things twice.

Specified by:
setDisableGZipCompression in interface IResourceSettings
See Also:
IResourceSettings.setDisableGZipCompression(boolean)

setEnforceMounts

public void setEnforceMounts(boolean enforce)
Description copied from interface: ISecuritySettings
Sets whether mounts should be enforced. If true, requests for mounted targets have to done through the mounted paths. If, for instance, a bookmarkable page is mounted to a path, a request to that same page via the bookmarkablePage parameter will be denied.

Specified by:
setEnforceMounts in interface ISecuritySettings
Parameters:
enforce - Whether mounts should be enforced
See Also:
ISecuritySettings.setEnforceMounts(boolean)

setGatherExtendedBrowserInfo

public void setGatherExtendedBrowserInfo(boolean gatherExtendedBrowserInfo)
Description copied from interface: IRequestCycleSettings
Sets whether Wicket should try to get extensive client info by redirecting to a page that polls for client capabilities. This method is used by the default implementation of WebRequestCycle.newClientInfo(), so if that method is overridden, there is no guarantee this method will be taken into account.

WARNING: though this facility should work transparently in most cases, it is recommended that you trigger the roundtrip to get the browser info somewhere where it hurts the least. The roundtrip will be triggered the first time you call Session.getClientInfo() for a session, and after the roundtrip a new request with the same info (url, post parameters) is handled. So rather than calling this in the middle of an implementation of a form submit method, which would result in the code of that method before the call to Session.getClientInfo() to be executed twice, you best call Session.getClientInfo() e.g. in a page constructor or somewhere else where you didn't do a lot of processing first.

Specified by:
setGatherExtendedBrowserInfo in interface IRequestCycleSettings
Parameters:
gatherExtendedBrowserInfo - Whether to gather extensive client info
See Also:
IRequestCycleSettings.setGatherExtendedBrowserInfo(boolean)

setInternalErrorPage

public <C extends Page> void setInternalErrorPage(java.lang.Class<C> internalErrorPage)
Description copied from interface: IApplicationSettings
Sets internal error page class. The class must be bookmarkable and must extend Page.

Specified by:
setInternalErrorPage in interface IApplicationSettings
Parameters:
internalErrorPage - The internalErrorPage to set.
See Also:
IApplicationSettings.setInternalErrorPage(java.lang.Class)

setMarkupParserFactory

public void setMarkupParserFactory(IMarkupParserFactory factory)
Description copied from interface: IMarkupSettings
Sets the markup parser factory that will be used to generate parsers for markup. By default MarkupParserFactory will be used.

Specified by:
setMarkupParserFactory in interface IMarkupSettings
Parameters:
factory - new factory
See Also:
IMarkupSettings.setMarkupParserFactory(org.apache.wicket.markup.IMarkupParserFactory)

setMaxPageMaps

public final void setMaxPageMaps(int maxPageMaps)
Description copied from interface: ISessionSettings
Sets maximum number of page maps allowed in this session

Specified by:
setMaxPageMaps in interface ISessionSettings
Parameters:
maxPageMaps - Maximum number of page maps
See Also:
ISessionSettings.setMaxPageMaps(int)

setPackageResourceGuard

public void setPackageResourceGuard(IPackageResourceGuard packageResourceGuard)
Description copied from interface: IResourceSettings
Sets the package resource guard.

Specified by:
setPackageResourceGuard in interface IResourceSettings
Parameters:
packageResourceGuard - The package resource guard
See Also:
IResourceSettings.setPackageResourceGuard(org.apache.wicket.markup.html.IPackageResourceGuard)

setPageExpiredErrorPage

public <C extends Page> void setPageExpiredErrorPage(java.lang.Class<C> pageExpiredErrorPage)
Description copied from interface: IApplicationSettings
Sets the page expired page class. The class must be bookmarkable and must extend Page.

Specified by:
setPageExpiredErrorPage in interface IApplicationSettings
Parameters:
pageExpiredErrorPage - The pageExpiredErrorPage to set.
See Also:
IApplicationSettings.setPageExpiredErrorPage(java.lang.Class)

setPageFactory

public void setPageFactory(IPageFactory defaultPageFactory)
Description copied from interface: ISessionSettings
Sets the factory to be used when creating pages.

Specified by:
setPageFactory in interface ISessionSettings
Parameters:
defaultPageFactory - The default factory
See Also:
ISessionSettings.setPageFactory(org.apache.wicket.IPageFactory)

setPageMapEvictionStrategy

public void setPageMapEvictionStrategy(IPageMapEvictionStrategy pageMapEvictionStrategy)
Description copied from interface: ISessionSettings
Sets the strategy for evicting pages from the page map.

Specified by:
setPageMapEvictionStrategy in interface ISessionSettings
Parameters:
pageMapEvictionStrategy - the strategy for evicting pages from the page map
See Also:
ISessionSettings.setPageMapEvictionStrategy(org.apache.wicket.session.pagemap.IPageMapEvictionStrategy)

setPropertiesFactory

public void setPropertiesFactory(IPropertiesFactory factory)
Description copied from interface: IResourceSettings
Set the property factory which will be used to load property files

Specified by:
setPropertiesFactory in interface IResourceSettings
See Also:
IResourceSettings.setPropertiesFactory(org.apache.wicket.resource.IPropertiesFactory)

setRenderStrategy

public void setRenderStrategy(IRequestCycleSettings.RenderStrategy renderStrategy)
Description copied from interface: IRequestCycleSettings
Sets in what way the render part of a request is handled. Basically, there are two different options:

setResourceFinder

public void setResourceFinder(IResourceFinder resourceFinder)
Description copied from interface: IResourceSettings
Sets the finder to use when searching for resources. By default, the resources are located on the classpath. If you want to configure other, additional, search paths, you can use this method.

Specified by:
setResourceFinder in interface IResourceSettings
Parameters:
resourceFinder - The resourceFinder to set
See Also:
IResourceSettings.setResourceFinder(org.apache.wicket.util.file.IResourceFinder)

setResourcePollFrequency

public void setResourcePollFrequency(Duration resourcePollFrequency)
Description copied from interface: IResourceSettings
Sets the resource polling frequency. This is the duration of time between checks of resource modification times. If a resource, such as an HTML file, has changed, it will be reloaded. Default is for no resource polling to occur.

Specified by:
setResourcePollFrequency in interface IResourceSettings
Parameters:
resourcePollFrequency - Frequency at which to poll resources
See Also:
IResourceSettings.setResourcePollFrequency(org.apache.wicket.util.time.Duration)

setResourceStreamLocator

public void setResourceStreamLocator(IResourceStreamLocator resourceStreamLocator)
Description copied from interface: IResourceSettings
Sets the resource stream locator for this application

Specified by:
setResourceStreamLocator in interface IResourceSettings
Parameters:
resourceStreamLocator - new resource stream locator
See Also:
IResourceSettings.setResourceStreamLocator(org.apache.wicket.util.resource.locator.IResourceStreamLocator)

setResponseRequestEncoding

public void setResponseRequestEncoding(java.lang.String responseRequestEncoding)
Description copied from interface: IRequestCycleSettings
In order to do proper form parameter decoding it is important that the response and the following request have the same encoding. see http://www.crazysquirrel.com/computing/general/form-encoding.jspx for additional information. Default encoding: UTF-8

Specified by:
setResponseRequestEncoding in interface IRequestCycleSettings
Parameters:
responseRequestEncoding - The request and response encoding to be used.
See Also:
IRequestCycleSettings.setResponseRequestEncoding(java.lang.String)

setStripComments

public void setStripComments(boolean stripComments)
Description copied from interface: IMarkupSettings
Enables stripping of markup comments denoted in markup by HTML comment tagging.

Specified by:
setStripComments in interface IMarkupSettings
Parameters:
stripComments - True to strip markup comments from rendered pages
See Also:
IMarkupSettings.setStripComments(boolean)

setStripWicketTags

public void setStripWicketTags(boolean stripWicketTags)
Description copied from interface: IMarkupSettings
Sets whether to remove wicket tags from the output.

Specified by:
setStripWicketTags in interface IMarkupSettings
Parameters:
stripWicketTags - whether to remove wicket tags from the output
See Also:
IMarkupSettings.setStripWicketTags(boolean)

setStripXmlDeclarationFromOutput

public void setStripXmlDeclarationFromOutput(boolean strip)
Specified by:
setStripXmlDeclarationFromOutput in interface IMarkupSettings
Parameters:
strip - if true, xml declaration will be stripped from output
See Also:
IMarkupSettings.setStripXmlDeclarationFromOutput(boolean)

setThrowExceptionOnMissingResource

public void setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
Specified by:
setThrowExceptionOnMissingResource in interface IExceptionSettings
Specified by:
setThrowExceptionOnMissingResource in interface IResourceSettings
Parameters:
throwExceptionOnMissingResource - Whether to throw an exception when a missing resource is requested
See Also:
IResourceSettings.setThrowExceptionOnMissingResource(boolean)

setTimeout

public void setTimeout(Duration timeout)
Description copied from interface: IRequestCycleSettings
Sets the time that a request will by default be waiting for the previous request to be handled before giving up.

Specified by:
setTimeout in interface IRequestCycleSettings
See Also:
IRequestCycleSettings.setTimeout(org.apache.wicket.util.time.Duration)

setUnauthorizedComponentInstantiationListener

public void setUnauthorizedComponentInstantiationListener(IUnauthorizedComponentInstantiationListener unauthorizedComponentInstantiationListener)
Specified by:
setUnauthorizedComponentInstantiationListener in interface ISecuritySettings
Parameters:
unauthorizedComponentInstantiationListener - The listener to set
See Also:
ISecuritySettings.setUnauthorizedComponentInstantiationListener(org.apache.wicket.authorization.IUnauthorizedComponentInstantiationListener)

setUnexpectedExceptionDisplay

public void setUnexpectedExceptionDisplay(IExceptionSettings.UnexpectedExceptionDisplay unexpectedExceptionDisplay)
Description copied from interface: IExceptionSettings
The exception display type determines how the framework displays exceptions to you as a developer or user.

The default value for exception display type is SHOW_EXCEPTION_PAGE. When this value is set and an unhandled runtime exception is thrown by a page, a redirect to a helpful exception display page will occur.

This is a developer feature, however, and you may want to instead show an internal error page without developer details that allows a user to start over at the application's home page. This can be accomplished by setting the exception display type to SHOW_INTERNAL_ERROR_PAGE.

Finally, if you are having trouble with the exception display pages themselves, you can disable exception displaying entirely with the value SHOW_NO_EXCEPTION_PAGE. This will cause the framework to re-throw any unhandled runtime exceptions after wrapping them in a ServletException wrapper.

Specified by:
setUnexpectedExceptionDisplay in interface IExceptionSettings
Specified by:
setUnexpectedExceptionDisplay in interface IRequestCycleSettings
Parameters:
unexpectedExceptionDisplay - The unexpectedExceptionDisplay to set.
See Also:
org.apache.wicket.settings.IRequestCycleSettings#setUnexpectedExceptionDisplay(org.apache.wicket.settings.Settings.UnexpectedExceptionDisplay)

setUseDefaultOnMissingResource

public void setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)
Specified by:
setUseDefaultOnMissingResource in interface IResourceSettings
Parameters:
useDefaultOnMissingResource - Whether to use a default value (if available) when a missing resource is requested
See Also:
IResourceSettings.setUseDefaultOnMissingResource(boolean)

setVersionPagesByDefault

public void setVersionPagesByDefault(boolean pagesVersionedByDefault)
Specified by:
setVersionPagesByDefault in interface IPageSettings
Parameters:
pagesVersionedByDefault - The pagesVersionedByDefault to set.
See Also:
IPageSettings.setVersionPagesByDefault(boolean)

getRecordSessionSize

public boolean getRecordSessionSize()
Specified by:
getRecordSessionSize in interface IRequestLoggerSettings
Returns:
true if the session size is recorded. (default true)
See Also:
IRequestLoggerSettings.getRecordSessionSize()

getRequestsWindowSize

public int getRequestsWindowSize()
Specified by:
getRequestsWindowSize in interface IRequestLoggerSettings
Returns:
The window size of the recorded requests. (default 2000)
See Also:
IRequestLoggerSettings.getRequestsWindowSize()

isRequestLoggerEnabled

public boolean isRequestLoggerEnabled()
Specified by:
isRequestLoggerEnabled in interface IRequestLoggerSettings
Returns:
true if the request Logger is enabled. (default false)
See Also:
IRequestLoggerSettings.isRequestLoggerEnabled()

setRecordSessionSize

public void setRecordSessionSize(boolean record)
Description copied from interface: IRequestLoggerSettings
Enable/Disable the recording of the session size for every request.

Specified by:
setRecordSessionSize in interface IRequestLoggerSettings
See Also:
IRequestLoggerSettings.setRecordSessionSize(boolean)

setRequestLoggerEnabled

public void setRequestLoggerEnabled(boolean enable)
Description copied from interface: IRequestLoggerSettings
Enable/Disable the request logger.

Specified by:
setRequestLoggerEnabled in interface IRequestLoggerSettings
Parameters:
enable - boolean.
See Also:
IRequestLoggerSettings.setRequestLoggerEnabled(boolean)

setRequestsWindowSize

public void setRequestsWindowSize(int size)
Description copied from interface: IRequestLoggerSettings
Set the window of all the requests that is kept in memory for viewing. Default is 2000, You can set this to 0 then only Sessions data is recorded (number of request, total time, latest size)

Specified by:
setRequestsWindowSize in interface IRequestLoggerSettings
See Also:
IRequestLoggerSettings.setRequestsWindowSize(int)

getStripJavascriptCommentsAndWhitespace

@Deprecated
public boolean getStripJavascriptCommentsAndWhitespace()
Deprecated. please us setJavascriptCompressor(IJavascriptCompressor) instead. Will be removed in 1.5

For backwards compatibility reasons, if the return value is true, wicket's default javascript compressor will be used no matter which one was configured via setJavascriptCompressor(IJavascriptCompressor).

Specified by:
getStripJavascriptCommentsAndWhitespace in interface IResourceSettings
Returns:
whether the comments and whitespace characters will be stripped from resources served through JavascriptPackageResource
See Also:
IResourceSettings.getStripJavascriptCommentsAndWhitespace()

setStripJavascriptCommentsAndWhitespace

@Deprecated
public void setStripJavascriptCommentsAndWhitespace(boolean value)
Deprecated. please us setJavascriptCompressor(IJavascriptCompressor) instead. Will be removed in 1.5

For backwards compatibility reasons, if the return value is true, wicket's default javascript compressor will be used no matter which one was configured via setJavascriptCompressor(IJavascriptCompressor).

Specified by:
setStripJavascriptCommentsAndWhitespace in interface IResourceSettings
See Also:
IResourceSettings.setStripJavascriptCommentsAndWhitespace(boolean)

setOutputMarkupContainerClassName

public void setOutputMarkupContainerClassName(boolean enable)
Description copied from interface: IDebugSettings
Enables wrapping output of markup container in html comments that contain markup container's class name. (Useful for determining which part of page belongs to which markup file).

Specified by:
setOutputMarkupContainerClassName in interface IDebugSettings
See Also:
IDebugSettings.setOutputMarkupContainerClassName(boolean)

isOutputMarkupContainerClassName

public boolean isOutputMarkupContainerClassName()
Description copied from interface: IDebugSettings
Returns whether the output of markup container's should be wrapped by comments containing the container's class name.

Specified by:
isOutputMarkupContainerClassName in interface IDebugSettings
Returns:
true if the markup container's class name should be written to response
See Also:
IDebugSettings.isOutputMarkupContainerClassName()

getMarkupCache

public IMarkupCache getMarkupCache()
Description copied from interface: IMarkupSettings
The markup cache also loads the markup if not yet available in the cache.

Specified by:
getMarkupCache in interface IMarkupSettings
Returns:
markup cache
See Also:
IMarkupSettings.getMarkupCache()

setMarkupCache

public void setMarkupCache(IMarkupCache markupCache)
Description copied from interface: IMarkupSettings
Sets a new markup cache which will also be used to load markup if not yet available in the cache.

Specified by:
setMarkupCache in interface IMarkupSettings
Parameters:
markupCache - new markup cache
See Also:
IMarkupSettings.setMarkupCache(org.apache.wicket.markup.IMarkupCache)

getDefaultMaximumUploadSize

public Bytes getDefaultMaximumUploadSize()
Description copied from interface: IApplicationSettings
Gets the default maximum size for uploads. This is used by Form.getMaxSize() if no value is explicitly set through Form.setMaxSize(Bytes).

Specified by:
getDefaultMaximumUploadSize in interface IApplicationSettings
Returns:
the default maximum size for uploads
See Also:
IApplicationSettings.getDefaultMaximumUploadSize()

setDefaultMaximumUploadSize

public void setDefaultMaximumUploadSize(Bytes defaultMaximumUploadSize)
Description copied from interface: IApplicationSettings
Sets the default maximum size for uploads. This is used by Form.getMaxSize() if no value is explicitly set through Form.setMaxSize(Bytes).

Specified by:
setDefaultMaximumUploadSize in interface IApplicationSettings
Parameters:
defaultMaximumUploadSize - the default maximum size for uploads
See Also:
IApplicationSettings.setDefaultMaximumUploadSize(org.apache.wicket.util.lang.Bytes)

setPageIdUniquePerSession

public void setPageIdUniquePerSession(boolean value)
Description copied from interface: ISessionSettings
Sets whether the id of a page should be unique across the entire session. Default is true, which means that a page id is unique per session.

Specified by:
setPageIdUniquePerSession in interface ISessionSettings
See Also:
ISessionSettings.setPageIdUniquePerSession(boolean)

isPageIdUniquePerSession

public boolean isPageIdUniquePerSession()
Description copied from interface: ISessionSettings
Returns whether the page id is unique per session. If the page id is not unique per session, it is only unique per pagemap.

Specified by:
isPageIdUniquePerSession in interface ISessionSettings
Returns:
true if he page id is unique per session
See Also:
ISessionSettings.isPageIdUniquePerSession()

isLinePreciseReportingOnAddComponentEnabled

public boolean isLinePreciseReportingOnAddComponentEnabled()
Description copied from interface: IDebugSettings
Returns status of line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes. This can cause a significant decrease in performance, do not use in customer facing applications.

Specified by:
isLinePreciseReportingOnAddComponentEnabled in interface IDebugSettings
Returns:
true if the line precise error reporting is enabled
See Also:
IDebugSettings.isLinePreciseReportingOnAddComponentEnabled()

isLinePreciseReportingOnNewComponentEnabled

public boolean isLinePreciseReportingOnNewComponentEnabled()
Description copied from interface: IDebugSettings
Returns status of line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes. This can cause a significant decrease in performance, do not use in customer facing applications.

Specified by:
isLinePreciseReportingOnNewComponentEnabled in interface IDebugSettings
Returns:
true if the line precise error reporting is enabled
See Also:
IDebugSettings.isLinePreciseReportingOnNewComponentEnabled()

setLinePreciseReportingOnAddComponentEnabled

public void setLinePreciseReportingOnAddComponentEnabled(boolean enable)
Description copied from interface: IDebugSettings
Enables line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes. This can cause a significant decrease in performance, do not use in customer facing applications.

Specified by:
setLinePreciseReportingOnAddComponentEnabled in interface IDebugSettings
See Also:
IDebugSettings.setLinePreciseReportingOnAddComponentEnabled(boolean)

setLinePreciseReportingOnNewComponentEnabled

public void setLinePreciseReportingOnNewComponentEnabled(boolean enable)
Description copied from interface: IDebugSettings
Enables line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes. This can cause a significant decrease in performance, do not use in customer facing applications.

Specified by:
setLinePreciseReportingOnNewComponentEnabled in interface IDebugSettings
See Also:
IDebugSettings.setLinePreciseReportingOnNewComponentEnabled(boolean)

setAddLastModifiedTimeToResourceReferenceUrl

public void setAddLastModifiedTimeToResourceReferenceUrl(boolean value)
Description copied from interface: IResourceSettings
Sets whether Wicket should add last modified time as a parameter to resource reference URL (can help with browsers too aggressively caching certain resources).

Specified by:
setAddLastModifiedTimeToResourceReferenceUrl in interface IResourceSettings
See Also:
IResourceSettings.setAddLastModifiedTimeToResourceReferenceUrl(boolean)

getAddLastModifiedTimeToResourceReferenceUrl

public boolean getAddLastModifiedTimeToResourceReferenceUrl()
Description copied from interface: IResourceSettings
Returns whether Wicket should add last modified time as resource reference URL parameter.

Specified by:
getAddLastModifiedTimeToResourceReferenceUrl in interface IResourceSettings
Returns:
whether Wicket should add last modified time as resource reference URL parameter
See Also:
IResourceSettings.getAddLastModifiedTimeToResourceReferenceUrl()

getThrowExceptionOnMissingXmlDeclaration

public boolean getThrowExceptionOnMissingXmlDeclaration()
Specified by:
getThrowExceptionOnMissingXmlDeclaration in interface IMarkupSettings
Returns:
if true, an exception is thrown if the markup file does not contain a xml declaration
See Also:
IMarkupSettings.getThrowExceptionOnMissingXmlDeclaration()

setThrowExceptionOnMissingXmlDeclaration

public void setThrowExceptionOnMissingXmlDeclaration(boolean throwException)
Description copied from interface: IMarkupSettings
If true, an exception is thrown if the markup file does not contain a xml declaration

Specified by:
setThrowExceptionOnMissingXmlDeclaration in interface IMarkupSettings
See Also:
IMarkupSettings.setThrowExceptionOnMissingXmlDeclaration(boolean)

getParentFolderPlaceholder

public java.lang.CharSequence getParentFolderPlaceholder()
Description copied from interface: IResourceSettings
Placeholder string for '..' within resource urls (which will be crippled by the browser and not work anymore). Note that by default the placeholder string is empty '' and thus will not allow to access parent folders. That is by purpose and for security reasons (see Wicket-1992). In case you really need it, a good value for placeholder would e.g. be "$up$". Resources additionally are protected by a IPackageResourceGuard implementation such as PackageResourceGuard which you may use or extend based on your needs.

Specified by:
getParentFolderPlaceholder in interface IResourceSettings
Returns:
placeholder
See Also:
IResourceSettings.getParentFolderPlaceholder()

setParentFolderPlaceholder

public void setParentFolderPlaceholder(java.lang.CharSequence sequence)
Description copied from interface: IResourceSettings
Placeholder string for '..' within resource urls (which will be crippled by the browser and not work anymore). Note that by default the placeholder string is empty '' and thus will not allow to access parent folders. That is by purpose and for security reasons (see Wicket-1992). In case you really need it, a good value for placeholder would e.g. be "$up$". Resources additionally are protected by a IPackageResourceGuard implementation such as PackageResourceGuard which you may use or extend based on your needs.

Specified by:
setParentFolderPlaceholder in interface IResourceSettings
Parameters:
sequence - character sequence which must not be ambiguous within urls
See Also:
IResourceSettings.setParentFolderPlaceholder(CharSequence)

isOutputComponentPath

public boolean isOutputComponentPath()
Specified by:
isOutputComponentPath in interface IDebugSettings
Returns:
true if output component path feature is enabled, false otherwise
See Also:
IDebugSettings.isOutputComponentPath()

setOutputComponentPath

public void setOutputComponentPath(boolean outputComponentPath)
Description copied from interface: IDebugSettings
If set to true wicket will output component path in a wicket:path attribute of the component tag. This can be useful for debugging and automating tests.

Specified by:
setOutputComponentPath in interface IDebugSettings
See Also:
IDebugSettings#setOutputComponentPath()

getJavascriptCompressor

public IJavascriptCompressor getJavascriptCompressor()
Description copied from interface: IResourceSettings
Get the javascript compressor to remove comments and whitespace characters from javascripts

Specified by:
getJavascriptCompressor in interface IResourceSettings
Returns:
whether the comments and whitespace characters will be stripped from resources served through JavascriptPackageResource. Null is a valid value.
See Also:
IResourceSettings.getJavascriptCompressor()

setJavascriptCompressor

public IJavascriptCompressor setJavascriptCompressor(IJavascriptCompressor compressor)
Description copied from interface: IResourceSettings
Set the javascript compressor implemententation use e.g. by JavascriptPackageResource . A typical implementation will remove comments and whitespace. But a no-op implementation is available as well.

Specified by:
setJavascriptCompressor in interface IResourceSettings
Parameters:
compressor - The implementation to be used
Returns:
The old value
See Also:
IResourceSettings.setJavascriptCompressor(org.apache.wicket.javascript.IJavascriptCompressor)

getDetachListener

public IDetachListener getDetachListener()
Specified by:
getDetachListener in interface IFrameworkSettings
Returns:
detach listener or null if none
See Also:
IFrameworkSettings.getDetachListener()

setDetachListener

public void setDetachListener(IDetachListener detachListener)
Description copied from interface: IFrameworkSettings
Sets detach listener

Specified by:
setDetachListener in interface IFrameworkSettings
Parameters:
detachListener - listener or null to remove
See Also:
IFrameworkSettings.setDetachListener(org.apache.wicket.IDetachListener)

setDevelopmentUtilitiesEnabled

public void setDevelopmentUtilitiesEnabled(boolean enable)
Description copied from interface: IDebugSettings
Enables all of the panels and pages, etc, from wicket-devutils package.

Specified by:
setDevelopmentUtilitiesEnabled in interface IDebugSettings
See Also:
IDebugSettings.setDevelopmentUtilitiesEnabled(boolean)

isDevelopmentUtilitiesEnabled

public boolean isDevelopmentUtilitiesEnabled()
Description copied from interface: IDebugSettings
Are all of the panels and pages, etc, from wicket-devutils package enabled?

Specified by:
isDevelopmentUtilitiesEnabled in interface IDebugSettings
Returns:
true if all of the panels and pages, etc, from wicket-devutils package are enabled
See Also:
IDebugSettings.isDevelopmentUtilitiesEnabled()
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2004-2009 Apache Software Foundation. All Rights Reserved.