Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.util.gui.layout
Class LayoutPivotingEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.dss.util.gui.layout.LayoutPivotingEvent
All Implemented Interfaces:
java.io.Serializable

public class LayoutPivotingEvent
extends java.util.EventObject

Information about an impending pivot operation to a LayoutAccess. The layout panels send this event to all registered LayoutPivotingListener implementations before the pivoting occurs in the Layout panel. The listeners can consume the event, thus stopping the pivot change.

See Also:
LayoutPivotingListener, Layout, LayoutAccess, Serialized Form

Constructor Summary
LayoutPivotingEvent(java.lang.Object source, int fromEdge, int toEdge, int fromLayer, int toLayer, boolean isSwap)
          Constructor.

 

Method Summary
 void consume()
          Consumes the event.
 int getDestinationEdge()
          Retrieves the edge to which the pivot will occur.
 int getDestinationLayer()
          Retrieves the layer that is being pivoted, on the destination edge.
 int getSourceEdge()
          Retrieves the edge from which the pivot will occur.
 int getSourceLayer()
          Retrieves the layer that is being pivoted, on the source edge.
 boolean isConsumed()
          Indicates whether the event was consumed by any registered LayoutPivotListener.
 boolean isSwap()
          Indicates whether the pivot is a swap or a move.

 

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

LayoutPivotingEvent

public LayoutPivotingEvent(java.lang.Object source,
                           int fromEdge,
                           int toEdge,
                           int fromLayer,
                           int toLayer,
                           boolean isSwap)
Constructor.
Parameters:
fromEdge - A constant that indicates the edge from which a layer will be pivoted. Valid constants end with _EDGE in oracle.dss.util.DataDirector interface.
toEdge - A constant that indicates the edge to which a layer will be pivoted. Valid constants end with _EDGE in oracle.dss.util.DataDirector interface.
fromLayer - The zero-based index of the physical layer on the fromEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object will report columns as its layers.
toLayer - The zero-based index of the physical layer on the toEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object reports columns as its layers.
isSwap - Indicates whether pivot is a swap or a move.
See Also:
DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, DataDirector.DATA_ELEMENT_EDGE
Method Detail

getSourceEdge

public int getSourceEdge()
Retrieves the edge from which the pivot will occur.
Returns:
A constant that indicates the edge from which a layer will be pivoted. Valid constants are listed in the See Also section.
See Also:
DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, DataDirector.DATA_ELEMENT_EDGE

getDestinationEdge

public int getDestinationEdge()
Retrieves the edge to which the pivot will occur.
Returns:
A constant that indicates the edge to which a layer will be pivoted. Valid constants are listed in the See Also section.
See Also:
DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, DataDirector.DATA_ELEMENT_EDGE

getSourceLayer

public int getSourceLayer()
Retrieves the layer that is being pivoted, on the source edge.
Returns:
The zero-based index of the physical layer on the fromEdge that should be pivoted or swapped. The outermost layer on the edge is 0. A TableLayout reports columns as its layers.

getDestinationLayer

public int getDestinationLayer()
Retrieves the layer that is being pivoted, on the destination edge.
Returns:
The zero-based index of the physical layer on the toEdge that should be pivoted or swapped. The outermost layer on the edge is 0. A TableLayout reports columns as its layers.

isSwap

public boolean isSwap()
Indicates whether the pivot is a swap or a move. In a swap, two members or dimensions trade places. In a move, one member or dimension is moved from one location to another.
Returns:
true if the pivot is a swap, false if a member or dimension is being moved.

consume

public void consume()
Consumes the event. Call this method to prevent the pivot from taking place.

isConsumed

public boolean isConsumed()
Indicates whether the event was consumed by any registered LayoutPivotListener.
Returns:
true if the event was consumed, false if the pivot will take place.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.