org.jowidgets.common.types

Class Accelerator

java.lang.Object

org.jowidgets.common.types.Accelerator

public final class Accelerator
extends java.lang.Object

This class defines a key accelerator consisting of an key and a set of key modifiers

Constructor Summary

Constructors

Constructor and Description
Accelerator(char key, java.util.Collection<Modifier> modifier) Creates a new key accelerator
Accelerator(char key, Modifier... modifier) Creates a new key accelerator
Accelerator(VirtualKey virtualKey, java.util.Collection<Modifier> modifier) Creates a new key accelerator
Accelerator(VirtualKey virtualKey, Modifier... modifier) Creates a new key accelerator

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Character	getCharacter() Gets the accelerators character or null if the accelerator is defined with a virtual key.
java.util.List<Modifier>	getModifier() The modifiers or an empty list if no modifiers are defined
VirtualKey	getVirtualKey() Gets the accelerators virtual key or null if the accelerator is defined with a character.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Accelerator

public Accelerator(VirtualKey virtualKey,
           Modifier... modifier)

Creates a new key accelerator

Parameters:

virtualKey - The virtual key to use

modifier - The modifier keys to use

Accelerator

public Accelerator(VirtualKey virtualKey,
           java.util.Collection<Modifier> modifier)

Creates a new key accelerator

Parameters:

virtualKey - The virtual key to use

modifier - The modifier keys to use

Accelerator

public Accelerator(char key,
           Modifier... modifier)

Creates a new key accelerator

Parameters:

virtualKey - The character to use

modifier - The modifier keys to use

Accelerator

public Accelerator(char key,
           java.util.Collection<Modifier> modifier)

Creates a new key accelerator

Parameters:

virtualKey - The character to use

modifier - The modifier keys to use

Method Detail

getCharacter

public java.lang.Character getCharacter()

Gets the accelerators character or null if the accelerator is defined with a virtual key. Remark: If the character is null, the virtual key is not null and vice versa

Returns:

The character or null

getVirtualKey

public VirtualKey getVirtualKey()

Gets the accelerators virtual key or null if the accelerator is defined with a character. Remark: If the character is null, the virtual key is not null and vice versa

Returns:

The virtual key or null

getModifier

public java.util.List<Modifier> getModifier()

The modifiers or an empty list if no modifiers are defined

Returns:

The odifers or an empry list

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object