ilog.cpl.graphic.views.background

Class IlpImageTileBackground

java.lang.Object

ilog.cpl.graphic.views.background.IlpImageTileBackground

All Implemented Interfaces:

IlpBackground

Deprecated.

See the Migration Guide a migration path.

@Deprecated
public class IlpImageTileBackground
extends Object
implements IlpBackground

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

This background type ignores load-on-demand hints and always uses load-on-demand.

The XML settable 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:

JTGO 3.0

Deprecated Since:

JTGO 7.5

Field Summary

Fields

Modifier and Type	Field and Description
protected String	colFormat Deprecated.
protected String	fullPattern Deprecated.
protected double	originX Deprecated.
protected double	originY Deprecated.
protected String	pattern Deprecated.
protected String	rowFormat Deprecated.
protected double	tileHeight Deprecated.
protected double	tileWidth Deprecated.

Constructor Summary

Constructors

Constructor and Description
IlpImageTileBackground() Deprecated.

Method Summary

Modifier and Type	Method and Description
IlvManagerLayer	createLayer(IlpViewsView view, URL XMLfileURL) Deprecated. Creates an empty IlvManagerLayer suitable for an image file.
void	fillLayer(IlpViewsView view, URL XMLfileURL, IlvManagerLayer layer) Deprecated. Fills a layer with an image file.
String	getColFormat() Deprecated. Returns the column format.
double	getOriginX() Deprecated. Returns the X coordinate of the tile origin.
double	getOriginY() Deprecated. Returns the Y coordinate of the tile origin.
String	getPattern() Deprecated. Returns the image tile pattern.
String	getRowFormat() Deprecated. Returns the row format.
double	getTileHeight() Deprecated. Returns the tile height.
double	getTileWidth() Deprecated. Returns the tile width.
void	setColFormat(String colFormat) Deprecated. Sets the column format.
void	setOriginX(double x) Deprecated. Sets the X coordinate of the tile origin.
void	setOriginY(double y) Deprecated. Sets the Y coordinate of the tile origin.
void	setPattern(String pattern) Deprecated. Sets the image tile pattern
void	setRowFormat(String rowFormat) Deprecated. Sets the row format
void	setTileHeight(double height) Deprecated. Sets the tile height.
void	setTileWidth(double width) Deprecated. Sets the tile width.

Methods inherited from class java.lang.Object

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

Field Detail

pattern

protected String pattern

Deprecated.

Internal: do not use!

rowFormat

protected String rowFormat

Deprecated.

Internal: do not use!

colFormat

protected String colFormat

Deprecated.

Internal: do not use!

originX

protected double originX

Deprecated.

Internal: do not use!

originY

protected double originY

Deprecated.

Internal: do not use!

tileWidth

protected double tileWidth

Deprecated.

Internal: do not use!

tileHeight

protected double tileHeight

Deprecated.

Internal: do not use!

fullPattern

protected String fullPattern

Deprecated.

Internal: do not use!

Constructor Detail

IlpImageTileBackground

public IlpImageTileBackground()

Deprecated.

Method Detail

getPattern

public String getPattern()

Deprecated.

Returns the image tile pattern.

setPattern

public void setPattern(String pattern)

Deprecated.

Sets the image tile pattern

Parameters:

pattern - Pattern

getRowFormat

public String getRowFormat()

Deprecated.

Returns the row format.

setRowFormat

public void setRowFormat(String rowFormat)

Deprecated.

Sets the row format

Parameters:

rowFormat - Row format

getColFormat

public String getColFormat()

Deprecated.

Returns the column format.

Returns:

Column format

setColFormat

public void setColFormat(String colFormat)

Deprecated.

Sets the column format.

Parameters:

colFormat - Column format

getOriginX

public double getOriginX()

Deprecated.

Returns the X coordinate of the tile origin.

setOriginX

public void setOriginX(double x)

Deprecated.

Sets the X coordinate of the tile origin.

Parameters:

x - X coordinate

getOriginY

public double getOriginY()

Deprecated.

Returns the Y coordinate of the tile origin.

Returns:

Y origin coordinate

setOriginY

public void setOriginY(double y)

Deprecated.

Sets the Y coordinate of the tile origin.

Parameters:

y - Y coordinate

getTileWidth

public double getTileWidth()

Deprecated.

Returns the tile width.

Returns:

Tile width

setTileWidth

public void setTileWidth(double width)

Deprecated.

Sets the tile width.

Parameters:

width - Width

getTileHeight

public double getTileHeight()

Deprecated.

Returns the tile height.

Returns:

Tile height

setTileHeight

public void setTileHeight(double height)

Deprecated.

Sets the tile height.

Parameters:

height - Height

createLayer

public IlvManagerLayer createLayer(IlpViewsView view,
                                   URL XMLfileURL)

Deprecated.

Creates an empty IlvManagerLayer suitable for an image file.

Specified by:

createLayer in interface IlpBackground

fillLayer

public void fillLayer(IlpViewsView view,
                      URL XMLfileURL,
                      IlvManagerLayer layer)

Deprecated.

Fills a layer with an image file.

Specified by:

fillLayer in interface IlpBackground

Parameters:

view - The view where the background will be displayed.

XMLfileURL - The background information.

layer - A layer that has already been added to the IlvGrapher.