Class BrokenLinkProvider
java.lang.Object
org.apache.batik.ext.awt.image.spi.BrokenLinkProvider
- Direct Known Subclasses:
DefaultBrokenLinkProvider
This interface is to be used to provide alternate ways of
generating a placeholder image when the ImageTagRegistry
fails to handle a given reference.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The image returned by getBrokenLinkImage should always return some value when queried for the BROKEN_LINK_PROPERTY. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract Filter
getBrokenLinkImage
(Object base, String code, Object[] params) This method is responsbile for constructing an image that will represent the missing image in the document.static boolean
-
Field Details
-
BROKEN_LINK_PROPERTY
The image returned by getBrokenLinkImage should always return some value when queried for the BROKEN_LINK_PROPERTY. This allows code the determine if the image is the 'real' image or the broken link image, which may be important for the application of profiles etc.- See Also:
-
-
Constructor Details
-
BrokenLinkProvider
public BrokenLinkProvider()
-
-
Method Details
-
getBrokenLinkImage
This method is responsbile for constructing an image that will represent the missing image in the document. This method recives information about the reason a broken link image is being requested in thecode
andparams
parameters. These parameters may be used to generate nicely localized messages for insertion into the broken link image, or for selecting the broken link image returned.- Parameters:
base
- The object to use for Message decoding.code
- This is the reason the image is unavailable should be taken from ErrorConstants.params
- This is more detailed information about the circumstances of the failure.
-
hasBrokenLinkProperty
-