glok-dock/uk.co.nickthecoder.glok.dock

Package-level declarations

Types

abstract class Dock(val dockID: String, val harbour: Harbour) : Region

Docks are panels at the edges of a stage, which can be contracted to save screen real-estate, then shown again with a press of a button.

DockFactory

interface DockFactory

Harbour can load/save the position and visibility of docks. We therefore need a way to create a dock from a unique identifier.

Harbour

class Harbour(initialContent: Node? = null) : Region

Allows Docks to be placed at the sides of a scene. A typical application places the Harbour in the center of a BorderPane, with a MenuBar and ToolBars at the top.

MapDockFactory

class MapDockFactory(docks: Dock) : DockFactory

A DockFactory, implemented by a simple Map.

OnDemandDockFactory

class OnDemandDockFactory(harbour: Harbour, map: Map<String, (Harbour) -> Dock>) : DockFactory

Creates docks using lambdas.

Functions

harbour

fun harbour(block: Harbour.() -> Unit): Harbour

Extends Glok's DSL to support Harbours.

load

fun Harbour.load(preferences: Preferences): Boolean

Load the layout of the Harbour from Preferences (aka the registry on Windows).

save

fun Harbour.save(preferences: Preferences)

Saves the layout of the Harbour to Java Preferences (aka the registry on Windows).