ilog.cpl.graph.background.event

Class IlpBackgroundEvent

java.lang.Object

java.util.EventObject

ilog.util.IlEventObject

ilog.cpl.graph.background.event.IlpBackgroundEvent

All Implemented Interfaces:

Serializable

public class IlpBackgroundEvent
extends IlEventObject

Represents events related to changes in the state of an IlpBackgroundSupport's list of backgrounds. For example, when backgrounds are added, removed, moved or reloaded.

Since:

JViews 7.5

See Also:

IlpBackgroundListener, IlpBackgroundSupport, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlpBackgroundEvent.Type Provides the predefined IlpBackgroundEvent event types.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
IlpBackgroundEvent(Object source, IlEventType type, IlpBackground background, int index, URL url) Instantiates a new background event.

Method Summary

Modifier and Type	Method and Description
IlpBackground	getBackground() Returns the target IlpBackground instance.
int	getIndex() Returns the index of the target IlpBackground instance.
URL	getUrl() Returns the URL of the target IlpBackground instance.

Methods inherited from class ilog.util.IlEventObject

getType

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpBackgroundEvent

public IlpBackgroundEvent(Object source,
                          IlEventType type,
                          IlpBackground background,
                          int index,
                          URL url)

Instantiates a new background event.

Parameters:

source - The event source

type - The event type

background - The target background

index - The target background index

url - The target background URL

Method Detail

getIndex

public int getIndex()

Returns the index of the target IlpBackground instance.

Returns:

the index of the background.

In case this is an IlpBackgroundEvent.Type.BackgroundAdded the returned value is the insertion index.

In case, this is an IlpBackgroundEvent.Type.BackgroundRemoved the index is the index of where background used to be at.

In case this is an IlpBackgroundEvent.Type.BackgroundReloaded the returned value is the index where background is currently at.

In case this is an IlpBackgroundEvent.Type.BackgroundMoved the returned value is the index where background was moved to.

getUrl

public URL getUrl()

Returns the URL of the target IlpBackground instance.

Returns:

the URL of the target IlpBackground instance.

getBackground

public IlpBackground getBackground()

Returns the target IlpBackground instance.

Returns:

the target IlpBackground instance.