| java.lang.Object
 com.xoetrope.swing.animation.XAnimation
| XAnimation | | public class XAnimation implements Runnable,ImageObserver(Code) | | "Mix-in" Animation Support.
This mix-in will draw on the owner's surface at specified intervals. The owner
must specify where the image is to be drawn and then this class will load and
render the image. Where multiple images are available an animation will result.
Copyright (c) Xoetrope Ltd., 2001-2006, This software is licensed under
the GNU Public License (GPL), please see license.txt for more details. If
you make commercial use of this software you must purchase a commercial
license from Xoetrope.
$Revision: 1.5 $
|
| Field Summary | |
| protected XProject | currentProject
The owner project and the context in which this object operates. |
| Method Summary | |
| public synchronized void | add(int index, String fileName)
Adds a picture to the current animation. | | public synchronized void | add(int index, String fileName, boolean fetchNow)
Adds a picture to the current animation. | | public synchronized void | displayImage(Graphics g)
Draws the image at an offset of 0, 0. | | public synchronized void | displayImage(Graphics g, int xOff, int yOff)
Draw the current image at the specified offsets. | | boolean | fetchImages(Vector images)
Fetch the images named in the argument. | | public synchronized void | first()
Sets the image index to the first image. | | public synchronized int | getIncrement()
Gets the interval between images in the animation. | | public synchronized int | getIndex()
| | public synchronized int | getNumImages()
| | public boolean | imageUpdate(Image img, int infoflags, int x, int y, int width, int height)
This method is called when information about an image which was
previously requested using an asynchronous interface becomes
available. | | public void | imageUpdate()
| | public synchronized void | last()
Sets the image index to the last image. | | int | loadImages()
| | public synchronized void | next()
Sets the image index to the next image. | | public void | paintComponent(Graphics g)
Draws any images on the specified graphics context. | | public synchronized void | prev()
Sets the image index to the prev image. | | public synchronized void | purge()
Removes all images from the current animation. | | public synchronized void | remove(int index)
Removes the specified image from the list of images. | | public void | run()
Functions required for multi-threading. | | public synchronized void | setIncrement(int inc)
Sets the interval between images in the animation. | | public synchronized void | setIndex(int newPos)
Sets the index of the image to display. | | public synchronized void | setSleepTime(int st)
Sets the amount of time to wait before refreshing the image. | | public synchronized void | setValue(int index, String fileName)
Sets the image at the specified index. | | public synchronized void | startAnimation()
| | public synchronized void | stopAnimation()
Stops the animation. | | public void | update()
Causes the animation to repaint itself. | | public void | update(Graphics g)
No need to clear anything; just paint. |
| currentProject | | protected XProject currentProject(Code) | | The owner project and the context in which this object operates.
|
| XAnimation | | public XAnimation()(Code) | | Create a new animation
|
| add | | public synchronized void add(int index, String fileName)(Code) | | Adds a picture to the current animation. Fetches the image immediately
Parameters:
index - the position at which the image is to be inserted
Parameters:
fileName - the name of the file to display. |
| add | | public synchronized void add(int index, String fileName, boolean fetchNow)(Code) | | Adds a picture to the current animation.
Parameters:
index - the position at which the image is to be inserted
Parameters:
fileName - the name of the file to display.
Parameters:
fetchNow - get teh image now or wait till more images are added |
| displayImage | | public synchronized void displayImage(Graphics g)(Code) | | Draws the image at an offset of 0, 0.
Parameters:
g - the graphics context. |
| displayImage | | public synchronized void displayImage(Graphics g, int xOff, int yOff)(Code) | | Draw the current image at the specified offsets.
Parameters:
g - the graphics context.
Parameters:
xOff - the x offset,
Parameters:
yOff - the y offset. |
| fetchImages | | boolean fetchImages(Vector images)(Code) | | Fetch the images named in the argument. Is restartable.
Parameters:
images - a Vector of URLs true if all went well, false otherwise. |
| first | | public synchronized void first()(Code) | | Sets the image index to the first image.
|
| getIncrement | | public synchronized int getIncrement()(Code) | | Gets the interval between images in the animation.
the time in milliseconds between images. |
| getIndex | | public synchronized int getIndex()(Code) | | Get the current image index
the current image index |
| getNumImages | | public synchronized int getNumImages()(Code) | | Get the number of images in this animation
the number of images |
| imageUpdate | | public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, int height)(Code) | | This method is called when information about an image which was
previously requested using an asynchronous interface becomes
available. Asynchronous interfaces are method calls such as
getWidth(ImageObserver) and drawImage(img, x, y, ImageObserver)
which take an ImageObserver object as an argument. Those methods
register the caller as interested either in information about
the overall image itself (in the case of getWidth(ImageObserver))
or about an output version of an image (in the case of the
drawImage(img, x, y, [w, h,] ImageObserver) call).
This method
should return true if further updates are needed or false if the
required information has been acquired. The image which was being
tracked is passed in using the img argument. Various constants
are combined to form the infoflags argument which indicates what
information about the image is now available. The interpretation
of the x, y, width, and height arguments depends on the contents
of the infoflags argument.
The infoflags argument should be the bitwise inclusive
OR of the following flags: WIDTH,
HEIGHT, PROPERTIES, SOMEBITS,
FRAMEBITS, ALLBITS, ERROR,
ABORT.
Parameters:
img - the image being observed.
Parameters:
infoflags - the bitwise inclusive OR of the following flags: WIDTH, HEIGHT, PROPERTIES, SOMEBITS,FRAMEBITS, ALLBITS, ERROR, ABORT.
Parameters:
x - the x coordinate.
Parameters:
y - the y coordinate.
Parameters:
width - the width.
Parameters:
height - the height. false if the infoflags indicate that theimage is completely loaded; true otherwise.
See Also: XAnimation.WIDTH
See Also: XAnimation.HEIGHT
See Also: XAnimation.PROPERTIES
See Also: XAnimation.SOMEBITS
See Also: XAnimation.FRAMEBITS
See Also: XAnimation.ALLBITS
See Also: XAnimation.ERROR
See Also: XAnimation.ABORT
See Also: Image.getWidth
See Also: Image.getHeight
See Also: java.awt.Graphics.drawImage |
| imageUpdate | | public void imageUpdate()(Code) | | Update the image/component
|
| last | | public synchronized void last()(Code) | | Sets the image index to the last image.
|
| loadImages | | int loadImages()(Code) | | |
| next | | public synchronized void next()(Code) | | Sets the image index to the next image.
|
| paintComponent | | public void paintComponent(Graphics g)(Code) | | Draws any images on the specified graphics context.
Parameters:
g - the graphics context. |
| prev | | public synchronized void prev()(Code) | | Sets the image index to the prev image.
|
| purge | | public synchronized void purge()(Code) | | Removes all images from the current animation.
|
| remove | | public synchronized void remove(int index)(Code) | | Removes the specified image from the list of images.
The index is forced to be in the range of valid images and
if no images exist then no action is taken.
Parameters:
index - the image index |
| run | | public void run()(Code) | | Functions required for multi-threading. Loads the image(s) and animates if more than
one image is loaded.
|
| setIncrement | | public synchronized void setIncrement(int inc)(Code) | | Sets the interval between images in the animation.
Parameters:
inc - the time in milliseconds between images. |
| setIndex | | public synchronized void setIndex(int newPos)(Code) | | Sets the index of the image to display.
The index is forced to be in the range of valid images and
if no images exist then no action is taken.
Parameters:
newPos - the index of the image. |
| setSleepTime | | public synchronized void setSleepTime(int st)(Code) | | Sets the amount of time to wait before refreshing the image.
A minimum of 100 milliseconds is enforced.
Parameters:
st - the time to sleep. |
| setValue | | public synchronized void setValue(int index, String fileName)(Code) | | Sets the image at the specified index.
The index is forced to be in the range of valid images and
if no images exist then no action is taken.
Parameters:
index - the number of the image to be changed
Parameters:
fileName - the name of the new image. |
| startAnimation | | public synchronized void startAnimation()(Code) | | Starts the animation
|
| stopAnimation | | public synchronized void stopAnimation()(Code) | | Stops the animation.
|
| update | | public void update()(Code) | | Causes the animation to repaint itself.
|
| update | | public void update(Graphics g)(Code) | | No need to clear anything; just paint.
Parameters:
g - the graphics context |
|
|