Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: HiddenSidesPane

[255:7] extends: Node, Control, Region

HiddenSidesPane wraps the ControlsFX container that reveals hidden edge panels when the pointer reaches the configured side.

CSS Classes

Scope CSS Classes
HiddenSidesPane hidden-sides-pane, content, and per-side reveal container classes.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
HiddenSidesPane Style the main content area, hidden side panels, and pinned-side presentation.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • HiddenSidesPane ()

    Creates a new hidden sides pane.

  • setContent (object NodeObj)

    Sets the main content node.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setTop (object NodeObj)

    Sets the top hidden node.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setBottom (object NodeObj)

    Sets the bottom hidden node.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setLeft (object NodeObj)

    Sets the left hidden node.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setRight (object NodeObj)

    Sets the right hidden node.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setPinnedSide (string SideName)

    Sets the pinned side.

    • @p SideName is a javafx.geometry.Side enum name.
    • @r this object for chaining
  • show (string SideName)

    Shows the requested side immediately.

    • @p SideName is a javafx.geometry.Side enum name.
    • @r this object for chaining
  • hide ()

    Hides the currently shown side.

    • @r this object for chaining

class: MasterDetailPane

[175:7] extends: Node, Control, Region

MasterDetailPane wraps the ControlsFX split-style container that manages a primary master node and a revealable detail node.

CSS Classes

Scope CSS Classes
MasterDetailPane master-detail-pane, divider, master-node, and detail-node classes from the skin.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
MasterDetailPane Style the divider, master area, detail area, and animated reveal behavior.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • MasterDetailPane ()

    Creates a new master-detail pane.

  • setMasterNode (object NodeObj)

    Sets the master content node.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setDetailNode (object NodeObj)

    Sets the detail content node.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setDetailSide (string SideName)

    Sets the side on which the detail node appears.

    • @p SideName is a javafx.geometry.Side enum name.
    • @r this object for chaining
  • setShowDetailNode (bool Show)

    Sets whether the detail node is shown.

    • @p Show is true to show the detail node.
    • @r this object for chaining
  • setAnimated (bool Animated)

    Sets whether detail transitions are animated.

    • @p Animated is true to animate transitions.
    • @r this object for chaining

class: HyperlinkLabel

[364:7] extends: Node, Control, Region

HyperlinkLabel wraps the ControlsFX rich text label that turns bracketed text fragments into hyperlink-like action targets.

CSS Classes

Scope CSS Classes
HyperlinkLabel hyperlink-label and internal hyperlink text classes supplied by the skin.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
HyperlinkLabel Style the root label plus the rendered hyperlink spans and hover states.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • HyperlinkLabel (string Text = null)

    Creates a hyperlink label with optional text.

    • @p Text is an optional content string.
  • setText (string Text)

    Sets the label text.

    • @p Text is the new label string.
    • @r this object for chaining
  • getText ()

    Returns the current label text.

    • @r A string with the current text.
  • onAction (callback OnAction)

    Registers the action callback for clicked hyperlinks.

    • @p OnAction is a callback invoked for JavaFX action events.
    • @r this object for chaining

class: StatusBar

[27:7] extends: Node, Control, Region

StatusBar wraps the ControlsFX status bar used for application status text, progress, and left/right accessory nodes.

CSS Classes

Scope CSS Classes
StatusBar status-bar plus left-items, right-items, text, and progress substructure classes.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
StatusBar Style the bar background, status text, progress bar area, and left/right item containers.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • StatusBar ()

    Creates a new ControlsFX status bar.

  • setText (string Text)

    Sets the main status text.

    • @p Text is the status string.
    • @r this object for chaining
  • getText ()

    Returns the current status text.

    • @r A string with the current status text.
  • setGraphic (object GraphicObj)

    Sets an optional status graphic node.

    • @p GraphicObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setProgress (double Progress)

    Sets the progress indicator value.

    • @p Progress is the new progress value.
    • @r this object for chaining
  • addLeftItem (object NodeObj)

    Adds a node to the left accessory item list.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • addRightItem (object NodeObj)

    Adds a node to the right accessory item list.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining

class: MaskerPane

[115:7] extends: Node, Control, Region

MaskerPane wraps the ControlsFX overlay pane used to block a region while background work is in progress.

CSS Classes

Scope CSS Classes
MaskerPane masker-pane, progress-node, and text container classes from the skin.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
MaskerPane Style the translucent overlay, progress indicator node, and text content.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • MaskerPane ()

    Creates a new masker pane.

  • setText (string Text)

    Sets the overlay text.

    • @p Text is the overlay string.
    • @r this object for chaining
  • setProgress (double Progress)

    Sets the progress value shown by the overlay.

    • @p Progress is the new progress value.
    • @r this object for chaining
  • setProgressVisible (bool Visible)

    Sets whether the progress node is visible.

    • @p Visible is true to show the progress node.
    • @r this object for chaining

class: InfoOverlay

[427:7] extends: Node, Control, Region

InfoOverlay wraps the ControlsFX overlay control that reveals explanatory text over another node.

CSS Classes

Scope CSS Classes
InfoOverlay info-overlay, overlay content, text, and reveal-state classes from the skin.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
InfoOverlay Style the overlay panel, descriptive text, content container, and hover reveal presentation.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • InfoOverlay (ContentObj = null, string Text = null)

    Creates a new info overlay.

    • @p ContentObj is an optional content node.
    • @p Text is the overlay text.
  • setContent (object ContentObj)

    Sets the wrapped content node.

    • @p ContentObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setText (string Text)

    Sets the overlay text.

    • @p Text is the overlay string.
    • @r this object for chaining
  • setShowOnHover (bool ShowOnHover)

    Sets whether the overlay appears on hover.

    • @p ShowOnHover is true to reveal on hover.
    • @r this object for chaining