org.cell2d.control

Class Control

java.lang.Object

org.cell2d.control.Control

Direct Known Subclasses:

ControllerControl, KeyControl, MouseButtonControl

public abstract class Control
extends java.lang.Object

A Control represents a form of input that can be pressed, held, and released, such as a key, mouse button, or controller button. A Control may be bound to a CellGame's command, allowing it to respond to the input that the Control represents. All instances of subclasses of Control are equal if and only if they represent the same input.

See Also:

CellGame.bindControl(int, org.cell2d.control.Control)

Constructor Summary

Constructors

Constructor and Description
Control()

Method Summary

Modifier and Type	Method and Description
static Control	getControl(java.lang.String name) Returns a Control whose name according to getName() is the specified String, or null if no Control has that String as a name.
abstract java.lang.String	getName() Returns a short, descriptive, and unique String name for this Control.

Methods inherited from class java.lang.Object

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

Constructor Detail

Control

public Control()

Method Detail

getName

public abstract java.lang.String getName()

Returns a short, descriptive, and unique String name for this Control. The name will be no more than 6 characters long and contain only ASCII characters and no whitespace. Two distinct Control objects have the same name if and only if they are equal.

Returns:

This Control's name

getControl

public static Control getControl(java.lang.String name)

Returns a Control whose name according to getName() is the specified String, or null if no Control has that String as a name.

Parameters:

name - The name of the Control to be returned

Returns:

A Control whose name is the specified String