com.xmlmind.xmledit.styled

Class BackgroundImage

java.lang.Object

com.xmlmind.xmledit.styled.BackgroundImage

All Implemented Interfaces:

BackgroundPaint, Cloneable

public final class BackgroundImage
extends Object
implements BackgroundPaint, Cloneable

Represents the background-image, background-repeat, background-position CSS properties.

Int values are in screen pixels, that is, the display scaling is already taken into account.

See Also:

CSS2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackgroundImage.Repeat Specifies how the image is to be repeated.

Field Summary

Fields

Modifier and Type	Field and Description
Image	image Corresponds to CSS property background-image.
String	imageSpec Used to identify the background image.
BackgroundImage.Repeat	repeat Specifies how the image is to be repeated.
boolean	xPercent If true, xPos is a percentage and not a length in pixels.
int	xPos The horizontal position of the image in pixels or in percent.
boolean	yPercent If true, yPos is a percentage and not a length in pixels.
int	yPos The vertical position of the image in pixels or in percent.

Constructor Summary

Constructors

Constructor and Description
BackgroundImage(Image image, String imageSpec, int xPos, boolean xPercent, int yPos, boolean yPercent, BackgroundImage.Repeat repeat)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Paint	getPaint(int width, int height) Returns the color pattern used to paint the background of a box.
int	hashCode()
void	paint(Graphics g, int width, int height, int clipX, int clipY, int clipW, int clipH) Paint the background of a box.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

image

public final Image image

Corresponds to CSS property background-image. May not be null.

imageSpec

public final String imageSpec

Used to identify the background image. For example, it could be the URI of the image. May be null if unknown.

xPos

public final int xPos

The horizontal position of the image in pixels or in percent. Corresponds to CSS property background-position.

See Also:

xPercent

xPercent

public final boolean xPercent

If true, xPos is a percentage and not a length in pixels.

yPos

public final int yPos

The vertical position of the image in pixels or in percent. Corresponds to CSS property background-position.

yPercent

public final boolean yPercent

If true, yPos is a percentage and not a length in pixels.

See Also:

yPercent

repeat

public BackgroundImage.Repeat repeat

Specifies how the image is to be repeated. Corresponds to CSS property background-repeat.

Constructor Detail

BackgroundImage

public BackgroundImage(Image image,
                       String imageSpec,
                       int xPos,
                       boolean xPercent,
                       int yPos,
                       boolean yPercent,
                       BackgroundImage.Repeat repeat)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getPaint

public Paint getPaint(int width,
                      int height)

Description copied from interface: BackgroundPaint

Returns the color pattern used to paint the background of a box.

Specified by:

getPaint in interface BackgroundPaint

Parameters:

width - the width of the box

height - the height of the box

Returns:

the color pattern or null if this color pattern cannot be created.

paint

public void paint(Graphics g,
                  int width,
                  int height,
                  int clipX,
                  int clipY,
                  int clipW,
                  int clipH)

Paint the background of a box.

Parameters:

g - the graphics used to paint

width - the width of the box

height - the height of the box

clipX - the X coordinate of the origin of the clip rectangle set in g

clipY - the Y coordinate of the origin of the clip rectangle set in g

clipW - the width of the clip rectangle set in g

clipH - the height of the clip rectangle set in g