glok-core/uk.co.nickthecoder.glok.scene

Package-level declarations

Types

ActionTooltip

class ActionTooltip(val command: Command) : Tooltip

Alignment

enum Alignment : Enum<Alignment>

Background

interface Background

Draws the background of a Region.

Border

interface Border

A drawn border, around a Region.

BrightnessColorFieldBackground

class BrightnessColorFieldBackground(val observableBrightness: ObservableFloat) : Background

CalculatedSizes

data class CalculatedSizes(val minWidth: Float, val minHeight: Float, val prefWidth: Float, val prefHeight: Float, val maxWidth: Float, val maxHeight: Float)

Color

class Color(r: Float, g: Float, b: Float, a: Float)

Holds a color as red, green, blue, alpha float value in the range 0..1. If a color is created with values outside the range 0..1, they are silently clamped.

ColorFieldBackground

class ColorFieldBackground(val topLeftColor: ObservableColor, val topRightColor: ObservableColor, val bottomLeftColor: ObservableColor, val bottomRightColor: ObservableColor) : Background

A Background, where each corner uses a different ObservableColor. This is used for the color field in the CustomColorPicker.

CompoundBackground

class CompoundBackground(val a: Background, val b: Background) : Background

A Background composed of two other Backgrounds.

Edges

data class Edges(val top: Float, val right: Float, val bottom: Float, val left: Float)

Empty space surrounding the content of a Region.

GradientBackground

class GradientBackground(val orientation: ObservableOrientation, fromColor: Color, toColor: Color) : Background

Draws a Background as a linear gradient. The left/bottom is fromColor and the right/top is toColor depending on orientation.

HAlignment

enum HAlignment : Enum<HAlignment> , WithPseudoStyle

HSVGradientBackground

class HSVGradientBackground(orientation: Orientation, fromHue: Float, fromSaturation: Float, fromValue: Float, fromAlpha: Float, toHue: Float, toSaturation: Float, toValue: Float, toAlpha: Float) : Background

Draws a Background as a linear gradient. The left/bottom is fromHue and the right/top is toHue depending on orientation.

HueColorFieldBackground

class HueColorFieldBackground(val observableHue: ObservableFloat) : Background

A Background, for a single hue.

Icons

class Icons(val resources: Resources) : NamedImages

Loads icons from Resources, where a single .png file contains many icons. These icons should have a gap between them, to prevent bleeding from one icon into its neighbours. You give a name to each icon, via a DSL (domain specific language).

IconSheet

class IconSheet(resources: Resources, textureName: String, val size: Int)

Image

interface Image

ImageView

class ImageView(image: Image?) : Region

MousePointer

enum MousePointer : Enum<MousePointer>

NamedImages

interface NamedImages

NinePatch

class NinePatch(val image: Image, val edges: Edges)

Draws a rectangular region using 9 'patches' the four corner patches are drawn 1:1 (unscaled). The top and bottom patches are stretched (or shrunk) horizontally to fit between the corners. The left and right patches are similarly stretched (or shrunk) vertically. The center path is stretch (or shrunk) in both directions.

NinePatchBackground

class NinePatchBackground(val ninePatch: NinePatch) : Background

NinePatchBorder

class NinePatchBorder(val ninePatch: NinePatch) : Border

A Border which uses a NinePatch.

NinePatchImages

class NinePatchImages(val resources: Resources, textureName: String)

Stores a map of NinePatches keyed on name (as String), loaded from Resources.

NoBackground

object NoBackground : Background

NoBorder

object NoBorder : Border

The default border for a Region. Takes no space, and draws nothing.

Node

abstract class Node : Styled

The base class for all GUI elements in a Scene. The nodes form a Scene Graph (which is a misnomer, because it is a tree structure, not a graph), starting at the Scene.root Node.

NodeParent

interface NodeParent

Orientation

enum Orientation : Enum<Orientation> , WithPseudoStyle

OverlappingBorder

class OverlappingBorder(val actualSize: Edges) : Border

A border which ignores Region.borderSize, and uses the size passed to the constructor instead. If actualSize is larger than Region.borderSize, then the border will encroach into the node's content/padding.

OverlayStage

class OverlayStage(val parent: Stage, val stageType: StageType) : StageBase

A Stage which is not backed by a native Window, but instead lives within a RegularStage.

OverlayStageBackground

class OverlayStageBackground(radius: Float, val thickness: Float) : Background

Very similar to OverlayStageBorder. Everything within the solid rectangle is filled.

OverlayStageBorder

class OverlayStageBorder(radius: Float, val thickness: Float) : Border

Similar to RoundedBorder, but instead of filling the whole of the edges, only fill a thin line (given by thickness). Everything outside the thin line remains un-drawn.

PlainBackground

object PlainBackground : Background

PlainBorder

object PlainBorder : Border

A plain, rectangular border using a single color.

RaisedBorder

class RaisedBorder(val light: Color, val dark: Color) : Border

A rectangular border, with a 3D effect.

RegularStage

class RegularStage : StageBase

The middleman between Scene and Window.

RepeatedBackground

class RepeatedBackground(val image: Image?, val tinted: Boolean) : Background

A repeated background pattern from an Image.

ResizableNamedImages

interface ResizableNamedImages : NamedImages

Used for images which can be resized on the fly. This is designed to be used by Icons, so that you can build the GUI Nodes, and then later, change the value of an iconSizeProperty, all icons will change size.

RoundedBackground

class RoundedBackground(val radius: Float, val side: Side? = null) : Background

Draws a rounded rectangle. If side is set, then only 1 side of the rectangle is rounded (i.e. two corners).

RoundedBorder

class RoundedBorder(val radius: Float) : Border

SaturationColorFieldBackground

class SaturationColorFieldBackground(val observableSaturation: ObservableFloat) : Background

A Background, for a single saturation value.

Scene

class Scene(root: Node, width: Float = 0.0f, height: Float = 0.0f) : Styled

There is a 1:1 relationship between a window and a Stage, and at any moment in time there is also a 1:1 relationship between Stage and Scene. However, it is possible to replace a Stage's scene. In most cases though, a stage keeps the same scene.

Sheets

class Sheets(icons: Icons)

Side

enum Side : Enum<Side> , WithPseudoStyle

Stage

sealed interface Stage

Stage is the owner of a Scene. There are two implementations : RegularStage, and OverlayStage.

StageBase

abstract class StageBase : Stage

StageType

enum StageType : Enum<StageType>

TextTooltip

class TextTooltip(val text: String) : Tooltip

A Tooltip which takes text, and splits it by line breaks, placing each line as a Label in a VBox. The Tantalum theme renders it with a rounded corners, and padding.

ThinBorder

object ThinBorder : Border

A thin border, which is always 1 logical pixel (ignoring the size passed to it).

TintedNinePatchBackground

class TintedNinePatchBackground(val ninePatch: NinePatch) : Background

Similar to NinePatchBackground, but the source texture's pixels are multiplied by a color (usually from Region.backgroundColor). Used in two ways :

TintedNinePatchBorder

class TintedNinePatchBorder(val ninePatch: NinePatch) : Border

Similar to NinePatchBorder, but the source texture's pixels are multiplied by a color (usually from Region.borderColor).

Tooltip

interface Tooltip

When the mouse remains still for a short period of time over a Node with a tooltip, the tooltip is displayed as a POPUP.

UnderlineBackground

class UnderlineBackground(val thickness: Float = 1.0f, val ratio: Float = 0.9f) : Background

A Background specifically designed for underlining Text Nodes, where it isn't possible to use a Border.

VAlignment

enum VAlignment : Enum<VAlignment> , WithPseudoStyle

WindowListener

interface WindowListener

WithChildren

interface WithChildren : NodeParent

Implemented by Node subclasses whose children are public, and mutable.

WithContent

interface WithContent

Implemented by Node subclasses with a settable child called content.

WithItems

interface WithItems : NodeParent

Implemented by Node subclasses with a list of Nodes called items, which are mutable.

WithPseudoStyle

interface WithPseudoStyle

Functions

asImageView

fun ObservableOptionalImage.asImageView(): ImageView

fun Image?.asImageView(): ImageView?

icons

fun icons(resources: Resources, block: Icons.() -> Unit): Icons

Collect metadata about the size and positions of Icons. Textures are not loaded yet, they will be loaded as required when Icons.get is called.

overlayStage

fun overlayStage(parent: Stage, stageType: StageType = StageType.NORMAL, block: OverlayStage.() -> Unit): OverlayStage

resizable

fun ObservableOptionalImage.resizable(sizeProperty: IntProperty): ObservableOptionalImage

stage

fun stage(parent: Stage, stageType: StageType = StageType.NORMAL, block: Stage.() -> Unit): Stage