jhelp.util.gui

Class JHelpSprite

java.lang.Object

jhelp.util.gui.JHelpSprite

public final class JHelpSprite
extends java.lang.Object

A sprite, in an other word an image can be show/hide/translate easily over an other image.
To create a sripe use JHelpImage.createSprite(int, int, int, int)

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private JHelpImage	back Back image before show the sprite
private int	height Sprite height
private JHelpImage	image Image draw on the sprite
private JHelpImage	parent Parent that contains the sprite
private int	spriteIndex Sprite index in the parent
private boolean	visible Indicates actual visibility
private int	width Sprite width
private int	x Sprite X
private int	y Sprite Y

Constructor Summary

Constructors

Constructor and Description
JHelpSprite(int x, int y, int width, int height, JHelpImage parent, int spriteIndex) Create a new instance of JHelpSprite
JHelpSprite(int x, int y, JHelpImage source, JHelpImage parent, int spriteIndex) Create a new instance of JHelpSprite

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	changeVisible(boolean visible, boolean forced) Change internally the sprite visibility
protected void	finalize() Call by garbage collector when want free some memory Parent documentation:
int	getHeight() Sprite height
JHelpImage	getImage() Image for draw on the sprite
JHelpImage	getParent() The sprite parent.
(package private) int	getSpriteIndex() Sprite index
int	getWidth() Sprite width
int	getX() X position
int	getY() Y position
boolean	isVisible() Indicates if sprite is visible
(package private) void	setParent(JHelpImage parent) Change parent image
void	setPosition(int x, int y) Change sprite position
(package private) void	setSpriteIndex(int spriteIndex) Change sprite index
void	setVisible(boolean visible) Change sprite visibility
void	translate(int vx, int vy) Translate the sprite

Methods inherited from class java.lang.Object

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

Field Detail

back

private JHelpImage back

Back image before show the sprite

height

private final int height

Sprite height

image

private JHelpImage image

Image draw on the sprite

parent

private JHelpImage parent

Parent that contains the sprite

spriteIndex

private int spriteIndex

Sprite index in the parent

visible

private boolean visible

Indicates actual visibility

width

private final int width

Sprite width

x

private int x

Sprite X

y

private int y

Sprite Y

Constructor Detail

JHelpSprite

JHelpSprite(int x,
           int y,
           int width,
           int height,
           JHelpImage parent,
           int spriteIndex)

Create a new instance of JHelpSprite

Parameters:

x - Start X

y - Start Y

width - Sprite width

height - Sprite height

parent - Image parent

spriteIndex - Sprite index

JHelpSprite

JHelpSprite(int x,
           int y,
           JHelpImage source,
           JHelpImage parent,
           int spriteIndex)

Create a new instance of JHelpSprite

Parameters:

x - X start position

y - Y start position

source - Image source

parent - Image parent

spriteIndex - Sprite index

Method Detail

changeVisible

void changeVisible(boolean visible,
                 boolean forced)

Change internally the sprite visibility

Parameters:

visible - New visible state

forced - Indicates if the change is forced

getSpriteIndex

int getSpriteIndex()

Sprite index

Returns:

Sprite index

setParent

void setParent(JHelpImage parent)

Change parent image

Parameters:

parent - New parent image

setSpriteIndex

void setSpriteIndex(int spriteIndex)

Change sprite index

Parameters:

spriteIndex - New sprite index

finalize

protected void finalize()
                 throws java.lang.Throwable

Call by garbage collector when want free some memory

Parent documentation:

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - On issue

See Also:

Object.finalize()

getHeight

public int getHeight()

Sprite height

Returns:

Sprite height

getImage

public JHelpImage getImage()

Image for draw on the sprite

Returns:

Image for draw on the sprite

getParent

public JHelpImage getParent()

The sprite parent. In other words, the JHelpImage where the sprite is attach to

Returns:

The sprite parent

getWidth

public int getWidth()

Sprite width

Returns:

Sprite width

getX

public int getX()

X position

Returns:

X position

getY

public int getY()

Y position

Returns:

Y position

isVisible

public boolean isVisible()

Indicates if sprite is visible

Returns:

true if sprite is visible

setPosition

public void setPosition(int x,
               int y)

Change sprite position

Parameters:

x - New X

y - New Y

setVisible

public void setVisible(boolean visible)

Change sprite visibility

Parameters:

visible - New visible state

translate

public void translate(int vx,
             int vy)

Translate the sprite

Parameters:

vx - X of translation vector

vy - Y of translation vector