Package org.jfree.util
Class WaitingImageObserver
java.lang.Object
org.jfree.util.WaitingImageObserver
- All Implemented Interfaces:
ImageObserver
,Serializable
,Cloneable
This image observer blocks until the image is completely loaded. AWT
defers the loading of images until they are painted on a graphic.
While printing reports it is not very nice, not to know whether a image
was completely loaded, so this observer forces the loading of the image
until a final state (either ALLBITS, ABORT or ERROR) is reached.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
A flag that signals an error.private Image
The image.private boolean
The lock.(package private) static final long
For serialization.Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
Constructor Summary
ConstructorsConstructorDescriptionWaitingImageObserver
(Image image) Creates a newImageObserver
for the givenImage
. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Deprecated.cloning may lock down the observerboolean
imageUpdate
(Image img, int infoflags, int x, int y, int width, int height) Callback function used by AWT to inform that more data is available.boolean
isError()
Returns true if there is an error condition, and false otherwise.boolean
Returnstrue
if loading is complete, andfalse
otherwise.void
The workerthread.
-
Field Details
-
serialVersionUID
static final long serialVersionUIDFor serialization.- See Also:
-
lock
private boolean lockThe lock. -
image
The image. -
error
private boolean errorA flag that signals an error.
-
-
Constructor Details
-
WaitingImageObserver
Creates a newImageObserver
for the givenImage
. The observer has to be started by an external thread.- Parameters:
image
- the image to observe (null
not permitted).
-
-
Method Details
-
imageUpdate
Callback function used by AWT to inform that more data is available. The observer waits until either all data is loaded or AWT signals that the image cannot be loaded.- Specified by:
imageUpdate
in interfaceImageObserver
- Parameters:
img
- the image being observed.infoflags
- the bitwise inclusive OR of the following flags:WIDTH
,HEIGHT
,PROPERTIES
,SOMEBITS
,FRAMEBITS
,ALLBITS
,ERROR
,ABORT
.x
- the x coordinate.y
- the y coordinate.width
- the width.height
- the height.- Returns:
false
if the infoflags indicate that the image is completely loaded;true
otherwise.
-
waitImageLoaded
public void waitImageLoaded()The workerthread. Simply draws the image to a BufferedImage's Graphics-Object and waits for the AWT to load the image. -
clone
Deprecated.cloning may lock down the observerClones this WaitingImageObserver.- Overrides:
clone
in classObject
- Returns:
- a clone.
- Throws:
CloneNotSupportedException
- this should never happen.
-
isLoadingComplete
public boolean isLoadingComplete()Returnstrue
if loading is complete, andfalse
otherwise.- Returns:
- A boolean.
-
isError
public boolean isError()Returns true if there is an error condition, and false otherwise.- Returns:
- A boolean.
-