oracle.dss.util.dimensionList
Class DimensionComboEvent

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

All Implemented Interfaces:

java.io.Serializable

public class DimensionComboEvent

extends java.util.EventObject

Contains information about DimensionCombo events.

See Also:

DimensionCombo, Serialized Form

Field Summary

static int	DIM_LISTCHANGED The dimension list has changed in some way.
static int	DIM_LISTSELECTED One or more items have been selected in the drop-down list of the DimensionCombo.
static int	DIM_LISTSELECTING One or more items are about to be selected in the drop-down list of the DimensionCombo.

Constructor Summary

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

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

DimensionComboEvent(java.lang.Object source, int id, int index)
Constructor that specifies the object that created this event, the identifier for this event, and the index of the item in the model.

DimensionComboEvent(java.lang.Object source, int id, int index, java.lang.Object o)
Constructor that specifies all arguments.

Method Summary

void	consume() Consumes this event.
java.lang.Object	getDataModel() Retrieves the data model for this data source.
int	getID() Retrieves the identifier for this event.
int	getIndex() Retrieves the index of the list item in the model.
boolean	isConsumed() Indicates whether this event has been consumed.
void	setDataModel(java.lang.Object o) Specifies the data model for this data source.
void	setIndex(int index) Specifies the index of the list item in the model.
java.lang.String	toString() Retrieves a String representation of the information about the event, such as the identifier of the event, the index of the item that caused the event, and whether the event has been consumed.

Methods inherited from class java.util.EventObject

getSource

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 list has changed in some way.

DIM_LISTSELECTING

public static final int DIM_LISTSELECTING

One or more items are about to be selected in the drop-down list of the DimensionCombo.

DIM_LISTSELECTED

public static final int DIM_LISTSELECTED

One or more items have been selected in the drop-down list of the DimensionCombo.

Constructor Detail

DimensionComboEvent

public DimensionComboEvent(java.lang.Object source)

Constructor that specifies the object that created this event.

Parameters:

source - The object that created this event.

DimensionComboEvent

public DimensionComboEvent(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.

DimensionComboEvent

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

Constructor that specifies the object that created this event, the identifier for this event, and the index of the item in the model.

Parameters:

source - The object that created this event.

id - The identifier for this event.

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

DimensionComboEvent

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

Constructor that specifies all arguments.

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 model 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 list item in the model.

Returns:

The index of the list item in the model.

setIndex

public void setIndex(int index)

Specifies the index of the list item in the model.

Parameters:

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

getDataModel

public java.lang.Object getDataModel()

Retrieves the data model for this data source.

Returns:

The data model for this data source.

setDataModel

public void setDataModel(java.lang.Object o)

Specifies the data model for this data source.

Parameters:

o - The data model for this data source.

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, then any processing of this event should be stopped.

toString

public java.lang.String toString()

Retrieves a String representation of the information about the event, such as the identifier of the event, the index of the item that caused the event, and whether the event has been consumed.

Overrides:

toString in class java.util.EventObject

Returns:

The String representation of the information about the event.