de.enough.polish.ui.backgrounds
Class TextBackground

java.lang.Object
  de.enough.polish.ui.Background
      de.enough.polish.ui.backgrounds.TextBackground

All Implemented Interfaces:

Serializable

public class TextBackground
extends Background

Paints text in a background.

Following CSS parameters are supported:

• text: the text, e.g. test
• text-style: the optional style text that is used for designing the text
• color: the background coloror "transparent".
• 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".
• x-offset: The number of pixels to move the image horizontally, negative values move it to the left.
• y-offset: The number of pixels to move the image vertically, negative values move it to the top.
• :

Copyright Enough Software 2004 - 2009

 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

TextBackground(String text, String textStyleName, int color, int anchor, int xOffset, int yOffset)
Creates a new image background.

Method Summary

void	animate(Screen screen, Item parent, long currentTime, ClippingRegion repaintRegion) Animates this background.
void	hideNotify() Informs the background that it is being hidden shortly.
void	paint(int x, int y, int width, int height, Graphics g) Paints this background.
void	releaseResources() Releases all (memory intensive) resources such as images or RGB arrays of this background.
static void	setLocalization(String original, String translation) Specifies a translations.
void	setStyle(Style style) Allows backgrounds to be animated using CSS attribute animations.
void	showNotify() Informs the background that it is being shown shortly or that it is now applied to a new visible item.

Methods inherited from class de.enough.polish.ui.Background

addRelativeToBackgroundRegion, animate

Methods inherited from class java.lang.Object

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

Constructor Detail

TextBackground

public TextBackground(String text,
                      String textStyleName,
                      int color,
                      int anchor,
                      int xOffset,
                      int yOffset)

Creates a new image background.

Parameters:

text - the text

textStyleName - name of style of the text

color - the background color or Item.TRANSPARENT

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

paint

public void paint(int x,
                  int y,
                  int width,
                  int height,
                  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.

releaseResources

public void releaseResources()

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

Overrides:

releaseResources in class Background

hideNotify

public void hideNotify()

Description copied from class: Background

Informs the background that it is being hidden shortly. The default implementation is empty.

Overrides:

hideNotify in class Background

showNotify

public void showNotify()

Description copied from class: Background

Informs the background that it is being shown shortly or that it is now applied to a new visible item. The default implementation is empty.

Overrides:

showNotify in class Background

animate

public void animate(Screen screen,
                    Item parent,
                    long currentTime,
                    ClippingRegion repaintRegion)

Description copied from class: Background

Animates this background. Subclasses can override this method to create animations. The default implementation calls the animate() method and adds the full content area to the repaint region.

Overrides:

animate in class Background

Parameters:

screen - the parent screen

parent - the parent item, can be null when the background belongs to a screen

currentTime - the current time in milliseconds

repaintRegion - the repaint area that needs to be updated when this item is animated

See Also:

Item.addRelativeToContentRegion(ClippingRegion, int, int, int, int)

setStyle

public void setStyle(Style style)

Description copied from class: Background

Allows backgrounds to be animated using CSS attribute animations.

Overrides:

setStyle in class Background

Parameters:

style - the style containing typically only one element

setLocalization

public static void setLocalization(String original,
                                   String translation)

Specifies a translations. Use this for localizing a TextBackground.

Parameters:

original - the original text

translation - the translation