io.elevator.components

Class Buttons<T>

java.lang.Object

io.elevator.components.Buttons<T>

Type Parameters:

T - The type of data to be stored in the button

All Implemented Interfaces:

Drawable

public class Buttons<T>
extends java.lang.Object
implements Drawable

A class representing the driver for physical buttons having boolean states to represent whether the button has been pressed, and to represent whether the button is active lighted, and a generic data type to convey information. This is the passive implementation of a button

Author:

Kage Weiss

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CLOSE
static boolean	DOWN
static boolean	OPEN
static boolean	UP

Constructor Summary

Constructors

Constructor and Description
Buttons(boolean pressed, boolean lit, T data) Creates a button based on the provided parameters
Buttons(T data) Creates a basic, unpressed and unlit, Button with some data

Method Summary

Modifier and Type	Method and Description
T	getData()
javafx.scene.image.ImageView	getRepresentation() Gets the reference to an object of type ImageView in which this Drawable stores its representation.
boolean	isLit()
boolean	isPressed()
Buttons<T>	press() Used to set the pressed status of the button to true Note: this does NOT light the button.
Drawable	setImageView(javafx.scene.image.ImageView representation) Sets the reference to an object of type ImageView into which this Drawable should store its representation.
Buttons<T>	setLit() Used to toggle the light status of a button
Buttons<T>	setLit(boolean lit) Used to set the light status of a button
Buttons<T>	setPressed(boolean pressed) Used to set the pressed status of a button
Buttons<T>	togglePress() Used to toggle the pressed status of a button
java.lang.String	toString()
Drawable	updateRepresentation() Updates the stored reference with a representation that represents the state of this Drawable

Methods inherited from class java.lang.Object

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

Field Detail

UP

public static final boolean UP

See Also:

Constant Field Values

OPEN

public static final boolean OPEN

See Also:

Constant Field Values

DOWN

public static final boolean DOWN

See Also:

Constant Field Values

CLOSE

public static final boolean CLOSE

See Also:

Constant Field Values

Constructor Detail

Buttons

public Buttons(T data)

Creates a basic, unpressed and unlit, Button with some data

Parameters:

data - The data used to identify the function of this button

Buttons

public Buttons(boolean pressed,
               boolean lit,
               T data)

Creates a button based on the provided parameters

Parameters:

pressed - Boolean state representing whether the Button has been pressed

lit - Boolean state representing whether the Button is currently lit

data - The data used to identify the function of this button

Method Detail

isPressed

public boolean isPressed()

Returns:

Boolean state representing whether the Button has been pressed

isLit

public boolean isLit()

Returns:

Boolean state representing whether the Button is currently lit

setLit

public Buttons<T> setLit(boolean lit)

Used to set the light status of a button

Parameters:

lit - Boolean state representing whether the Button is currently lit

Returns:

This Button

setLit

public Buttons<T> setLit()

Used to toggle the light status of a button

Returns:

This Button

getData

public T getData()

Returns:

The data used to identify the function of this button

press

public Buttons<T> press()

Used to set the pressed status of the button to true Note: this does NOT light the button. The software must do that.

Returns:

This Button

setPressed

public Buttons<T> setPressed(boolean pressed)

Used to set the pressed status of a button

Parameters:

pressed - Boolean state representing whether the Button is currently pressed

Returns:

This Button

togglePress

public Buttons<T> togglePress()

Used to toggle the pressed status of a button

Returns:

This Button

setImageView

public Drawable setImageView(javafx.scene.image.ImageView representation)

Description copied from interface: Drawable

Sets the reference to an object of type ImageView into which this Drawable should store its representation. The passed reference should be stored, and an immediate call to updateRepresentation() should be made.

Specified by:

setImageView in interface Drawable

Parameters:

representation - The reference to the ImageView in which the representation of this Drawable should be placed

Returns:

this Drawable

getRepresentation

public javafx.scene.image.ImageView getRepresentation()

Description copied from interface: Drawable

Gets the reference to an object of type ImageView in which this Drawable stores its representation.

Specified by:

getRepresentation in interface Drawable

Returns:

The reference to the representation of this Drawable.

updateRepresentation

public Drawable updateRepresentation()

Description copied from interface: Drawable

Updates the stored reference with a representation that represents the state of this Drawable

Specified by:

updateRepresentation in interface Drawable

Returns:

this Drawable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object