Interface GUIToggleable

All Superinterfaces:

GUIValueField<Boolean>

All Known Implementing Classes:

GUICheckbox, GUIRadioButton, GUITogglePanel

public interface GUIToggleable
extends GUIValueField<Boolean>

Describes a GUI object that can be toggled between two states.

Author:

Matthew Tropiano

Field Summary

Fields inherited from interface GUIValueField

EVENT_VALUE_CHANGE

Method Summary

Modifier and Type	Method	Description
boolean	isSet()	Gets the state of this toggleable object.
GUIToggleable	setState(boolean state)	Changes the state of this toggleable object to the specified state.
GUIToggleable	toggle()	Changes the state of this toggleable object to the opposite state.

Methods inherited from interface GUIValueField

getValue, setValue

Method Details

isSet

boolean isSet()

Gets the state of this toggleable object.

Returns:

true if this is in the enabled state, false if not.

toggle

GUIToggleable toggle()

Changes the state of this toggleable object to the opposite state. If true, calling this sets it to false. If false, calling this sets it to true.

Returns:

itself, to chain calls.

setState

GUIToggleable setState(boolean state)

Changes the state of this toggleable object to the specified state. Must fire an GUIValueField.EVENT_VALUE_CHANGE if the state of this object changes.

Parameters:

state - the new state.

Returns:

itself, to chain calls.