com.alee.graphics.image.gif

Class GifIcon

java.lang.Object

com.alee.graphics.image.gif.GifIcon

All Implemented Interfaces:

DisabledCopySupplier<GifIcon>, TransparentCopySupplier<GifIcon>, Icon

public class GifIcon
extends Object
implements Icon, DisabledCopySupplier<GifIcon>, TransparentCopySupplier<GifIcon>

Simple GIF Icon implementation.

Author:

Mikle Garin

See Also:

GifDecoder, GifEncoder

Field Summary

Fields

Modifier and Type	Field and Description
protected int	displayedFrame Currently displayed GifFrame index.
protected List<GifFrame>	frames List of all GifFrames in this GifIcon.
protected Thread	gifAnimator Daemon Thread that handles GifIcon animation.
protected List<FrameChangeListener>	listeners List of FrameChangeListeners.
protected int	status GifIcon loading status.

Constructor Summary

Constructors

Constructor and Description
GifIcon(GifFrame... frames) Constructs new GifIcon.
GifIcon(InputStream inputStream) Constructs new GifIcon.
GifIcon(List<GifFrame> frames) Constructs new GifIcon.
GifIcon(Resource resource) Constructs new GifIcon.

Method Summary

Modifier and Type	Method and Description
void	addFrameChangeListener(FrameChangeListener listener) Adds specified FrameChangeListener.
GifIcon	createDisabledCopy() Returns copy of this GifIcon with only first frame made look disabled.
GifIcon	createTransparentCopy(float opacity) Returns copy of this GifIcon with only first frame made semi-transparent.
void	fireFrameChanged(int index) Fires displayed GifFrame change.
int	getDisplayedFrame() Returns currently displayed GifFrame index.
BufferedImage	getDisplayedImage() Returns currently displayed BufferedImage.
GifFrame	getFrame(int index) Returns GifFrame at the specified index.
int	getFrameCount() Returns GifIcon frame count.
List<GifFrame>	getFrames() Returns copy of the List of all GifFrames in this GifIcon.
int	getIconHeight()
int	getIconWidth()
int	getStatus() Returns GifIcon loading status.
void	paintIcon(Component c, Graphics g, int x, int y)
void	removeFrameChangeListener(FrameChangeListener listener) Removes specified FrameChangeListener.
void	startAnimation() Starts animation Thread.
void	stopAnimation() Stops animation Thread.

Methods inherited from class java.lang.Object

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

Field Detail

frames

@NotNull
protected final List<GifFrame> frames

List of all GifFrames in this GifIcon.

status

protected final int status

GifIcon loading status.

See Also:

GifDecoder.STATUS_OK, GifDecoder.STATUS_FORMAT_ERROR, GifDecoder.STATUS_OPEN_ERROR

listeners

@NotNull
protected List<FrameChangeListener> listeners

List of FrameChangeListeners.

displayedFrame

protected transient int displayedFrame

Currently displayed GifFrame index.

gifAnimator

@Nullable
protected transient Thread gifAnimator

Daemon Thread that handles GifIcon animation.

Constructor Detail

GifIcon

public GifIcon(@NotNull
               Resource resource)

Constructs new GifIcon.

Parameters:

resource - GIF Resource

GifIcon

public GifIcon(@NotNull
               InputStream inputStream)

Constructs new GifIcon.

Parameters:

inputStream - GIF InputStream

GifIcon

public GifIcon(@NotNull
               GifFrame... frames)

Constructs new GifIcon.

Parameters:

frames - GifFrames

GifIcon

public GifIcon(@NotNull
               List<GifFrame> frames)

Constructs new GifIcon.

Parameters:

frames - List of GifFrames

Method Detail

getStatus

public int getStatus()

Returns GifIcon loading status.

Returns:

GifIcon loading status

See Also:

GifDecoder.STATUS_OK, GifDecoder.STATUS_FORMAT_ERROR, GifDecoder.STATUS_OPEN_ERROR

getFrameCount

public int getFrameCount()

Returns GifIcon frame count.

Returns:

GifIcon frame count

getFrames

@NotNull
public List<GifFrame> getFrames()

Returns copy of the List of all GifFrames in this GifIcon.

Returns:

copy of the List of all GifFrames in this GifIcon

getFrame

@NotNull
public GifFrame getFrame(int index)

Returns GifFrame at the specified index.

Parameters:

index - GifFrame index

Returns:

GifFrame at the specified index

getDisplayedFrame

public int getDisplayedFrame()

Returns currently displayed GifFrame index.

Returns:

currently displayed GifFrame index

getDisplayedImage

@NotNull
public BufferedImage getDisplayedImage()

Returns currently displayed BufferedImage.

Returns:

currently displayed BufferedImage

startAnimation

public void startAnimation()

Starts animation Thread.

stopAnimation

public void stopAnimation()

Stops animation Thread.

paintIcon

public void paintIcon(Component c,
                      Graphics g,
                      int x,
                      int y)

Specified by:

paintIcon in interface Icon

getIconWidth

public int getIconWidth()

Specified by:

getIconWidth in interface Icon

getIconHeight

public int getIconHeight()

Specified by:

getIconHeight in interface Icon

addFrameChangeListener

public void addFrameChangeListener(@NotNull
                                   FrameChangeListener listener)

Adds specified FrameChangeListener.

Parameters:

listener - FrameChangeListener to add

removeFrameChangeListener

public void removeFrameChangeListener(@NotNull
                                      FrameChangeListener listener)

Removes specified FrameChangeListener.

Parameters:

listener - FrameChangeListener to remove

fireFrameChanged

public void fireFrameChanged(int index)

Fires displayed GifFrame change.

Parameters:

index - new displayed GifFrame index

createDisabledCopy

@NotNull
public GifIcon createDisabledCopy()

Returns copy of this GifIcon with only first frame made look disabled.

Specified by:

createDisabledCopy in interface DisabledCopySupplier<GifIcon>

Returns:

copy of this GifIcon with only first frame made look disabled

createTransparentCopy

@NotNull
public GifIcon createTransparentCopy(float opacity)

Returns copy of this GifIcon with only first frame made semi-transparent.

Specified by:

createTransparentCopy in interface TransparentCopySupplier<GifIcon>

Parameters:

opacity - opacity value, must be between 0 and 1

Returns:

copy of this GifIcon with only first frame made semi-transparent