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

    • Constructor Detail

      • GanttChartBase

        protected GanttChartBase()
        Constructs a new Gantt Chart control.
        Since:
        1.6
    • Method Detail

      • rowFilterProperty

        public final ObjectProperty<Predicate<R>> rowFilterProperty()
        A predicate used to filter the rows.
        Returns:
        the filter predicate
      • setRowFilter

        public final void setRowFilter​(Predicate<R> predicate)
        Sets the value of rowFilterProperty().
        Parameters:
        predicate - the filter predicate
      • createGraphics

        protected ListViewGraphics<R> createGraphics()
        Creates the graphics view used by the Gantt chart. Applications can override this method to return a customized graphics view.
        Returns:
        a graphics view instance
        Since:
        1.6
      • graphicsHeaderProperty

        public final ObjectProperty<Node> graphicsHeaderProperty()
        A property used to store a node that will be placed above the graphics area instead of the timeline. This can be very useful when, for example, using a DualGanttChartContainer where the users do not want to see two timelines at the same time. The graphics header node could simply be a gray empty area or it could be used as a toolbar control for the secondary Gantt chart.
        Returns:
        the graphics header node property
        Since:
        1.6
      • getGraphicsHeader

        public final Node getGraphicsHeader()
        Returns the value of graphicsHeaderProperty().
        Returns:
        the graphics header node
        Since:
        1.6
      • setGraphicsHeader

        public final void setGraphicsHeader​(Node node)
        Sets the value of graphicsHeaderProperty().
        Parameters:
        node - the node used as a header above the graphics area
        Since:
        1.6
      • redrawObservable

        protected void redrawObservable​(Observable property)
      • positionProperty

        public final ObjectProperty<Position> positionProperty()
        A property used to store the position of the Gantt chart in a multi Gantt chart context, for example, inside a DualGanttChartContainer or a MultiGanttChartContainerBase. One of the charts will be the first, some will be in the middle, and one will be the last. The first chart is the owner of the master timeline.
        Returns:
        the Gantt chart position
        Since:
        1.6
        See Also:
        getMasterTimeline()
      • getPosition

        public final Position getPosition()
        Returns the value of positionProperty().
        Returns:
        the position of the chart
        Since:
        1.6
      • setPosition

        public final void setPosition​(Position position)
        Sets the value of positionProperty().
        Parameters:
        position - the chart position (first, last, middle, only)
      • masterTimelineProperty

        public final ObjectProperty<Timeline> masterTimelineProperty()
        A property used to store a reference to the timeline that is being considered the "master" timeline. This property is needed when several charts are used in combination with each other (see DualGanttChartContainer or MultiGanttChartContainerBase). The master timeline is the one provided by the Gantt chart located at the top of the container (the "first" chart).
        Returns:
        the master timeline
        Since:
        1.6
        See Also:
        Position, setPosition(Position)
      • setMasterTimeline

        public final void setMasterTimeline​(Timeline timeline)
        Sets the value of masterTimelineProperty().
        Parameters:
        timeline - the new master timeline
        Since:
        1.6
      • createTimeline

        protected Timeline createTimeline()
        Creates the timeline component used by the Gantt chart. Applications can override this method to return a customized timeline.
        Returns:
        the timeline instance
        Since:
        1.6
      • getGraphics

        public final ListViewGraphics<R> getGraphics()
        Returns the graphics view shown on the right-hand side of the Gantt chart. The view is set as the master node on the primary MasterDetailPane instance.
        Returns:
        the graphics view
        Since:
        1.6
        See Also:
        createGraphics()
      • getTimelineScrollBar

        public final TimelineScrollBar getTimelineScrollBar()
        Returns the specialized timeline scrollbar control used for scrolling forward and back in time. The scrollbar becomes visible when the user moves the mouse cursor close to the bottom edge of the graphics area.
        Returns:
        the timeline scrollbar
        Since:
        1.6
        See Also:
        HiddenSidesPane
      • getGraphicsMasterDetailPane

        public org.controlsfx.control.MasterDetailPane getGraphicsMasterDetailPane()
        Returns the MasterDetailPane instance that is used to display the ListViewGraphics in the master section and the detail node in the detail section.
        Returns:
        the master detail pane
        Since:
        1.6
      • detailProperty

        public final ObjectProperty<Node> detailProperty()
        A property used to store a node that can be made visible on the right-hand side of the Gantt chart. The node can be used to show any kind of controls that the application might require.
        Returns:
        the detail node
        Since:
        1.6
        See Also:
        showDetailProperty(), MasterDetailPane.detailNodeProperty()
      • setDetail

        public final void setDetail​(Node node)
        Sets the value of detailProperty().
        Parameters:
        node - the new detail node
        Since:
        1.6
      • getDetail

        public final Node getDetail()
        Returns the value of detailProperty().
        Returns:
        the detail node
        Since:
        1.6
      • getFixedCellSize

        public final double getFixedCellSize()
        Returns the value of fixedCellSizeProperty().
        Returns:
        the fixed cell size
        Since:
        1.6
      • setFixedCellSize

        public final void setFixedCellSize​(double size)
        Sets the value of fixedCellSizeProperty().
        Parameters:
        size - the fixed cell size
        Since:
        1.6
      • showDetailProperty

        public final BooleanProperty showDetailProperty()
        A property used to control whether the "details" node will be shown or not. This node gets shown on the right-hand side of the Gantt chart and can contain arbitrary content. By default it is used to display a property sheet with the current settings / configuration of the Gantt chart. The detail node is shown by the secondary master detail pane (see getGraphicsMasterDetailPane()).
        Returns:
        the show details property
        Since:
        1.6
        See Also:
        MasterDetailPane.detailNodeProperty(), MasterDetailPane.setDetailNode(Node), getGraphicsMasterDetailPane()
      • isShowDetail

        public final boolean isShowDetail()
        Returns the value of showDetailProperty().
        Returns:
        true if the detail node gets shown
        Since:
        1.6
      • setShowDetail

        public final void setShowDetail​(boolean show)
        Sets the value of showDetailProperty().
        Parameters:
        show - if true the detail node will be shown on the right-hand side of the Gantt chart
        Since:
        1.6
      • getLayers

        public final ObservableList<Layer> getLayers()
        Convenience method to return the list of layers registered on the graphics view.
        Returns:
        the layers registered on the graphics area
        Since:
        1.6
        See Also:
        GraphicsBase.getLayers()
      • getCalendars

        public final ObservableList<Calendar<?>> getCalendars()
        Convenience method to return the list of calendars registered on the graphics view.
        Returns:
        the calendars registered on the graphics area
        Since:
        1.6
        See Also:
        GraphicsBase.getCalendars()