Package tools.aqua.bgw.components.uicomponents

Types

Link copied to clipboard
sealed class BinaryStateButton : LabeledUIComponent

Baseclass for ToggleButtons and RadioButtons.

Link copied to clipboard
open class Button(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_BUTTON_WIDTH,     height: Number = DEFAULT_BUTTON_HEIGHT,     text: String = "",     font: Font = Font(),     alignment: Alignment = Alignment.CENTER,     isWrapText: Boolean = false,     visual: Visual = ColorVisual.WHITE) : LabeledUIComponent

A simple Button with a text.

Link copied to clipboard
open class CheckBox(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_CHECKBOX_WIDTH,     height: Number = DEFAULT_CHECKBOX_HEIGHT,     text: String = "",     font: Font = Font(),     alignment: Alignment = Alignment.CENTER,     isWrapText: Boolean = false,     visual: Visual = Visual.EMPTY,     isChecked: Boolean = false,     allowIndeterminate: Boolean = false,     isIndeterminate: Boolean = false) : LabeledUIComponent

A simple CheckBox with a text.

Link copied to clipboard
open class ColorPicker(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_COLOR_PICKER_WIDTH,     height: Number = DEFAULT_COLOR_PICKER_HEIGHT,     initialColor: Color = Color.WHITE) : UIComponent

A ColorPicker that allows to choose a Color.

Link copied to clipboard
open class ComboBox<T>(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_COMBOBOX_WIDTH,     height: Number = DEFAULT_COMBOBOX_HEIGHT,     font: Font = Font(),     val prompt: String = "",     items: List<T> = emptyList(),     formatFunction: (T) -> String? = null) : UIComponent

A standard ComboBox that may be populated with items of specified type parameter.

Link copied to clipboard
open class Label(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_LABEL_WIDTH,     height: Number = DEFAULT_LABEL_HEIGHT,     text: String = "",     font: Font = Font(),     alignment: Alignment = Alignment.CENTER,     isWrapText: Boolean = false,     visual: Visual = Visual.EMPTY) : LabeledUIComponent

A basic Label displaying text.

Link copied to clipboard
sealed class LabeledUIComponent : UIComponent

Baseclass for all UIComponents that have a label.

Link copied to clipboard
open class ListView<T>(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_LIST_VIEW_WIDTH,     height: Number = DEFAULT_LIST_VIEW_HEIGHT,     items: List<T> = emptyList(),     font: Font = Font(),     visual: Visual = ColorVisual.WHITE,     orientation: Orientation = Orientation.VERTICAL,     selectionMode: SelectionMode = SelectionMode.SINGLE,     selectionBackground: ColorVisual = ColorVisual.BLUE,     formatFunction: (T) -> String? = null) : StructuredDataView<T>

A ListView displaying its items next to each other in the given orientation.

Link copied to clipboard
enum Orientation : Enum<Orientation>

Enum for orientations HORIZONTAL and VERTICAL.

Link copied to clipboard
open class PasswordField(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_TEXT_FIELD_WIDTH,     height: Number = DEFAULT_TEXT_FIELD_HEIGHT,     text: String = "",     prompt: String = "",     font: Font = Font(),     visual: Visual = ColorVisual(Color(240, 240, 240))) : TextInputUIComponent

A PasswordField is a single line input field that shows stars instead of typed text.

Link copied to clipboard
open class ProgressBar(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_PROGRESSBAR_WIDTH,     height: Number = DEFAULT_PROGRESSBAR_HEIGHT,     progress: Double = 0.0,     barColor: Color = Color.CYAN) : UIComponent
Link copied to clipboard
open class RadioButton(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_RADIO_BUTTON_WIDTH,     height: Number = DEFAULT_RADIO_BUTTON_HEIGHT,     text: String = "",     font: Font = Font(),     alignment: Alignment = Alignment.CENTER_LEFT,     isSelected: Boolean = false,     toggleGroup: ToggleGroup = ToggleGroup(),     visual: Visual = Visual.EMPTY) : BinaryStateButton

RadioButton is analogous to a ToggleButton with a different visual representation but cannot be deselected.

Link copied to clipboard
enum SelectionMode : Enum<SelectionMode>

Enum indicating allowed selection mode.

Link copied to clipboard
sealed class StructuredDataView<T> : UIComponent

A StructuredDataView displaying its items with given format function.

Link copied to clipboard
open class TableColumn<T>(    title: String,     width: Number,     font: Font = Font(),     formatFunction: (T) -> String)

A TableColumn may be used to represent a column in a TableView.

Link copied to clipboard
open class TableView<T>(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_TABLE_VIEW_WIDTH,     height: Number = DEFAULT_TABLE_VIEW_HEIGHT,     columns: List<TableColumn<T>> = emptyList(),     items: List<T> = emptyList(),     visual: Visual = ColorVisual.WHITE,     selectionMode: SelectionMode = SelectionMode.SINGLE,     selectionBackground: ColorVisual = ColorVisual.BLUE) : StructuredDataView<T>

A TableView may be used to visualize a data table.

Link copied to clipboard
open class TextArea(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_TEXT_AREA_WIDTH,     height: Number = DEFAULT_TEXT_AREA_HEIGHT,     text: String = "",     prompt: String = "",     font: Font = Font(),     visual: Visual = ColorVisual(Color(240, 240, 240))) : TextInputUIComponent

A TextArea is a multi line input field.

Link copied to clipboard
open class TextField(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_TEXT_FIELD_WIDTH,     height: Number = DEFAULT_TEXT_FIELD_HEIGHT,     text: String = "",     prompt: String = "",     font: Font = Font(),     visual: Visual = ColorVisual(Color(240, 240, 240))) : TextInputUIComponent

A TextField is a single line input field.

Link copied to clipboard
sealed class TextInputUIComponent : UIComponent

Baseclass for all UIComponents that have a text input field.

Link copied to clipboard
class ToggleButton(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_TOGGLE_BUTTON_WIDTH,     height: Number = DEFAULT_TOGGLE_BUTTON_HEIGHT,     text: String = "",     font: Font = Font(),     alignment: Alignment = Alignment.CENTER_LEFT,     isWrapText: Boolean = false,     isSelected: Boolean = false,     toggleGroup: ToggleGroup = ToggleGroup(),     visual: Visual = Visual.EMPTY) : BinaryStateButton

A ToggleButton may be used as a Button that is either selected or not selected. An important feature of ToggleButtons is the ToggleGroup.

Link copied to clipboard
open class ToggleGroup

A ToggleGroup may be set as an attribute in ToggleButton or RadioButton.

Link copied to clipboard
sealed class UIComponent : StaticComponentView<UIComponent>

Baseclass for all UI components.