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

PlacesDock

open class PlacesDock(val harbour: Harbour, val places: MutableObservableList<Place> = Places.sharedPlaces, id: String = ID) : Dock

A tree view of folders and files.

The root of the tree can be any folder within the list : places, and initially, the first Place in the list is used as the root.

The dock can be used to open files within your application, instead of the more traditional File->Open dialog. To do so, override openFile.

The default value of places in the constructor are taken from Places.sharedPlaces, which means these favourite places are shared by all Glok applications. If you prefer, your application can keep its own list of favourite places, which can be loaded and saved using Places.loadPlaces and Places.savePlaces.

Constructors

PlacesDock

constructor(harbour: Harbour, places: MutableObservableList<Place> = Places.sharedPlaces, id: String = ID)

Types

Companion

object Companion

Properties

allowedSides

val allowedSides: MutableObservableSet<Side>

Which sides of the harbour this Dock can be moved to by the user.

background

var background: Background

backgroundColor

var backgroundColor: Color

backgroundColorProperty

val backgroundColorProperty: StylableColorProperty

backgroundProperty

val backgroundProperty: StylableBackgroundProperty

border

var border: Border

borderColor

var borderColor: Color

borderColorProperty

val borderColorProperty: StylableColorProperty

borderProperty

val borderProperty: StylableBorderProperty

borderSize

var borderSize: Edges

borderSizeProperty

val borderSizeProperty: StylableEdgesProperty

buttonText

val buttonText: String

buttonTextProperty

val buttonTextProperty: ObservableString

canClose

var canClose: Boolean

canCloseProperty

val canCloseProperty: BooleanProperty

Set this to false to prevent the user closing this Dock. Closing the Dock programmatically is not affected by this.

children

open override val children: ObservableList<Node>

content

var content: Node?

contentProperty

val contentProperty: OptionalNodeProperty

The main content of the Dock.

currentPlace

var currentPlace: Place?

currentPlaceProperty

val currentPlaceProperty: SimpleProperty<Place?>

The current favourite Place selected from places. Changing this will change the root of the tree.

defaultPrimary

var defaultPrimary: Boolean

defaultPrimaryProperty

val defaultPrimaryProperty: BooleanProperty

Each side of the Harbour has two sets of Docks, primary or secondary. This decides if this Dock is placed in the primary set if not explicitly specified. See Harbour.add

defaultSide

var defaultSide: Side

defaultSideProperty

val defaultSideProperty: SideProperty

Determines which side of the Harbour this Dock will be placed if not explicitly specified. See Harbour.add.

dockID

val dockID: String

A Unique identifier. Used when loading/saving the meta-data.

fileDialogFactory

var fileDialogFactory: FileDialogFactory

fileDialogFactoryProperty

val fileDialogFactoryProperty: SimpleProperty<FileDialogFactory>

Allows an application to use its own dialogs for renaming, copying and deleting files. In most cases the default value (StandardFileDialogFactory) is sufficient.

fileFilter

var fileFilter: (File) -> Boolean

fileFilterProperty

val fileFilterProperty: Property<(File) -> Boolean>

Filters which files to display in the PlacesDock. The default value is EXCLUDE_HIDDEN_FILES.

focusAcceptable

var focusAcceptable: Boolean

focusAcceptableProperty

val focusAcceptableProperty: StylableBooleanProperty

focusBorder

var focusBorder: Border

focusBorderColor

var focusBorderColor: Color

focusBorderColorProperty

val focusBorderColorProperty: StylableColorProperty

focusBorderProperty

val focusBorderProperty: StylableBorderProperty

focusBorderSize

var focusBorderSize: Edges

focusBorderSizeProperty

val focusBorderSizeProperty: StylableEdgesProperty

focused

var focused: Boolean

focusedProperty

val focusedProperty: ReadOnlyBooleanProperty

focusHighlight

var focusHighlight: Background

focusHighlightColor

var focusHighlightColor: Color

focusHighlightColorProperty

val focusHighlightColorProperty: StylableColorProperty

focusHighlightProperty

val focusHighlightProperty: StylableBackgroundProperty

focusTraversable

var focusTraversable: Boolean

focusTraversableProperty

val focusTraversableProperty: StylableBooleanProperty

folderFilter

var folderFilter: (File) -> Boolean

folderFilterProperty

val folderFilterProperty: Property<(File) -> Boolean>

Filters which folders to display in the PlacesDock. The default value is EXCLUDE_HIDDEN_FILES.

growPriority

var growPriority: Float

growPriorityProperty

val growPriorityProperty: StylableFloatProperty

harbour

val harbour: Harbour

height

var height: Float

heightProperty

val heightProperty: ReadOnlyFloatProperty

iconName

var iconName: String

iconNameProperty

val iconNameProperty: StringProperty

An optional icon, which is displayed to the left of the title in the ToggleButtons at the side of the Harbour as well as in the title-bar of the dock.

icons

var icons: NamedImages?

iconsProperty

val iconsProperty: SimpleProperty<NamedImages?>

var id: String

idProperty

val idProperty: StringProperty

localX

var localX: Float

localXProperty

val localXProperty: ReadOnlyFloatProperty

localY

var localY: Float

localYProperty

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

padding

var padding: Edges

paddingProperty

val paddingProperty: StylableEdgesProperty

parent

var parent: Node?

parentProperty

val parentProperty: ReadOnlyOptionalNodeProperty

places

val places: MutableObservableList<Place>

A list of "favourite" places. Any item in this list can be the root node of the tree.

prefix

var prefix: String?

prefixProperty

val prefixProperty: OptionalStringProperty

Optional text which is appended (with a space) to the title in the ToggleButtons at the side of the Harbour. These can be used a visual hints for a shortcut, which makes this Dock visible.

primary

var primary: Boolean

Is this dock in the primary or secondary set of docks? If this Dock is not within a Harbour (yet), then this value is meaningless.

primaryProperty

val primaryProperty: ReadOnlyBooleanProperty

pseudoStyles

val pseudoStyles: MutableObservableSet<String>

scene

var scene: Scene?

sceneProperty

val sceneProperty: ReadOnlyOptionalSceneProperty

scenesFontProperty

val scenesFontProperty: ObservableOptionalFont

sceneX

var sceneX: Float

sceneXProperty

val sceneXProperty: ReadOnlyFloatProperty

sceneY

var sceneY: Float

sceneYProperty

val sceneYProperty: ReadOnlyFloatProperty

section

var section: Boolean

sectionProperty

val sectionProperty: StylableBooleanProperty

shrinkPriority

var shrinkPriority: Float

shrinkPriorityProperty

val shrinkPriorityProperty: StylableFloatProperty

side

var side: Side

The side of the Harbour that this dock occupies. If this Dock is not within a Harbour (yet), then this value is meaningless.

sideProperty

val sideProperty: ReadOnlySideProperty

styles

val styles: MutableObservableSet<String>

title

var title: String

titleButtons

val titleButtons: MutableObservableList<Node>

Buttons (or other Nodes), which appear in the title-bar of this Dock. Initially, this contains only a close button. If you want the close button to remain on the far right, then add items at the front of the list.

titleProperty

val titleProperty: StringProperty

Appears in to ToggleButton at the side of the Harbour, as well as in the title-bar of the dock.

tooltip

var tooltip: Tooltip?

tooltipProperty

val tooltipProperty: OptionalTooltipProperty

visible

var visible: Boolean

visibleProperty

val visibleProperty: StylableBooleanProperty

width