oracle.dss.util.dimensionList
Class DimensionListEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.dss.util.dimensionList.DimensionListEvent

All Implemented Interfaces:

java.io.Serializable

public class DimensionListEvent

extends java.util.EventObject

Contains information about DimensionList events.

See Also:

Serialized Form

Field Summary

static int	DIM_LISTCHANGED The dimension has changed in the model.
static int	DIM_LISTCLEARED One or more items in the dimension list that were selected have been deselected.
static int	DIM_LISTCLEARING One or more items in the dimension list that are selected are about to be deselected.
static int	DIM_LISTCOLLAPSED The dimension list has been collapsed.
static int	DIM_LISTCOLLAPSING The dimension list is about to be collapsed.
static int	DIM_LISTDRAGCANCEL A dragging operation has been canceled.
static int	DIM_LISTDRAGEND One or more items in the dimension list have been dragged.
static int	DIM_LISTDRAGSTART One or more items in the dimension list are about to be dragged.
static int	DIM_LISTDRILLED The dimension list has been drilled.
static int	DIM_LISTDRILLING The dimension list is about to be drilled.
static int	DIM_LISTEXPANDED The dimension list has been expanded.
static int	DIM_LISTEXPANDING The dimension list is about to be expanded.
static int	DIM_LISTPREFIXICONSELECTED The prefix icon has been selected.
static int	DIM_LISTPREFIXICONSELECTING The prefix icon is about to be selected.
static int	DIM_LISTSELECTED One or more items in the dimension list have been selected.
static int	DIM_LISTSELECTING One or more items in the dimension list are about to be selected.

Constructor Summary

DimensionListEvent(java.lang.Object source)
Constructor that specifies the object that created this event.

DimensionListEvent(java.lang.Object source, int id)
Constructor that specifies the object that created this event and the identifier for this event.

DimensionListEvent(java.lang.Object source, int id, int index)
Constructor that specifies the object that created this event, the identifier for this event, and the item's index.

DimensionListEvent(java.lang.Object source, int id, int index, java.lang.Object o)
Constructor that specifies the object that created this event, the identifier for this event, the item's index, and the data source object.

DimensionListEvent(java.lang.Object source, int id, long iStart, long iEnd, java.lang.Object o)
Constructor that specifies arguments for an item that is dragged and the position that it is dropped in.

DimensionListEvent(java.lang.Object source, int id, long iStart, java.lang.Object o)
Constructor that specifies arguments for an item that is dragged.

Method Summary

void	consume() Consumes this event.
java.lang.Object	getDataModel() Retrieves the data model object for this event.
long	getEndIndex() Retrieves the index of the position where the item was dropped or will be dropped.
int	getId() Retrieves the identifier for this event.
int	getIndex() Retrieves the index of the item in the model.
long	getStartIndex() Retrieves the index of the item that is being dragged or was dragged.
boolean	isConsumed() Indicates whether this event has been consumed.
void	setDataModel(java.lang.Object o) Specifies the data model object for this event.
void	setEndIndex(long endIndex) Specifies the index of the position where the item will be dropped.
void	setIndex(int index) Specifies the index of the item in the model.
void	setStartIndex(long startIndex) Specifies the index of the item that will be dragged.
java.lang.String	toString(int id) Retrieves a String representation of the information about the event, such as the identifier of the event, the index of the item that fired the event, the index of the position where the event started, the index of the position where the event ended, and whether the event has been consumed.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DIM_LISTCHANGED

public static final int DIM_LISTCHANGED

The dimension has changed in the model.

DIM_LISTCOLLAPSING

public static final int DIM_LISTCOLLAPSING

The dimension list is about to be collapsed.

DIM_LISTCOLLAPSED

public static final int DIM_LISTCOLLAPSED

The dimension list has been collapsed.

DIM_LISTEXPANDING

public static final int DIM_LISTEXPANDING

The dimension list is about to be expanded.

DIM_LISTEXPANDED

public static final int DIM_LISTEXPANDED

The dimension list has been expanded.

DIM_LISTDRILLING

public static final int DIM_LISTDRILLING

The dimension list is about to be drilled.

DIM_LISTDRILLED

public static final int DIM_LISTDRILLED

The dimension list has been drilled.

DIM_LISTCLEARING

public static final int DIM_LISTCLEARING

One or more items in the dimension list that are selected are about to be deselected.

DIM_LISTCLEARED

public static final int DIM_LISTCLEARED

One or more items in the dimension list that were selected have been deselected.

DIM_LISTSELECTING

public static final int DIM_LISTSELECTING

One or more items in the dimension list are about to be selected.

DIM_LISTSELECTED

public static final int DIM_LISTSELECTED

One or more items in the dimension list have been selected.

DIM_LISTDRAGSTART

public static final int DIM_LISTDRAGSTART

One or more items in the dimension list are about to be dragged.

DIM_LISTDRAGEND

public static final int DIM_LISTDRAGEND

One or more items in the dimension list have been dragged.

DIM_LISTDRAGCANCEL

public static final int DIM_LISTDRAGCANCEL

A dragging operation has been canceled.

DIM_LISTPREFIXICONSELECTING

public static final int DIM_LISTPREFIXICONSELECTING

The prefix icon is about to be selected.

DIM_LISTPREFIXICONSELECTED

public static final int DIM_LISTPREFIXICONSELECTED

The prefix icon has been selected.

Constructor Detail

DimensionListEvent

public DimensionListEvent(java.lang.Object source)

Constructor that specifies the object that created this event.

Parameters:

source - The object that created this event.

DimensionListEvent

public DimensionListEvent(java.lang.Object source,
                          int id)

Constructor that specifies the object that created this event and the identifier for this event.

Parameters:

source - The object that created this event.

id - The identifier for this event.

DimensionListEvent

public DimensionListEvent(java.lang.Object source,
                          int id,
                          int index)

Constructor that specifies the object that created this event, the identifier for this event, and the item's index.

Parameters:

source - The object that created this event.

id - The identifier for this event.

index - The index of the list item in the model.

DimensionListEvent

public DimensionListEvent(java.lang.Object source,
                          int id,
                          int index,
                          java.lang.Object o)

Constructor that specifies the object that created this event, the identifier for this event, the item's index, and the data source object.

Parameters:

source - The object that created this event.

id - The identifier for this event.

index - The index of the list item in the model.

o - The data source object.

DimensionListEvent

public DimensionListEvent(java.lang.Object source,
                          int id,
                          long iStart,
                          java.lang.Object o)

Constructor that specifies arguments for an item that is dragged.

Parameters:

source - The object that created this event.

id - The identifier for this event.

iStart - The index of the item in the model. This is the item that is being dragged or was dragged.

o - The data source object.

DimensionListEvent

public DimensionListEvent(java.lang.Object source,
                          int id,
                          long iStart,
                          long iEnd,
                          java.lang.Object o)

Constructor that specifies arguments for an item that is dragged and the position that it is dropped in.

Parameters:

source - The object that created this event.

id - The identifier for this event.

iStart - The index of the item in the model. This is the item that is being dragged or was dragged.

iEnd - The index of the position in the model where the item has been dropped.

o - The data source object.

Method Detail

getId

public int getId()

Retrieves the identifier for this event.

Returns:

The identifier for this event.

getIndex

public int getIndex()

Retrieves the index of the item in the model.

Returns:

The index of the item in the model.

setIndex

public void setIndex(int index)

Specifies the index of the item in the model.

Parameters:

index - The index of the item in the model.

getStartIndex

public long getStartIndex()

Retrieves the index of the item that is being dragged or was dragged. This is the index of the item in the model.

Returns:

The index of the item that is being dragged or was dragged.

setStartIndex

public void setStartIndex(long startIndex)

Specifies the index of the item that will be dragged. This is the index of the item in the model.

Parameters:

index - The index of the item that will be dragged.

getEndIndex

public long getEndIndex()

Retrieves the index of the position where the item was dropped or will be dropped. This is the index of the position in the model.

Returns:

The index of the position where the item was dropped or will be dropped.

setEndIndex

public void setEndIndex(long endIndex)

Specifies the index of the position where the item will be dropped. This is the index of the position in the model.

Parameters:

index - The index of the position where the item was dropped or will be dropped.

getDataModel

public java.lang.Object getDataModel()

Retrieves the data model object for this event.

Returns:

The data model object for this event.

setDataModel

public void setDataModel(java.lang.Object o)

Specifies the data model object for this event.

Parameters:

o - The data model object for this event.

isConsumed

public boolean isConsumed()

Indicates whether this event has been consumed. If this event has been consumed, then any processing of this event should be stopped.

Returns:

true if this event has been consumed, false if it has not.

consume

public void consume()

Consumes this event.

When an event has been consumed, any processing of this event should be stopped.

toString

public java.lang.String toString(int id)

Retrieves a String representation of the information about the event, such as the identifier of the event, the index of the item that fired the event, the index of the position where the event started, the index of the position where the event ended, and whether the event has been consumed.

Parameters:

int - The identifier of the event whose information you want to have.

Returns:

The String representation of the information about the event.