ilog.cpl.graph.background
Class IlpIVLMapBackground

java.lang.Object
  ilog.cpl.graph.background.IlpAbstractBackground
      ilog.cpl.graph.background.IlpAbstractIVLBackground
          ilog.cpl.graph.background.IlpIVLMapBackground

All Implemented Interfaces:

IlpBackground, IlvBatchable

public class IlpIVLMapBackground
extends IlpAbstractIVLBackground

This type of background allows one to integrate backgrounds described in the ILOG JViews IVL file format that contain JViews Maps content as a background in JViews TGO.

It allows IVL files that were exported from JViews Maps' Map Builder that contain Map Themes to be used within JViews TGO.

For more details of Map Themes see the following section of the JViews TGO User Manual:

Graphic Components > Network Component > Network Component Services > Background Support

Note:

Although not encouraged, one can use this background to load JViews Framework IVL files, as this IlpAbstractIVLBackground does support loading JViews Framework IVL files. Keep in mind though, that loading JViews Framework IVL files using the IlpIVLFrameworkBackground is more efficient.

Since:

JViews 7.5

See Also:

IlpAbstractIVLBackground, IlpIVLFrameworkBackground

Field Summary

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

MAP_THEMED_PROPERTY, numberOfPaddingLayers

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

IlpIVLMapBackground()
Sets the default property values.

Method Summary

void	create(IlvManager manager, int index, IlpViewsView view) Populates the IlvManager with the contents of the background file at the specified index.
void	dispose(IlvManager manager, IlpViewsView view) Calls the super implementation and then disposes of any potential Map Theme settings.

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

addManagerLayer, isMapThemed, removeManagerLayer, setMapThemed

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

Constructor Detail

IlpIVLMapBackground

public IlpIVLMapBackground()

Sets the default property values.

Method Detail

create

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

Populates the IlvManager with the contents of the background file at the specified index.

Specified by:

create in interface IlpBackground

Overrides:

create in class IlpAbstractIVLBackground

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)

dispose

public void dispose(IlvManager manager,
                    IlpViewsView view)
             throws IlpBackgroundHandlingException

Calls the super implementation and then disposes of any potential Map Theme settings.

Specified by:

dispose in interface IlpBackground

Overrides:

dispose in class IlpAbstractIVLBackground

Parameters:

manager - the manager where the graphics are being displayed.

view - the associated IlpViewsView

Throws:

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

Since:

JViews 7.5

See Also:

IlpAbstractBackground.dispose(ilog.views.IlvManager, ilog.cpl.graphic.views.IlpViewsView)