com.jmex.bui.background
Class ImageBackground

java.lang.Object
  com.jmex.bui.background.BBackground
      com.jmex.bui.background.ImageBackground

public class ImageBackground
extends BBackground

Supports image backgrounds in a variety of ways. Specifically:

• Centering the image either horizontally, vertically or both.
• Scaling the image either horizontally, vertically or both.
• Tiling the image either horizontally, vertically or both.
• Framing the image in a fancy way: the background image is divided into nine sections (three across and three down), the corners are rendered unscaled, the central edges are scaled in one direction and the center section is scaled in both directions.

   +----------+----------------+----------+
   | unscaled |  <- scaled ->  | unscaled |
   +----------+----------------+----------+
   |    ^     |       ^        |    ^     |
   |  scaled  |  <- scaled ->  |  scaled  |
   |    v     |       v        |    v     |
   +----------+----------------+----------+
   | unscaled |  <- scaled ->  | unscaled |
   +----------+----------------+----------+
   

Field Summary

protected Insets	_frame
protected BImage	_image
protected int	_mode
protected static int	CENTER
static int	CENTER_X
static int	CENTER_XY
static int	CENTER_Y
protected static int	FRAME
static int	FRAME_X
static int	FRAME_XY
static int	FRAME_Y
protected static int	SCALE
static int	SCALE_X
static int	SCALE_XY
static int	SCALE_Y
protected static int	TILE
static int	TILE_X
static int	TILE_XY
static int	TILE_Y

Constructor Summary

ImageBackground(int mode, BImage image)
Creates an image background in the specified mode using the supplied image.

ImageBackground(int mode, BImage image, Insets frame)
Creates an image background in the specified mode using the supplied image and the special frame.

Method Summary

int	getMinimumHeight() Returns the minimum height allowed by this background.
int	getMinimumWidth() Returns the minimum width allowed by this background.
void	render(Renderer renderer, int x, int y, int width, int height, float alpha) Renders this background.
protected void	renderCentered(Renderer renderer, int x, int y, int width, int height, float alpha)
protected void	renderFramed(Renderer renderer, int x, int y, int width, int height, float alpha)
protected void	renderRow(Renderer renderer, int x, int y, int width, int iheight, float alpha)
protected void	renderScaled(Renderer renderer, int x, int y, int width, int height, float alpha)
protected void	renderTiled(Renderer renderer, int x, int y, int width, int height, float alpha)
void	wasAdded() Called when the component that contains this background is was added to the interface hierarchy.
void	wasRemoved() Called when the component that contains this background is no longer part of a user interface hierarchy.

Methods inherited from class java.lang.Object

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

Field Detail

CENTER_XY

public static final int CENTER_XY

See Also:

Constant Field Values

CENTER_X

public static final int CENTER_X

See Also:

Constant Field Values

CENTER_Y

public static final int CENTER_Y

See Also:

Constant Field Values

SCALE_XY

public static final int SCALE_XY

See Also:

Constant Field Values

SCALE_X

public static final int SCALE_X

See Also:

Constant Field Values

SCALE_Y

public static final int SCALE_Y

See Also:

Constant Field Values

TILE_XY

public static final int TILE_XY

See Also:

Constant Field Values

TILE_X

public static final int TILE_X

See Also:

Constant Field Values

TILE_Y

public static final int TILE_Y

See Also:

Constant Field Values

FRAME_XY

public static final int FRAME_XY

See Also:

Constant Field Values

FRAME_X

public static final int FRAME_X

See Also:

Constant Field Values

FRAME_Y

public static final int FRAME_Y

See Also:

Constant Field Values

_mode

protected int _mode

_image

protected BImage _image

_frame

protected Insets _frame

CENTER

protected static final int CENTER

See Also:

Constant Field Values

SCALE

protected static final int SCALE

See Also:

Constant Field Values

TILE

protected static final int TILE

See Also:

Constant Field Values

FRAME

protected static final int FRAME

See Also:

Constant Field Values

Constructor Detail

ImageBackground

public ImageBackground(int mode,
                       BImage image)

Creates an image background in the specified mode using the supplied image.

ImageBackground

public ImageBackground(int mode,
                       BImage image,
                       Insets frame)

Creates an image background in the specified mode using the supplied image and the special frame. This should only be used if one of the framing modes is being used and the supplied frame will be used instead of the default frame which divides the image in thirds.

Method Detail

getMinimumWidth

public int getMinimumWidth()

Description copied from class: BBackground

Returns the minimum width allowed by this background.

Overrides:

getMinimumWidth in class BBackground

getMinimumHeight

public int getMinimumHeight()

Returns the minimum height allowed by this background.

Overrides:

getMinimumHeight in class BBackground

render

public void render(Renderer renderer,
                   int x,
                   int y,
                   int width,
                   int height,
                   float alpha)

Description copied from class: BBackground

Renders this background.

Overrides:

render in class BBackground

wasAdded

public void wasAdded()

Description copied from class: BBackground

Called when the component that contains this background is was added to the interface hierarchy.

Overrides:

wasAdded in class BBackground

wasRemoved

public void wasRemoved()

Description copied from class: BBackground

Called when the component that contains this background is no longer part of a user interface hierarchy.

Overrides:

wasRemoved in class BBackground

renderCentered

protected void renderCentered(Renderer renderer,
                              int x,
                              int y,
                              int width,
                              int height,
                              float alpha)

renderScaled

protected void renderScaled(Renderer renderer,
                            int x,
                            int y,
                            int width,
                            int height,
                            float alpha)

renderTiled

protected void renderTiled(Renderer renderer,
                           int x,
                           int y,
                           int width,
                           int height,
                           float alpha)

renderRow

protected void renderRow(Renderer renderer,
                         int x,
                         int y,
                         int width,
                         int iheight,
                         float alpha)

renderFramed

protected void renderFramed(Renderer renderer,
                            int x,
                            int y,
                            int width,
                            int height,
                            float alpha)