ilog.cpl.graph.background

Class IlpIVLBackgroundFactory

java.lang.Object

ilog.cpl.graph.background.IlpIVLBackgroundFactory

All Implemented Interfaces:

IlpBackgroundFactory

public class IlpIVLBackgroundFactory
extends Object
implements IlpBackgroundFactory

This factory creates IlpBackground implementation instances that can handle files of type IVL.

It creates the following types of IlpBackground implementations:

• IlpIVLFrameworkBackground
• IlpIVLMapBackground

This factory determines which IlpBackground implementation to create based on its creation mode property.

By default the creation mode is MAP_CREATION_MODE , which ensures that instances of IlpIVLMapBackground are created by default.

Since:

JViews 7.5

See Also:

IlpIVLFrameworkBackground, IlpIVLMapBackground

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CREATION_MODE Holds the creation mode which all IlpIVLBackgroundFactory will default to when creating implementations of the IlpBackground interface.
static String	FRAMEWORK_CREATION_MODE Creation mode that indicates that this factory will be creating IlpIVLFrameworkBackground instances.
static String	MAP_CREATION_MODE Creation mode that indicates that this factory will be creating IlpIVLMapBackground instances.

Constructor Summary

Constructors

Constructor and Description
IlpIVLBackgroundFactory() Instantiates a new background factory.

Method Summary

Modifier and Type	Method and Description
IlpBackground	createBackground(IlpViewsView view, URL backgroundURL) Creates an IlpBackground implementation for IVL files depending on the current creation mode.
String	getCreationMode() Returns the current creation mode under which this factory is operating.
void	setCreationMode(String creationMode) Sets the creation mode under which this factory is to operate.

Methods inherited from class java.lang.Object

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

Field Detail

MAP_CREATION_MODE

public static final String MAP_CREATION_MODE

Creation mode that indicates that this factory will be creating IlpIVLMapBackground instances.

See Also:

Constant Field Values

FRAMEWORK_CREATION_MODE

public static final String FRAMEWORK_CREATION_MODE

Creation mode that indicates that this factory will be creating IlpIVLFrameworkBackground instances.

See Also:

Constant Field Values

DEFAULT_CREATION_MODE

public static String DEFAULT_CREATION_MODE

Holds the creation mode which all IlpIVLBackgroundFactory will default to when creating implementations of the IlpBackground interface. By default it is the MAP_CREATION_MODE.

Constructor Detail

IlpIVLBackgroundFactory

public IlpIVLBackgroundFactory()

Instantiates a new background factory.

Method Detail

createBackground

public IlpBackground createBackground(IlpViewsView view,
                                      URL backgroundURL)
                               throws IlpBackgroundHandlingException

Creates an IlpBackground implementation for IVL files depending on the current creation mode.

Specified by:

createBackground in interface IlpBackgroundFactory

Parameters:

view - the view in which the background will be displayed.

backgroundURL - the URL of interest.

Returns:

an IlpBackground representing the given file.

Throws:

IlpBackgroundHandlingException - in case a problem occurs.

See Also:

DEFAULT_CREATION_MODE, FRAMEWORK_CREATION_MODE, MAP_CREATION_MODE

getCreationMode

public String getCreationMode()

Returns the current creation mode under which this factory is operating.

Returns:

the current creation mode under which this factory is operating.

setCreationMode

public void setCreationMode(String creationMode)

Sets the creation mode under which this factory is to operate.

Parameters:

creationMode - the creation mode under which this factory is to operate

See Also:

FRAMEWORK_CREATION_MODE, MAP_CREATION_MODE