com.luciad.input

Class ScrollEvent

java.lang.Object

com.luciad.input.ScrollEvent

All Implemented Interfaces:

IInputEvent, AutoCloseable

public final class ScrollEvent
extends Object
implements IInputEvent, AutoCloseable

Implementation of IInputEvent that represents a scroll gesture (for example using the mouse wheel).

This class contains the location, the scroll amount and direction and modifiers if any.

Constructor Summary

Constructors

Constructor and Description
ScrollEvent(Coordinate location, ModifierKeys modifierKeys, double deltaY) Creates a scroll event.

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	finalize()
double	getDeltaY() Returns the vertical scroll amount and direction.
Coordinate	getLocation()
ModifierKeys	getModifierKeys()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScrollEvent

public ScrollEvent(@NotNull
                   Coordinate location,
                   @NotNull
                   ModifierKeys modifierKeys,
                   double deltaY)

Creates a scroll event.

Parameters:

location - The location of the event, defined in device independent pixels.

modifierKeys - The modifiers of the event.

deltaY - the vertical scroll amount and direction.

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

getLocation

@NotNull
public Coordinate getLocation()

Returns:

the position of the event, expressed in device independent pixel coordinates with top-left corner of the map being the (0,0) position.

getModifierKeys

@NotNull
public ModifierKeys getModifierKeys()

Returns:

the modifiers of the event.

getDeltaY

public double getDeltaY()

Returns the vertical scroll amount and direction.

A positive value indicates scrolling up, a negative value indicates scrolling down.

A delta of 1.0 (or -1.0) should be interpreted as follows:

• for mouse wheels, this would correspond to 1 tick, typically 15 degrees of rotation
• for other devices, this would correspond to 10 pixels (device independent pixels)

Returns:

the vertical scroll amount and scroll direction.