Java Doc for IResourceSettings.java in  » J2EE » wicket » org » apache » wicket » settings » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » wicket » org.apache.wicket.settings 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.wicket.settings.IResourceSettings

All known Subclasses:   org.apache.wicket.settings.Settings,
IResourceSettings
public interface IResourceSettings (Code)
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 , org.apache.wicket.markup.html.image.resource.DefaultButtonImageResourceFactory and especially org.apache.wicket.markup.html.image.resource.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: org.apache.wicket.Component.getString(String key) and org.apache.wicket.Component.getString(String keyIModel 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.


author:
   Igor Vaynberg (ivaynberg)




Method Summary
 voidaddResourceFactory(String name, IResourceFactory resourceFactory)
    
 voidaddResourceFolder(String resourceFolder)
     Convenience method that sets the resource search path to a single folder. use when searching for resources.
 voidaddStringResourceLoader(IStringResourceLoader loader)
     Add a string resource loader to the chain of loaders.
 booleangetDisableGZipCompression()
     Whether to disable gzip compression for resources.
 LocalizergetLocalizer()
     Get the application's localizer.
See Also:   IResourceSettings.addStringResourceLoader(org.apache.wicket.resource.loader.IStringResourceLoader)
See Also:   for means of extending the way Wicket resolves keys to localized
See Also:   messages.
 IPackageResourceGuardgetPackageResourceGuard()
     Gets the PackageResourceGuard package resource guard .
 IPropertiesFactorygetPropertiesFactory()
    
 IResourceFactorygetResourceFactory(String name)
    
 IResourceFindergetResourceFinder()
     Gets the resource finder to use when searching for resources.
 DurationgetResourcePollFrequency()
    
 IResourceStreamLocatorgetResourceStreamLocator()
    
 ModificationWatchergetResourceWatcher(boolean start)
    
Parameters:
  start - boolean if the resource watcher should be started if notalready started.
 ListgetStringResourceLoaders()
    
 booleangetStripJavascriptCommentsAndWhitespace()
    
 booleangetThrowExceptionOnMissingResource()
    
 booleangetUseDefaultOnMissingResource()
    
 voidsetDisableGZipCompression(boolean disableGZipCompression)
     Sets whether to disable gzip compression for resources.
 voidsetLocalizer(Localizer localizer)
     Sets the localizer which will be used to find property values.
 voidsetPackageResourceGuard(IPackageResourceGuard packageResourceGuard)
     Sets the PackageResourceGuard package resource guard .
 voidsetPropertiesFactory(IPropertiesFactory factory)
    
 voidsetResourceFinder(IResourceFinder resourceFinder)
     Sets the finder to use when searching for resources.
 voidsetResourcePollFrequency(Duration resourcePollFrequency)
     Sets the resource polling frequency.
 voidsetResourceStreamLocator(IResourceStreamLocator resourceStreamLocator)
    
 voidsetStripJavascriptCommentsAndWhitespace(boolean value)
    
 voidsetThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
    
 voidsetUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)
    



Method Detail
addResourceFactory
void addResourceFactory(String name, IResourceFactory resourceFactory)(Code)
Adds a resource factory to the list of factories to consult when generating resources automatically
Parameters:
  name - The name to give to the factory
Parameters:
  resourceFactory - The resource factory to add



addResourceFolder
void addResourceFolder(String resourceFolder)(Code)
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
Parameters:
  resourceFolder - The resourceFolder to set



addStringResourceLoader
void addStringResourceLoader(IStringResourceLoader loader)(Code)
Add a string resource loader to the chain of loaders. If this is the first call to this method since the creation of the application settings then the existing chain is cleared before the new loader is added.
Parameters:
  loader - The loader to be added



getDisableGZipCompression
boolean getDisableGZipCompression()(Code)
Whether to disable gzip compression for resources. You need this on SAP, which gzips things twice. True if we should disable gzip compression
since:
   1.3.0



getLocalizer
Localizer getLocalizer()(Code)
Get the application's localizer.
See Also:   IResourceSettings.addStringResourceLoader(org.apache.wicket.resource.loader.IStringResourceLoader)
See Also:   for means of extending the way Wicket resolves keys to localized
See Also:   messages. The application wide localizer instance



getPackageResourceGuard
IPackageResourceGuard getPackageResourceGuard()(Code)
Gets the PackageResourceGuard package resource guard . The package resource guard



getPropertiesFactory
IPropertiesFactory getPropertiesFactory()(Code)
Get the property factory which will be used to load property files PropertiesFactory



getResourceFactory
IResourceFactory getResourceFactory(String name)(Code)

Parameters:
  name - Name of the factory to get The IResourceFactory with the given name.



getResourceFinder
IResourceFinder getResourceFinder()(Code)
Gets the resource finder to use when searching for resources. Returns the resourceFinder.
See Also:   IResourceSettings.setResourceFinder(IResourceFinder)



getResourcePollFrequency
Duration getResourcePollFrequency()(Code)
Returns the resourcePollFrequency.
See Also:   IResourceSettings.setResourcePollFrequency(Duration)



getResourceStreamLocator
IResourceStreamLocator getResourceStreamLocator()(Code)
Resource locator for this application



getResourceWatcher
ModificationWatcher getResourceWatcher(boolean start)(Code)

Parameters:
  start - boolean if the resource watcher should be started if notalready started. Resource watcher with polling frequency determined by setting, ornull if no polling frequency has been set.



getStringResourceLoaders
List getStringResourceLoaders()(Code)
an unmodifiable list of all available string resource loaders



getStripJavascriptCommentsAndWhitespace
boolean getStripJavascriptCommentsAndWhitespace()(Code)
whether the comments and whitespace characters will be strippedfrom resources served through JavascriptPackageResource



getThrowExceptionOnMissingResource
boolean getThrowExceptionOnMissingResource()(Code)

See Also:   org.apache.wicket.settings.IExceptionSettings.getThrowExceptionOnMissingResource boolean



getUseDefaultOnMissingResource
boolean getUseDefaultOnMissingResource()(Code)
Whether to use a default value (if available) when a missingresource is requested



setDisableGZipCompression
void setDisableGZipCompression(boolean disableGZipCompression)(Code)
Sets whether to disable gzip compression for resources. You need to set this on some SAP versions, which gzip things twice.
Parameters:
  disableGZipCompression -
since:
   1.3.0



setLocalizer
void setLocalizer(Localizer localizer)(Code)
Sets the localizer which will be used to find property values.
Parameters:
  localizer -
since:
   1.3.0



setPackageResourceGuard
void setPackageResourceGuard(IPackageResourceGuard packageResourceGuard)(Code)
Sets the PackageResourceGuard package resource guard .
Parameters:
  packageResourceGuard - The package resource guard



setPropertiesFactory
void setPropertiesFactory(IPropertiesFactory factory)(Code)
Set the property factory which will be used to load property files
Parameters:
  factory -



setResourceFinder
void setResourceFinder(IResourceFinder resourceFinder)(Code)
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.
Parameters:
  resourceFinder - The resourceFinder to set



setResourcePollFrequency
void setResourcePollFrequency(Duration resourcePollFrequency)(Code)
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.
Parameters:
  resourcePollFrequency - Frequency at which to poll resources
See Also:   IResourceSettings.setResourceFinder(IResourceFinder)



setResourceStreamLocator
void setResourceStreamLocator(IResourceStreamLocator resourceStreamLocator)(Code)
Sets the resource stream locator for this application
Parameters:
  resourceStreamLocator - new resource stream locator



setStripJavascriptCommentsAndWhitespace
void setStripJavascriptCommentsAndWhitespace(boolean value)(Code)
Sets whether the whitespace characters and comments should be stripped for resources served through JavascriptPackageResource
Parameters:
  value -



setThrowExceptionOnMissingResource
void setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)(Code)

See Also:   org.apache.wicket.settings.IExceptionSettings.setThrowExceptionOnMissingResource(boolean)
Parameters:
  throwExceptionOnMissingResource -



setUseDefaultOnMissingResource
void setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)(Code)

Parameters:
  useDefaultOnMissingResource - Whether to use a default value (if available) when a missingresource is requested



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.