public final class LocalizedImageResource extends Object implements org.apache.wicket.util.io.IClusterable
This class contains the logic for extracting static image resources referenced by the SRC attribute of component tags and keeping these static image resources in sync with the component locale.
If no image is specified by the SRC attribute of an IMG tag, then any VALUE attribute is
inspected. If there is a VALUE attribute, it must be of the form
"[factoryName]:[sharedImageName]?:[specification]". [factoryName] is the name of a resource
factory that has been added to Application (for example, DefaultButtonImageResourceFactory is
installed by default under the name "buttonFactory"). The [sharedImageName] value is optional and
gives a name under which a given generated image is shared. For example, a cancel button image
generated by the VALUE attribute "buttonFactory:cancelButton:Cancel" is shared under the name
"cancelButton" and this specification will cause a component to reference the same image resource
no matter what page it appears on, which is a very convenient and efficient way to create and
share images. The [specification] string which follows the second colon is passed directly to the
image factory and its format is dependent on the specific image factory. For details on the
default buttonFactory, see
DefaultButtonImageResourceFactory
.
Finally, if there is no SRC attribute and no VALUE attribute, the Image component's model is inspected. If the model contains a resource or resource reference, this image is used, otherwise the model is converted to a String and that value is used as a path to load the image.
Constructor and Description |
---|
LocalizedImageResource(Component component)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
bind()
Binds this resource if it is shared
|
IResource |
getResource()
return the resource
|
ResourceReference |
getResourceReference()
return the resource
|
boolean |
isStateless() |
void |
onResourceRequested(org.apache.wicket.request.mapper.parameter.PageParameters parameters) |
void |
setResource(IResource resource) |
void |
setResourceReference(ResourceReference resourceReference) |
void |
setResourceReference(ResourceReference resourceReference,
org.apache.wicket.request.mapper.parameter.PageParameters resourceParameters) |
void |
setSrcAttribute(ComponentTag tag) |
public LocalizedImageResource(Component component)
component
- The component that owns this localized image resourcepublic final void bind()
public final void onResourceRequested(org.apache.wicket.request.mapper.parameter.PageParameters parameters)
parameters
- page parameterspublic final void setResource(IResource resource)
resource
- The resource to set.public final void setResourceReference(ResourceReference resourceReference)
resourceReference
- The resource to set.public final boolean isStateless()
public final void setResourceReference(ResourceReference resourceReference, org.apache.wicket.request.mapper.parameter.PageParameters resourceParameters)
resourceReference
- The resource to set.resourceParameters
- The resource parameters for the shared resourcepublic final void setSrcAttribute(ComponentTag tag)
tag
- The tag to inspect for an optional src attribute that might reference an image.WicketRuntimeException
- Thrown if an image is required by the caller, but none can be found.public final IResource getResource()
null
if there is nonepublic final ResourceReference getResourceReference()
null
if there is noneCopyright © 2006–2020 Apache Software Foundation. All rights reserved.