Module com.flexganttfx.view
Package com.flexganttfx.view.container

Class DualGanttChartContainerBase<T extends GanttChartBase<?>>

  • Type Parameters:
    T - the type of the Gantt chart
    All Implemented Interfaces:
    Styleable, EventTarget, Skinnable
    Direct Known Subclasses:
    DualGanttChartContainer, DualGanttChartLiteContainer
    public abstract class DualGanttChartContainerBase<T extends GanttChartBase<?>>
extends ContainerBase<T>
    A specialization of ContainerBase capable of displaying exactly two instances of GanttChartBase and keeping their layouts and their scrolling and zooming behavior in sync. The container distinguishes between a primary and a secondary Gantt chart, where the secondary Gantt chart is located in the detail node section of a MasterDetailPane. It can be hidden or shown on demand. Each one of the two Gantt charts can have its own header and footer.
    Since:
    1.6

    • Constructor Detail

      • DualGanttChartContainerBase

        protected DualGanttChartContainerBase​(boolean autoBinding,
                                      T primaryGanttChart,
                                      T secondaryGanttChart)
        Constructs a new container with the given Gantt chart controls.
        Parameters:
        autoBinding - if true many properties of the secondary control will be bound to their equivalent of the primary Gantt chart
        primaryGanttChart - the primary Gantt chart shown in the top position
        secondaryGanttChart - the secondary Gantt chart shown in the bottom position
        Since:
        1.6

      • DualGanttChartContainerBase

        protected DualGanttChartContainerBase​(T primaryGanttChart,
                                      T secondaryGanttChart)
        Constructs a new container with the given Gantt chart controls. The properties of the secondary Gantt chart will be bound to their equivalent of the primary Gantt chart.
        Parameters:
        primaryGanttChart - the primary Gantt chart shown in the top position
        secondaryGanttChart - the secondary Gantt chart shown in the bottom position
        Since:
        1.6

    • Method Detail

      • getMasterDetailPane

        public final org.controlsfx.control.MasterDetailPane getMasterDetailPane()
        Returns the MasterDetailPane instance used by the skin of this control to arrange the primary and secondary Gantt charts. The primary Gantt chart will be the master and the secondary Gantt chart will be the detail node.
        Returns:
        the master detail pane
        Since:
        1.3
        See Also:
        MasterDetailPane.setMasterNode(Node), MasterDetailPane.setDetailNode(Node)

      • primaryGanttChartProperty

        public final ObjectProperty<T> primaryGanttChartProperty()
        A property used to store the reference to the Gantt chart control that is serving as the primary Gantt chart.
        Returns:
        the primary Gantt chart property
        Since:
        1.6

      • setPrimaryGanttChart

        public final void setPrimaryGanttChart​(T ganttChart)
        Sets the value of primaryGanttChartProperty().
        Parameters:
        ganttChart - the gantt chart control
        Since:
        1.6

      • getPrimaryGanttChart

        public final T getPrimaryGanttChart()
        Returns the value of primaryGanttChartProperty().
        Returns:
        the primary Gantt chart control
        Since:
        1.6

      • primaryHeaderProperty

        public final ObjectProperty<Node> primaryHeaderProperty()
        A property used to store the reference to a control that will be serving as a header for the primary Gantt chart. In most cases the primary header will be a toolbar.
        Returns:
        the primary header control property
        Since:
        1.6

      • setPrimaryHeader

        public final void setPrimaryHeader​(Node header)
        Sets the value of the primaryHeaderProperty().
        Parameters:
        header - the node that will be used as a header
        Since:
        1.6

      • getPrimaryHeader

        public final Node getPrimaryHeader()
        Returns the value of primaryHeaderProperty().
        Returns:
        the primary header node
        Since:
        1.6

      • primaryFooterProperty

        public final ObjectProperty<Node> primaryFooterProperty()
        A property used to store the reference to a node that will be displayed in the footer position of the primary Gantt chart.
        Returns:
        the primary footer property
        Since:
        1.6

      • setPrimaryFooter

        public final void setPrimaryFooter​(Node footer)
        Sets the value of primaryFooterProperty().
        Parameters:
        footer - the node that will be displayed in the footer position of the primary Gantt chart
        Since:
        1.6

      • getPrimaryFooter

        public final Node getPrimaryFooter()
        Returns the value of primaryFooterProperty().
        Returns:
        the node displayed in the footer position of the primary Gantt chart
        Since:
        1.6

      • secondaryHeaderProperty

        public final ObjectProperty<Node> secondaryHeaderProperty()
        A property used to store the reference to a control that will be serving as a header for the secondary Gantt chart. In most cases the secondary header will not be used.
        Returns:
        the secondary header control property
        Since:
        1.6

      • setSecondaryHeader

        public final void setSecondaryHeader​(Node header)
        Sets the value of secondaryHeaderProperty().
        Parameters:
        header - the control used as a header for the secondary Gantt chart
        Since:
        1.6

      • getSecondaryHeader

        public final Node getSecondaryHeader()
        Returns the value of secondaryHeaderProperty().
        Returns:
        the secondary header node
        Since:
        1.6

      • secondaryFooterProperty

        public final ObjectProperty<Node> secondaryFooterProperty()
        A property used to store the reference to a node that will be used in the footer position of the secondary Gantt chart.
        Returns:
        the secondary footer property
        Since:
        1.6

      • setSecondaryFooter

        public final void setSecondaryFooter​(Node footer)
        Sets the value of secondaryFooterProperty().
        Parameters:
        footer - the node that will be shown in the footer position of the secondary Gantt chart
        Since:
        1.6

      • getSecondaryFooter

        public final Node getSecondaryFooter()
        Returns the value of secondaryFooterProperty().
        Returns:
        the secondary footer node
        Since:
        1.6

      • secondaryGanttChartProperty

        public final ObjectProperty<T> secondaryGanttChartProperty()
        A property used to store the reference to the secondary Gantt chart.
        Returns:
        the secondary Gantt chart property

      • setSecondaryGanttChart

        public final void setSecondaryGanttChart​(T ganttChart)
        Sets the value of secondaryGanttChartProperty().
        Parameters:
        ganttChart - the gantt chart control
        Since:
        1.6

      • getSecondaryGanttChart

        public final T getSecondaryGanttChart()
        Returns the value of secondaryGanttChartProperty().
        Returns:
        the secondary Gantt chart control
        Since:
        1.6

      • showSecondaryProperty

        public final BooleanProperty showSecondaryProperty()
        A property used to toggle the visibility of the secondary Gantt chart.
        Returns:
        a property storing the visibility flag of the secondary Gantt chart
        Since:
        1.6

      • isShowSecondary

        public final boolean isShowSecondary()
        Returns the value of showSecondaryProperty().
        Returns:
        true if the secondary Gantt chart shall be visible
        Since:
        1.6

      • setShowSecondary

        public final void setShowSecondary​(boolean show)
        Sets the value of showSecondaryProperty().
        Parameters:
        show - if true the secondary Gantt chart will be visible
        Since:
        1.6

      • getPropertySheetItems

        public final ObservableList<org.controlsfx.control.PropertySheet.Item> getPropertySheetItems()
        Returns property sheet items.
        Returns:
        property sheet items