ilog.cpl.graph.background

Class IlpImageBackground

java.lang.Object

ilog.cpl.graph.background.IlpAbstractBackground

ilog.cpl.graph.background.IlpAbstractMapDataSourceBackground

ilog.cpl.graph.background.IlpImageBackground

All Implemented Interfaces:

IlpBackground, IlpMapDataSourceBackground, IlvBatchable

public class IlpImageBackground
extends IlpAbstractMapDataSourceBackground

Support for using an image file as background.

Since:

JViews 7.5

Field Summary

Fields

Modifier and Type	Field and Description
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
IlpImageBackground() Defines the default values for properties defined in this background type.

Method Summary

Modifier and Type	Method and Description
IlvMapDataSource	createMapDataSource(IlpViewsView view) Creates an ilog.views.maps.datasource.IlvMapDataSource that can handle the supported raster formats.
protected IlvMapStyle	createMapStyle() If no style is already being defined in the IlvMapDataSource, it by default creates an IlvRasterStyle.
protected IlvFeatureRenderer	createRenderer(IlpViewsView view, URL backgroundURL, IlvMapFeatureIterator featureIterator) Creates a renderer for the attributes of the map.
int	getTileHeight() Returns the tile height for this background.
int	getTileWidth() Returns the tile width for this background.
void	setTileHeight(int tileHeight) Sets the tile height for this background.
void	setTileWidth(int tileWidth) Sets the tile width for this background.

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

create, createRenderer, customizeMapStyle, dispose, getMapDataSource, getMapStyle

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

addLayer, addLayers, addPropertyChangeListener, 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

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

addPropertyChangeListener, getManagerLayer, getManagerLayers, getManagerLayersCount, getProperty, removePropertyChangeListener, setProperty

Field Detail

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 an Integer.

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 an Integer.

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

See Also:

Constant Field Values

Constructor Detail

IlpImageBackground

public IlpImageBackground()

Defines the default values for properties defined in this background type.

Method Detail

createMapDataSource

public IlvMapDataSource createMapDataSource(IlpViewsView view)
                                     throws IlpBackgroundHandlingException

Creates an ilog.views.maps.datasource.IlvMapDataSource that can handle the supported raster formats.

Parameters:

view - the IlpViewsView being used

Returns:

an IlvMapDataSource

Throws:

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

See Also:

IlpMapDataSourceBackground.createMapDataSource(ilog.cpl.graphic.views.IlpViewsView)

createRenderer

protected IlvFeatureRenderer createRenderer(IlpViewsView view,
                                            URL backgroundURL,
                                            IlvMapFeatureIterator featureIterator)

Creates a renderer for the attributes of the map.

createMapStyle

protected IlvMapStyle createMapStyle()
                              throws IlpBackgroundHandlingException

If no style is already being defined in the IlvMapDataSource, it by default creates an IlvRasterStyle.

Overrides:

createMapStyle in class IlpAbstractMapDataSourceBackground

Returns:

the ilog.views.maps.graphic.style.IlvMapStyle to be used by this background's ilog.views.maps.datasource.IlvMapDataSource.

Throws:

IlpBackgroundHandlingException - if a problem occurs.

See Also:

IlpAbstractMapDataSourceBackground.createMapStyle()

getTileHeight

public int getTileHeight()

Returns the tile height for this background.

Returns:

the tile height or -1 if this property has not been set.

getTileWidth

public int getTileWidth()

Returns the tile width for this background.

Returns:

the tile width or -1 if this property has not been set.

setTileWidth

public void setTileWidth(int tileWidth)

Sets the tile width for this background.

Parameters:

tileWidth - the tile width.

setTileHeight

public void setTileHeight(int tileHeight)

Sets the tile height for this background.

Parameters:

tileHeight - the tile height.