ilog.cpl.graphic.views.background
Class IlpDefaultBackgroundSupport

java.lang.Object
  ilog.cpl.graphic.views.background.IlpDefaultBackgroundSupport

All Implemented Interfaces:

IlpBackgroundSupport

Deprecated. See the Migration Guide a migration path.

public class IlpDefaultBackgroundSupport
extends Object
implements IlpBackgroundSupport

This class implements the support of background images for IlpViewsView.

Since:

JTGO 3.0

Deprecated Since:

JTGO 7.5

Constructor Summary

IlpDefaultBackgroundSupport()
Deprecated. Default constructor

Method Summary

void	addBackground(URL backgroundURL) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	addBackground(URL backgroundURL, IlpBackground background, int index) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	addBackground(URL backgroundURL, int index) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	addBackgroundListener(IlpBackgroundListener listener) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	addBackgrounds(List backgroundURLs) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	addBackgroundURL(URL backgroundURL) Deprecated. Adds a background on top of the other existing backgrounds.
void	addBackgroundURL(URL backgroundURL, IlpBackground background) Deprecated. Adds a background on top of the other existing backgrounds.
void	attach(IlpViewsView view) Deprecated. Attaches this object to a given view.
IlpBackground	createBackground(URL backgroundURL) Deprecated. Creates an IlpBackground representing the given file.
void	detach() Deprecated. Detaches this object from its current view.
IlpBackgroundFactory	getBackgroundFactory(String extension) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
IlpBackground	getBackgroundInstance(URL backgroundURL) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
IlvManagerLayer	getBackgroundLayer(URL backgroundURL) Deprecated. Returns the layer containing a background.
List	getBackgrounds() Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
String	getBackgroundTypeFactoryClassName(String extension) Deprecated. Return the background factory class name for an extension, or null if none is registered.
Collection	getBackgroundURLs() Deprecated. Returns the list of backgrounds.
IlvManager	getManager() Deprecated. Returns the IlvManager of the view.
IlvManagerView	getManagerView() Deprecated. Returns the IlvManagerView of the view.
IlpViewsView	getView() Deprecated. Returns the view.
boolean	isVisible(URL backgroundURL) Deprecated. Returns the visibility of a particular background.
void	moveBackground(URL backgroundURL, int index) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	registerBackgroundFactory(String extension, IlpBackgroundFactory factory) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	registerBackgroundType(String extension, IlpBackgroundFactory backgroundHandler) Deprecated. Registers an IlpBackgroundFactory to be responsible for all URLs that have a given file extension.
void	reload(URL backgroundURL) Deprecated. Reloads a particular background.
void	reloadAllBackgrounds() Deprecated. Reloads all backgrounds.
void	reloadBackground(URL backgroundURL) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	reloadBackgrounds() Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	removeAllBackgroundURLs() Deprecated. Removes all backgrounds.
void	removeBackground(URL backgroundURL) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
protected void	removeBackgroundLayerInternal(URL backgroundURL, IlvManagerLayer layer) Deprecated.
void	removeBackgroundListener(IlpBackgroundListener listener) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	removeBackgrounds() Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	removeBackgroundURL(URL backgroundURL) Deprecated. Removes a background.
void	setBackgroundURLs(URL[] backgroundURLs) Deprecated. Replaces the entire list of backgrounds.
void	setView(IlpViewsView view) Deprecated. Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.
void	setVisible(URL backgroundURL, boolean visible) Deprecated. Changes the visibility of a particular background.
void	unregisterBackgroundType(String extension, IlpBackgroundFactory backgroundHandler) Deprecated. Unregisters an IlpBackgroundFactory.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpDefaultBackgroundSupport

public IlpDefaultBackgroundSupport()

Deprecated.

Default constructor

Method Detail

getView

public IlpViewsView getView()

Deprecated.

Returns the view.

Specified by:

getView in interface IlpBackgroundSupport

Returns:

view the IlpViewsView that this background support is associated with.

getManager

public IlvManager getManager()

Deprecated.

Returns the IlvManager of the view.

getManagerView

public IlvManagerView getManagerView()

Deprecated.

Returns the IlvManagerView of the view.

registerBackgroundType

public void registerBackgroundType(String extension,
                                   IlpBackgroundFactory backgroundHandler)

Deprecated.

Registers an IlpBackgroundFactory to be responsible for all URLs that have a given file extension. URLs with the extensions "ivl", "ilv", "jpg", "jpeg", "png", "gif" are already handled by default.

unregisterBackgroundType

public void unregisterBackgroundType(String extension,
                                     IlpBackgroundFactory backgroundHandler)

Deprecated.

Unregisters an IlpBackgroundFactory.

getBackgroundTypeFactoryClassName

public String getBackgroundTypeFactoryClassName(String extension)

Deprecated.

Return the background factory class name for an extension, or null if none is registered.

Internal method or field: do not use!

attach

public void attach(IlpViewsView view)

Deprecated.

Attaches this object to a given view.

detach

public void detach()

Deprecated.

Detaches this object from its current view.

createBackground

public IlpBackground createBackground(URL backgroundURL)

Deprecated.

Creates an IlpBackground representing the given file. This uses the registered IlpBackgroundFactorys.

addBackgroundURL

public void addBackgroundURL(URL backgroundURL)

Deprecated.

Adds a background on top of the other existing backgrounds.

addBackgroundURL

public void addBackgroundURL(URL backgroundURL,
                             IlpBackground background)

Deprecated.

Adds a background on top of the other existing backgrounds.

removeBackgroundLayerInternal

protected void removeBackgroundLayerInternal(URL backgroundURL,
                                             IlvManagerLayer layer)

Deprecated.

Parameters:

backgroundURL -

layer -

Internal method or field: do not use!

removeBackgroundURL

public void removeBackgroundURL(URL backgroundURL)

Deprecated.

Removes a background.

removeAllBackgroundURLs

public void removeAllBackgroundURLs()

Deprecated.

Removes all backgrounds.

getBackgroundURLs

public Collection getBackgroundURLs()

Deprecated.

Returns the list of backgrounds.

Returns:

An unmodifiable collection of URLs.

setBackgroundURLs

public void setBackgroundURLs(URL[] backgroundURLs)

Deprecated.

Replaces the entire list of backgrounds.

getBackgroundLayer

public IlvManagerLayer getBackgroundLayer(URL backgroundURL)

Deprecated.

Returns the layer containing a background.

isVisible

public boolean isVisible(URL backgroundURL)

Deprecated.

Returns the visibility of a particular background.

setVisible

public void setVisible(URL backgroundURL,
                       boolean visible)

Deprecated.

Changes the visibility of a particular background.

reload

public void reload(URL backgroundURL)

Deprecated.

Reloads a particular background.

reloadAllBackgrounds

public void reloadAllBackgrounds()

Deprecated.

Reloads all backgrounds.

addBackground

public void addBackground(URL backgroundURL)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Specified by:

addBackground in interface IlpBackgroundSupport

Parameters:

backgroundURL - the URL of the background to be added

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.addBackground(java.net.URL)

Internal method or field: do not use!

getBackgrounds

public List getBackgrounds()

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Specified by:

getBackgrounds in interface IlpBackgroundSupport

Returns:

a read-only List of URL instances in the same order as they were indexed

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.getBackgrounds()

Internal method or field: do not use!

reloadBackground

public void reloadBackground(URL backgroundURL)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Specified by:

reloadBackground in interface IlpBackgroundSupport

Parameters:

backgroundURL - the URL that points to a given background.

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.reloadBackground(java.net.URL)

Internal method or field: do not use!

removeBackground

public void removeBackground(URL backgroundURL)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Specified by:

removeBackground in interface IlpBackgroundSupport

Parameters:

backgroundURL - the URL of the background of interest

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.removeBackground(java.net.URL)

Internal method or field: do not use!

setView

public void setView(IlpViewsView view)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Specified by:

setView in interface IlpBackgroundSupport

Parameters:

view - the IlpViewsView of interest.

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.setView(ilog.cpl.graphic.views.IlpViewsView)

Internal method or field: do not use!

getBackgroundFactory

public IlpBackgroundFactory getBackgroundFactory(String extension)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Should not be called as it is not supported.

Specified by:

getBackgroundFactory in interface IlpBackgroundSupport

Parameters:

extension - the extension that should specified in the form: "gif", "png"...

Returns:

the IlpBackgroundFactory registered for the given extension or null if no factory has been registered for it.

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.getBackgroundFactory(java.lang.String)

Internal method or field: do not use!

registerBackgroundFactory

public void registerBackgroundFactory(String extension,
                                      IlpBackgroundFactory factory)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Should not be called as it is not supported.

Specified by:

registerBackgroundFactory in interface IlpBackgroundSupport

Parameters:

extension - the extension that should specified in the form: "gif", "png"...

factory - the IlpBackgroundFactory to be used for the given extension or null

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.registerBackgroundFactory(java.lang.String, ilog.cpl.graph.background.IlpBackgroundFactory)

Internal method or field: do not use!

removeBackgrounds

public void removeBackgrounds()

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Specified by:

removeBackgrounds in interface IlpBackgroundSupport

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.removeBackgrounds()

Internal method or field: do not use!

addBackgrounds

public void addBackgrounds(List backgroundURLs)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Specified by:

addBackgrounds in interface IlpBackgroundSupport

Parameters:

backgroundURLs - a List of URL instances

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.addBackgrounds(java.util.List)

Internal method or field: do not use!

getBackgroundInstance

public IlpBackground getBackgroundInstance(URL backgroundURL)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Should not be called as it is not supported.

Specified by:

getBackgroundInstance in interface IlpBackgroundSupport

Parameters:

backgroundURL - the URL of interest.

Returns:

the IlpBackground instance that represents the provided URL

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.getBackgroundInstance(java.net.URL)

Internal method or field: do not use!

reloadBackgrounds

public void reloadBackgrounds()

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Specified by:

reloadBackgrounds in interface IlpBackgroundSupport

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.reloadBackgrounds()

Internal method or field: do not use!

addBackground

public void addBackground(URL backgroundURL,
                          int index)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Should not be called as it is not supported.

Specified by:

addBackground in interface IlpBackgroundSupport

Parameters:

backgroundURL - the URL of the background to be added

index - the index where to add the background

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.addBackground(java.net.URL, int)

Internal method or field: do not use!

addBackground

public void addBackground(URL backgroundURL,
                          IlpBackground background,
                          int index)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Should not be called as it is not supported.

Specified by:

addBackground in interface IlpBackgroundSupport

Parameters:

backgroundURL - the URL of the background to be added

background - the IlpBackground instance to be used

index - the index where to add the background

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.addBackground(java.net.URL, ilog.cpl.graph.background.IlpBackground, int)

Internal method or field: do not use!

addBackgroundListener

public void addBackgroundListener(IlpBackgroundListener listener)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Should not be called as it is not supported.

Specified by:

addBackgroundListener in interface IlpBackgroundSupport

Parameters:

listener - IlpBackgroundListener to be notified of changes.

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.addBackgroundListener(ilog.cpl.graph.background.event.IlpBackgroundListener)

Internal method or field: do not use!

removeBackgroundListener

public void removeBackgroundListener(IlpBackgroundListener listener)

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Should not be called as it is not supported.

Specified by:

removeBackgroundListener in interface IlpBackgroundSupport

Parameters:

listener - IlpBackgroundListener to be removed.

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.removeBackgroundListener(ilog.cpl.graph.background.event.IlpBackgroundListener)

Internal method or field: do not use!

moveBackground

public void moveBackground(URL backgroundURL,
                           int index)
                    throws IlpBackgroundHandlingException

Deprecated.

Implementation of ilog.cpl.graph.background.IlpBackgroundSupport.

Should not be called as it is not supported.

Specified by:

moveBackground in interface IlpBackgroundSupport

Parameters:

backgroundURL - the URL of the background of interest.

index - the index where the background should now be located.

Throws:

IlpBackgroundHandlingException - in case a problem occurs when moving the background.

Since:

JViews 7.5

See Also:

IlpBackgroundSupport.moveBackground(java.net.URL, int)

Internal method or field: do not use!