oracle.dss.dataSource.common
Class LayoutChangingEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.dss.dataSource.common.QueryEvent
              |
              +--oracle.dss.dataSource.common.LayoutEvent
                    |
                    +--oracle.dss.dataSource.common.LayoutChangingEvent

All Implemented Interfaces:

java.lang.Cloneable, Consumable, java.io.Serializable

public class LayoutChangingEvent

extends LayoutEvent

implements Consumable

Informs listeners when the layout of the Query object is about to change. A listener has the option to veto the change by calling the consume method of this event. If a listener vetoes the operation, then subsequent listeners are not notified and the operation is cancelled (that is, the operation is not added to the pending operation queue).

See Also:

Serialized Form

Constructor Summary

LayoutChangingEvent(java.lang.Object source, int sourceedge, int targetedge)
Constructor to use for an edge swap.

LayoutChangingEvent(java.lang.Object source, java.lang.String[][] dimensions)
Constructor to use if the affected dimension names are available from the original call that is about to change the layout.

LayoutChangingEvent(java.lang.Object source, java.lang.String sourcedim, java.lang.String targetdim)
Constructor to use for a swap or pivot of specific dimensions.

LayoutChangingEvent(java.lang.Object source, java.lang.String sourcedim, java.lang.String targetdim, int flags)
Constructor to use to specify the kind of pivot.

Method Summary

void	consume() Consumes this event.
boolean	isConsumed() Indicates whether this event was consumed.

Methods inherited from class oracle.dss.dataSource.common.LayoutEvent

getDimensions, getFlags, getSourceDimension, getTargetDimension, isEdgeDirty

Methods inherited from class oracle.dss.dataSource.common.QueryEvent

clone

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutChangingEvent

public LayoutChangingEvent(java.lang.Object source,
                           java.lang.String[][] dimensions)

Constructor to use if the affected dimension names are available from the original call that is about to change the layout.

Parameters:

source - The source of the event, that is, a reference to the object that fired the event.

dimensions - The names of the dimensions that are affected by the call that will change the layout.

LayoutChangingEvent

public LayoutChangingEvent(java.lang.Object source,
                           java.lang.String sourcedim,
                           java.lang.String targetdim,
                           int flags)

Constructor to use to specify the kind of pivot.

Parameters:

source - The source of the event, that is, a reference to the object that fired the event.

sourcedim - The name of the source dimension for a pivot or swap.

targetdim - The name of the target dimension for a pivot or swap.

flags - A constant that indicates the type of pivot. Use either PivotConstants.PIVOT_AFTER or PivotConstants.PIVOT_BEFORE.

See Also:

PivotConstants.PIVOT_AFTER, PivotConstants.PIVOT_BEFORE

LayoutChangingEvent

public LayoutChangingEvent(java.lang.Object source,
                           java.lang.String sourcedim,
                           java.lang.String targetdim)

Constructor to use for a swap or pivot of specific dimensions.

Parameters:

source - The source of the event, that is, a reference to the object that fired the event.

sourcedim - The name of the source dimension for a pivot or swap.

targetdim - The name of the target dimension for a pivot or swap.

LayoutChangingEvent

public LayoutChangingEvent(java.lang.Object source,
                           int sourceedge,
                           int targetedge)

Constructor to use for an edge swap.

Parameters:

source - The source of the event, that is, a reference to the object that fired the event.

sourceedge - A constant (DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE) that represents the source edge for an edge swap.

targetedge - A constant (DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE) that represents the target edge for an edge swap.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

Method Detail

consume

public void consume()

Consumes this event.

Specified by:

consume in interface Consumable

Overrides:

consume in class QueryEvent

isConsumed

public boolean isConsumed()

Indicates whether this event was consumed.

Specified by:

isConsumed in interface Consumable

Overrides:

isConsumed in class QueryEvent

Returns:

true if consumed, false if not.