satin.uishell
Class ModifierKey

java.lang.Object
  |
  +--satin.common.Enum
        |
        +--satin.uishell.ModifierKey

public class ModifierKey
extends Enum

Identifies one of several modifier (shift) keys on the keyboard. The UI Shell is MacIntosh-oriented; there is no Alt key.

Author:

Ed Stauff

Constant Summary

static final ModifierKey	APPLE The apple key (an alias for COMMAND).
static final ModifierKey	COMMAND The command (apple) key.
static final ModifierKey	CONTROL The control key.
static final ModifierKey	OPTION The option key.
static final ModifierKey	SHIFT The shift key.

Field Summary

final int

value The integer value used in MacIntosh system calls.

Fields inherited from class satin.common.Enum

name

Constructor Summary

protected

ModifierKey(java.lang.String name, int value) The constructor.

Method Summary

static int	getValues(ModifierKey[] shiftKeys) Combines the values of zero or more ShiftKeys constants using bit-wise "OR".
static java.lang.String	toString(ModifierKey[] shiftKeys) Converts an array of ShiftKeys to a string.

Methods inherited from class satin.common.Enum

toString

Methods inherited from class java.lang.Object

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

Constant Detail

SHIFT

public static final ModifierKey SHIFT

The shift key.

CONTROL

public static final ModifierKey CONTROL

The control key.

OPTION

public static final ModifierKey OPTION

The option key.

COMMAND

public static final ModifierKey COMMAND

The command (apple) key.

APPLE

public static final ModifierKey APPLE

The apple key (an alias for COMMAND).

Field Detail

value

public final int value

The integer value used in MacIntosh system calls.

Constructor Detail

ModifierKey

protected ModifierKey(java.lang.String name,
                      int value)

The constructor.

Parameters:

name

the name of the status.

value

the integer value.

Method Detail

getValues

public static int getValues(ModifierKey[] shiftKeys)

Combines the values of zero or more ShiftKeys constants using bit-wise "OR".

toString

public static java.lang.String toString(ModifierKey[] shiftKeys)

Converts an array of ShiftKeys to a string. The string will contain the name of each shift key in the array, separated by commas.

Returns:

a string representing the shift keys.

Revision History

7/26/01 - code review.

4/6/01 Ed Stauff - changes per review.

3/28/01 Ed Stauff - initial review by Satin team.