Package org.hexworks.zircon.api.component

This package contains the public API of the Component abstraction. Components are text GUI elements that you can use on Screens and Views.

Types

AlignmentStrategy
Link copied to clipboard
common
fun fun interface AlignmentStrategy
An AlignmentStrategy can be used to calculate the Position of a Boundable (such as Components) relative to another one.
AttachedComponent
Link copied to clipboard
common
interface AttachedComponent : Component
Decorator that represents a Component which is attached to a ComponentContainer.
Button
Link copied to clipboard
common
interface Button : Component, TextOverride
A Component that looks like a button visually and can be activated by either clicking on it or pressing the action key (<Spacebar> by default).
CheckBox
Link copied to clipboard
common
interface CheckBox : Component, Selectable, TextOverride
A CheckBox is a Selectable that represents its Selectable.isSelected state with a check box.
ColorTheme
Link copied to clipboard
common
interface ColorTheme
A ColorTheme can be used to give a Component context-dependent styles.
Component
Link copied to clipboard
common
A Component is a graphical text GUI element and can be used either to display information to the user or to enable the user to interact with the program.
ComponentAlignment
Link copied to clipboard
common
enum ComponentAlignment : Enum<ComponentAlignment>
Contains the possible alignment options for a Boundable object relative to other Boundable objects.
ComponentContainer
Link copied to clipboard
common
interface ComponentContainer : ColorThemeOverride
Represents an object that can contain gui Components and also maintains a theme property that's synchronized between its child Components.
ComponentProperties
Link copied to clipboard
common
This interface contains all the common properties that a UI Component can have.
ComponentStyleSet
Link copied to clipboard
common
interface ComponentStyleSet
This interface represents a collection of StyleSets which will be used when a Component's ComponentState changes.
Container
Link copied to clipboard
common
interface Container : Component, ComponentContainer
A Container is a Component that can contain other components.
Fragment
Link copied to clipboard
common
interface Fragment
A Fragment is a reusable container for a Component.
Group
Link copied to clipboard
common
interface Group<T : Component> : ComponentProperties
A Group is a logical grouping of Components.
HBox
Link copied to clipboard
common
interface HBox : Container, TitleOverride
A HBox is a Container that automatically aligns elements added to it horizontally (from left to right) and can contain a title.
Header
Link copied to clipboard
common
interface Header : Component, TextOverride
A Header is a non-interactive Component that semantically represents a header.
Icon
Link copied to clipboard
common
interface Icon : Component
An Icon is a non-interactive Component that semantically represents an icon.
Label
Link copied to clipboard
common
interface Label : Component, TextOverride
A Label is a non-interactive Component that semantically represents a label.
ListItem
Link copied to clipboard
common
interface ListItem : Component, TextOverride
A ListItem is a non-interactive Component that semantically represents a textual list item.
LogArea
Link copied to clipboard
common
interface LogArea : Component, Clearable
A LogArea provides the possibility to display a stream of messages.
NumberInput
Link copied to clipboard
common
interface NumberInput : Component
Panel
Link copied to clipboard
common
interface Panel : Container, TitleOverride
A simple Container for Components that can contain a title and doesn't align its children.
Paragraph
Link copied to clipboard
common
interface Paragraph : Component, TextOverride
A Paragraph is a non-interactive Component that semantically represents a paragraph of text.
ProgressBar
Link copied to clipboard
common
interface ProgressBar : Component
A ProgressBar visualizes the progress of an operation.
RadioButton
Link copied to clipboard
common
interface RadioButton : Component, Selectable, TextOverride
A radio button is a Selectable that can only be selected once.
RadioButtonGroup
Link copied to clipboard
common
interface RadioButtonGroup : Group<RadioButton>
A RadioButtonGroup is a specialization of a Group that will enforce that only one RadioButton is selected in it at all times.
ScrollBar
Link copied to clipboard
common
interface ScrollBar : Component
A ScrollBar is a Component that can be used for scrolling content.
Slider
Link copied to clipboard
common
interface Slider : Component
A Slider is a Component that can be used to select values from a range of numbers with a visual sliding mechanism.
TextArea
Link copied to clipboard
common
interface TextArea : Component, Scrollable
A TextArea is an editable text box.
TextBox
Link copied to clipboard
common
interface TextBox : Component
A TextBox is a Component that contains non-editable stylized text (headers, paragraphs, list items, etc.
ToggleButton
Link copied to clipboard
common
interface ToggleButton : Component, Selectable, TextOverride
A ToggleButton is an Component that's Selectable and will visually display its Selectable.isSelected state.
VBox
Link copied to clipboard
common
interface VBox : Container, TitleOverride
A VBox is a Container that automatically aligns its child elements vertically (from top to bottom).