de.enough.polish.ui.backgrounds
Class ImageBackground

java.lang.Object
  extended by de.enough.polish.ui.Background
      extended by de.enough.polish.ui.backgrounds.ImageBackground
All Implemented Interfaces:
Serializable, ImageConsumer

public class ImageBackground
extends Background
implements ImageConsumer

Paints an image as a background.

Following CSS parameters are supported:

Copyright Enough Software 2004 - 2008

 history
        14-Mar-2004 - rob creation
 

Author:
Robert Virkus, robert@enough.de

Field Summary
 
Fields inherited from class de.enough.polish.ui.Background
borderWidth
 
Constructor Summary
ImageBackground(int color, javax.microedition.lcdui.Image image, int anchor)
          Creates a new image background.
ImageBackground(int color, javax.microedition.lcdui.Image image, int anchor, int xOffset, int yOffset)
          Creates a new image background.
ImageBackground(int color, java.lang.String imageUrl, int anchor)
          Creates a new image background.
ImageBackground(int color, java.lang.String imageUrl, int anchor, int xOffset, int yOffset)
          Creates a new image background.
 
Method Summary
 javax.microedition.lcdui.Image getImage()
          Retrieves the image from this background.
 void paint(int x, int y, int width, int height, javax.microedition.lcdui.Graphics g)
          Paints this background.
 void releaseResources()
          Releases all (memory intensive) resources such as images or RGB arrays of this background.
 void setImage(javax.microedition.lcdui.Image image)
          Sets the image for this background.
 void setImage(java.lang.String url, javax.microedition.lcdui.Image image)
          sets the image which has been loaded in the background.
 
Methods inherited from class de.enough.polish.ui.Background
addRelativeToBackgroundRegion, animate, animate, hideNotify, showNotify
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageBackground

public ImageBackground(int color,
                       java.lang.String imageUrl,
                       int anchor)
Creates a new image background.

Parameters:
color - the background color or Item.TRANSPARENT
imageUrl - the url of the image, e.g. "/bg.png", must not be null!
anchor - the anchor of the image, either "left", "right", "center" (="horizontal-center"), "vertical-center", "top" or "bottom" or any combinationof these values. Defaults to "horizontal-center | vertical-center"

ImageBackground

public ImageBackground(int color,
                       java.lang.String imageUrl,
                       int anchor,
                       int xOffset,
                       int yOffset)
Creates a new image background.

Parameters:
color - the background color or Item.TRANSPARENT
imageUrl - the url of the image, e.g. "/bg.png", must not be null!
anchor - the anchor of the image, either "left", "right", "center" (="horizontal-center"), "vertical-center", "top" or "bottom" or any combinationof these values. Defaults to "horizontal-center | vertical-center"
xOffset - The number of pixels to move the image horizontally, negative values move it to the left.
yOffset - The number of pixels to move the image vertically, negative values move it to the top.

ImageBackground

public ImageBackground(int color,
                       javax.microedition.lcdui.Image image,
                       int anchor)
Creates a new image background.

Parameters:
color - the background color or Item.TRANSPARENT
image - the image, must not be null!
anchor - the anchor of the image, either "left", "right", "center" (="horizontal-center"), "vertical-center", "top" or "bottom" or any combinationof these values. Defaults to "horizontal-center | vertical-center"

ImageBackground

public ImageBackground(int color,
                       javax.microedition.lcdui.Image image,
                       int anchor,
                       int xOffset,
                       int yOffset)
Creates a new image background.

Parameters:
color - the background color or Item.TRANSPARENT
image - the image, must not be null!
anchor - the anchor of the image, either "left", "right", "center" (="horizontal-center"), "vertical-center", "top" or "bottom" or any combinationof these values. Defaults to "horizontal-center | vertical-center"
xOffset - The number of pixels to move the image horizontally, negative values move it to the left.
yOffset - The number of pixels to move the image vertically, negative values move it to the top.
Method Detail

setImage

public void setImage(java.lang.String url,
                     javax.microedition.lcdui.Image image)
Description copied from interface: ImageConsumer
sets the image which has been loaded in the background.

Specified by:
setImage in interface ImageConsumer
Parameters:
url - the name of the image. This allows the image-consumer to differentiate between several images.
image - the image which was loaded in the background thread.

paint

public void paint(int x,
                  int y,
                  int width,
                  int height,
                  javax.microedition.lcdui.Graphics g)
Description copied from class: Background
Paints this background.

Specified by:
paint in class Background
Parameters:
x - the horizontal start point
y - the vertical start point
width - the width of the background
height - the height of the background
g - the Graphics on which the background should be painted.

setImage

public void setImage(javax.microedition.lcdui.Image image)
Sets the image for this background.

Parameters:
image - the image

getImage

public javax.microedition.lcdui.Image getImage()
Retrieves the image from this background.

Returns:
the image

releaseResources

public void releaseResources()
Releases all (memory intensive) resources such as images or RGB arrays of this background.

Overrides:
releaseResources in class Background