nextapp.echo
Class BackgroundImageProperties

java.lang.Object
  nextapp.echo.BackgroundImageProperties

All Implemented Interfaces:

java.io.Serializable

public class BackgroundImageProperties

extends java.lang.Object

implements java.io.Serializable

Describes a background image.

See Also:

Serialized Form

Field Summary

static java.lang.String	ATTACHMENT_CHANGED_PROPERTY
static int	ATTACHMENT_FIXED A constant for the attachment property that indicates that the background image should remain fixed and NOT scroll with content.
static int	ATTACHMENT_SCROLL A constant for the attachment property that indicates that the background image should scroll with content above it.
static java.lang.String	HORIZONTAL_POSITION_CHANGED_PROPERTY
static java.lang.String	IMAGE_CHANGED_PROPERTY
static int	NO_REPEAT A constant for the Background Image Repeat property that indicates the background image should not be repeated.
static int	PERCENT_UNITS Deprecated. Use Extent.PERCENT.
static int	PIXEL_UNITS Deprecated. Use Extent.PX.
static int	REPEAT A constant for the Background Image Repeat property that indicates the background image should be repeated both horizontally and vertically.
static java.lang.String	REPEAT_CHANGED_PROPERTY
static int	REPEAT_HORIZONTAL A constant for the Background Image Repeat property that indicates the background image should be repeated horizontally.
static int	REPEAT_VERTICAL A constant for the Background Image Repeat property that indicates the background image should be repeated vertically.
static java.lang.String	VERTICAL_POSITION_CHANGED_PROPERTY

Constructor Summary

BackgroundImageProperties(ImageReference image)
Creates a new background image properties object with the specified background image.

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Adds a property change listener.
int	getAttachment() Returns the background image attachment policy.
int	getHorizontalPosition() Returns the horizontal position of the background image.
Extent	getHorizontalPositionExtent() Returns the horizontal position of the background image as an Extent.
int	getHorizontalPositionUnits() Returns the units in which the horizontal position of the background is defined.
ImageReference	getImage() Returns the background image.
int	getRepeat() Returns the background image repetition policy.
int	getVerticalPosition() Returns the vertical position of the background image.
Extent	getVerticalPositionExtent() Returns the vertical position of the background image as an Extent.
int	getVerticalPositionUnits() Returns the units in which the vertical position of the background is defined.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Removes a property change listener.
void	setAttachment(int newValue) Sets the background image attachment policy.
void	setHorizontalPosition(int newValue) Sets the horizontal position of the background image.
void	setHorizontalPositionExtent(Extent newValue) Sets the horizontal position of the background image as an Extent
void	setHorizontalPositionUnits(int newValue) Sets the units in which the horizontal position of the background is defined.
void	setImage(ImageReference newValue) Sets the background image.
void	setRepeat(int newValue) Sets the background image repetition policy.
void	setVerticalPosition(int newValue) Sets the vertical position of the background image.
void	setVerticalPositionExtent(Extent newValue) Sets the vertical position of the background image as an Extent
void	setVerticalPositionUnits(int newValue) Sets the units in which the vertical position of the background is defined.

Methods inherited from class java.lang.Object

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

Field Detail

REPEAT

public static final int REPEAT

A constant for the Background Image Repeat property that indicates the background image should be repeated both horizontally and vertically.

See Also:

Constant Field Values

NO_REPEAT

public static final int NO_REPEAT

A constant for the Background Image Repeat property that indicates the background image should not be repeated.

See Also:

Constant Field Values

REPEAT_HORIZONTAL

public static final int REPEAT_HORIZONTAL

A constant for the Background Image Repeat property that indicates the background image should be repeated horizontally.

See Also:

Constant Field Values

REPEAT_VERTICAL

public static final int REPEAT_VERTICAL

A constant for the Background Image Repeat property that indicates the background image should be repeated vertically.

See Also:

Constant Field Values

PERCENT_UNITS

public static final int PERCENT_UNITS

Deprecated. Use Extent.PERCENT.

A constant for horizontal and vertical position units that indicates percent-based units.

See Also:

Constant Field Values

PIXEL_UNITS

public static final int PIXEL_UNITS

Deprecated. Use Extent.PX.

A constant for horizontal and vertical position units that indicates pixel-based units.

See Also:

Constant Field Values

ATTACHMENT_FIXED

public static final int ATTACHMENT_FIXED

A constant for the attachment property that indicates that the background image should remain fixed and NOT scroll with content.

See Also:

Constant Field Values

ATTACHMENT_SCROLL

public static final int ATTACHMENT_SCROLL

A constant for the attachment property that indicates that the background image should scroll with content above it.

See Also:

Constant Field Values

REPEAT_CHANGED_PROPERTY

public static final java.lang.String REPEAT_CHANGED_PROPERTY

See Also:

Constant Field Values

IMAGE_CHANGED_PROPERTY

public static final java.lang.String IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

ATTACHMENT_CHANGED_PROPERTY

public static final java.lang.String ATTACHMENT_CHANGED_PROPERTY

See Also:

Constant Field Values

HORIZONTAL_POSITION_CHANGED_PROPERTY

public static final java.lang.String HORIZONTAL_POSITION_CHANGED_PROPERTY

See Also:

Constant Field Values

VERTICAL_POSITION_CHANGED_PROPERTY

public static final java.lang.String VERTICAL_POSITION_CHANGED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

BackgroundImageProperties

public BackgroundImageProperties(ImageReference image)

Creates a new background image properties object with the specified background image.

Parameters:

image - The initial background image.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Adds a property change listener.

Parameters:

l - The listener to add.

getAttachment

public int getAttachment()

Returns the background image attachment policy.

Returns:

The background image attachment policy, one of the following values:

• ATTACHMENT_FIXED
• ATTACHMENT_SCROLL

getHorizontalPosition

public int getHorizontalPosition()

Returns the horizontal position of the background image. Generally, the Extent-based positioning methods should be used instead of this non-Extent-based positioning method.

Returns:

The horizontal position of the background image.

getHorizontalPositionExtent

public Extent getHorizontalPositionExtent()

Returns the horizontal position of the background image as an Extent.

Returns:

The horizontal position of the background image as an Extent.

getHorizontalPositionUnits

public int getHorizontalPositionUnits()

Returns the units in which the horizontal position of the background is defined. Generally, the Extent-based positioning methods should be used instead of this non-Extent-based positioning method.

Returns:

The units in which the horizontal position of the background is defined, one of the units constants defined in the Extent class.

getImage

public ImageReference getImage()

Returns the background image.

Returns:

The background image.

getRepeat

public int getRepeat()

Returns the background image repetition policy.

Returns:

The background image repetition policy, one of the following values:

• REPEAT
• REPEAT_HORIZONTAL
• REPEAT_VERTICAL
• NO_REPEAT

getVerticalPositionExtent

public Extent getVerticalPositionExtent()

Returns the vertical position of the background image as an Extent.

Returns:

The vertical position of the background image as an Extent.

getVerticalPosition

public int getVerticalPosition()

Returns the vertical position of the background image.

Returns:

The vertical position of the background image.

getVerticalPositionUnits

public int getVerticalPositionUnits()

Returns the units in which the vertical position of the background is defined.

Returns:

The units in which the vertical position of the background is defined, one of the units constants defined in the Extent class.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Removes a property change listener.

Parameters:

l - The listener to remove.

setAttachment

public void setAttachment(int newValue)

Sets the background image attachment policy.

Parameters:

newValue - The new background image attachment policy, one of the following values:

• ATTACHMENT_FIXED
• ATTACHMENT_SCROLL

setHorizontalPosition

public void setHorizontalPosition(int newValue)

Sets the horizontal position of the background image. Generally, the Extent-based positioning methods should be used instead of this non-Extent-based positioning method.

Parameters:

newValue - The new horizontal position of the background image.

setHorizontalPositionExtent

public void setHorizontalPositionExtent(Extent newValue)

Sets the horizontal position of the background image as an Extent

Parameters:

newValue - The new horizontal position of the background image.

setHorizontalPositionUnits

public void setHorizontalPositionUnits(int newValue)

Sets the units in which the horizontal position of the background is defined. Generally, the Extent-based positioning methods should be used instead of this non-Extent-based positioning method.

Parameters:

newValue - The new units in which the horizontal position of the background is defined, one of the units constants defined in the Extent class.

setImage

public void setImage(ImageReference newValue)

Sets the background image.

Parameters:

newValue - The new background image.

setRepeat

public void setRepeat(int newValue)

Sets the background image repetition policy.

Parameters:

newValue - The new background image repetition policy, one of the following values:

• REPEAT
• REPEAT_HORIZONTAL
• REPEAT_VERTICAL
• NO_REPEAT

setVerticalPosition

public void setVerticalPosition(int newValue)

Sets the vertical position of the background image. Generally, the Extent-based positioning methods should be used instead of this non-Extent-based positioning method.

Parameters:

newValue - The new vertical position of the background image.

setVerticalPositionExtent

public void setVerticalPositionExtent(Extent newValue)

Sets the vertical position of the background image as an Extent

Parameters:

newValue - The new vertical position of the background image.

setVerticalPositionUnits

public void setVerticalPositionUnits(int newValue)

Sets the units in which the vertical position of the background is defined. Generally, the Extent-based positioning methods should be used instead of this non-Extent-based positioning method.

Parameters:

newValue - The new units in which the vertical position of the background is defined, one of the units constants defined in the Extent class.