wicket
Class ResourceReference

java.lang.Object
  wicket.ResourceReference

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

StaticResourceReference

public class ResourceReference

extends java.lang.Object

implements java.io.Serializable

ResourceReference is essentially a reference to an actual resource which is shared through the Application. A ResourceReference has a name and a scope (within which the name must be unique). It may also have a locale or style. The locale and/or style do not need to be set on a resource reference because those values will automatically be determined based on the context in which the resource is being used. For example, if a ResourceReference is attached to an Image component, when the locale for the page switches, the Image component will notice this and automatically change the locale for the referenced resource as appropriate. It's for this reason that there are no constructor overloads taking a Locale or style (these details are essentially internal and so the framework uses setLocale/setStyle internally so you don't have to worry about it).

Resources may be added to the Application when the Application is constructed using Application.getSharedResources() followed by SharedResources.add(Class, String, Locale, String, Resource), SharedResources.add(String, Locale, Resource)or SharedResources.add(String, Resource).

If a component has its own shared resource which should not be added to the application construction logic in this way, it can lazy-initialize the resource by overriding the newResource()method. In this method, the component should supply logic that creates the shared resource.

Author:

Jonathan Locke

See Also:

Serialized Form

Constructor Summary

ResourceReference(java.lang.Class scope, java.lang.String name)
Constructs a ResourceReference with the given scope and name.

ResourceReference(java.lang.String name)
Contructs a resource reference with Application.class scope and the given name.

Method Summary

void	bind(Application application) Binds this shared resource to the given application.
java.util.Locale	getLocale()
java.lang.String	getName()
java.lang.String	getPath()
Resource	getResource() Gets the resource for this resource reference.
java.lang.Class	getScope()
java.lang.String	getStyle()
void	invalidate() Sets any loaded resource to null, thus forcing a reload on the next request.
protected Resource	newResource() Factory method for lazy initialization of shared resources.
void	setLocale(java.util.Locale locale)
void	setStyle(java.lang.String style)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceReference

public ResourceReference(java.lang.Class scope,
                         java.lang.String name)

Constructs a ResourceReference with the given scope and name. The scope is used as a namespace and the scope together with the name must uniquely identify the reference.

Parameters:

scope - The scope of the name

name - The name of the resource

ResourceReference

public ResourceReference(java.lang.String name)

Contructs a resource reference with Application.class scope and the given name. All resource references constructed with this constructor must have unique names since they all have the same Application-wide scope.

Parameters:

name - The name of the resource

Method Detail

bind

public final void bind(Application application)

Binds this shared resource to the given application.

Parameters:

application - The application which holds the shared resource

getLocale

public final java.util.Locale getLocale()

Returns:

Returns the locale.

getName

public final java.lang.String getName()

Returns:

Name

getPath

public final java.lang.String getPath()

Returns:

Path for this resource reference.

getResource

public final Resource getResource()

Gets the resource for this resource reference. If the ResourceReference has not yet been bound to the application via bind(Application)this method may return null.

Returns:

The resource, or null if the ResourceReference has not yet been bound.

getScope

public final java.lang.Class getScope()

Returns:

Scope

getStyle

public final java.lang.String getStyle()

Returns:

Returns the style. (see Session)

invalidate

public final void invalidate()

Sets any loaded resource to null, thus forcing a reload on the next request.

setLocale

public final void setLocale(java.util.Locale locale)

Parameters:

locale - The locale to set.

setStyle

public final void setStyle(java.lang.String style)

Parameters:

style - The style to set (see Session).

toString

public java.lang.String toString()

See Also:

Object.toString()

newResource

protected Resource newResource()

Factory method for lazy initialization of shared resources.

Returns:

The resource