All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.KeyRemap

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----com.ibm.eNetwork.beans.HOD.HODPanelBean
                                   |
                                   +----com.ibm.eNetwork.beans.HOD.KeyRemap

public class KeyRemap
extends HODPanelBean
implements KeyRemapIntf, KeyListener
The primary purpose of KeyRemap is to listen to KeyEvents (keystrokes) fired by the Terminal bean or Screen bean, remap those keystrokes to SendKey Mnemonics, generate a SendKeyEvent containing those SendKey Mnemonics, and fire that SendKeyEvent back to the Terminal bean or Screen bean for processing.

KeyRemap provides a Graphical User Interface (GUI) to control the process of remapping keystrokes to functions. Through the GUI you can view the mappings of keystrokes to functions, reassign which keystrokes get remapped to which functions, restore the default mappings for keystrokes, and search the current mappings for a specified keystroke.

KeyRemap also provides an API which supports all the operations performed by the GUI as well as additional advanced operations. The API allows you to define and add custom functions to KeyRemap. Once a custom function is added to KeyRemap both the API and GUI can interact with the custom function assigning keystrokes to it. KeyRemap uses the ActionListener interface of Java to notify interested code when a custom function has been activated.

KeyRemap additionally provides support for controlling the repetition of keys. KeyRemap normally processes keys when they are pressed. When a key is pressed and held, KeyRemap will continue to process the held key over and over until the key is released. You can designate a key to be processed only when it is released by adding the key as a non-repeating key. Both the API and GUI support this operation.

KeyRemap organizes functions into categories. Each category maintains a set of ActionListeners registered to receive ActionEvents from that category. You can register to receive ActionEvents from a specific category by calling the addActionListener(String category, ActionListener listener) method. When a keystroke remaps to a function in that category, an ActionEvent is generated and fired to registered ActionListeners for that category. The getActionCommand() method of ActionEvent will return the function of the remapped keystroke. You can also register to receive ActionEvents from all categories by calling the addActionListener(ActionListener listener) method.

All of the default functions of KeyRemap are assigned to one of two predefined function categories, named by the variables HOST_FUNCTIONS and CHARACTERS. The HOST_FUNCTIONS category contains only SendKey Mnemonics, which are documented in Appendix A. SendKey Mnemonics of the Host Access Class Library Reference. You can add custom functions to the HOST_FUNCTIONS category but they must conform to the SendKey interface. The CHARACTERS category contains special characters that may or may not appear on a keyboard. You can add additional characters to the CHARACTERS category but they must also conform to the SendKey interface. When a keystroke remaps to a function in one of these two categories, a SendKeyEvent in addition to an ActionEvent is generated and fired to registered SendKeyListeners. Only the HOST_FUNCTIONS and CHARACTERS categories cause an ActionEvent/SendKeyEvent pair to be fired from KeyRemap.

KeyRemap is sensitive to both the session type and codepage. It remaps different sets of default functions for 3270, 5250, VT, and CICS sessions and for single-byte, double-byte, bi-directional, Thai, Hindi, and Euro codepages.

The KeyRemap Bean has a set of public properties that can be accessed through the standard bean accessor methods. For example, KeyRemap has a sessionType property that affects the set of functions to which keystrokes can be remapped. SessionType is a read/write property and correspondingly has a getSessionType() method and a setSessionType() method that provide access to the property.

The properties can also be initialized when the bean is constructed using a Properties object with the appropriate keyword/value pairs. In the Properties object, the keyword for properties is the same as the property name. For example, the keyword for the sessionType property is "sessionType"--the constant, SESSION_TYPE, is provided for convenience.

Properties

* - Properties with type "enum" are String types that accept a specific set of string values. The valid values for an enum property can be obtained by calling the list <property name> method. The set method for enum properties validates the value before any changes are accepted, and a PropertyVetoException will be thrown if an incorrect value is given.

Note: All properties are bound and vetoable. A PropertyChangeEvent is fired to all PropertyChangeListeners after a property is changed. A vetoable PropertyChangeEvent is fired to all VetoableChangeListeners before a property is changed. VetoableChangeListeners can veto a property change by throwing a PropertyVetoException.

Property Name Type Default Access
sessionType enum* ECLSession.SESSION_TYPE_3270_STR read/write
codePage enum* ECLSession.SESSION_CODE_PAGE_US read/write
autoApply boolean true read/write

Events Fired

Event Type Fired To Event Handler Method
ActionEvent - Fired when a keystroke remaps to a function. Any ActionListener actionPerformed(ActionEvent)
SendKeyEvent - Fired when a keystroke remaps to a function within the HOST_FUNCTIONS or CHARACTERS category. Also fired when a keystroke produces a printable character and does not remap to any function. Terminal, Screen, Session sendKeys(SendKeyEvent)
PropertyChangeEvent - Fired after a bound property of the Bean is changed. Any PropertyChangeListener propertyChange(propertyChangeEvent)
Vetoable PropertyChangeEvent - Fired before a vetoable property of the Bean is changed. Any VetoableChangeListener vetoableChange(PropertyChangeEvent)

Events Accepted

Event Type Fired From Event Handler Method
KeyEvent - Standard Java key event fired when keystrokes are typed while a Component has focus. Terminal, Screen keyPressed(KeyEvent),
keyTyped(KeyEvent),
keyReleased(KeyEvent)
PropertyChangeEvent - Fired when a property of the source Bean is changed. Because KeyRemap is sensitive to the sessionType and codePage properties, it can listen to Property change events of other Beans and sync its own properties to correspond to those of the source Bean. Terminal, Session propertyChange(propertyChangeEvent)


Variable Index

 o AUTO_APPLY
autoApply property keyword
 o CHARACTERS
Characters category definition string
 o CODE_PAGE
codePage property keyword
 o FIELD_SEPARATOR
Field separator character
 o HOST_FUNCTIONS
Host Functions category definition string
 o SESSION_TYPE
sessionType property keyword

Constructor Index

 o KeyRemap()
Constructor that uses the default values for all properties.
 o KeyRemap(Properties)
Constructor that takes a Properties object containing the initial property settings.

Method Index

 o addActionListener(ActionListener)
Registers the specified ActionListener to receive ActionEvents from all categories.
 o addActionListener(String, ActionListener)
Registers the specified ActionListener to receive ActionEvents from the specified category.
 o addButton(Button)
Adds a user defined button to the bottom row of the Graphical User Interface.
 o addButton(Component, int)
Deprecated.
 o addFunction(String, String, String, String, boolean)
Adds a Function.
 o addMapping(String, String, boolean)
Adds a mapping.
 o addNonRepeatingKey(int, boolean)
Adds a non-repeating key.
 o addSendKeyListener(SendKeyListener)
Registers the specified SendKeyListener to receive SendKeyEvents.
 o apply()
Applies all non-default changes.
 o cancel()
Cancels all non-default changes made since the apply() method was last invoked.
 o defaults()
Obtains a Properties object containing the default properties for this Bean.
 o getCategory(String)
Obtains the Category the specified function belongs to.
 o getCodePage()
Accessor method for the codePage property.
 o getCodePageFlags()
Obtains the current Codepage Flags.
 o getDescription(String)
Obtains the Description associated with the specified function.
 o getKeystroke(KeyEvent)
Obtains the Keystroke associated with the specified KeyEvent.
 o getMapping(String)
Obtains the function that the specified Keystroke remaps too.
 o getProperties()
Obtains a Properties object containing the current properties of the Bean.
 o getSelectedPanelIndex()
Obtains the index of the currently displayed panel.
 o getSessionType()
Accessor method for the sessionType property.
 o getTraceName()
Obtains a trace identifier for this bean
 o isAutoApply()
Accessor method for the autoApply property.
 o isDefaultFunction(String)
Determines if the specified function is a default function.
 o isDefaultMapping(String)
Determines if the specified Keystroke is currently mapped to its default.
 o isDefaultNonRepeatingKey(int)
Determines if the specified key is a default non-repeating key.
 o isNonRepeatingKey(int)
Determines if the specified key is a non-repeating key.
 o keyPressed(KeyEvent)
KeyListener interface method.
 o keyReleased(KeyEvent)
KeyListener interface method.
 o keyTyped(KeyEvent)
KeyListener interface method.
 o listCategories()
Lists the categories currently defined in KeyRemap.
 o listCodePages()
Lists valid codePages for the current session type.
 o listCodePages(String)
Lists valid codePages for the specified session type.
 o listFunctions()
Lists the functions currently available in KeyRemap.
 o listMappings(String)
Lists the Keystrokes that remap to the specified function.
 o listNonRepeatingKeys()
Lists the non-repeating keys added to KeyRemap.
 o listSessionTypes()
Lists the valid sessionTypes.
 o propertyChange(PropertyChangeEvent)
PropertyChangeListener interface method.
 o removeActionListener(ActionListener)
Unregisters the specified ActionListener so that it no longer receives ActionEvents from any category.
 o removeButton(Button)
Removes a user defined button from the bottom row of the Graphical User Interface
 o removeButton(Component, int)
Deprecated.
 o removeFunction(String)
Removes a function.
 o removeMapping(String)
Removes a mapping.
 o removeNonRepeatingKey(int)
Removes a non-repeating key.
 o removeSendKeyListener(SendKeyListener)
Unregisters the specified SendKeyListener so that it no longer receives SendKeyEvents.
 o requestFocus()
Transfers focus to the bean.
 o reset()
Resets KeyRemap to default functions, mappings, and non-repeating keys.
 o resetMapping(String)
Resets the specified Keystroke to its default mapping.
 o setAutoApply(boolean)
Sets the autoApply property.
 o setCodePage(String)
Sets the codePage property.
 o setProperties(Properties)
Sets the Bean properties using a Properties object containing the appropriate keyword/value pairs.
 o setSessionType(String)
Sets the sessionType property.
 o setTraceLevel(int)
Sets the current tracing level for this object

Variables

 o SESSION_TYPE
 public static final String SESSION_TYPE
sessionType property keyword

 o CODE_PAGE
 public static final String CODE_PAGE
codePage property keyword

 o AUTO_APPLY
 public static final String AUTO_APPLY
autoApply property keyword

 o HOST_FUNCTIONS
 public static final String HOST_FUNCTIONS
Host Functions category definition string

 o CHARACTERS
 public static final String CHARACTERS
Characters category definition string

 o FIELD_SEPARATOR
 public static final String FIELD_SEPARATOR
Field separator character

See Also:
getProperties

Constructors

 o KeyRemap
 public KeyRemap()
Constructor that uses the default values for all properties.

 o KeyRemap
 public KeyRemap(Properties properties) throws PropertyVetoException
Constructor that takes a Properties object containing the initial property settings. Any properties that are not specified in the Properties object are defaulted.

Parameters:
properties - Properties for the Bean.
Throws: PropertyVetoException
Thrown if an incorrect property value is given.

Methods

 o addButton
 public void addButton(Component b,
                       int panel)
Note: addButton() is deprecated.

See Also:
addButton
 o addButton
 public void addButton(Button button)
Adds a user defined button to the bottom row of the Graphical User Interface. The calling class must handle adding listeners to the button if it wants to react to the events generated by it.

Parameters:
button - Button to be added.
See Also:
removeButton
 o removeButton
 public void removeButton(Component b,
                          int panel)
Note: removeButton() is deprecated.

See Also:
removeButton
 o removeButton
 public void removeButton(Button button)
Removes a user defined button from the bottom row of the Graphical User Interface

Parameters:
button - Button to be removed.
See Also:
addButton
 o setProperties
 public void setProperties(Properties properties) throws PropertyVetoException
Sets the Bean properties using a Properties object containing the appropriate keyword/value pairs. This method resets KeyRemap to its default functions and mappings before processing the new properties object.

Parameters:
properties - Properties for the Bean.
Throws: PropertyVetoException
Thrown if an incorrect property value is given.
Overrides:
setProperties in class HODPanelBean
See Also:
getProperties
 o getProperties
 public Properties getProperties()
Obtains a Properties object containing the current properties of the Bean. The properties of the KeyRemap Bean are SESSION_TYPE, CODE_PAGE, AUTO_APPLY, and changes made to defaults in the following keyword/value pair formats:

Key Value Effect
| Codepage Flags | Category | Description Function Adds a non-default function
XF:Function Function Removes a default function
TKeycode Keycode Adds a non-default non-repeating key
XT:Keycode Keycode Removes a default non-repeating key
Keystroke Function Adds a non-default mapping
XM:Keystroke Keystroke Removes a default mapping

Note: The FIELD_SEPARATOR character is used to delimit the Codepage Flags, Category, and Description fields.

Codepage Flags
The Codepage Flags field specifies the codepages which the function is valid for. If the codepage of the KeyRemap bean does not match any of the codepage flags the function will not be added. If Codepage Flags field is blank the function will be added for all codepages. You can include more than one codepage flag. Multiple codepage flags are valid.
Example. BD = Bidi or DBCD codepages.

Flag Codepages
blank
All codepages
B
Bidi codepages
D
DBCS codepages
T
Thai codepages
H
Hindi codepages
E
Euro codepages

Category
The Category field specifies the category which the function will be added to. If the Category field is blank the function will either be added to the HOST_FUNCTIONS category or the CHARACTERS category. If the Function is one character in length the function will be added to the CHARACTERS category otherwise it will be added to the HOST_FUNCTIONS category.

Description
The Description field specifies the text that will appear in the Graphical User Interface for this function. If the Description field is blank the Function will appear in the Graphical User Interface as is.

Function
The Function field can start with the FIELD_SEPARATOR character , or the "[" character. If the Function field starts with FIELD_SEPARATOR all characters after the first FIELD_SEPARATOR character are considered part of the function. If the Function field starts with the "[" character, all of the characters including the first "[" are considered part of the function. If the Function function does not start with either the FIELD_SEPARATOR character or the "[" character then the Function must be a String representation of a base 10 integer. The Function is then converted into a single character based on the Unicode point represented by that integer.

Keycode
The Keycode field specifies the Java keycode obtained by invoking the getKeyCode() method of a KeyEvent. Java keycodes can be found in the JDK documentation under the KeyEvent class.

Keystroke
The Keystroke field is defined as Modifiers + Keycode. Modifiers is a single character that represents the state of the modifier keys. The Keycode is the same as described above. The table below lists valid values for the Modifiers character:

Modifiers character Description
B
base state, no modifiers
C
Ctrl modifier
A
Alt modifier
S
Shift modifier
D
Ctrl+Shift modifier
H
Alt+Shift modifier
I
Ctrl+Alt modifier
J
Ctrl+Alt+Shift modifier

Examples:

Key Value Effect
||host|Logon |username[tab]password[enter] Adds a function with the description "Logon"
to the HOST_FUNCTIONS category
for all codepages
|B|host| [bidilayer] Adds a function with the description "[bidilayer]"
to the HOST_FUNCTIONS category for
BiDi codepages only
|||Exclamation Mark 33 Adds a function with the description "Exclamation Mark"
to the CHARACTERS category for all codepages
||char|Exclamation Mark |! Adds a function with the description "Exclamation Mark"
to the CHARACTERS category for all codepages.
(Same as above)
XF:[bidilayer] [bidilayer] Removes the [bidilayer] function
T10 10 Adds the Enter key to the non-repeating key list
XT:65 65 Removes the A key from the non-repeating key list
A65 [altcsr] Maps the Alt-A key combination to the function [altcsr]
XM:B10 B10 Unmaps the Enter key
B112 |username[tab]password[enter] Maps the F1 key to the "Logon" function added above
C113 33 Maps the Ctl-F2 key combination to the "Exclamation Mark"
function added above

Overrides:
getProperties in class HODPanelBean
See Also:
setProperties
 o defaults
 public static Properties defaults()
Obtains a Properties object containing the default properties for this Bean. The properties do not include default functions, mappings, or non-repeating keys.

See Also:
setProperties, getProperties
 o setSessionType
 public void setSessionType(String type) throws PropertyVetoException
Sets the sessionType property. Changing the value of this property resets KeyRemap to its default functions and mappings and may change the value of the CODE_PAGE property.

Parameters:
type - The session type to use.
Throws: PropertyVetoException
Thrown if an incorrect parameter is specified or the vetoable PropertyChangeEvent is vetoed.
See Also:
getSessionType, listSessionTypes
 o getSessionType
 public String getSessionType()
Accessor method for the sessionType property.

Returns:
The value of the sessionType property.
See Also:
setSessionType, listSessionTypes
 o listSessionTypes
 public Enumeration listSessionTypes()
Lists the valid sessionTypes.

Returns:
Returns an Enumeration of valid sessionType Strings.
See Also:
setSessionType, getSessionType
 o setCodePage
 public void setCodePage(String codePage) throws PropertyVetoException
Sets the codePage property. Changing the value of this property resets KeyRemap to its default functions and mappings.

Parameters:
codePage - The code page to use.
Throws: PropertyVetoException
Thrown if an incorrect parameter is specified or the vetoable PropertyChangeEvent is vetoed.
See Also:
getCodePage, listCodePages, listCodePages
 o getCodePage
 public String getCodePage()
Accessor method for the codePage property.

Returns:
The value of the codePage property.
See Also:
setCodePage, listCodePages, listCodePages
 o listCodePages
 public Enumeration listCodePages()
Lists valid codePages for the current session type.

Returns:
Enumeration of valid codePage Strings for the current session type.
See Also:
setCodePage, getCodePage
 o listCodePages
 public static Enumeration listCodePages(String sessionType)
Lists valid codePages for the specified session type.

Parameters:
sessionType - The session type for which to generate the list.
Returns:
Enumeration of valid codePage Strings for the specified session type.
See Also:
setCodePage, getCodePage
 o setAutoApply
 public void setAutoApply(boolean autoApply) throws PropertyVetoException
Sets the autoApply property. If set to true the apply() method will be invoked after each change made in the Graphical User Interface. If set to false changes made in the Graphical User Interface will not be applied until the apply() method is called.

Parameters:
autoApply - The value for the autoApply property.
Throws: PropertyVetoException
Thrown if the PropertyChangeEvent is vetoed.
See Also:
isAutoApply, apply
 o isAutoApply
 public boolean isAutoApply()
Accessor method for the autoApply property.

Returns:
The value of the autoApply property.
See Also:
setAutoApply, apply
 o setTraceLevel
 public void setTraceLevel(int traceLevel) throws PropertyVetoException
Sets the current tracing level for this object

Parameters:
traceLevel - One of the trace level constants.
Throws: PropertyVetoException
Thrown if the PropertyChangeEvent is vetoed.
Overrides:
setTraceLevel in class HODPanelBean
 o addSendKeyListener
 public void addSendKeyListener(SendKeyListener l)
Registers the specified SendKeyListener to receive SendKeyEvents.

Parameters:
listener - The SendKeyListener to be added.
See Also:
removeSendKeyListener
 o removeSendKeyListener
 public void removeSendKeyListener(SendKeyListener l)
Unregisters the specified SendKeyListener so that it no longer receives SendKeyEvents.

Parameters:
listener - The SendKeyListener to be removed.
See Also:
addSendKeyListener
 o addActionListener
 public void addActionListener(ActionListener listener)
Registers the specified ActionListener to receive ActionEvents from all categories. When a keystroke remaps to any function an ActionEvent is generated and fired to registered ActionListeners. The getActionCommand() method of ActionEvent returns the function the keystroke was remapped to.

Parameters:
listener - The ActionListener to be added.
See Also:
addActionListener, removeActionListener
 o addActionListener
 public void addActionListener(String category,
                               ActionListener listener)
Registers the specified ActionListener to receive ActionEvents from the specified category. When a keystroke remaps to a function in the specified category an ActionEvent is generated and fired to registered ActionListeners on that category. The getActionCommand() method of ActionEvent returns the function the keystroke was remapped to.

Parameters:
category - The category to receive ActionEvents from.
listener - The ActionListener to be added.
See Also:
addActionListener, removeActionListener
 o removeActionListener
 public void removeActionListener(ActionListener listener)
Unregisters the specified ActionListener so that it no longer receives ActionEvents from any category.

Parameters:
listener - The ActionListener to be removed.
See Also:
addActionListener, addActionListener
 o addNonRepeatingKey
 public void addNonRepeatingKey(int keyCode,
                                boolean isDefault)
Adds a non-repeating key. KeyRemap normally processes keys when they are pressed. When a key is pressed and held KeyRemap will continue to process the held key over and over until the key is released. You can designate a key to be processed only when it is released by adding the key to KeyRemap list of non-repeating keys.

Parameters:
keyCode - The key-code for the non-repeating key to be added.
isDefault - Specifies whether the non-repeating key is a default non-repeating key.
See Also:
removeNonRepeatingKey, isNonRepeatingKey, isDefaultNonRepeatingKey, listNonRepeatingKeys
 o removeNonRepeatingKey
 public void removeNonRepeatingKey(int keyCode)
Removes a non-repeating key.

Parameters:
keyCode - The key-code for the non-repeating key to be removed.
See Also:
addNonRepeatingKey, isNonRepeatingKey, isDefaultNonRepeatingKey, listNonRepeatingKeys
 o isNonRepeatingKey
 public boolean isNonRepeatingKey(int keyCode)
Determines if the specified key is a non-repeating key.

Parameters:
keyCode - The key-code for the key to be checked.
Returns:
True - If the specified key is a non-repeating key.
False - If the specified key is a repeating key.
See Also:
addNonRepeatingKey, removeNonRepeatingKey, isNonRepeatingKey, isDefaultNonRepeatingKey, listNonRepeatingKeys
 o isDefaultNonRepeatingKey
 public boolean isDefaultNonRepeatingKey(int keyCode)
Determines if the specified key is a default non-repeating key.

Parameters:
keyCode - The key-code for the key to be checked.
Returns:
True - If the specified key is a default non-repeating key.
False - If the specified key is a repeating key or the specified key is a non-default non-repeating key.
See Also:
addNonRepeatingKey, removeNonRepeatingKey, isNonRepeatingKey, isDefaultNonRepeatingKey, listNonRepeatingKeys
 o listNonRepeatingKeys
 public Enumeration listNonRepeatingKeys()
Lists the non-repeating keys added to KeyRemap.

Returns:
Enumeration of Integer keycodes for the current non-repeating keys.
See Also:
addNonRepeatingKey, removeNonRepeatingKey, isNonRepeatingKey, isDefaultNonRepeatingKey, listNonRepeatingKeys
 o addFunction
 public void addFunction(String function,
                         String codePageFlags,
                         String category,
                         String description,
                         boolean isDefault)
Adds a Function.

Parameters:
function - Any String. Note: The function is not processed as described above in Function. The function is exactly the specified string.
codePageFlags - The Codepage Flags for the specified function.
category - The Category for the specified function.
description - The Description for the specified function.
isDefault - Specifies whether the function is a default function.
See Also:
removeFunction, listFunctions, getDescription, getCategory, getCodePageFlags
 o removeFunction
 public void removeFunction(String function)
Removes a function.

Parameters:
function - The function to be removed.
See Also:
addFunction, listFunctions
 o listFunctions
 public Enumeration listFunctions()
Lists the functions currently available in KeyRemap.

Returns:
Enumeration of current function Strings.
See Also:
addFunction, removeFunction
 o getDescription
 public String getDescription(String function)
Obtains the Description associated with the specified function. This is the text that appears in the Graphical User Interface.

Parameters:
function - The specified function.
Returns:
The Description associated with the specified function.
See Also:
addFunction
 o getCategory
 public String getCategory(String function)
Obtains the Category the specified function belongs to.

Parameters:
function - The specified function.
Returns:
The Category the specified function belongs to.
See Also:
addFunction, listCategories
 o getCodePageFlags
 public String getCodePageFlags()
Obtains the current Codepage Flags.

Returns:
The current Codepage Flags.
See Also:
addFunction
 o isDefaultFunction
 public boolean isDefaultFunction(String function)
Determines if the specified function is a default function.

Parameters:
function - The specified function.
Returns:
True - If the specified function is a default function.
False - If the specified function is not defined or not a default function.
See Also:
addFunction, listCategories
 o listCategories
 public Enumeration listCategories()
Lists the categories currently defined in KeyRemap.

Returns:
Enumeration of category Strings currently defined.
See Also:
getCategory
 o addMapping
 public void addMapping(String keystroke,
                        String function,
                        boolean isDefault)
Adds a mapping. Remaps the specified Keystroke to the specified function.

Parameters:
keystroke - The Keystroke to be remapped.
function - The function the Keystroke is remapped to.
isDefault - Specifies whether this mapping is a default mapping.
See Also:
removeMapping, getMapping, listMappings, resetMapping, isDefaultMapping, getKeystroke
 o removeMapping
 public void removeMapping(String keystroke)
Removes a mapping.

Parameters:
keystroke - The Keystroke to be unmapped.
See Also:
addMapping, getMapping, listMappings, resetMapping, isDefaultMapping, getKeystroke
 o getMapping
 public String getMapping(String keystroke)
Obtains the function that the specified Keystroke remaps too.

Parameters:
keystroke - The key pressed.
Returns:
The function that the specified Keystroke remaps too.
See Also:
addMapping, removeMapping, listMappings, resetMapping, isDefaultMapping, getKeystroke
 o listMappings
 public Enumeration listMappings(String function)
Lists the Keystrokes that remap to the specified function.

Parameters:
function - The specified function.
Returns:
Enumeration of Keystrokes that remap to the specified function.
See Also:
addMapping, removeMapping, getMapping, resetMapping, isDefaultMapping, getKeystroke
 o resetMapping
 public void resetMapping(String keystroke)
Resets the specified Keystroke to its default mapping.

Parameters:
keystroke - The specified Keystroke.
See Also:
addMapping, removeMapping, getMapping, listMappings, isDefaultMapping, getKeystroke
 o isDefaultMapping
 public boolean isDefaultMapping(String keystroke)
Determines if the specified Keystroke is currently mapped to its default.

Parameters:
function - The specified Keystroke.
Returns:
True - If the specified Keystroke is mapped to its default function.
False - If the specified Keystroke is not mapped or is not mapped to its default function.
See Also:
addMapping, removeMapping, getMapping, listMappings, resetMapping, getKeystroke
 o getKeystroke
 public static String getKeystroke(KeyEvent evt)
Obtains the Keystroke associated with the specified KeyEvent.

Parameters:
evt - A KeyEvent.
Returns:
The Keystroke associated with the specified KeyEvent.
Returns null if the specified KeyEvent is not a KEY_PRESSED KeyEvent.
See Also:
addMapping, removeMapping, getMapping, resetMapping, isDefaultMapping
 o apply
 public void apply()
Applies all non-default changes. All changes made through the Graphical User Interface or API are persisted and reflected in the Properties object returned when getProperties() is invoked.

See Also:
cancel, reset, setAutoApply, isAutoApply, getProperties
 o cancel
 public void cancel()
Cancels all non-default changes made since the apply() method was last invoked. Default changes are not affected by invoking this method.

See Also:
apply, reset
 o reset
 public void reset()
Resets KeyRemap to default functions, mappings, and non-repeating keys. The cancel() method can be invoked to restore the prior settings of KeyRemap before this method was invoked. The apply() method must be called before changes made by invoking this method are persisted and reflected in the Properties object returned by invoking getProperties().

See Also:
apply, cancel, getProperties
 o requestFocus
 public void requestFocus()
Transfers focus to the bean.

Overrides:
requestFocus
 o getSelectedPanelIndex
 public int getSelectedPanelIndex()
Obtains the index of the currently displayed panel. The Graphical User Interface consists of several panels with tabs. The first panel with the left most tab is the zero index panel.

Returns:
A zero based index of the currently displayed panel.
 o getTraceName
 public String getTraceName()
Obtains a trace identifier for this bean

Overrides:
getTraceName in class HODPanelBean
 o propertyChange
 public synchronized void propertyChange(PropertyChangeEvent evt)
PropertyChangeListener interface method. This method is called when other Beans that KeyRemap is listening to fire PropertyChangeEvents. KeyRemap is sensitive to both sessionType and codePage properties of other Beans such as the Terminal or Session Beans. When the sessionType or codePage changes on a Bean that KeyRemap is listening to, KeyRemap will change its own property to match. This may cause KeyRemap to reset itself based on the new properties.

Overrides:
propertyChange in class HODPanelBean
 o keyPressed
 public void keyPressed(KeyEvent evt)
KeyListener interface method.

 o keyReleased
 public void keyReleased(KeyEvent evt)
KeyListener interface method.

 o keyTyped
 public void keyTyped(KeyEvent evt)
KeyListener interface method.


All Packages  Class Hierarchy  This Package  Previous  Next  Index