Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: NotificationPane

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

NotificationPane wraps the inline ControlsFX banner used to show a message above or below normal content inside the scene graph.

CSS Classes

Scope CSS Classes
NotificationPane notification-pane, top, bottom, and dark-style variants when enabled by ControlsFX.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
NotificationPane Style .notification-pane, its bar, text area, buttons, and graphic container.
Control Skin and focus traversal behavior.
Region Background, border, padding, size, and shape properties.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • NotificationPane (object ContentObj = null)

    Creates a notification pane with optional scene-graph content.

    • @p ContentObj is an optional node to show under the notification bar.
  • setContent (object ContentObj)

    Sets the content node shown behind the notification bar.

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

    Sets the notification text.

    • @p Text is the notification message string.
    • @r this object for chaining
  • setGraphic (object GraphicObj)

    Sets the optional notification graphic node.

    • @p GraphicObj is a wrapped JavaFX node.
    • @r this object for chaining
  • setShowFromTop (bool Show)

    Sets whether the pane animates from the top edge.

    • @p Show is true to show from the top edge.
    • @r this object for chaining
  • setCloseButtonVisible (bool Visible)

    Sets whether the close button is visible.

    • @p Visible is true to show the close button.
    • @r this object for chaining
  • show ()

    Shows the current notification state.

    • @r this object for chaining
  • showText (string Text)

    Shows the pane with a new text message.

    • @p Text is the notification message string.
    • @r this object for chaining
  • hide ()

    Hides the notification bar.

    • @r this object for chaining

class: PopOver

[352:7] extends: CfxObj

PopOver wraps the ControlsFX popup callout used to anchor rich content to a node or window.

CSS Classes

Scope CSS Classes
PopOver popover, arrow-location classes, and popup header/body substructure classes supplied by the skin.
Parent groups The popup is styleable itself, and its content node continues to inherit its own JavaFX parent groups such as Control, Region, and Node.

CSS Guide

Group What To Style
PopOver Style the popup root, arrow, title area, content container, and detached-state classes.
Content node parents Style the embedded content using the normal CSS groups for that content node type.

Methods

  • PopOver (object ContentObj = null)

    Creates a new popover with optional content.

    • @p ContentObj is an optional JavaFX node to display inside the popover.
  • setContentNode (object ContentObj)

    Sets the content node shown inside the popover.

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

    Sets the popover title text.

    • @p Text is the title string.
    • @r this object for chaining
  • setHeaderAlwaysVisible (bool AlwaysVisible)

    Sets whether the popover header is always visible.

    • @p AlwaysVisible is true to keep the header visible.
    • @r this object for chaining
  • setCloseButtonEnabled (bool Enabled)

    Sets whether the close button is enabled.

    • @p Enabled is true to enable the close button.
    • @r this object for chaining
  • setDetachable (bool Detachable)

    Sets whether the popover can detach into its own window.

    • @p Detachable is true to allow detaching.
    • @r this object for chaining
  • setAnimated (bool Animated)

    Sets whether show and hide transitions are animated.

    • @p Animated is true to enable animation.
    • @r this object for chaining
  • setArrowLocation (string LocationName)

    Sets the popover arrow location.

    • @p LocationName is a PopOver.ArrowLocation enum name.
    • @r this object for chaining
  • showForNode (object NodeObj)

    Shows the popover anchored to the provided node.

    • @p NodeObj is the anchor node.
    • @r this object for chaining
  • showForWindow (WindowObj)

    Shows the popover for the provided owner window or stage.

    • @p WindowObj is a wrapped window object or fxApp.
    • @r this object for chaining
  • showAtNode (object NodeObj, double X, double Y)

    Shows the popover at explicit coordinates relative to the anchor node.

    • @p NodeObj is the anchor node.
    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r this object for chaining
  • hide ()

    Hides the popover immediately.

    • @r this object for chaining

class: RangeSlider

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

RangeSlider wraps the ControlsFX slider with independently movable low and high thumbs for selecting a numeric interval.

CSS Classes

Scope CSS Classes
RangeSlider range-slider with low-thumb, high-thumb, range-bar, tick mark, and track substructure classes.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
RangeSlider Style .range-slider, .low-thumb, .high-thumb, .range-bar, .track, and tick subnodes.
Control Skin and focus traversal behavior.
Region Background, border, padding, shape, snap-to-pixel, and size hints.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • RangeSlider (double Min = 0.0, double Max = 100.0, double LowValue = 25.0, double HighValue = 75.0)

    Creates a new range slider.

    • @p Min is the minimum slider value.
    • @p Max is the maximum slider value.
    • @p LowValue is the starting low-thumb value.
    • @p HighValue is the starting high-thumb value.
  • setMin (double Min)

    Sets the slider minimum value.

    • @p Min is the new minimum.
    • @r this object for chaining
  • setMax (double Max)

    Sets the slider maximum value.

    • @p Max is the new maximum.
    • @r this object for chaining
  • setLowValue (double Val)

    Sets the low-thumb value.

    • @p Val is the low value.
    • @r this object for chaining
  • setHighValue (double Val)

    Sets the high-thumb value.

    • @p Val is the high value.
    • @r this object for chaining
  • getLowValue ()

    Returns the low-thumb value.

    • @r A double with the low value.
  • getHighValue ()

    Returns the high-thumb value.

    • @r A double with the high value.
  • adjustLowValue (double Val)

    Adjusts the low-thumb value using slider snapping rules.

    • @p Val is the requested low value.
    • @r this object for chaining
  • adjustHighValue (double Val)

    Adjusts the high-thumb value using slider snapping rules.

    • @p Val is the requested high value.
    • @r this object for chaining
  • setShowTickLabels (bool Show)

    Sets whether tick labels are shown.

    • @p Show is true to show tick labels.
    • @r this object for chaining
  • setShowTickMarks (bool Show)

    Sets whether tick marks are shown.

    • @p Show is true to show tick marks.
    • @r this object for chaining
  • setOrientation (string Orientation)

    Sets the slider orientation.

    • @p Orientation is HORIZONTAL or VERTICAL.
    • @r this object for chaining

class: ToggleSwitch

[29:7] extends: Node, Labeled

ToggleSwitch wraps the ControlsFX on/off switch control used for boolean settings with a touch-style visual affordance.

CSS Classes

Scope CSS Classes
ToggleSwitch toggle-switch, plus skin-specific substructure classes such as thumb and track.
Parent groups Labeled, Control, Region, and Node.

CSS Guide

Group What To Style
ToggleSwitch Target .toggle-switch, .thumb, and .track for switch-specific visuals.
Labeled Text color, font, alignment, content display, and graphic spacing.
Control Skin and focus traversal behavior.
Region Background, border, padding, shape, and preferred sizes.
Node Effects, opacity, transforms, cursor, and visibility.

Methods

  • ToggleSwitch (string Text = "")

    Creates a new ControlsFX toggle switch.

    • @p Text is an optional label string.
  • setSelected (bool Selected)

    Sets the selected state of the switch.

    • @p Selected is true to switch on the control.
    • @r this object for chaining
  • isSelected ()

    Returns whether the switch is selected.

    • @r A bool with the current selected state.
  • fire ()

    Programmatically fires the switch action.

    • @r this object for chaining