multiplicity3.csys.items.keyboard.model

Class KeyboardKey

java.lang.Object

multiplicity3.csys.items.keyboard.model.KeyboardKey

public class KeyboardKey
extends java.lang.Object

The Class KeyboardKey.

Constructor Summary

Constructors

Constructor and Description
KeyboardKey(CharacterKey defaultCharacter, java.awt.Shape keyShape) Instantiates a new keyboard key.

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getBackgroundColour() Gets the background colour.
int	getKeyCode() Gets the key code.
java.awt.Shape	getKeyShape() Gets the key shape.
java.lang.String	getKeyStringRepresentation() Gets the key string representation.
java.awt.Color	getKeyTextColour() Gets the key text colour.
int	getMaxX() Gets the max x.
int	getMaxY() Gets the max y.
int	getMinX() Gets the min x.
int	getMinY() Gets the min y.
KeyModifiers	getModifiers() Gets the modifiers.
boolean	isEnabled() Checks if is enabled.
void	setBackgroundColour(java.awt.Color backgroundColour) Sets the background colour.
void	setEnabled(boolean enabled) Sets the enabled.
void	setKeyShape(java.awt.Shape keyShape) Sets the key shape.
void	setKeyTextColour(java.awt.Color keyTextColour) Sets the key text colour.
void	setModifiers(KeyModifiers modifiers) Sets the modifiers.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyboardKey

public KeyboardKey(CharacterKey defaultCharacter,
           java.awt.Shape keyShape)

Instantiates a new keyboard key.

Parameters:

defaultCharacter - the default character

keyShape - the key shape

Method Detail

getBackgroundColour

public java.awt.Color getBackgroundColour()

Gets the background colour.

Returns:

the background colour

getKeyCode

public int getKeyCode()

Gets the key code.

Returns:

the key code

getKeyShape

public java.awt.Shape getKeyShape()

Gets the key shape.

Returns:

the key shape

getKeyStringRepresentation

public java.lang.String getKeyStringRepresentation()

Gets the key string representation.

Returns:

the key string representation

getKeyTextColour

public java.awt.Color getKeyTextColour()

Gets the key text colour.

Returns:

the key text colour

getMaxX

public int getMaxX()

Gets the max x.

Returns:

the max x

getMaxY

public int getMaxY()

Gets the max y.

Returns:

the max y

getMinX

public int getMinX()

Gets the min x.

Returns:

the min x

getMinY

public int getMinY()

Gets the min y.

Returns:

the min y

getModifiers

public KeyModifiers getModifiers()

Gets the modifiers.

Returns:

the modifiers

isEnabled

public boolean isEnabled()

Checks if is enabled.

Returns:

true, if is enabled

setBackgroundColour

public void setBackgroundColour(java.awt.Color backgroundColour)

Sets the background colour.

Parameters:

backgroundColour - the new background colour

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled.

Parameters:

enabled - the new enabled

setKeyShape

public void setKeyShape(java.awt.Shape keyShape)

Sets the key shape.

Parameters:

keyShape - the new key shape

setKeyTextColour

public void setKeyTextColour(java.awt.Color keyTextColour)

Sets the key text colour.

Parameters:

keyTextColour - the new key text colour

setModifiers

public void setModifiers(KeyModifiers modifiers)

Sets the modifiers.

Parameters:

modifiers - the new modifiers