org.j3d.geom.overlay
Class ScrollEvent

public class ScrollEvent
extends java.util.EventObject
An event describing a scroll action or request.

Version:
$Revision: 1.2 $
Author:
Will Holcomb
Field Detail

SCROLLED_UP

public static final int SCROLLED_UP
The scroll type/direction is up

SCROLLED_DOWN

public static final int SCROLLED_DOWN
The scroll type/direction is down

SCROLLED_LEFT

public static final int SCROLLED_LEFT
The scroll type/direction is left

SCROLLED_RIGHT

public static final int SCROLLED_RIGHT
The scroll type/direction is right

scrolledItem

private java.lang.Object scrolledItem
The item that has just been scrolled

scrollType

private int scrollType
The action that has taken place (up/down)

Constructor Detail

ScrollEvent

public ScrollEvent(java.lang.Object source,
                   java.lang.Object scrolledItem,
                   int scrollType)
Create a new event instance that represents the collection of data.
Parameters:
source - The class that created the event
scrolledItem - The item that was actually scrolled
scrollType - the direction the scroll action has taken

Method Detail

getScrolledItem

public java.lang.Object getScrolledItem()
Get a reference to the item that has actually be scrolled, rather than the class that generated the event
Returns:
The item that was scrolled

getScrollType

public int getScrollType()
Get the direction flag for the scroll action.
Returns:
One of the constants defined in this class