org.pilotix.client
Class Controls

java.lang.Object
  java.awt.event.KeyAdapter
      org.pilotix.client.Controls

All Implemented Interfaces:

java.awt.event.KeyListener, java.awt.KeyEventDispatcher, java.util.EventListener

public class Controls
extends java.awt.event.KeyAdapter
implements java.awt.KeyEventDispatcher

Le rôle de cette classe est de gérer la souris et le clavier. L'état de toutes les touches du clavier est stocké dans un tableau, qui peut être récupéré avec la fonction getKeyStatus(). La variation de déplacement de la souris est récupérée avec getMouseVariation(). La fonction setMainFrame doit être utilisée afin de récupérer les évènements clavier. et la fonction setMouseComponent pour les évènements souris. Les plugins peuvent s'enregistrer en tant que listeners pour récupérer les évènements clavier.

Author:

Loïc Guibart

À faire :

chargement des touches (dans Environnement) @.todo changement du pointeur de la souris quand celui-ci est attaché à un composant

Field Summary

int	keyAccel
static int	NOTHING état de la touche : pas appuyée
static int	PRESSED état de la touche : pressée
static int	PRESSED_AND_RELEASED état de la touche : pressée et relachée depuis le dernier appel à getKeyStatus

Constructor Summary

Controls()
Construit un objet Controls

Method Summary

void	active(boolean isActive) Active ou désactive les contrôles.
void	addListener(java.awt.event.KeyListener kl) Ajoute un listener d'évènement clavier
boolean	dispatchKeyEvent(java.awt.event.KeyEvent ke) Traitement d'un évènement clavier
int	getKeyCodeFromAction(java.lang.String actionName) Récupère le code touche associé à une action définie dans le fichier de configuration utilisateur.
int[]	getKeyStatus() Renvoie le tableau de statut des touches.
Vector	getMouseVariation() Récupère la variation de la position de la souris depuis le dernier appel
void	keyPressed(java.awt.event.KeyEvent e) Traitement d'un évènement "touche pressée"
void	keyReleased(java.awt.event.KeyEvent e) Traitement d'un évènement "touche relachée"
void	keyTyped(java.awt.event.KeyEvent e) Traitement d'un évènement "touche appuyée"
void	removeListener(java.awt.event.KeyListener kl) Retire un listener d'évènement clavier
void	setMainFrame(GUI gui) Indique à Controls où doivent être récupérés les évènements claviers.
void	setMouseComponent(java.awt.Component comp) Associe le gestionnaire de souris à un composant AWT.

Methods inherited from class java.lang.Object

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

Field Detail

NOTHING

public static final int NOTHING

état de la touche : pas appuyée

See Also:

Constant Field Values

PRESSED

public static final int PRESSED

état de la touche : pressée

See Also:

Constant Field Values

PRESSED_AND_RELEASED

public static final int PRESSED_AND_RELEASED

état de la touche : pressée et relachée depuis le dernier appel à getKeyStatus

See Also:

Constant Field Values

keyAccel

public int keyAccel

Constructor Detail

Controls

public Controls()

Construit un objet Controls

Method Detail

setMainFrame

public void setMainFrame(GUI gui)

Indique à Controls où doivent être récupérés les évènements claviers.

Parameters:

gui - Fenêtre principale du client.

getKeyStatus

public int[] getKeyStatus()

Renvoie le tableau de statut des touches.

Returns:

Tableau d'entier contenant l'état de toutes les touches.

dispatchKeyEvent

public boolean dispatchKeyEvent(java.awt.event.KeyEvent ke)

Traitement d'un évènement clavier

Specified by:

dispatchKeyEvent in interface java.awt.KeyEventDispatcher

Parameters:

ke - Evènement à traiter.

active

public void active(boolean isActive)

Active ou désactive les contrôles.

Parameters:

isActive - Indique si les contrôles doivent être activés.

addListener

public void addListener(java.awt.event.KeyListener kl)

Ajoute un listener d'évènement clavier

Parameters:

kl - Listener à ajouter.

removeListener

public void removeListener(java.awt.event.KeyListener kl)

Retire un listener d'évènement clavier

Parameters:

kl - Listener à supprimer.

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Traitement d'un évènement "touche pressée"

Specified by:

keyPressed in interface java.awt.event.KeyListener

Overrides:

keyPressed in class java.awt.event.KeyAdapter

Parameters:

e - Evenement clavier.

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Traitement d'un évènement "touche relachée"

Specified by:

keyReleased in interface java.awt.event.KeyListener

Overrides:

keyReleased in class java.awt.event.KeyAdapter

Parameters:

e - Evenement clavier.

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Traitement d'un évènement "touche appuyée"

Specified by:

keyTyped in interface java.awt.event.KeyListener

Overrides:

keyTyped in class java.awt.event.KeyAdapter

Parameters:

e - Evenement clavier.

setMouseComponent

public void setMouseComponent(java.awt.Component comp)

Associe le gestionnaire de souris à un composant AWT. Les évènements souris vont être récupérés dans ce composant. Le pointeur de la souris peut être attaché à ce composant ce qui fait que le pointeur ne sortira pas du composant.

Parameters:

comp - Composant AWT où vont être récupérés les évènements souris.

getMouseVariation

public Vector getMouseVariation()

Récupère la variation de la position de la souris depuis le dernier appel

Returns:

Vecteur contenant la variation de la position en x et y.

getKeyCodeFromAction

public int getKeyCodeFromAction(java.lang.String actionName)

Récupère le code touche associé à une action définie dans le fichier de configuration utilisateur. Le code touche correspond à une constante VK_* définie dans la classe KeyEvent.

Parameters:

actionName - Nom de l'action.

Returns:

code correspondant.