Components

eu.joaocosta.interim.api.Components
See theComponents companion trait
object Components extends Components

Object containing the default components.

By convention, all components are functions in the form def component(id, ...params, skin)(area, value): Value.

The area parameter can be ommited if there's an area allocator in scope.

Attributes

Companion
trait
Graph
Supertypes
trait Components
class Object
trait Matchable
class Any
Self type
Components.type

Members list

Value members

Inherited methods

Button component. Returns true if it's being clicked, false otherwise.

Button component. Returns true if it's being clicked, false otherwise.

Value parameters

label

text label to show on this button

Attributes

Inherited from:
Components

Checkbox component. Returns true if it's enabled, false otherwise.

Checkbox component. Returns true if it's enabled, false otherwise.

Attributes

Inherited from:
Components

Close handle. Closes the panel when clicked.

Close handle. Closes the panel when clicked.

Instead of using this component directly, it can be easier to use eu.joaocosta.interim.api.Panels.window with closable = true.

Attributes

Inherited from:
Components

Draggable handle. Returns the moved area.

Draggable handle. Returns the moved area.

Instead of using this component directly, it can be easier to use eu.joaocosta.interim.api.Panels.window with movable = true.

Attributes

Inherited from:
Components
final def radioButton[T](id: ItemId, area: Rect, buttonValue: T, label: String, skin: ButtonSkin): DynamicComponentWithValue[T]

Radio button component. Returns value currently selected.

Radio button component. Returns value currently selected.

Value parameters

buttonValue

the value of this button (value that this button returns when selected)

label

text label to show on this button

Attributes

Inherited from:
Components

Draggable handle. Returns the resized area.

Draggable handle. Returns the resized area.

Instead of using this component directly, it can be easier to use eu.joaocosta.interim.api.Panels.window with movable = true.

Attributes

Inherited from:
Components
final def select(id: ItemId, labels: Vector[String], defaultLabel: String, skin: SelectSkin): DynamicComponentWithValue[PanelState[Int]]

Select box component. Returns the index value currently selected inside a PanelState.

Select box component. Returns the index value currently selected inside a PanelState.

It also allows one to define a default label if the value is invalid. This can be particularly to keep track if a user has selected no value, by setting the initial value to an invalid sentinel value (e.g. -1).

Value parameters

defaultLabel

label to print if the value doesn't match any of the labels.

labels

text labels for each value

Attributes

Inherited from:
Components
final def slider(id: ItemId, min: Int, max: Int, skin: SliderSkin): DynamicComponentWithValue[Int]

Slider component. Returns the current position of the slider, between min and max.

Slider component. Returns the current position of the slider, between min and max.

Value parameters

max

maximum value fr this slider

min

minimum value for this slider

Attributes

Inherited from:
Components

Text input component. Returns the current string inputed.

Text input component. Returns the current string inputed.

Attributes

Inherited from:
Components