Module com.flexganttfx.view
Package com.flexganttfx.view.graphics

Class ListViewGraphics<R extends Row<?,​?,​?>>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.flexganttfx.view.util.FlexGanttFXControl
com.flexganttfx.view.graphics.GraphicsBase<R>
com.flexganttfx.view.graphics.ListViewGraphics<R>
Type Parameters:
R - the type of the rows displayed inside the list view
All Implemented Interfaces:
Styleable, EventTarget, Skinnable
public class ListViewGraphics<R extends Row<?,​?,​?>>
extends GraphicsBase<R>
A specialization of GraphicsBase that uses a ListView to display a list of rows. The user can use the arrow up and down keys for scrolling vertically and arrows left and right for scrolling horizontally.
Since:
1.0

  • Property Details

    • autoscrollProximity

      public final DoubleProperty autoscrollProximityProperty
      This property defines the distance from the viewport borders (in pixels) where the viewport will automatically start scrolling, either horizontally or vertically. This behaviour is needed when the user performs a drag operation and needs to reach an area inside the graphics that is currently not visible. Setting this value to 0 disables the automatic scrolling feature.
      Since:
      1.3
      See Also:
      getAutoscrollProximity(), setAutoscrollProximity(double)

    • scrollValue

      public final DoubleProperty scrollValueProperty
      Stores the number of pixels that the list view will scroll when the user uses the arrow up and down keys.
      Since:
      1.3
      See Also:
      getScrollValue(), setScrollValue(double)

  • Constructor Details

    • ListViewGraphics

      public ListViewGraphics()

  • Method Details

    • createDefaultSkin

      protected Skin<?> createDefaultSkin()
      Overrides:
      createDefaultSkin in class Control

    • getListView

      public final ListView<R> getListView()
      Returns the list view control used by this graphics view.
      Returns:
      the list view
      Since:
      1.0

    • createListView

      protected ListView<R> createListView()
      Creates the list view instance to be used by this graphics view. This method can be overridden to return a specialization of ListView.
      Returns:
      a list view
      Since:
      1.0

    • autoscrollProximityProperty

      public final DoubleProperty autoscrollProximityProperty()
      This property defines the distance from the viewport borders (in pixels) where the viewport will automatically start scrolling, either horizontally or vertically. This behaviour is needed when the user performs a drag operation and needs to reach an area inside the graphics that is currently not visible. Setting this value to 0 disables the automatic scrolling feature.
      Since:
      1.3
      See Also:
      getAutoscrollProximity(), setAutoscrollProximity(double)

    • getAutoscrollProximity

      public final double getAutoscrollProximity()
      Returns the value of autoscrollProximityProperty().
      Returns:
      the distance in pixels to the viewport borders
      Since:
      1.3

    • setAutoscrollProximity

      public final void setAutoscrollProximity​(double value)
      Sets the value of autoscrollProximityProperty().
      Parameters:
      value - the distance in pixels to the viewport borders
      Since:
      1.3

    • scrollValueProperty

      public final DoubleProperty scrollValueProperty()
      Stores the number of pixels that the list view will scroll when the user uses the arrow up and down keys.
      Since:
      1.3
      See Also:
      getScrollValue(), setScrollValue(double)

    • getScrollValue

      public final double getScrollValue()
      Returns the value of scrollValueProperty().
      Returns:
      the scroll value (in pixels)
      Since:
      1.3

    • setScrollValue

      public final void setScrollValue​(double pixels)
      Sets the value of scrollValueProperty().
      Parameters:
      pixels - the scroll value (in pixels)
      Since:
      1.3

    • scrollUp

      public final void scrollUp()
      Makes the list view scroll up.
      Since:
      1.3
      See Also:
      setScrollValue(double), scrollValueProperty()

    • scrollDown

      public final void scrollDown()
      Makes the list view scroll down.
      Since:
      1.3
      See Also:
      setScrollValue(double), scrollValueProperty()