|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IResourceSettings
Interface for resource related settings
resourcePollFrequency (defaults to no polling frequency) - Frequency at which resources should be polled for changes.
resourceFinder (classpath) - Set this to alter the search path for resources.
useDefaultOnMissingResource (defaults to true) - Set to true to return a default value if available when a required string resource is not found. If set to false then the throwExceptionOnMissingResource flag is used to determine how to behave. If no default is available then this is the same as if this flag were false
A ResourceStreamLocator - An Application's ResourceStreamLocator is used to find resources such as images or markup files. You can supply your own ResourceStreamLocator if your prefer to store your application's resources in a non-standard location (such as a different filesystem location, a particular JAR file or even a database) by overriding the getResourceLocator() method.
Resource Factories - Resource factories can be used to create resources dynamically from
specially formatted HTML tag attribute values. For more details, see IResourceFactory
,
DefaultButtonImageResourceFactory
and
especially LocalizedImageResource
.
A Localizer The getLocalizer() method returns an object encapsulating all of the
functionality required to access localized resources. For many localization problems, even this
will not be required, as there are convenience methods available to all components:
Component.getString(String key)
and
Component.getString(String key, IModel model)
.
stringResourceLoaders - A chain of IStringResourceLoader
instances that are
searched in order to obtain string resources used during localization. By default the chain is
set up to first search for resources against a particular component (e.g. page etc.) and then
against the application.
Method Summary | |
---|---|
void |
addResourceFactory(String name,
IResourceFactory resourceFactory)
Adds a resource factory to the list of factories to consult when generating resources automatically |
void |
addResourceFolder(String resourceFolder)
Convenience method that sets the resource search path to a single folder. |
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. |
boolean |
getAddLastModifiedTimeToResourceReferenceUrl()
Returns whether Wicket should add last modified time as resource reference URL parameter. |
int |
getDefaultCacheDuration()
Get the the default cache duration (3600 secs == 1hr) for WebResource. |
boolean |
getDisableGZipCompression()
Whether to disable gzip compression for resources. |
IJavascriptCompressor |
getJavascriptCompressor()
Get the javascript compressor to remove comments and whitespace characters from javascripts |
Localizer |
getLocalizer()
Get the application's localizer. |
IPackageResourceGuard |
getPackageResourceGuard()
Gets the package resource guard . |
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 |
IResourceFactory |
getResourceFactory(String name)
|
IResourceFinder |
getResourceFinder()
Gets the resource finder to use when searching for resources. |
Duration |
getResourcePollFrequency()
|
IResourceStreamLocator |
getResourceStreamLocator()
|
IModificationWatcher |
getResourceWatcher(boolean start)
|
List<IStringResourceLoader> |
getStringResourceLoaders()
|
boolean |
getStripJavascriptCommentsAndWhitespace()
Deprecated. please use getJavascriptCompressor() instead. Will be removed in 1.5 |
boolean |
getThrowExceptionOnMissingResource()
|
boolean |
getUseDefaultOnMissingResource()
|
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 |
setDefaultCacheDuration(int defaultDuration)
Set the the default cache duration for WebResource. |
void |
setDisableGZipCompression(boolean disableGZipCompression)
Sets whether to disable gzip compression for resources. |
IJavascriptCompressor |
setJavascriptCompressor(IJavascriptCompressor compressor)
Set the javascript compressor implemententation use e.g. |
void |
setLocalizer(Localizer localizer)
Sets the localizer which will be used to find property values. |
void |
setPackageResourceGuard(IPackageResourceGuard packageResourceGuard)
Sets the package resource guard . |
void |
setParentFolderPlaceholder(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 |
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 |
setResourceWatcher(IModificationWatcher watcher)
Sets the resource watcher |
void |
setStripJavascriptCommentsAndWhitespace(boolean value)
Deprecated. please us setJavascriptCompressor(IJavascriptCompressor) instead. Will
be removed in 1.5 |
void |
setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
|
void |
setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)
|
Method Detail |
---|
void addResourceFactory(String name, IResourceFactory resourceFactory)
name
- The name to give to the factoryresourceFactory
- The resource factory to addvoid addResourceFolder(String resourceFolder)
resourceFolder
- The resourceFolder to setvoid addStringResourceLoader(IStringResourceLoader loader)
loader
- The loader to be addedaddStringResourceLoader(int, IStringResourceLoader)
,
getStringResourceLoaders()
void addStringResourceLoader(int index, IStringResourceLoader loader)
index
- The position within the array to insert the loaderloader
- The loader to be addedaddStringResourceLoader(IStringResourceLoader)
,
getStringResourceLoaders()
int getDefaultCacheDuration()
boolean getDisableGZipCompression()
Localizer getLocalizer()
for means of extending the way Wicket resolves keys to localized messages.
IPackageResourceGuard getPackageResourceGuard()
package resource guard
.
IPropertiesFactory getPropertiesFactory()
IResourceFactory getResourceFactory(String name)
name
- Name of the factory to get
IResourceFinder getResourceFinder()
setResourceFinder(IResourceFinder)
Duration getResourcePollFrequency()
setResourcePollFrequency(Duration)
IResourceStreamLocator getResourceStreamLocator()
IModificationWatcher getResourceWatcher(boolean start)
start
- boolean if the resource watcher should be started if not already started.
List<IStringResourceLoader> getStringResourceLoaders()
addStringResourceLoader(IStringResourceLoader)
,
addStringResourceLoader(int, IStringResourceLoader)
boolean getThrowExceptionOnMissingResource()
IExceptionSettings.getThrowExceptionOnMissingResource()
boolean getUseDefaultOnMissingResource()
void setDefaultCacheDuration(int defaultDuration)
defaultDuration
- default cache duration in secondsvoid setDisableGZipCompression(boolean disableGZipCompression)
disableGZipCompression
- void setLocalizer(Localizer localizer)
localizer
- void setPackageResourceGuard(IPackageResourceGuard packageResourceGuard)
package resource guard
.
packageResourceGuard
- The package resource guardvoid setPropertiesFactory(IPropertiesFactory factory)
factory
- void setResourceFinder(IResourceFinder resourceFinder)
resourceFinder
- The resourceFinder to setvoid setResourcePollFrequency(Duration resourcePollFrequency)
resourcePollFrequency
- Frequency at which to poll resourcessetResourceFinder(IResourceFinder)
void setResourceStreamLocator(IResourceStreamLocator resourceStreamLocator)
resourceStreamLocator
- new resource stream locatorvoid setResourceWatcher(IModificationWatcher watcher)
watcher
- void setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
throwExceptionOnMissingResource
- IExceptionSettings.setThrowExceptionOnMissingResource(boolean)
void setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)
useDefaultOnMissingResource
- Whether to use a default value (if available) when a missing resource is requested@Deprecated void setStripJavascriptCommentsAndWhitespace(boolean value)
setJavascriptCompressor(IJavascriptCompressor)
instead. Will
be removed in 1.5
JavascriptPackageResource
value
- @Deprecated boolean getStripJavascriptCommentsAndWhitespace()
getJavascriptCompressor()
instead. Will be removed in 1.5
JavascriptPackageResource
IJavascriptCompressor setJavascriptCompressor(IJavascriptCompressor compressor)
JavascriptPackageResource
. A typical implementation will remove comments and whitespace. But a no-op implementation is
available as well.
compressor
- The implementation to be used
IJavascriptCompressor getJavascriptCompressor()
JavascriptPackageResource
. Null is a valid value.void setAddLastModifiedTimeToResourceReferenceUrl(boolean value)
value
- boolean getAddLastModifiedTimeToResourceReferenceUrl()
CharSequence getParentFolderPlaceholder()
IPackageResourceGuard
implementation such as PackageResourceGuard
which you may use or extend based on your needs.
void setParentFolderPlaceholder(CharSequence sequence)
IPackageResourceGuard
implementation such as PackageResourceGuard
which you may use or extend based on your needs.
sequence
- character sequence which must not be ambiguous within urlsgetParentFolderPlaceholder()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |