Package com.amalgamasimulation.charts.visualsets.containers

Class GanttVisualSetContainer

java.lang.Object

com.amalgamasimulation.charts.visualsets.containers.AbstractVisualSetContainer<IGanttChartVisualSet>

com.amalgamasimulation.charts.visualsets.containers.GanttVisualSetContainer

All Implemented Interfaces:

IYAxisCategoryVisualSetContainer<GanttChartRow>

public class GanttVisualSetContainer
extends AbstractVisualSetContainer<IGanttChartVisualSet>
implements IYAxisCategoryVisualSetContainer<GanttChartRow>

Class that represents the container for VisualSets used in the AbstractGanttChart.

Author:

Aleksey Kirillov

Field Summary

Fields inherited from class com.amalgamasimulation.charts.visualsets.containers.AbstractVisualSetContainer

defaultUpdatePolicy, listeners, sortedVisualSets, visualSets, visualSetsComparator, visualSetWindowSizeDescriptorsMap

Constructor Summary

Constructors

Constructor	Description
GanttVisualSetContainer()	Default GanttVisualSetContainer constructor.

Method Summary

Modifier and Type	Method	Description
GanttVisualSetContainer	addSeparator(GanttChartRow ganttChartRow, Color color, double width)	Sets the GanttChartRowSeparator that should be placed under the given ganttChartRow.
protected void	addVisualSetInternal(IGanttChartVisualSet visualSet)
GanttVisualSetContainer	collapseAll()	Collapses the entire tree structure, leaving only top-level elements visible.
boolean	containsAnyChild(GanttChartRow ganttChartRow)	Checks if given ganttChartRow contains at least one child row with at least one VisualSet.
GanttVisualSetContainer	expandAll()	Expands the entire tree structure, making all elements at all nesting levels visible.
List<GanttChartRow>	getChildrens(GanttChartRow ganttChartRow)	Returns the childrens list for given GanttChartRow.
Comparator<GanttChartRow>	getGanttChartRowsComparator()	Returns the comparator for GanttChartRow's.
Comparator<IGanttChartVisualSet>	getInternalVisualSetsComparator()	Returns the internal visualSets comparator i.e.
GanttChartRow	getParent(GanttChartRow ganttChartRow)	Returns the parent GanttChartRow for the given GanttChartRow.
IRowHeightPolicy	getRowHeightPolicy()	Returns the policy for calculating the height of the GanttChartRow.
GanttChartRowSeparator	getSeparator(GanttChartRow ganttChartRow)	Returns the GanttChartRowSeparator that should be placed under the given ganttChartRow.
List<GanttChartRowSeparator>	getSeparators()	Returns list of existed GanttChartRowSeparator's.
List<GanttChartRow>	getTreeFlatGanttChartRows()	Returns a flat list of GanttChartRows.
int	getTreeLevel(GanttChartRow ganttChartRow)	Returns the nesting level of the given GanttChartRow.
List<IGanttChartVisualSet>	getVisualSets(GanttChartRow ganttChartRow)	Returns a list of visualSets drawn on the given ganttChartRow.
protected void	invalidateDependencies()
boolean	isTree()	Checks if this container is a tree container.
boolean	isTreeStateExpanded(GanttChartRow ganttChartRow)	Checks if the given GanttChartRow is currently expanded.
GanttVisualSetContainer	newInstance()	Creates a new instance of AbstractVisualSetContainer corresponding to the current container type.
protected void	onAfterRemoveVisualSetInternal(IGanttChartVisualSet visualSet)
protected void	onBeforeRemoveVisualSetInternal(IGanttChartVisualSet visualSet)
protected void	onVisualSetsChange()
protected void	onVisualSetsClear()
GanttVisualSetContainer	removeSeparator(GanttChartRow ganttChartRow)	Removes the GanttChartRowSeparator that should be placed under the given ganttChartRow.
GanttVisualSetContainer	setChildrenProvider(Function<GanttChartRow,List<GanttChartRow>> childrenProvider)	Sets the childrens prodiver i.e.
GanttVisualSetContainer	setGanttChartRowsComparator(Comparator<GanttChartRow> ganttChartRowsComparator)	Sets the comparator for GanttChartRow's.
GanttVisualSetContainer	setRowHeightPolicy(IRowHeightPolicy rowHeightPolicy)	Sets the policy for calculating the height of the GanttChartRow.
GanttVisualSetContainer	setRowHeightPolicy(RowHeightPolicy rowHeightPolicy, double rowHeightPolicyValue)	Deprecated. use setRowHeightPolicy(IRowHeightPolicy rowHeightPolicy) instead
GanttVisualSetContainer	setTreeState(GanttChartRow ganttChartRow, boolean expanded, boolean recursively)	Sets the expand status of the given ganttChartRow.

Methods inherited from class com.amalgamasimulation.charts.visualsets.containers.AbstractVisualSetContainer

addVisualSet, addVisualSet, addVisualSet, addVisualSetContainerChangeHandler, addVisualSets, clear, containsVisualSet, getDefaultUpdatePolicy, getVisualSets, getVisualSetsComparator, getVisualSetsInjectionIndex, getWindowSizeDescriptor, removeVisualSet, removeVisualSetContainerChangeHandler, reset, reset, setDefaultUpdatePolicy, setVisualSetsComparator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GanttVisualSetContainer

public GanttVisualSetContainer()

Default GanttVisualSetContainer constructor.

Method Details

onVisualSetsClear

protected void onVisualSetsClear()

Specified by:

onVisualSetsClear in class AbstractVisualSetContainer<IGanttChartVisualSet>

setRowHeightPolicy

public GanttVisualSetContainer setRowHeightPolicy(IRowHeightPolicy rowHeightPolicy)

Sets the policy for calculating the height of the GanttChartRow. It is possible to set the GanttChartRow height depending on the number of lines or depending on the fixed line size.

Parameters:

rowHeightPolicy - policy for calculating the height of the GanttChartRow

Returns:

reference to this object

setRowHeightPolicy

public GanttVisualSetContainer setRowHeightPolicy(RowHeightPolicy rowHeightPolicy,
 double rowHeightPolicyValue)

Deprecated.

use setRowHeightPolicy(IRowHeightPolicy rowHeightPolicy) instead

Sets the policy for calculating the height of the GanttChartRow. It is possible to set the GanttChartRow height depending on the number of lines or depending on the fixed line size.

Parameters:

rowHeightPolicy - policy for calculating the height of the GanttChartRow

rowHeightPolicyValue - corresponding numeric value for the selected policy

Returns:

reference to this object

getRowHeightPolicy

public IRowHeightPolicy getRowHeightPolicy()

Returns the policy for calculating the height of the GanttChartRow.

Specified by:

getRowHeightPolicy in interface IYAxisCategoryVisualSetContainer<GanttChartRow>

Returns:

the policy for calculating the height of the GanttChartRow

setGanttChartRowsComparator

public GanttVisualSetContainer setGanttChartRowsComparator(Comparator<GanttChartRow> ganttChartRowsComparator)

Sets the comparator for GanttChartRow's. The comparator determines the sorting order in which the ganttChartRows are located.

Parameters:

ganttChartRowsComparator - new comparator for GanttChartRow's

Returns:

reference to this object

addSeparator

public GanttVisualSetContainer addSeparator(GanttChartRow ganttChartRow,
 Color color,
 double width)

Sets the GanttChartRowSeparator that should be placed under the given ganttChartRow.

Parameters:

ganttChartRow - GanttChartRow for which the separator is being set

color - separator line color

width - separator line width, in pixels

Returns:

reference to this object

getSeparator

public GanttChartRowSeparator getSeparator(GanttChartRow ganttChartRow)

Returns the GanttChartRowSeparator that should be placed under the given ganttChartRow. Returns null if no separator is set.

Parameters:

ganttChartRow - GanttChartRow for which the separator is being checked

Returns:

the GanttChartRowSeparator that should be placed under the given ganttChartRow

getSeparators

public List<GanttChartRowSeparator> getSeparators()

Returns list of existed GanttChartRowSeparator's.

Returns:

list of existed GanttChartRowSeparator's

removeSeparator

public GanttVisualSetContainer removeSeparator(GanttChartRow ganttChartRow)

Removes the GanttChartRowSeparator that should be placed under the given ganttChartRow.

Parameters:

ganttChartRow - GanttChartRow for which the separator is being removed

Returns:

reference to this object

getVisualSets

public List<IGanttChartVisualSet> getVisualSets(GanttChartRow ganttChartRow)

Returns a list of visualSets drawn on the given ganttChartRow.

Parameters:

ganttChartRow - GanttChartRow for which the list of visualSets are being checked

Returns:

a list of visualSets drawn on the given ganttChartRow

containsAnyChild

public boolean containsAnyChild(GanttChartRow ganttChartRow)

Checks if given ganttChartRow contains at least one child row with at least one VisualSet.

Used in tree structures.

Specified by:

containsAnyChild in interface IYAxisCategoryVisualSetContainer<GanttChartRow>

Parameters:

ganttChartRow - GanttChartRow for which the childs are being checked

Returns:

true if given given ganttChartRow contains at least one child row with at least one VisualSet, false otherwise

getTreeFlatGanttChartRows

public List<GanttChartRow> getTreeFlatGanttChartRows()

Returns a flat list of GanttChartRows. A flat list is a list with a direct order of elements, as the user would see it in a tree in expandAll-mode.

Used in tree structures.

Returns:

a flat list of GanttChartRows

isTree

public boolean isTree()

Description copied from interface: IYAxisCategoryVisualSetContainer

Checks if this container is a tree container.

Specified by:

isTree in interface IYAxisCategoryVisualSetContainer<GanttChartRow>

Returns:

true if this container is a tree container, false otherwise

setChildrenProvider

public GanttVisualSetContainer setChildrenProvider(Function<GanttChartRow,List<GanttChartRow>> childrenProvider)

Sets the childrens prodiver i.e. the function that specifies the parent-child relationship between GanttChartRow's for the tree structure.

Used in tree structures.

Parameters:

childrenProvider - the function that specifies the parent-child relationship between GanttChartRow's for the tree structure

Returns:

reference to this object

getGanttChartRowsComparator

public Comparator<GanttChartRow> getGanttChartRowsComparator()

Returns the comparator for GanttChartRow's. The comparator determines the sorting order in which the ganttChartRows are located.

Returns:

the comparator for GanttChartRow's

getChildrens

public List<GanttChartRow> getChildrens(GanttChartRow ganttChartRow)

Returns the childrens list for given GanttChartRow.

Used in tree structures.

Specified by:

getChildrens in interface IYAxisCategoryVisualSetContainer<GanttChartRow>

Parameters:

ganttChartRow - GanttChartRow for which the childrens list is being checked

Returns:

the childrens list for given GanttChartRow

isTreeStateExpanded

public boolean isTreeStateExpanded(GanttChartRow ganttChartRow)

Checks if the given GanttChartRow is currently expanded.

Used in tree structures.

Specified by:

isTreeStateExpanded in interface IYAxisCategoryVisualSetContainer<GanttChartRow>

Parameters:

ganttChartRow - GanttChartRow for which the expand status is being checked

Returns:

true the given GanttChartRow is currently expanded, false otherwise

expandAll

public GanttVisualSetContainer expandAll()

Expands the entire tree structure, making all elements at all nesting levels visible.

Used in tree structures.

Returns:

reference to this object

collapseAll

public GanttVisualSetContainer collapseAll()

Collapses the entire tree structure, leaving only top-level elements visible.

Used in tree structures.

Returns:

reference to this object

setTreeState

public GanttVisualSetContainer setTreeState(GanttChartRow ganttChartRow,
 boolean expanded,
 boolean recursively)

Sets the expand status of the given ganttChartRow. 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.

Specified by:

setTreeState in interface IYAxisCategoryVisualSetContainer<GanttChartRow>

Parameters:

ganttChartRow - GanttChartRow 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

public int getTreeLevel(GanttChartRow ganttChartRow)

Returns the nesting level of the given GanttChartRow.

Used in tree structures to define parent-child dependencies between GanttChartRow's.

Specified by:

getTreeLevel in interface IYAxisCategoryVisualSetContainer<GanttChartRow>

Parameters:

ganttChartRow - GanttChartRow for which the nesting level is being checked

Returns:

the nesting level of the given GanttChartRow

getParent

public GanttChartRow getParent(GanttChartRow ganttChartRow)

Returns the parent GanttChartRow for the given GanttChartRow.

Used in tree structures to define parent-child dependencies between GanttChartRow's.

Specified by:

getParent in interface IYAxisCategoryVisualSetContainer<GanttChartRow>

Parameters:

ganttChartRow - GanttChartRow for which the parent row is being checked

Returns:

the parent GanttChartRow for the given GanttChartRow

addVisualSetInternal

protected void addVisualSetInternal(IGanttChartVisualSet visualSet)

Specified by:

addVisualSetInternal in class AbstractVisualSetContainer<IGanttChartVisualSet>

onBeforeRemoveVisualSetInternal

protected void onBeforeRemoveVisualSetInternal(IGanttChartVisualSet visualSet)

Specified by:

onBeforeRemoveVisualSetInternal in class AbstractVisualSetContainer<IGanttChartVisualSet>

onAfterRemoveVisualSetInternal

protected void onAfterRemoveVisualSetInternal(IGanttChartVisualSet visualSet)

Specified by:

onAfterRemoveVisualSetInternal in class AbstractVisualSetContainer<IGanttChartVisualSet>

invalidateDependencies

protected void invalidateDependencies()

Specified by:

invalidateDependencies in class AbstractVisualSetContainer<IGanttChartVisualSet>

onVisualSetsChange

protected void onVisualSetsChange()

Specified by:

onVisualSetsChange in class AbstractVisualSetContainer<IGanttChartVisualSet>

getInternalVisualSetsComparator

public Comparator<IGanttChartVisualSet> getInternalVisualSetsComparator()

Description copied from class: AbstractVisualSetContainer

Returns the internal visualSets comparator i.e. the function that determines the sorting order of visualSets. The internal comparator is applied as last comparator, after all other sorting operations.

Specified by:

getInternalVisualSetsComparator in class AbstractVisualSetContainer<IGanttChartVisualSet>

Returns:

the internal visualSets comparator

newInstance

public GanttVisualSetContainer newInstance()

Description copied from class: AbstractVisualSetContainer

Creates a new instance of AbstractVisualSetContainer corresponding to the current container type.

Specified by:

newInstance in class AbstractVisualSetContainer<IGanttChartVisualSet>

Returns:

a new instance of AbstractVisualSetContainer corresponding to the current container type