Serialized Form

Package com.spinyowl.legui.component

Class com.spinyowl.legui.component.AbstractTextComponent

class AbstractTextComponent extends Component implements Serializable

Serialized Fields

textState

TextState textState

Class com.spinyowl.legui.component.Button

class Button extends AbstractTextComponent implements Serializable

Serialized Fields

textDirection

TextDirection textDirection

Used to set text direction (vertical, horizontal).

Class com.spinyowl.legui.component.CheckBox

class CheckBox extends AbstractTextComponent implements Serializable

Serialized Fields

checked

boolean checked

Checkbox state.

iconChecked

Icon iconChecked

Icon used to show checked state of checkbox.

iconUnchecked

Icon iconUnchecked

Icon used to show unchecked state of checkbox.

Class com.spinyowl.legui.component.Component

class Component extends Object implements Serializable

Serialized Fields

childComponents

List<Component> childComponents

List of child components.

enabled

boolean enabled

Used to enable and disable event processing for this component. If enabled==false then component won't receive events.

focusable

boolean focusable

Show if component can be focused.
Note! You should take in consideration that component that marked as non-focusable will not receive any events. In fact this could be used to organize elements using containers.

focused

boolean focused

Determines whether this component focused or not.

focusedStyle

Style focusedStyle

Component style.

hovered

boolean hovered

Determines whether this component hovered or not (cursor is over this component).

hoveredStyle

Style hoveredStyle

Component style.

intersector

Intersector intersector

Intersector which used to determine for example if cursor intersects component or not. Cannot be null.

keepRendering

boolean keepRendering

Used to redefine rendering pipeline to not skip element rendering if it is not visible in parent components (is out of view).

listenerMap

ListenerMap listenerMap

Map for UI event listeners.

metadata

Map<String,Object> metadata

Metadata map, place where renderers or event processors can store state of component.

parent

Component parent

Parent component container. For root components it could be null.

position

org.joml.Vector2f position

Position of component relative top left corner in parent component.

If component is the root component then position calculated relative window top left corner.

pressed

boolean pressed

Determines whether this component pressed or not (Mouse button is down and on this component).

pressedStyle

Style pressedStyle

Component style.

size

org.joml.Vector2f size

Size of component.

style

Style style

Component style.

tabFocusable

boolean tabFocusable

Show if component can be focused by tabbing.

tabIndex

int tabIndex

Tab index. Used to switch between components using tab key.

tooltip

Tooltip tooltip

Tooltip.

Class com.spinyowl.legui.component.Dialog

class Dialog extends Widget implements Serializable

Serialized Fields

dialogLayer

Dialog.DialogLayer dialogLayer

Used to hold dialog.

frame

Frame frame

Used to hold dialog layer with dialog.

Class com.spinyowl.legui.component.Dialog.DialogLayer

class DialogLayer extends Layer implements Serializable

Class com.spinyowl.legui.component.ImageView

class ImageView extends Component implements Serializable

Serialized Fields

image

Image image

BufferedImage (or image data).

Class com.spinyowl.legui.component.Label

class Label extends AbstractTextComponent implements Serializable

Serialized Fields

textDirection

TextDirection textDirection

Used to set text direction (vertical, horizontal).

Class com.spinyowl.legui.component.Layer

class Layer extends Component implements Serializable

Serialized Fields

eventPassable

boolean eventPassable

Determines if current layer allow to pass events to bottom layer if event wasn't handled by components of this layer.

eventReceivable

boolean eventReceivable

Determines if current layer and all of it components can receive events.

frame

Frame frame

Parent frame.

Class com.spinyowl.legui.component.Panel

class Panel extends Component implements Serializable

Class com.spinyowl.legui.component.PasswordInput

class PasswordInput extends TextInput implements Serializable

Serialized Fields

maskCharacter

int maskCharacter

Used to mask password.

masked

boolean masked

Used to enable or disable masking

Class com.spinyowl.legui.component.ProgressBar

class ProgressBar extends Component implements Serializable

Serialized Fields

progressColor

org.joml.Vector4f progressColor

Color of progress bar.

value

float value

Used to display current status.

Class com.spinyowl.legui.component.RadioButton

class RadioButton extends AbstractTextComponent implements Serializable

Serialized Fields

checked

boolean checked

Used to represent if radio button checked or not.

iconChecked

Icon iconChecked

Used to render checked state of radio button.

iconUnchecked

Icon iconUnchecked

Used to render unchecked state of radio button.

radioButtonGroup

RadioButtonGroup radioButtonGroup

Used to determine group of radio buttons where only one can be checked.

Class com.spinyowl.legui.component.RadioButtonGroup

class RadioButtonGroup extends Object implements Serializable

Serialized Fields

index

int index

Index of radio button group.

radioButtons

List<RadioButton> radioButtons

Used to hold radio buttons.

selection

RadioButton selection

Currently selected radio button.

Class com.spinyowl.legui.component.ScrollablePanel

class ScrollablePanel extends Component implements Serializable

Serialized Fields

animation

Animation animation

Scrollable panel animation. Updates container position in viewport.

autoResize

boolean autoResize

container

Component container

Used to hold components added by user.

horizontalScrollBar

ScrollBar horizontalScrollBar

Used to scroll panel horizontally.

verticalScrollBar

ScrollBar verticalScrollBar

Used to scroll panel vertically.

viewport

Component viewport

Base container which holds component container. Viewport size is limited by scroll bars and parent ScrollablePanel size.

Class com.spinyowl.legui.component.ScrollablePanel.ScrollablePanelContainer

class ScrollablePanelContainer extends Panel implements Serializable

Class com.spinyowl.legui.component.ScrollablePanel.ScrollablePanelViewport

class ScrollablePanelViewport extends Panel implements Serializable

Class com.spinyowl.legui.component.ScrollBar

class ScrollBar extends Component implements Serializable

Serialized Fields

animation

Animation animation

arrowColor

org.joml.Vector4f arrowColor

Defines arrow color.

arrowsEnabled

boolean arrowsEnabled

Defines if scrollbar has arrows or not.

arrowSize

float arrowSize

Defines size of arrows.

curValue

float curValue

Current value.

maxValue

float maxValue

Maximum value.

minValue

float minValue

Minimum value.

orientation

Orientation orientation

Used to determine if scroll bar vertical or horizontal.

scrollColor

org.joml.Vector4f scrollColor

Defines scrollbar color.

scrolling

boolean scrolling

Mostly used by event listeners. Shows if scrollbar is currently scrolling or not.

scrollStep

float scrollStep

Scroll step. Used to determine delta which should be added on scroll event.

viewport

Viewport viewport

Viewport.

visibleAmount

float visibleAmount

Used to determine visible part of viewport.

Class com.spinyowl.legui.component.SelectBox

class SelectBox extends Component implements Serializable

Serialized Fields

buttonWidth

float buttonWidth

collapsed

boolean collapsed

collapseIcon

Icon collapseIcon

elementHeight

float elementHeight

elements

List<T> elements

expandButton

Button expandButton

expandIcon

Icon expandIcon

Expand button icon (Char icon).

lock

Lock lock

selectBoxElements

List<SelectBox<T>.SelectBoxElement<T>> selectBoxElements

selectBoxLayer

SelectBox.SelectBoxLayer selectBoxLayer

selectedElement

T selectedElement

selectionButton

Button selectionButton

selectionListPanel

SelectBox<T>.SelectBoxScrollablePanel selectionListPanel

visibleCount

int visibleCount

Class com.spinyowl.legui.component.SelectBox.SelectBoxElement

class SelectBoxElement extends Button implements Serializable

Serialized Fields

object

T object

selected

boolean selected

Class com.spinyowl.legui.component.SelectBox.SelectBoxLayer

class SelectBoxLayer extends Layer implements Serializable

Class com.spinyowl.legui.component.SelectBox.SelectBoxScrollablePanel

class SelectBoxScrollablePanel extends ScrollablePanel implements Serializable

Class com.spinyowl.legui.component.Slider

class Slider extends Component implements Serializable

Serialized Fields

maxValue

float maxValue

Maximum value of the slider.

minValue

float minValue

Maximum value of the slider.

orientation

Orientation orientation

Slider orientation.

sliderActiveColor

org.joml.Vector4f sliderActiveColor

Slider active color.

sliderColor

org.joml.Vector4f sliderColor

Slider color.

sliderSize

float sliderSize

Slider size. Size of slider knob. (Knob size).

stepSize

float stepSize

The step size of the slider.

value

float value

Slider value.

Class com.spinyowl.legui.component.SplitPanel

class SplitPanel extends Panel implements Serializable

Serialized Fields

bottomRight

Component bottomRight

orientation

Orientation orientation

ratio

float ratio

separator

com.spinyowl.legui.component.SplitPanel.SeparatorButton separator

separatorThickness

float separatorThickness

topLeft

Component topLeft

Class com.spinyowl.legui.component.TextArea

class TextArea extends Component implements Serializable

Serialized Fields

animation

Animation animation

Scrollable panel animation. Updates container position in viewport.

horizontalScrollBar

ScrollBar horizontalScrollBar

Used to scroll panel horizontally.

textAreaField

TextAreaField textAreaField

verticalScrollBar

ScrollBar verticalScrollBar

Used to scroll panel vertically.

viewport

Component viewport

Base container which holds component container. Viewport size is limited by scroll bars and parent ScrollablePanel size.

Class com.spinyowl.legui.component.TextArea.TextAreaViewport

class TextAreaViewport extends Panel implements Serializable

Class com.spinyowl.legui.component.TextAreaField

class TextAreaField extends AbstractTextComponent implements Serializable

Serialized Fields

stickToAlignment

boolean stickToAlignment

tabSize

int tabSize

Used to describe size of '\t' symbol in spaces.

Class com.spinyowl.legui.component.TextInput

class TextInput extends AbstractTextComponent implements Serializable

Class com.spinyowl.legui.component.ToggleButton

class ToggleButton extends Button implements Serializable

Serialized Fields

toggled

boolean toggled

toggledBackgroundColor

org.joml.Vector4f toggledBackgroundColor

togglededBackgroundIcon

Icon togglededBackgroundIcon

Class com.spinyowl.legui.component.Tooltip

class Tooltip extends AbstractTextComponent implements Serializable

Serialized Fields

component

Component component

Class com.spinyowl.legui.component.Widget

class Widget extends Component implements Serializable

Serialized Fields

ascendible

boolean ascendible

closeButton

Button closeButton

closeIcon

Icon closeIcon

container

Component container

draggable

boolean draggable

maximizedHeight

Length maximizedHeight

maximizedMaxHeight

Length maximizedMaxHeight

maximizedMaxWidth

Length maximizedMaxWidth

maximizedMinHeight

Length maximizedMinHeight

maximizedMinWidth

Length maximizedMinWidth

maximizedSize

org.joml.Vector2f maximizedSize

Used to store widget size in maximized state when minimizing widget.

maximizedWidth

Length maximizedWidth

maximizeIcon

Icon maximizeIcon

minimizeButton

Button minimizeButton

minimized

boolean minimized

minimizeIcon

Icon minimizeIcon

mouseDragEventLeguiEventListener

MouseDragEventListener mouseDragEventLeguiEventListener

resizable

boolean resizable

resizeButton

Button resizeButton

title

Label title

titleContainer

Component titleContainer

Package com.spinyowl.legui.component.optional

Class com.spinyowl.legui.component.optional.TextState

class TextState extends Object implements Serializable

Serialized Fields

caretPosition

int caretPosition

Used to store caret position in text.

caretX

Float caretX

caretY

Float caretY

editable

boolean editable

Used to store text input editable state. If true then text could be updated by user input.

endSelectionIndex

int endSelectionIndex

Used to store end selection index.

mouseCaretPosition

int mouseCaretPosition

Used to store caret position calculated on mouse position base. Updated by renderers.

startSelectionIndex

int startSelectionIndex

Used to store start selection index.

text

String text

Text data.

textHeight

float textHeight

textSetCallback

BiConsumer<String,String> textSetCallback

Should be defined to call some extra functionality after TextState.setText(String). Accepts old value as first arg, and new value as the second arg.

textWidth

float textWidth

validator

Predicate<String> validator

Package com.spinyowl.legui.demo

Class com.spinyowl.legui.demo.ExampleGui

class ExampleGui extends Panel implements Serializable

Serialized Fields

debugLabel

Label debugLabel

focusedGuiLabel

Label focusedGuiLabel

generateEventsByLayoutManager

CheckBox generateEventsByLayoutManager

imageView

ImageView imageView

mouseLabel

Label mouseLabel

mouseTargetLabel

Label mouseTargetLabel

splitPanel

SplitPanel splitPanel

textArea

TextArea textArea

textInput

TextInput textInput

upsLabel

Label upsLabel

Package com.spinyowl.legui.exception

Exception com.spinyowl.legui.exception.LeguiException

class LeguiException extends RuntimeException implements Serializable

Package com.spinyowl.legui.icon

Class com.spinyowl.legui.icon.CharIcon

class CharIcon extends Icon implements Serializable

Serialized Fields

charCode

char charCode

Used to hold icon character.

color

org.joml.Vector4f color

Used to hold icon color.

font

String font

Used to hold icon font.

Class com.spinyowl.legui.icon.Icon

class Icon extends Object implements Serializable

Serialized Fields

horizontalAlign

HorizontalAlign horizontalAlign

Icon horizontal alignment in component.

position

org.joml.Vector2f position

Icon position.

size

org.joml.Vector2f size

Icon size.

verticalAlign

VerticalAlign verticalAlign

Icon vertical alignment in component.

Class com.spinyowl.legui.icon.ImageIcon

class ImageIcon extends Icon implements Serializable

Serialized Fields

image

Image image