org.malai.interaction.library
Class KeyInteraction

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

public abstract class KeyInteraction
extends Interaction

This abstract interaction should be used to define interaction based on keyboards.

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.

12/01/2011

Since:
0.2
Author:
Arnaud BLOUIN

Nested Class Summary
(package private)  class KeyInteraction.KeyInteractionKeyPressedTransition
          Defines a transition modifying the key attribute of the interaction.
 
Field Summary
protected  int key
          The key pressed.
protected  java.lang.Object object
          The object that produced the interaction.
 
Fields inherited from class org.malai.interaction.Interaction
activated, currentState, currentTimeout, handlers, initState, lastHIDUsed, states, stillProcessingEvents
 
Constructor Summary
KeyInteraction()
          Creates the interaction.
 
Method Summary
 int getKey()
           
 void reinit()
          Reinits the state machine.
 
Methods inherited from class org.malai.interaction.Interaction
addEvent, addHandler, addState, checkTimeoutTransition, clearEventsStillInProcess, getHandlers, getLastHIDUsed, getPickableAt, initStateMachine, 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

key

protected int key
The key pressed.


object

protected java.lang.Object object
The object that produced the interaction.

Constructor Detail

KeyInteraction

public KeyInteraction()
Creates the interaction.

Since:
0.2
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

getKey

public int getKey()
Returns:
The key pressed.
Since:
0.2