ui.accessibility
Class ContextualHelp

java.lang.Object
  extended by ui.accessibility.ContextualHelp
All Implemented Interfaces:
java.awt.event.FocusListener, java.awt.event.KeyListener, java.util.EventListener

public class ContextualHelp
extends java.lang.Object
implements java.awt.event.FocusListener, java.awt.event.KeyListener

Contextual Help

Author:
gregoire

Field Summary
private  java.lang.Boolean addTexts
          true : should add texts
(package private)  javax.swing.JComponent comp
          component
(package private)  Context context
          context
(package private)  java.lang.Boolean hasContext
          false if with context
private  int hasFocus
          1 if button has focus
private  java.awt.AWTKeyStroke helpKey
          help key
private  java.lang.String helpName
          component name
private  java.lang.String id
          id of the help page
private  int isPressed
          1 if helpkey is pressed
private  java.lang.String[] otherKeys
          otherKeys
private  java.lang.String[] otherLabels
          otherLabels
private static long serialVersionUID
          Pour la sérialisation (non utilisé)
private  Language texts
          Textual contents
private  java.awt.AWTKeyStroke tradKey
          help key
 
Constructor Summary
ContextualHelp()
          Contructor
ContextualHelp(javax.swing.JComponent jc)
          Constructor
ContextualHelp(javax.swing.JComponent jc, Context ctext)
          Constructor with context (implements tooltip,name,description)
ContextualHelp(javax.swing.JComponent jc, java.lang.String helpid)
          Constructor
ContextualHelp(javax.swing.JComponent jc, java.lang.String helpid, Context ctext)
          Constructor with context (implements tooltip,name,description)
ContextualHelp(javax.swing.JTabbedPane jtp)
          Contextual Help for the settings tabbed pane
 
Method Summary
 void addContext(Context c, java.lang.Boolean b)
          Sert à lier le fichier .properties au bouton.
 void addLabel(java.lang.String label, java.lang.String key)
          Adds label|key
 void addLabels(java.lang.String[] labels, java.lang.String[] keys)
          add labels
 void changeID(java.lang.String newID)
          change help tab
 void focusGained(java.awt.event.FocusEvent e)
           
 void focusLost(java.awt.event.FocusEvent e)
           
 void keyPressed(java.awt.event.KeyEvent k)
           
 void keyReleased(java.awt.event.KeyEvent k)
           
 void keyTyped(java.awt.event.KeyEvent k)
           
 void setHelpKey(java.awt.AWTKeyStroke ks)
           
 void setHelpName(java.lang.String newName)
          set help name
 void setParameters(javax.swing.JComponent jc, java.lang.String helpid)
           
 void setParameters(javax.swing.JComponent jc, java.lang.String helpid, Context ctext)
          sets parameters
private  void setShortCut()
          set shortcut
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

texts

private Language texts
Textual contents


serialVersionUID

private static final long serialVersionUID
Pour la sérialisation (non utilisé)

See Also:
Constant Field Values

hasFocus

private int hasFocus
1 if button has focus


hasContext

java.lang.Boolean hasContext
false if with context


addTexts

private java.lang.Boolean addTexts
true : should add texts


otherLabels

private java.lang.String[] otherLabels
otherLabels


otherKeys

private java.lang.String[] otherKeys
otherKeys


context

Context context
context


helpName

private java.lang.String helpName
component name


isPressed

private int isPressed
1 if helpkey is pressed


comp

javax.swing.JComponent comp
component


id

private java.lang.String id
id of the help page


helpKey

private java.awt.AWTKeyStroke helpKey
help key


tradKey

private java.awt.AWTKeyStroke tradKey
help key

Constructor Detail

ContextualHelp

public ContextualHelp()
Contructor


ContextualHelp

public ContextualHelp(javax.swing.JComponent jc,
                      java.lang.String helpid,
                      Context ctext)
Constructor with context (implements tooltip,name,description)

Parameters:
jc - component's name
helpid - id of the help page ("target" in the mapfile : nat.jhm )
ctext - contexts

ContextualHelp

public ContextualHelp(javax.swing.JComponent jc,
                      Context ctext)
Constructor with context (implements tooltip,name,description)

Parameters:
jc - component's name
ctext - contexts

ContextualHelp

public ContextualHelp(javax.swing.JComponent jc,
                      java.lang.String helpid)
Constructor

Parameters:
jc - component's name
helpid - id of the help page ("target" in the mapfile : nat.jhm )

ContextualHelp

public ContextualHelp(javax.swing.JComponent jc)
Constructor

Parameters:
jc - component's name

ContextualHelp

public ContextualHelp(javax.swing.JTabbedPane jtp)
Contextual Help for the settings tabbed pane

Parameters:
jtp - tabbed pane
Method Detail

setHelpKey

public void setHelpKey(java.awt.AWTKeyStroke ks)
Parameters:
ks - : new helpkey

setParameters

public void setParameters(javax.swing.JComponent jc,
                          java.lang.String helpid,
                          Context ctext)
sets parameters

Parameters:
jc - component
helpid - id in the help sheet (=anchor)
ctext - context

setParameters

public void setParameters(javax.swing.JComponent jc,
                          java.lang.String helpid)
Parameters:
jc - component's name
helpid - id of the help page ("target" in the mapfile : nat.jhm )

changeID

public void changeID(java.lang.String newID)
change help tab

Parameters:
newID - new id

setHelpName

public void setHelpName(java.lang.String newName)
set help name

Parameters:
newName - : name in the help page

focusGained

public void focusGained(java.awt.event.FocusEvent e)
Specified by:
focusGained in interface java.awt.event.FocusListener
Parameters:
e - : focus event

focusLost

public void focusLost(java.awt.event.FocusEvent e)
Specified by:
focusLost in interface java.awt.event.FocusListener
Parameters:
e - : focus event

keyPressed

public void keyPressed(java.awt.event.KeyEvent k)
Specified by:
keyPressed in interface java.awt.event.KeyListener
Parameters:
k - : key event

keyReleased

public void keyReleased(java.awt.event.KeyEvent k)
Specified by:
keyReleased in interface java.awt.event.KeyListener
Parameters:
k - : key event

keyTyped

public void keyTyped(java.awt.event.KeyEvent k)
Specified by:
keyTyped in interface java.awt.event.KeyListener
Parameters:
k - : key event

addLabels

public void addLabels(java.lang.String[] labels,
                      java.lang.String[] keys)
add labels

Parameters:
labels - labels
keys - keys

addContext

public void addContext(Context c,
                       java.lang.Boolean b)
Sert à lier le fichier .properties au bouton. Pour ne pas ajouter les clés de base, mettre b=false

Parameters:
c - context
b - true to add basic keys (name, description, tooltip, label) to the dialog

addLabel

public void addLabel(java.lang.String label,
                     java.lang.String key)
Adds label|key

Parameters:
label - label
key - key

setShortCut

private void setShortCut()
set shortcut