org.j3d.renderer.java3d.overlay
Class ScrollEvent

java.lang.Object
  java.util.EventObject
      org.j3d.renderer.java3d.overlay.ScrollEvent

All Implemented Interfaces:

java.io.Serializable

public class ScrollEvent

extends java.util.EventObject

An event describing a scroll action or request.

Version:

$Revision: 1.1 $

Author:

Will Holcomb

See Also:

Serialized Form

Field Summary

static int	SCROLLED_DOWN The scroll type/direction is down
static int	SCROLLED_LEFT The scroll type/direction is left
static int	SCROLLED_RIGHT The scroll type/direction is right
static int	SCROLLED_UP The scroll type/direction is up

Fields inherited from class java.util.EventObject

source

Constructor Summary

ScrollEvent(java.lang.Object source, java.lang.Object scrolledItem, int scrollType)
Create a new event instance that represents the collection of data.

Method Summary

java.lang.Object	getScrolledItem() Get a reference to the item that has actually be scrolled, rather than the class that generated the event
int	getScrollType() Get the direction flag for the scroll action.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SCROLLED_UP

public static final int SCROLLED_UP

The scroll type/direction is up

See Also:

Constant Field Values

SCROLLED_DOWN

public static final int SCROLLED_DOWN

The scroll type/direction is down

See Also:

Constant Field Values

SCROLLED_LEFT

public static final int SCROLLED_LEFT

The scroll type/direction is left

See Also:

Constant Field Values

SCROLLED_RIGHT

public static final int SCROLLED_RIGHT

The scroll type/direction is right

See Also:

Constant Field Values

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