Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.0.0)

E17483-01

oracle.jbo
Class ScrollEvent

java.lang.Object
  extended by java.util.EventObject
      extended by oracle.jbo.JboEvent
          extended by oracle.jbo.RangeEvent
              extended by oracle.jbo.ScrollEvent
All Implemented Interfaces:
java.io.Serializable

public class ScrollEvent
extends RangeEvent

Generated by RowSetIterator to inform its listeners when a range of rows is scrolled.

Since:
JDeveloper 3.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ScrollEvent(RowSetIterator source, int rangeStartBefore)
          Creates a scroll event.
 
Method Summary
 int getFirstNewRowRangeIndex()
          Gets the index of the new first row of the range.
 int getNewRowCountInRange()
          Counts the number of rows exposed by the scroll.
 int getRangeStartBefore()
          Gets the index of the original first row of the range.
 int getScrollAmount()
          Gets the distance rows are displaced by the scroll.
 java.lang.String toString()
          Internal: For debugging only.
 
Methods inherited from class oracle.jbo.RangeEvent
getAllRowsInRange, getRangeStart, getRowCountInRange, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScrollEvent

public ScrollEvent(RowSetIterator source,
                   int rangeStartBefore)
Creates a scroll event.

Parameters:
source - the publisher of the event.
rangeStartBefore - the View Object index of the first row of the range, before scrolling.
Method Detail

getRangeStartBefore

public int getRangeStartBefore()
Gets the index of the original first row of the range.

Returns:
the View Object index of the first row of the range, before scrolling.

getScrollAmount

public int getScrollAmount()
Gets the distance rows are displaced by the scroll.

Returns:
the displacement as a number of rows. A negative value indicates scroll-up, and positive value scroll-down.

getFirstNewRowRangeIndex

public int getFirstNewRowRangeIndex()
Gets the index of the new first row of the range.

Returns:
the View Object index of the first row of the range, after scrolling.

getNewRowCountInRange

public int getNewRowCountInRange()
Counts the number of rows exposed by the scroll. Rows that were previously in the range are not counted.

Returns:
then number of newly visible rows.

toString

public java.lang.String toString()
Internal: For debugging only.

Overrides:
toString in class java.util.EventObject
Returns:
a diagnostic string.

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.0.0)

E17483-01

Copyright © 1997, 2011, Oracle. All rights reserved.