Class ImageInfo
java.lang.Object
org.apache.xmlgraphics.image.loader.ImageInfo
Represents an image that may not have been fully loaded. Usually, the loading only goes as far
as necessary to know the intrinsic size of the image. The image will only fully loaded later
when the image needs to be presented in a particular format so the consuming component can
actually process it. The "preloading" is done so a layout engine can work with the image without
having to fully load it (in memory).
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a Map of custom objects associated with this instance.Returns the image's MIME type.Returns the original Image instance if such an Image instance is created while building this ImageInfo object.Returns the original URI of the image.getSize()
Returns the image's intrinsic size.void
Sets the image's intrinsic size.toString()
-
Field Details
-
ORIGINAL_IMAGE
Key to register the "original object" among the custom objects of an ImageInfo instance.- See Also:
-
HAS_MORE_IMAGES
Key to register information about additional (sub-)images in the image file after the selected one. Valid values for this key is either a positive Integer or the constantBoolean.TRUE
orBoolean.FALSE
. A value of TRUE indicates that there are more subimages available but the exact number of additional images has not been determined for performance reasons.
-
-
Constructor Details
-
ImageInfo
Main constructor.- Parameters:
originalURI
- the original URI that was specified by the user (not the resolved URI!)mimeType
- the MIME type of the image
-
-
Method Details
-
getOriginalURI
Returns the original URI of the image.- Returns:
- the original URI
-
getMimeType
Returns the image's MIME type.- Returns:
- the MIME type
-
getSize
Returns the image's intrinsic size.- Returns:
- the image size
-
setSize
Sets the image's intrinsic size.- Parameters:
size
- the size
-
getCustomObjects
Returns a Map of custom objects associated with this instance.- Returns:
- the Map of custom objects
-
getOriginalImage
Returns the original Image instance if such an Image instance is created while building this ImageInfo object. Some images cannot be "preloaded". They have to be fully loaded in order to determine the intrinsic image size. This method allows access to that fully loaded image so no additional re-loading has to be done later.This method is short for: (Image)this.customObjects.get(ORIGINAL_IMAGE);
- Returns:
- the original Image instance or null if none is set
- See Also:
-
toString
-