Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: SegmentedButton

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

SegmentedButton wraps the ControlsFX container that groups toggle buttons into a segmented control.

CSS Classes

Scope CSS Classes
SegmentedButton segmented-button, optional dark, and per-button first/middle/last segment classes.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
SegmentedButton Style the segment container plus the child toggle buttons and dark variant.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • SegmentedButton (Buttons = null)

    Creates a segmented button from an optional list of toggle buttons.

    • @p Buttons is an optional list of fx.ToggleButton wrappers.
  • addButton (object ButtonObj)

    Adds one toggle button segment.

    • @p ButtonObj is a wrapped ToggleButton.
    • @r this object for chaining
  • setButtons (list Buttons)

    Replaces the segment list.

    • @p Buttons is a list of ToggleButton wrappers.
    • @r this object for chaining

class: CheckBoxTreeItem

[16:7] extends: TreeItem

CheckBoxTreeItem wraps the JavaFX tree item that carries a checkbox state and is commonly used as the root model for ControlsFX CheckTreeView.

Methods

  • CheckBoxTreeItem (Val = null)

    Creates a new checkbox tree item with an optional value.

    • @p Val is the item value, or null for an empty item.

class: CheckListView

[178:7] extends: ListView

CheckListView wraps the ControlsFX list view that pairs each row with a checkbox and manages checked state separately from selection.

CSS Classes

Scope CSS Classes
CheckListView Inherits the standard list-view classes plus ControlsFX checkbox cell styling.
Parent groups ListView, Control, Region, and Node.

CSS Guide

Group What To Style
CheckListView Style the list cells, embedded checkbox graphic, checked rows, and placeholder.
ListView Orientation-specific list styling and cell sizing.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • CheckListView (Items = null)

    Creates a new check list view with optional items.

    • @p Items is an optional list of initial items.
  • checkIndex (int Index)

    Checks the row at the provided index.

    • @p Index is the row index to check.
    • @r this object for chaining
  • clearCheckIndex (int Index)

    Clears the checked state at the provided index.

    • @p Index is the row index to clear.
    • @r this object for chaining
  • getCheckedItems ()

    Returns the checked items.

    • @r A list with the checked items.

class: CheckTreeView

[245:7] extends: TreeView

CheckTreeView wraps the ControlsFX tree view that supports checkbox state on tree items.

CSS Classes

Scope CSS Classes
CheckTreeView Inherits tree-view plus ControlsFX checkbox tree cell classes.
Parent groups TreeView, Control, Region, and Node.

CSS Guide

Group What To Style
CheckTreeView Style tree cells, disclosure nodes, embedded checkboxes, and checked rows.
TreeView Fixed cell size and other tree-view CSS inherited from JavaFX.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • CheckTreeView (object RootItem = null)

    Creates a new check tree view with an optional checkbox root item.

    • @p RootItem is an optional CheckBoxTreeItem.
  • checkItem (object ItemObj)

    Checks the provided tree item.

    • @p ItemObj is a wrapped tree item.
    • @r this object for chaining
  • clearCheckItem (object ItemObj)

    Clears the checked state for the provided tree item.

    • @p ItemObj is a wrapped tree item.
    • @r this object for chaining
  • getCheckedItems ()

    Returns the checked tree items.

    • @r A list with the checked TreeItem objects.

class: SearchableComboBox

[312:7] extends: ComboBox

SearchableComboBox wraps the ControlsFX combo box variant that adds built-in type-ahead searching within the popup choices.

CSS Classes

Scope CSS Classes
SearchableComboBox Inherits the normal combo-box structure, popup, and editable field classes.
Parent groups ComboBox, Control, Region, and Node.

CSS Guide

Group What To Style
SearchableComboBox Style the combo box button, arrow button, popup list, and search behavior through combo-box skin classes.
ComboBox Standard combo box CSS such as popup visibility, editable state, and cell sizing.
Control Skin and focus behavior.
Region Background, border, padding, and size hints.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • SearchableComboBox (Items = null)

    Creates a new searchable combo box with optional items.

    • @p Items is an optional list of initial items.

class: BreadCrumbBar

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

BreadCrumbBar wraps the ControlsFX breadcrumb navigation control built on a TreeItem hierarchy.

CSS Classes

Scope CSS Classes
BreadCrumbBar bread-crumb-bar plus crumb button and arrow classes from the ControlsFX skin.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
BreadCrumbBar Style crumb buttons, separators, current-crumb state, and hover/pressed states.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • BreadCrumbBar (object SelectedCrumb = null)

    Creates a breadcrumb bar with an optional selected crumb root.

    • @p SelectedCrumb is an optional TreeItem.
  • setSelectedCrumb (object ItemObj)

    Sets the selected crumb.

    • @p ItemObj is a wrapped TreeItem.
    • @r this object for chaining
  • setAutoNavigationEnabled (bool Enabled)

    Sets whether automatic breadcrumb navigation is enabled.

    • @p Enabled is true to enable auto navigation.
    • @r this object for chaining
  • onCrumbAction (callback OnAction)

    Registers an on-crumb-action event handler.

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

class: CheckComboBox

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

CheckComboBox wraps the ControlsFX combo box that supports selecting many items with check marks in the popup list.

CSS Classes

Scope CSS Classes
CheckComboBox check-combo-box together with combo-box popup and check cell classes used by the skin.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
CheckComboBox Style the combo box button area, popup list cells, checkbox marks, and checked-count title rendering.
Control Skin and focus traversal behavior.
Region Background, border, padding, and size hints.
Node Effects, transforms, cursor, opacity, and visibility.

Methods

  • CheckComboBox (Items = null)

    Creates a new check combo box with optional items.

    • @p Items is an optional list of initial items.
  • setItems (list Items)

    Replaces the combo box items.

    • @p Items is the new item list.
    • @r this object for chaining
  • getItems ()

    Returns the current item list.

    • @r A list with the current items.
  • checkIndex (int Index)

    Checks the item at the provided index.

    • @p Index is the item index to check.
    • @r this object for chaining
  • clearCheckIndex (int Index)

    Clears the checked state at the provided index.

    • @p Index is the item index to clear.
    • @r this object for chaining
  • getCheckedItems ()

    Returns the checked items.

    • @r A list with the currently checked items.
  • setTitle (string Text)

    Sets the title text shown when the popup is collapsed.

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

    Sets whether the checked item count is shown in the title area.

    • @p Show is true to show the checked count.
    • @r this object for chaining
  • show ()

    Shows the popup list.

    • @r this object for chaining
  • hide ()

    Hides the popup list.

    • @r this object for chaining