kyd-editor/uk.co.nickthecoder.kyd.editor.docks/PickerDock

PickerDock

class PickerDock(harbour: Harbour) : Dock

Displays collections of actors which can be placed onto a stage.

NOTE. The name is misleading, as it is really deals with Picks and PickGroups, not Actors. However, Pick and PickGroup are not really anything that the user has to deal with; they are private to the internals of the Kyd editor. Therefore, I've chosen to use the user-focused name for this class. From their point of view, this dock is where new actors are placed on stages.

Constructors

constructor(harbour: Harbour)

Types

object Companion

Properties

val allowedSides: MutableObservableSet<Side>

var background: Background

backgroundColor

var backgroundColor: Color

backgroundColorProperty

val backgroundColorProperty: StylableColorProperty

backgroundProperty

val backgroundProperty: StylableBackgroundProperty

var border: Border

var borderColor: Color

borderColorProperty

val borderColorProperty: StylableColorProperty

val borderProperty: StylableBorderProperty

var borderSize: Edges

borderSizeProperty

val borderSizeProperty: StylableEdgesProperty

val buttonText: String

buttonTextProperty

val buttonTextProperty: ObservableString

var canClose: Boolean

canCloseProperty

val canCloseProperty: BooleanProperty

open override val children: ObservableList<Node>

var content: Node?

contentProperty

val contentProperty: OptionalNodeProperty

var defaultPrimary: Boolean

defaultPrimaryProperty

val defaultPrimaryProperty: BooleanProperty

var defaultSide: Side

defaultSideProperty

val defaultSideProperty: SideProperty

val dockID: String

focusAcceptable

var focusAcceptable: Boolean

focusAcceptableProperty

val focusAcceptableProperty: StylableBooleanProperty

var focusBorder: Border

focusBorderColor

var focusBorderColor: Color

focusBorderColorProperty

val focusBorderColorProperty: StylableColorProperty

focusBorderProperty

val focusBorderProperty: StylableBorderProperty

focusBorderSize

var focusBorderSize: Edges

focusBorderSizeProperty

val focusBorderSizeProperty: StylableEdgesProperty

var focused: Boolean

focusedProperty

val focusedProperty: ReadOnlyBooleanProperty

var focusHighlight: Background

focusHighlightColor

var focusHighlightColor: Color

focusHighlightColorProperty

val focusHighlightColorProperty: StylableColorProperty

focusHighlightProperty

val focusHighlightProperty: StylableBackgroundProperty

focusTraversable

var focusTraversable: Boolean

focusTraversableProperty

val focusTraversableProperty: StylableBooleanProperty

val game: Game?

val gameProperty: SimpleProperty<Game?>

var growPriority: Float

growPriorityProperty

val growPriorityProperty: StylableFloatProperty

val harbour: Harbour

var height: Float

val heightProperty: ReadOnlyFloatProperty

var iconName: String

iconNameProperty

val iconNameProperty: StringProperty

var icons: NamedImages?

val iconsProperty: SimpleProperty<NamedImages?>

val idProperty: StringProperty

var localX: Float

val localXProperty: ReadOnlyFloatProperty

var localY: Float

val localYProperty: ReadOnlyFloatProperty

overrideMaxHeight

var overrideMaxHeight: Float?

overrideMaxHeightProperty

val overrideMaxHeightProperty: StylableOptionalFloatProperty

overrideMaxWidth

var overrideMaxWidth: Float?

overrideMaxWidthProperty

val overrideMaxWidthProperty: StylableOptionalFloatProperty

overrideMinHeight

var overrideMinHeight: Float?

overrideMinHeightProperty

val overrideMinHeightProperty: StylableOptionalFloatProperty

overrideMinWidth

var overrideMinWidth: Float?

overrideMinWidthProperty

val overrideMinWidthProperty: StylableOptionalFloatProperty

overridePrefHeight

var overridePrefHeight: Float?

overridePrefHeightProperty

val overridePrefHeightProperty: StylableOptionalFloatProperty

overridePrefWidth

var overridePrefWidth: Float?

overridePrefWidthProperty

val overridePrefWidthProperty: StylableOptionalFloatProperty

var padding: Edges

paddingProperty

val paddingProperty: StylableEdgesProperty

var parent: Node?

val parentProperty: ReadOnlyOptionalNodeProperty

var prefix: String?

val prefixProperty: OptionalStringProperty

var primary: Boolean

primaryProperty

val primaryProperty: ReadOnlyBooleanProperty

val pseudoStyles: MutableObservableSet<String>

var scene: Scene?

val sceneProperty: ReadOnlyOptionalSceneProperty

scenesFontProperty

val scenesFontProperty: ObservableOptionalFont

var sceneX: Float

val sceneXProperty: ReadOnlyFloatProperty

var sceneY: Float

val sceneYProperty: ReadOnlyFloatProperty

var section: Boolean

sectionProperty

val sectionProperty: StylableBooleanProperty

var selectedPick: Pick?

selectedPickProperty

val selectedPickProperty: SimpleProperty<Pick?>

var shrinkPriority: Float

shrinkPriorityProperty

val shrinkPriorityProperty: StylableFloatProperty

var side: Side

val sideProperty: ReadOnlySideProperty

val styles: MutableObservableSet<String>

var title: String

val titleButtons: MutableObservableList<Node>

val titleProperty: StringProperty

var tooltip: Tooltip?

tooltipProperty

val tooltipProperty: OptionalTooltipProperty

var visible: Boolean

visibleProperty

val visibleProperty: StylableBooleanProperty

var width: Float

val widthProperty: ReadOnlyFloatProperty

Functions

fun <E : Event> addEventFilter(eventType: EventType<E>, handler: EventHandler<E>, combination: HandlerCombination)

fun <E : Event> addEventFilter(eventType: EventType<E>, handlerCombination: HandlerCombination, handler: (E) -> Unit)

addEventHandler

fun <E : Event> addEventHandler(eventType: EventType<E>, handler: EventHandler<E>, combination: HandlerCombination)

fun <E : Event> addEventHandler(eventType: EventType<E>, combination: HandlerCombination, handler: (E) -> Unit)

alignChildFormGrids

fun Node.alignChildFormGrids()

open fun close()

containsScenePoint

fun containsScenePoint(sceneX: Float, sceneY: Float): Boolean

createContextMenu

open fun createContextMenu(): PopupMenu

fun dump(prefix: String, borders: Boolean, size: Boolean, filter: (Node) -> Boolean)

open fun Number.em(): ObservableOptionalFloat

fun evalMaxHeight(): Float

fun evalMaxWidth(): Float

fun evalMinHeight(): Float

fun evalMinWidth(): Float

fun evalPrefHeight(): Float

fun evalPrefWidth(): Float

findDeepestNodeAt

open fun findDeepestNodeAt(sceneX: Float, sceneY: Float): Node

fun findNodeById(id: String): Node?

findStylableProperty

open fun findStylableProperty(propertyName: String): StylableProperty<*>?

fun firstToRoot(filter: (Node) -> Boolean): Node?

forEachDescending

fun forEachDescending(block: (Node) -> Unit)

forEachFromRoot

fun forEachFromRoot(block: (Node) -> Unit)

fun forEachToRoot(block: (Node) -> Unit)

getStylableProperties

open override fun getStylableProperties(): List<StylableProperty<*>>

fun Node.grow()

fun iconImageView(): ImageView

fun isAncestorOf(other: Node): Boolean

nextFocusableNode

fun nextFocusableNode(): Node?

fun nextSection(): Node?

open override fun nodeMaxHeight(): Float

open override fun nodeMaxWidth(): Float

open fun nodeMinHeight(): Float

open fun nodeMinWidth(): Float

open override fun nodePrefHeight(): Float

open override fun nodePrefWidth(): Float

fun onFilesDropped(combination: HandlerCombination, handler: (DroppedFilesEvent) -> Unit)

fun onKeyPressed(combination: HandlerCombination, handler: (KeyEvent) -> Unit)

fun onKeyReleased(combination: HandlerCombination, handler: (KeyEvent) -> Unit)

fun onKeyTyped(combination: HandlerCombination, handler: (KeyTypedEvent) -> Unit)

fun onMouseClicked(combination: HandlerCombination, handler: (MouseEvent) -> Unit)

fun onMouseDragged(combination: HandlerCombination, handler: (MouseEvent) -> Unit)

fun onMouseEntered(combination: HandlerCombination, handler: (MouseEvent) -> Unit)

fun onMouseExited(combination: HandlerCombination, handler: (MouseEvent) -> Unit)

fun onMouseMoved(combination: HandlerCombination, handler: (MouseEvent) -> Unit)

fun onMousePressed(combination: HandlerCombination, handler: (MouseEvent) -> Unit)

onMouseReleased

fun onMouseReleased(combination: HandlerCombination, handler: (MouseEvent) -> Unit)

fun onPopupTrigger(combination: HandlerCombination, handler: (MouseEvent) -> Unit)

fun onScrolled(combination: HandlerCombination, handler: (ScrollEvent) -> Unit)

fun order(): Int

previousFocusableNode

fun previousFocusableNode(): Node?

previousSection

fun previousSection(): Node?

removeEventFilter

fun <E : Event> removeEventFilter(eventType: EventType<E>, handler: EventHandler<E>)

removeEventHandler

fun <E : Event> removeEventHandler(eventType: EventType<E>, handler: EventHandler<E>)

fun requestFocus(useFocusTraversable: Boolean, showFocusBorder: Boolean)

open fun requestLayout()

fun requestRedraw()

requiresClipping

open fun requiresClipping(): Boolean

open override fun scrollTo(descendant: Node)

fun surroundBottom(): Float

fun surroundLeft(): Float

fun surroundRight(): Float

fun surroundTop(): Float

fun surroundX(): Float

fun surroundY(): Float

fun toShortString(): String

open override fun toString(): String

fun treeVisitor(filter: (Node) -> Boolean, action: (Node) -> Unit)

withInformation

fun Node.withInformation(text: String, block: VBox.() -> Unit? = null): VBox