eve.fx

Class AnimatedDrawing

java.lang.Object

eve.fx.ImageObject

eve.fx.Drawing

eve.fx.AnimatedDrawing

All Implemented Interfaces:

Drawable, IImage, ImageMaker, OnScreenImage, ImageData

Direct Known Subclasses:

AniImage, IconAndText

public class AnimatedDrawing
extends Drawing
implements OnScreenImage

Author:

Michael L Brereton

Field Summary

Fields inherited from class eve.fx.Drawing

AlwaysOnTop, CompletelyIn, freeImageWithDrawing, HasBorder, HasChanged, HasMoved, hotArea, hotPolygon, image, InUse, IsAnimated, IsEmpty, IsInvisible, IsLocked, IsMoveable, IsNotHot, IsNotStill, IsPrepared, IsPreparing, KeepOnScreen, lastDrawn, location, MouseMustBeOver, properties, RelativeToOrigin

Fields inherited from class eve.fx.ImageObject

background, height, width

Fields inherited from interface eve.sys.ImageData

CREATE_OPTION_DONT_SCALE_UP, CREATE_OPTION_IGNORE_ALPHA, CREATE_OPTION_KEEP_ASPECT_RATIO, CREATE_OPTION_ROUGH_SCALING, SCAN_LINE_BYTE_ARRAY, SCAN_LINE_INT_ARRAY, TYPE_ARGB, TYPE_GRAY_SCALE_16, TYPE_GRAY_SCALE_2, TYPE_GRAY_SCALE_256, TYPE_GRAY_SCALE_4, TYPE_INDEXED_16, TYPE_INDEXED_2, TYPE_INDEXED_256, TYPE_INDEXED_4, TYPE_MASK, TYPE_MONO, TYPE_RGB, TYPE_UNKNOWN

Fields inherited from interface eve.fx.Drawable

ACTIVE, DISABLED, INACTIVE, INDENT_ITEM_FLAG, OUTLINED

Constructor Summary

Constructors

Constructor and Description
AnimatedDrawing()
AnimatedDrawing(ImageData image, Object maskObject)
AnimatedDrawing(String imageName, Object maskObject)

Method Summary

Modifier and Type	Method and Description
boolean	changeRefresher(ImageRefresher newRefresher, ImageRefresher oldRefresher) Change the ImageRefresher for the Image only if the old Refresher is the same as the one specified.
ImageRefresher	getRefresher() Retrieve the ImageRefresher for the image which is weakly referenced by the OnScreenImage.
protected void	newRefresher(ImageRefresher r) This is called when a new ImageRefresher has been assigned as the refresher for this AnimatedDrawing - even if the refresher is null.
void	refresh()
protected void	refresh(ImageRefresher on)
void	setRefresher(ImageRefresher refresher) Weakly set the ImageRefresher for the Image.
protected void	startAnimate()
protected void	stopAnimate()

Methods inherited from class eve.fx.Drawing

compareTo, copyFrom, doDraw, draw, draw, drawBorder, drawn, free, getBackground, getCopy, getDim, getHotArea, getImage, getImageScanLines, getLocation, getNew, getPixels, getSize, getUnusedColor, isWriteableImage, onHotArea, setHotAreaInImage, setImage, setImageScanLines, setLocation, setPixels, setRect, setSize, usesAlpha

Methods inherited from class eve.fx.ImageObject

createImageFor, draw, draw, freeImage, getCompatibleImagePoints, getDPI, getHeight, getImageColorTable, getImageData, getImageHeight, getImageScanLineLength, getImageScanLineType, getImageType, getImageWidth, getNativeDrawable, getPixelsUsingScanLines, getScanLinesUsingPixels, getWidth, isReadableImage, scanLinesComplete, setPixelsUsingScanLines, setScanLinePixels, setScanLinesUsingPixels

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface eve.fx.IImage

getBackground, usesAlpha

Methods inherited from interface eve.sys.ImageData

freeImage, getImageColorTable, getImageHeight, getImageScanLineLength, getImageScanLines, getImageScanLineType, getImageType, getImageWidth, getPixels, isReadableImage, isWriteableImage, setImageScanLines, setPixels

Methods inherited from interface eve.fx.Drawable

draw, draw, draw, free, getHeight, getWidth

Constructor Detail

AnimatedDrawing

public AnimatedDrawing(String imageName,
                       Object maskObject)

Parameters:

imageName -

maskImageName -

AnimatedDrawing

public AnimatedDrawing(ImageData image,
                       Object maskObject)

Parameters:

image -

transparent -

AnimatedDrawing

public AnimatedDrawing()

Method Detail

startAnimate

protected void startAnimate()

stopAnimate

protected void stopAnimate()

newRefresher

protected void newRefresher(ImageRefresher r)

This is called when a new ImageRefresher has been assigned as the refresher for this AnimatedDrawing - even if the refresher is null. This can be used to start/stop animation sequences. By default if r is null then stopAnimate() will be called otherwise startAnimate() will be called.

Parameters:

r - the new Refresher - which may be null if the refresher is set to null.

setRefresher

public void setRefresher(ImageRefresher refresher)

Description copied from interface: OnScreenImage

Weakly set the ImageRefresher for the Image.

Specified by:

setRefresher in interface OnScreenImage

changeRefresher

public boolean changeRefresher(ImageRefresher newRefresher,
                               ImageRefresher oldRefresher)

Description copied from interface: OnScreenImage

Change the ImageRefresher for the Image only if the old Refresher is the same as the one specified. The newRefresher can be null, indicating that the image is no longer on display.

Specified by:

changeRefresher in interface OnScreenImage

Parameters:

newRefresher - The new ImageRefresher for the image.

oldRefresher - What the old ImageRefresher was expected to be.

Returns:

true if the refresher was changed, false if it was not changed because the old Refresher was not the same as that specified in the parameter.

getRefresher

public ImageRefresher getRefresher()

Description copied from interface: OnScreenImage

Retrieve the ImageRefresher for the image which is weakly referenced by the OnScreenImage.

Specified by:

getRefresher in interface OnScreenImage

refresh

protected void refresh(ImageRefresher on)

refresh

public void refresh()