JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.cell
Class JCKeyModifier

java.lang.Object
  |
  +--com.klg.jclass.cell.JCKeyModifier
All Implemented Interfaces:
Serializable

public class JCKeyModifier
extends Object
implements Serializable

This class is a container for a key code and a modifier value. It is used by JCCellEditor to pass back reserved key/modifier combinations.

See Also:
Serialized Form

Field Summary
static int ALL
          Modifier value that indicates all modifiers active.
 boolean canInitializeEdit
          Determines whether the key and modifier can be used to initialize an edit.
 int key
          Key code.
 int modifier
          Modifer for the key code.
static int NONE
          Modifier value that indicates no modifiers active.
 
Constructor Summary
JCKeyModifier(int key)
          Constructor used to represent a key press with all modifiers active.
JCKeyModifier(int key, int modifier)
          Convenience constructor.
JCKeyModifier(int key, int modifier, boolean canInitializeEdit)
          Convenience constructor.
 
Method Summary
 boolean match(int key, int modifier)
          Determines whether the specified key/modifier combination matches the one stored in this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

key

public int key
Key code.


modifier

public int modifier
Modifer for the key code.


canInitializeEdit

public boolean canInitializeEdit
Determines whether the key and modifier can be used to initialize an edit.


ALL

public static final int ALL
Modifier value that indicates all modifiers active.

See Also:
Constant Field Values

NONE

public static final int NONE
Modifier value that indicates no modifiers active.

See Also:
Constant Field Values
Constructor Detail

JCKeyModifier

public JCKeyModifier(int key,
                     int modifier,
                     boolean canInitializeEdit)
Convenience constructor. Use ALL to specify that all modifiers apply to this keycode. If a key plus modifier are flagged true for canInitializeEdit, then that key combination will invoke the editor.

Parameters:
canInitializeEdit -
key -
modifier -

JCKeyModifier

public JCKeyModifier(int key,
                     int modifier)
Convenience constructor. Use ALL to specify that all modifiers apply to this keycode.

Parameters:
key -
modifier -

JCKeyModifier

public JCKeyModifier(int key)
Constructor used to represent a key press with all modifiers active.

Parameters:
key -
Method Detail

match

public boolean match(int key,
                     int modifier)
Determines whether the specified key/modifier combination matches the one stored in this object.

Parameters:
key -
modifier -
Returns:

Copyright © 2004 Quest Software Inc..
All rights reserved.