Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: TaskProgressView

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

TaskProgressView wraps the ControlsFX task list view that shows JavaFX Task progress, state, and messages in a single control.

CSS Classes

Scope CSS Classes
TaskProgressView task-progress-view, task cells, progress bars, and message/status substructure classes.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
TaskProgressView Style task rows, progress bars, titles, messages, and status indicators.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • TaskProgressView ()

    Creates a new task progress view.

  • addTask (TaskObj)

    Adds one JavaFX Task object to the control.

    • @p TaskObj is a wrapped or AJI JavaFX task object.
    • @r this object for chaining
  • setTasks (list Tasks)

    Replaces the task list.

    • @p Tasks is a list of wrapped or AJI JavaFX task objects.
    • @r this object for chaining
  • setRetainTasks (bool Retain)

    Sets whether completed tasks remain visible.

    • @p Retain is true to retain finished tasks.
    • @r this object for chaining

class: PropertySheet

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

PropertySheet wraps the ControlsFX property sheet control used to edit collections of PropertySheet.Item values.

CSS Classes

Scope CSS Classes
PropertySheet property-sheet, category headers, editor rows, search box, and mode switcher classes.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
PropertySheet Style category headers, property rows, labels, editor controls, search box, and mode switcher.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • PropertySheet (Items = null)

    Creates a property sheet with an optional list of existing PropertySheet.Item Java objects.

    • @p Items is an optional list of wrapped or AJI item objects.
  • setItems (list Items)

    Replaces the property sheet items.

    • @p Items is a list of wrapped or AJI PropertySheet.Item objects.
    • @r this object for chaining
  • addItem (ItemObj)

    Adds one property item.

    • @p ItemObj is a wrapped or AJI PropertySheet.Item object.
    • @r this object for chaining
  • setMode (string ModeName)

    Sets the property sheet display mode.

    • @p ModeName is NAME or CATEGORY.
    • @r this object for chaining
  • setSearchBoxVisible (bool Visible)

    Sets whether the search box is visible.

    • @p Visible is true to show the search box.
    • @r this object for chaining
  • setModeSwitcherVisible (bool Visible)

    Sets whether the mode switcher is visible.

    • @p Visible is true to show the mode switcher.
    • @r this object for chaining
  • setTitleFilter (string Text)

    Sets the title filter text.

    • @p Text is the filter string.
    • @r this object for chaining

class: Rating

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

Rating wraps the ControlsFX star-style rating control.

CSS Classes

Scope CSS Classes
Rating rating, star button classes, and orientation-specific classes.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
Rating Style the star glyphs, empty/filled segments, hover state, and orientation.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • Rating (int Max = null, int Val = null)

    Creates a rating control.

    • @p Max is the number of rating items, or null to use the ControlsFX default.
    • @p Val is the initial rating value, or null to use the ControlsFX default.
  • setRating (double Val)

    Sets the current rating value.

    • @p Val is the new rating value.
    • @r this object for chaining
  • getRating ()

    Returns the current rating value.

    • @r A double with the current rating.
  • setOrientation (string Orientation)

    Sets the rating orientation.

    • @p Orientation is HORIZONTAL or VERTICAL.
    • @r this object for chaining
  • setPartialRating (bool Partial)

    Sets whether partial ratings are allowed.

    • @p Partial is true to allow partial ratings.
    • @r this object for chaining
  • setUpdateOnHover (bool Update)

    Sets whether hover updates the rating immediately.

    • @p Update is true to update on hover.
    • @r this object for chaining

class: GridView

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

GridView wraps the ControlsFX tiled data view for showing a scrollable grid of items.

CSS Classes

Scope CSS Classes
GridView grid-view, grid-cell, and cell selection/focus classes from the ControlsFX skin.
Parent groups Control, Region, and Node.

CSS Guide

Group What To Style
GridView Style cells, spacing, selection state, and the internal virtual flow viewport.
Control Skin and focus behavior.
Region Background, border, padding, and sizing.
Node Effects, transforms, opacity, cursor, and visibility.

Methods

  • GridView (Items = null)

    Creates a grid view with optional initial items.

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

    Replaces the grid items.

    • @p Items is a list of items to show.
    • @r this object for chaining
  • addItem (Item)

    Adds one item to the grid.

    • @p Item is the item value to add.
    • @r this object for chaining
  • getItems ()

    Returns the current grid items.

    • @r A list with the current grid items.
  • setCellWidth (double Width)

    Sets the preferred cell width.

    • @p Width is the cell width in pixels.
    • @r this object for chaining
  • setCellHeight (double Height)

    Sets the preferred cell height.

    • @p Height is the cell height in pixels.
    • @r this object for chaining
  • setHorizontalCellSpacing (double Spacing)

    Sets the horizontal spacing between cells.

    • @p Spacing is the horizontal spacing in pixels.
    • @r this object for chaining
  • setVerticalCellSpacing (double Spacing)

    Sets the vertical spacing between cells.

    • @p Spacing is the vertical spacing in pixels.
    • @r this object for chaining