org.malai.interaction.library
Class Scrolling

java.lang.Object
  extended by org.malai.interaction.Interaction
      extended by org.malai.interaction.library.Scrolling
All Implemented Interfaces:
EventHandler, IStateMachine
Direct Known Subclasses:
KeysScrolling

public class Scrolling
extends Interaction

Defines an interaction based on mouse scrolling.

This file is part of Malai.
Copyright (c) 2009-2012 Arnaud BLOUIN

Malai is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Malai is distributed without any warranty; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

10/28/2010

Since:
0.2
Version:
0.2
Author:
Arnaud BLOUIN

Nested Class Summary
(package private)  class Scrolling.ScrollingScrollTransition
          This scroll transition modifies the scrolling interaction.
 
Field Summary
protected  int increment
          The total increment of the scrolling.
protected  double px
          The X-coordinate of the scroll position.
protected  double py
          The Y-coordinate of the scroll position.
protected  Pickable scrollTarget
          The object on which the scroll is performed.
 
Fields inherited from class org.malai.interaction.Interaction
activated, currentState, currentTimeout, handlers, initState, lastHIDUsed, states, stillProcessingEvents
 
Constructor Summary
Scrolling()
          Creates the interaction.
 
Method Summary
 int getIncrement()
           
 double getPx()
           
 double getPy()
           
 Pickable getScrollTarget()
           
protected  void initStateMachine()
          Initialises the interaction: creates the states and the transitions.
 void reinit()
          Reinits the state machine.
 
Methods inherited from class org.malai.interaction.Interaction
addEvent, addHandler, addState, checkTimeoutTransition, clearEventsStillInProcess, getHandlers, getLastHIDUsed, getPickableAt, isRunning, linkToEventable, notifyHandlersOnAborting, notifyHandlersOnStart, notifyHandlersOnStop, notifyHandlersOnUpdate, onAborting, onButtonPressed, onCheckBoxModified, onItemSelected, onKeyPressure, onKeyRelease, onMenuItemPressed, onMove, onPressure, onRelease, onScroll, onSpinnerChanged, onStarting, onTabChanged, onTerminating, onTextChanged, onTimeout, onUpdating, onWindowClosed, processEvents, removeKeyEvent, removePressEvent, setActivated, setLastHIDUsed, stopCurrentTimeout
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

scrollTarget

protected Pickable scrollTarget
The object on which the scroll is performed.


px

protected double px
The X-coordinate of the scroll position.


py

protected double py
The Y-coordinate of the scroll position.


increment

protected int increment
The total increment of the scrolling.

Constructor Detail

Scrolling

public Scrolling()
Creates the interaction.

Method Detail

reinit

public void reinit()
Description copied from interface: IStateMachine
Reinits the state machine.

Specified by:
reinit in interface IStateMachine
Overrides:
reinit in class Interaction

initStateMachine

protected void initStateMachine()
Description copied from class: Interaction
Initialises the interaction: creates the states and the transitions.

Specified by:
initStateMachine in class Interaction

getScrollTarget

public Pickable getScrollTarget()
Returns:
The object on which the scroll is performed.
Since:
0.2

getPx

public double getPx()
Returns:
The X-coordinate of the scroll position.
Since:
0.2

getPy

public double getPy()
Returns:
The Y-coordinate of the scroll position.
Since:
0.2

getIncrement

public int getIncrement()
Returns:
The total increment of the scrolling.
Since:
0.2