net.sf.mpxj
Class GraphicalIndicator

java.lang.Object
  net.sf.mpxj.GraphicalIndicator

public class GraphicalIndicator
extends Object

This class represents the set of information which defines how a Graphical Indicator will be presented for a single column in a table within Microsoft Project.

Constructor Summary

GraphicalIndicator()

Method Summary

void	addNonSummaryRowCriteria(GraphicalIndicatorCriteria criteria) Add criteria relating to non summary rows.
void	addProjectSummaryCriteria(GraphicalIndicatorCriteria criteria) Add criteria relating to project summary.
void	addSummaryRowCriteria(GraphicalIndicatorCriteria criteria) Add criteria relating to summary rows.
int	evaluate(FieldContainer container) This method evaluates a if a graphical indicator should be displayed, given a set of Task or Resource data.
boolean	getDisplayGraphicalIndicators() Retrieves a flag indicating if graphical indicators should be displayed for this column, rather than the actual values.
FieldType	getFieldType() Retrieves the field type to which this indicator applies.
List<GraphicalIndicatorCriteria>	getNonSummaryRowCriteria() Retrieve the criteria to be applied to non-summary rows.
List<GraphicalIndicatorCriteria>	getProjectSummaryCriteria() Retrieve the criteria to be applied to the project summary.
boolean	getProjectSummaryInheritsFromSummaryRows() Retrieves a flag which indicates if the project summary row inherits criteria from the summary row.
boolean	getShowDataValuesInToolTips() Retrieve the flag which indicates that data values should be shown as tool tips.
List<GraphicalIndicatorCriteria>	getSummaryRowCriteria() Retrieve the criteria to be applied to summary rows.
boolean	getSummaryRowsInheritFromNonSummaryRows() Retrieves a flag which indicates if summary rows inherit criteria from non-summary rows.
void	setDisplayGraphicalIndicators(boolean displayGraphicalIndicators) Sets a flag indicating if graphical indicators should be displayed for this column, rather than the actual values.
void	setFieldType(FieldType fieldType) Sets the field type to which this indicator applies.
void	setProjectSummaryInheritsFromSummaryRows(boolean projectSummaryInheritsFromSummaryRows) Sets a flag which indicates if the project summary row inherits criteria from the summary row.
void	setShowDataValuesInToolTips(boolean showDataValuesInToolTips) Set the flag which indicates that data values should be shown as tool tips.
void	setSummaryRowsInheritFromNonSummaryRows(boolean summaryRowsInheritFromNonSummaryRows) Sets a flag which indicates if summary rows inherit criteria from non-summary rows.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicalIndicator

public GraphicalIndicator()

Method Detail

evaluate

public int evaluate(FieldContainer container)

This method evaluates a if a graphical indicator should be displayed, given a set of Task or Resource data. The method will return -1 if no indicator should be displayed.

Parameters:

container - Task or Resource instance

Returns:

indicator index

setFieldType

public void setFieldType(FieldType fieldType)

Sets the field type to which this indicator applies.

Parameters:

fieldType - field type

getFieldType

public FieldType getFieldType()

Retrieves the field type to which this indicator applies.

Returns:

field type

getDisplayGraphicalIndicators

public boolean getDisplayGraphicalIndicators()

Retrieves a flag indicating if graphical indicators should be displayed for this column, rather than the actual values.

Returns:

boolean flag

setDisplayGraphicalIndicators

public void setDisplayGraphicalIndicators(boolean displayGraphicalIndicators)

Sets a flag indicating if graphical indicators should be displayed for this column, rather than the actual values.

Parameters:

displayGraphicalIndicators - boolean flag

getNonSummaryRowCriteria

public List<GraphicalIndicatorCriteria> getNonSummaryRowCriteria()

Retrieve the criteria to be applied to non-summary rows.

Returns:

list of non-summary row criteria

getProjectSummaryCriteria

public List<GraphicalIndicatorCriteria> getProjectSummaryCriteria()

Retrieve the criteria to be applied to the project summary.

Returns:

list of project summary criteria

getSummaryRowCriteria

public List<GraphicalIndicatorCriteria> getSummaryRowCriteria()

Retrieve the criteria to be applied to summary rows.

Returns:

list of summary row criteria

getProjectSummaryInheritsFromSummaryRows

public boolean getProjectSummaryInheritsFromSummaryRows()

Retrieves a flag which indicates if the project summary row inherits criteria from the summary row.

Returns:

boolean flag

setProjectSummaryInheritsFromSummaryRows

public void setProjectSummaryInheritsFromSummaryRows(boolean projectSummaryInheritsFromSummaryRows)

Sets a flag which indicates if the project summary row inherits criteria from the summary row.

Parameters:

projectSummaryInheritsFromSummaryRows - boolean flag

getSummaryRowsInheritFromNonSummaryRows

public boolean getSummaryRowsInheritFromNonSummaryRows()

Retrieves a flag which indicates if summary rows inherit criteria from non-summary rows.

Returns:

boolean flag

setSummaryRowsInheritFromNonSummaryRows

public void setSummaryRowsInheritFromNonSummaryRows(boolean summaryRowsInheritFromNonSummaryRows)

Sets a flag which indicates if summary rows inherit criteria from non-summary rows.

Parameters:

summaryRowsInheritFromNonSummaryRows - boolean flag

getShowDataValuesInToolTips

public boolean getShowDataValuesInToolTips()

Retrieve the flag which indicates that data values should be shown as tool tips.

Returns:

boolean flag

setShowDataValuesInToolTips

public void setShowDataValuesInToolTips(boolean showDataValuesInToolTips)

Set the flag which indicates that data values should be shown as tool tips.

Parameters:

showDataValuesInToolTips - boolean flag

addNonSummaryRowCriteria

public void addNonSummaryRowCriteria(GraphicalIndicatorCriteria criteria)

Add criteria relating to non summary rows.

Parameters:

criteria - indicator criteria

addSummaryRowCriteria

public void addSummaryRowCriteria(GraphicalIndicatorCriteria criteria)

Add criteria relating to summary rows.

Parameters:

criteria - indicator criteria

addProjectSummaryCriteria

public void addProjectSummaryCriteria(GraphicalIndicatorCriteria criteria)

Add criteria relating to project summary.

Parameters:

criteria - indicator criteria

toString

public String toString()

Overrides:

toString in class Object