ilog.cpl.graph.background

Class IlpImageTileBackground

java.lang.Object

ilog.cpl.graph.background.IlpAbstractBackground

ilog.cpl.graph.background.IlpImageTileBackground

All Implemented Interfaces:

IlpBackground, IlvBatchable

public class IlpImageTileBackground
extends IlpAbstractBackground

Support for using a set of image files, each representing a tile, as background.

This background type always uses load-on-demand via tiling.

The available properties are:

• property name="pattern" (required)
  A pattern that describes the file naming scheme of the images. It must contain one '%r' and one '%c' conversion specifier. The %r conversion specifier is a placeholder for the row index of the tile, and the %c conversion specifier is a placeholder the column index of the tile. The resulting filename is interpreted as an URL, relative to the XML file's URL.
• property name="rowFormat" (optional)
  A java.text.DecimalFormat description of how the row numbers are formatted before being inserted in the pattern.
• property name="colFormat" (optional)
  A java.text.DecimalFormat description of how the column numbers are formatted before being inserted in the pattern.
• property name="tileWidth" (required)
• property name="tileHeight" (required)
• property name="originX" (optional)
• property name="originY" (optional)

A property named "url" should not be given for this class.

Since:

JViews 7.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLUMN_FORMAT_PROPERTY The column format property.
static String	ORIGIN_X_PROPERTY The X origin property.
static String	ORIGIN_Y_PROPERTY The Y origin property.
static String	PATTERN_PROPERTY The pattern property.
static String	ROW_FORMAT_PROPERTY The row format property.
static String	TILE_HEIGHT_PROPERTY The tile height property.
static String	TILE_WIDTH_PROPERTY The tile width property.

Fields inherited from class ilog.cpl.graph.background.IlpAbstractBackground

managerLayers

Fields inherited from interface ilog.cpl.graph.background.IlpBackground

LOAD_ON_DEMAND_PROPERTY, THREADED_PROPERTY, URL_PROPERTY, VISIBLE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
IlpImageTileBackground() Instantiates a new background.

Method Summary

Modifier and Type	Method and Description
void	create(IlvManager manager, int index, IlpViewsView view) Loads the images using load-on-demand via tiling.
String	getColFormat() Returns the column format.
double	getOriginX() Returns the X coordinate of the tile origin.
double	getOriginY() Returns the Y coordinate of the tile origin or -1 is not set.
String	getPattern() Returns the image tile pattern.
String	getRowFormat() Returns the row format.
double	getTileHeight() Returns the tile height or -1 if not set.
double	getTileWidth() Returns the tile width or -1 if not set.
void	setColFormat(String colFormat) Sets the column format.
void	setOriginX(double x) Sets the X coordinate of the tile origin.
void	setOriginY(double y) Sets the Y coordinate of the tile origin.
void	setPattern(String pattern) Sets the image tile pattern
void	setRowFormat(String rowFormat) Sets the row format
void	setTileHeight(double height) Sets the tile height.
void	setTileWidth(double width) Sets the tile width.

Methods inherited from class ilog.cpl.graph.background.IlpAbstractBackground

addLayer, addLayers, addPropertyChangeListener, dispose, endBatch, getManagerLayer, getManagerLayers, getManagerLayersCount, getProperties, getProperty, getUrl, isLoadOnDemand, isThreaded, isVisible, removeLayer, removeLayers, removePropertyChangeListener, setLoadOnDemand, setProperty, setThreaded, setUrl, setVisible, startBatch

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN_PROPERTY

public static final String PATTERN_PROPERTY

The pattern property. It can be used to retrieve/set value of this property. It holds a string.

Setting this property causes the background to be re-generated.

See Also:

Constant Field Values

ROW_FORMAT_PROPERTY

public static final String ROW_FORMAT_PROPERTY

The row format property. It can be used to retrieve/set value of this property. It holds a String.

Setting this property causes the background to be re-generated.

See Also:

Constant Field Values

COLUMN_FORMAT_PROPERTY

public static final String COLUMN_FORMAT_PROPERTY

The column format property. It can be used to retrieve/set value of this property. It holds a String.

Setting this property causes the background to be re-generated.

See Also:

Constant Field Values

ORIGIN_X_PROPERTY

public static final String ORIGIN_X_PROPERTY

The X origin property. It can be used to retrieve/set value of this property. It holds a Double

Setting this property causes the background to be re-generated.

See Also:

Constant Field Values

ORIGIN_Y_PROPERTY

public static final String ORIGIN_Y_PROPERTY

The Y origin property. It can be used to retrieve/set value of this property. It holds a Double.

Setting this property causes the background to be re-generated.

See Also:

Constant Field Values

TILE_HEIGHT_PROPERTY

public static final String TILE_HEIGHT_PROPERTY

The tile height property. It can be used to retrieve/set value of this property. It holds a Double.

Setting this property causes the background to be re-generated.

See Also:

Constant Field Values

TILE_WIDTH_PROPERTY

public static final String TILE_WIDTH_PROPERTY

The tile width property. It can be used to retrieve/set value of this property. It holds a Double.

Setting this property causes the background to be re-generated.

See Also:

Constant Field Values

Constructor Detail

IlpImageTileBackground

public IlpImageTileBackground()

Instantiates a new background.

Method Detail

getPattern

public String getPattern()

Returns the image tile pattern.

setPattern

public void setPattern(String pattern)

Sets the image tile pattern

Parameters:

pattern - Pattern

getRowFormat

public String getRowFormat()

Returns the row format.

setRowFormat

public void setRowFormat(String rowFormat)

Sets the row format

Parameters:

rowFormat - Row format

getColFormat

public String getColFormat()

Returns the column format.

Returns:

Column format

setColFormat

public void setColFormat(String colFormat)

Sets the column format.

Parameters:

colFormat - Column format

getOriginX

public double getOriginX()

Returns the X coordinate of the tile origin.

setOriginX

public void setOriginX(double x)

Sets the X coordinate of the tile origin.

Parameters:

x - X coordinate

getOriginY

public double getOriginY()

Returns the Y coordinate of the tile origin or -1 is not set.

Returns:

Y origin coordinate

setOriginY

public void setOriginY(double y)

Sets the Y coordinate of the tile origin.

Parameters:

y - Y coordinate

getTileWidth

public double getTileWidth()

Returns the tile width or -1 if not set.

Returns:

Tile width

setTileWidth

public void setTileWidth(double width)

Sets the tile width.

Parameters:

width - Width

getTileHeight

public double getTileHeight()

Returns the tile height or -1 if not set.

Returns:

Tile height

setTileHeight

public void setTileHeight(double height)

Sets the tile height.

Parameters:

height - Height

create

public void create(IlvManager manager,
                   int index,
                   IlpViewsView view)
            throws IlpBackgroundHandlingException

Loads the images using load-on-demand via tiling.

Specified by:

create in interface IlpBackground

Overrides:

create in class IlpAbstractBackground

Parameters:

manager - the manager where the graphics should be added to

index - the IlvManagerLayer index in the manager from which this background should start inserting the graphics.

view - the associated IlpViewsView

Throws:

IlpBackgroundHandlingException - in case there is a problem handling this operation.

See Also:

IlpAbstractBackground.create(ilog.views.IlvManager, int, ilog.cpl.graphic.views.IlpViewsView)