Package com.spinyowl.legui.component

Class ToggleButton

java.lang.Object

com.spinyowl.legui.component.Component

com.spinyowl.legui.component.AbstractTextComponent

com.spinyowl.legui.component.Button

com.spinyowl.legui.component.ToggleButton

All Implemented Interfaces:

TextComponent, Serializable

public class ToggleButton
extends Button

An implementation of "toggle" button. Behavior the same as checkbox but have not any text.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.spinyowl.legui.component.Button

DEFAULT_BUTTON_TEXT

Fields inherited from class com.spinyowl.legui.component.AbstractTextComponent

textState

Constructor Summary

Constructors

Constructor	Description
ToggleButton()	Creates toggle button with default bg color and default toggled bg color.
ToggleButton(float x, float y, float width, float height)	Creates a button with specified position and size and default bg color and default toggled bg color.
ToggleButton(String text)	Creates toggle button with default bg color, toggled bg color and specified text.
ToggleButton(String text, float x, float y, float width, float height)	Creates a button with specified text and specified position and size.
ToggleButton(org.joml.Vector2f position, org.joml.Vector2f size)	Creates a button with specified position and size and default bg color and default toggled bg color.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
org.joml.Vector4f	getToggledBackgroundColor()	Returns background color which will be used as background color if button toggled.
Icon	getTogglededBackgroundIcon()	Returns toggled background icon.
int	hashCode()
boolean	isToggled()	Returns true if toggle button is toggled.
void	setToggled(boolean toggled)	Used to change toggled state.
void	setToggledBackgroundColor(org.joml.Vector4f toggledBackgroundColor)	Used to change background color which will be used as background color if button toggled.
void	setTogglededBackgroundIcon(Icon togglededBackgroundIcon)	Used to change toggled background icon.
String	toString()

Methods inherited from class com.spinyowl.legui.component.Button

getTextDirection, setTextDirection

Methods inherited from class com.spinyowl.legui.component.AbstractTextComponent

getTextState, setTextState

Methods inherited from class com.spinyowl.legui.component.Component

add, add, addAll, clearChildComponents, containerIterator, contains, containsAll, count, forEach, getAbsolutePosition, getChildComponents, getFocusedStyle, getFrame, getHoveredStyle, getIntersector, getLayer, getListenerMap, getMetadata, getParent, getPosition, getPressedStyle, getSize, getStyle, getTabIndex, getTooltip, indexOfChild, intersects, isEmpty, isEnabled, isFocusable, isFocused, isHovered, isPressed, isTabFocusable, isVisible, keepRendering, keepRendering, parallelStream, remove, remove, removeAll, removeIf, setEnabled, setFocusable, setFocused, setHovered, setIntersector, setListenerMap, setParent, setPosition, setPosition, setPressed, setSize, setSize, setStyle, setTabFocusable, setTabIndex, setTooltip, stream

Methods inherited from class java.lang.Object

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

Constructor Details

ToggleButton

public ToggleButton(String text,
 float x,
 float y,
 float width,
 float height)

Creates a button with specified text and specified position and size.

Parameters:

text - button text.

x - x position in parent.

y - y position in parent.

width - width of component.

height - height of component.

ToggleButton

public ToggleButton()

Creates toggle button with default bg color and default toggled bg color.

ToggleButton

public ToggleButton(String text)

Creates toggle button with default bg color, toggled bg color and specified text.

Parameters:

text - button text.

ToggleButton

public ToggleButton(float x,
 float y,
 float width,
 float height)

Creates a button with specified position and size and default bg color and default toggled bg color.

Parameters:

x - x position in parent.

y - y position in parent.

width - width of component.

height - height of component.

ToggleButton

public ToggleButton(org.joml.Vector2f position,
 org.joml.Vector2f size)

Creates a button with specified position and size and default bg color and default toggled bg color.

Parameters:

position - position in parent.

size - size of component.

Method Details

isToggled

public boolean isToggled()

Returns true if toggle button is toggled.

Returns:

true if toggle button is toggled.

setToggled

public void setToggled(boolean toggled)

Used to change toggled state.

Parameters:

toggled - new value.

getToggledBackgroundColor

public org.joml.Vector4f getToggledBackgroundColor()

Returns background color which will be used as background color if button toggled.

Returns:

toggled button color.

setToggledBackgroundColor

public void setToggledBackgroundColor(org.joml.Vector4f toggledBackgroundColor)

Used to change background color which will be used as background color if button toggled.

Parameters:

toggledBackgroundColor - new value.

getTogglededBackgroundIcon

public Icon getTogglededBackgroundIcon()

Returns toggled background icon.

Returns:

toggled background icon.

setTogglededBackgroundIcon

public void setTogglededBackgroundIcon(Icon togglededBackgroundIcon)

Used to change toggled background icon.

Parameters:

togglededBackgroundIcon - toggled background icon.

equals

public boolean equals(Object o)

Overrides:

equals in class Button

hashCode

public int hashCode()

Overrides:

hashCode in class Button

toString

public String toString()

Overrides:

toString in class Button