ej.microui.display

Class FlyingImage

java.lang.Object

ej.microui.display.FlyingImage

public class FlyingImage
extends java.lang.Object

The FlyingImage class defines an image to be displayed at the top level in the rendering depth of a display.

A FlyingImage contains an Image. This image associates the FlyingImage with a specific display (since an Image is created for a specific display).
Several FlyingImage objects may be associated with a Display. The flying images of an application are drawn above all drawings coming from the standard paint() calls. Flying images are drawn on a display in the order they are shown: The flying image drawn on top of the display is the last shown (it is above all the other drawings)

See Also:

Pointer.setFlyingImage(FlyingImage)

Constructor Summary

Constructors

Constructor and Description
FlyingImage(Display display, Image skin) Creates a new FlyingImage.
FlyingImage(Image skin) Creates a new FlyingImage.

Method Summary

Modifier and Type	Method and Description
Display	getDisplay() Returns the display associated to the FlyingImage.
Image	getImage() Returns the image associated to the FlyingImage.
int	getX() Get the x coordinate of the FlyingImage position
int	getY() Get the y coordinate of the FlyingImage position
void	hide() Sets the FlyingImage as hidden on its display.
boolean	isShown() Checks whether the FlyingImage is visible on its display.
void	repaint() Requests a repaint of the FlyingImage.
void	setLocation(int x, int y) Sets the location of the FlyingImage.
void	show() Sets the FlyingImage as visible on its display.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlyingImage

public FlyingImage(Image skin)

Creates a new FlyingImage. On creation the FlyingImage is not shown - call show() to show it.

Parameters:

skin - the Image the FlyingImage is associated with.

Throws:

java.lang.NullPointerException - if skin is null.

java.lang.OutOfMemoryError - if there is not enough room to add a new flying image.

FlyingImage

public FlyingImage(Display display,
                   Image skin)

Creates a new FlyingImage. On creation the FlyingImage is not shown - call show() to show it.

Parameters:

display - the Display where the FlyingImage will appears.

skin - the Image the FlyingImage is associated with.

Throws:

java.lang.NullPointerException - if skin is null.

java.lang.OutOfMemoryError - if there is not enough room to add a new flying image.

Method Detail

show

public void show()

Sets the FlyingImage as visible on its display.

hide

public void hide()

Sets the FlyingImage as hidden on its display.

isShown

public boolean isShown()

Checks whether the FlyingImage is visible on its display.

Returns:

true if the FlyingImage is currently visible, false otherwise

repaint

public void repaint()

Requests a repaint of the FlyingImage.

getImage

public Image getImage()

Returns the image associated to the FlyingImage.

Returns:

the image associated to this FlyingImage

setLocation

public void setLocation(int x,
                        int y)

Sets the location of the FlyingImage.

Parameters:

x - the x coordinate where to set the FlyingImage

y - the y coordinate where to set the FlyingImage

getX

public int getX()

Get the x coordinate of the FlyingImage position

Returns:

the x coordinate of the FlyingImage position

getY

public int getY()

Get the y coordinate of the FlyingImage position

Returns:

the y coordinate of the FlyingImage position

getDisplay

public Display getDisplay()

Returns the display associated to the FlyingImage.

Returns:

the display associated to the FlyingImage.