Package com.amalgamasimulation.charts.visualsets.containers

Interface IYAxisCategoryVisualSetContainer<X>

All Known Implementing Classes:
GanttVisualSetContainer, HeatmapVisualSetContainer
public interface IYAxisCategoryVisualSetContainer<X>
Interface of Y-axis categories property owners. Provides a set of methods corresponding to it. Used for visuals that are drawn on separate Y-axis categories of the charts.
Author:
Aleksey Kirillov

  • Method Details

    • isTree

      boolean isTree()
      Checks if this container is a tree container.
      Returns:
      true if this container is a tree container, false otherwise

    • isTreeStateExpanded

      boolean isTreeStateExpanded(X category)
      Checks if the given category is currently expanded.

      Used in tree structures.

      Parameters:
      category - category for which the expand status is being checked
      Returns:
      true the given category is currently expanded, false otherwise

    • containsAnyChild

      boolean containsAnyChild(X category)
      Checks if given category contains at least one child row with at least one VisualSet.

      Used in tree structures.

      Parameters:
      category - category for which the childs are being checked
      Returns:
      true if given given category contains at least one child row with at least one VisualSet, false otherwise

    • setTreeState

      IYAxisCategoryVisualSetContainer<X> setTreeState(X category, boolean expanded, boolean recursively)
      Sets the expand status of the given category. Provides the opportunity to expand a list of elements recursively, i.e. also expand all parent elements, up to the top-level elements.

      Used in tree structures.

      Parameters:
      category - category for which the expand status is being set
      expanded - new expand status
      recursively - determines whether the new status should be applied to all parent elements up to top-level elements
      Returns:
      reference to this object

    • getTreeLevel

      int getTreeLevel(X category)
      Returns the nesting level of the given category.

      Used in tree structures to define parent-child dependencies between categories.

      Parameters:
      category - category for which the nesting level is being checked
      Returns:
      the nesting level of the given category

    • getParent

      X getParent(X category)
      Returns the parent category for the given category.

      Used in tree structures to define parent-child dependencies between categories.

      Parameters:
      category - category for which the parent row is being checked
      Returns:
      the parent category for the given category

    • getChildrens

      List<X> getChildrens(X category)
      Returns the childrens list for given category.

      Used in tree structures.

      Parameters:
      category - category for which the childrens list is being checked
      Returns:
      the childrens list for given category

    • getRowHeightPolicy

      IRowHeightPolicy getRowHeightPolicy()
      Returns the policy for calculating the height of the category.
      Returns:
      the policy for calculating the height of the category