ilog.views.gantt.project

Class IlvGanttProjectConfiguration

java.lang.Object

ilog.views.gantt.project.IlvGanttProjectConfiguration

public class IlvGanttProjectConfiguration
extends Object

An IlvGanttProjectConfiguration is the logical grouping of:

• A type of Gantt.
• A Gantt data model.
• Some style sheets.
• A method to read or save it.

Since:

JViews 6.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	GANTT_CHART_TYPE The chart type for an activity-oriented Gantt chart.
static String	SCHEDULE_CHART_TYPE The chart type for a resource-oriented Schedule chart.

Constructor Summary

Constructors

Constructor and Description
IlvGanttProjectConfiguration() Creates a new IlvGanttProjectConfiguration.

Method Summary

Modifier and Type	Method and Description
void	addStyleSheet(String ssheet) Adds the specified style sheet to this configuration.
void	addStyleSheets(String[] ssheets) Adds the specified style sheets to this configuration.
void	apply(IlvStylable chart) Applies this configuration to the specified chart.
boolean	canApply(IlvStylable chart) Returns whether the chart type of this configuration is compatible with the specified chart.
String	getChartType() Returns the chart type of the configuration.
IlvGanttDataSource	getDataSource() Returns the Gantt data source handled by this configuration.
IlvGanttModel	getGanttModel() Returns the Gantt data model handled by this configuration.
String[]	getStyleSheets() Returns the style sheets handled by this configuration.
boolean	isSupportedChartType(String chartType) Returns whether the specified chart type is supported by this configuration.
void	read(URL url) Initialize this configuration from the specified URL.
void	setChartType(IlvHierarchyChart chart) Sets the chart type of the configuration based upon the specified chart.
void	setChartType(String chartType) Sets the chart type of the configuration.
void	setDataSource(IlvGanttDataSource dataSource) Sets the Gantt data source handled by this configuration.
void	setGanttModel(IlvGanttModel ganttModel) Sets the Gantt data model handled by this configuration.
void	setStyleSheets(String[] ssheets) Sets the style sheets of this configuration.
void	write(URL url) Writes this configuration to the specified output stream.

Methods inherited from class java.lang.Object

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

Field Detail

GANTT_CHART_TYPE

public static final String GANTT_CHART_TYPE

The chart type for an activity-oriented Gantt chart.

See Also:

isSupportedChartType(java.lang.String), Constant Field Values

SCHEDULE_CHART_TYPE

public static final String SCHEDULE_CHART_TYPE

The chart type for a resource-oriented Schedule chart.

See Also:

isSupportedChartType(java.lang.String), Constant Field Values

Constructor Detail

IlvGanttProjectConfiguration

public IlvGanttProjectConfiguration()

Creates a new IlvGanttProjectConfiguration.

Method Detail

isSupportedChartType

public boolean isSupportedChartType(String chartType)

Returns whether the specified chart type is supported by this configuration. This default implementation supports the GANTT_CHART_TYPE and the SCHEDULE_CHART_TYPE.

Parameters:

chartType - The chart type to test.

Returns:

true if the chart type is supported by the configuration, false otherwise.

getDataSource

public IlvGanttDataSource getDataSource()

Returns the Gantt data source handled by this configuration.

Returns:

The IlvGanttDataSource.

setDataSource

public final void setDataSource(IlvGanttDataSource dataSource)

Sets the Gantt data source handled by this configuration.

Parameters:

dataSource - The IlvGanttDataSource.

getGanttModel

public IlvGanttModel getGanttModel()

Returns the Gantt data model handled by this configuration.

Returns:

The IlvGanttModel.

setGanttModel

public final void setGanttModel(IlvGanttModel ganttModel)

Sets the Gantt data model handled by this configuration.

Parameters:

ganttModel - The IlvGanttModel.

setStyleSheets

public final void setStyleSheets(String[] ssheets)

Sets the style sheets of this configuration.

Parameters:

ssheets - The style sheets to add.

getStyleSheets

public final String[] getStyleSheets()

Returns the style sheets handled by this configuration.

Returns:

The style sheets.

getChartType

public String getChartType()

Returns the chart type of the configuration.

setChartType

public void setChartType(String chartType)

Sets the chart type of the configuration.

Parameters:

chartType - The chart type, which must be one of the types supported by this configuration.

Throws:

IllegalArgumentException - if the chart type is not supported by the configuration.

setChartType

public void setChartType(IlvHierarchyChart chart)

Sets the chart type of the configuration based upon the specified chart.

Parameters:

chart - The chart.

addStyleSheet

public final void addStyleSheet(String ssheet)

Adds the specified style sheet to this configuration.

Parameters:

ssheet - The style sheet to add.

addStyleSheets

public final void addStyleSheets(String[] ssheets)

Adds the specified style sheets to this configuration.

Parameters:

ssheets - The style sheets to add.

canApply

public boolean canApply(IlvStylable chart)

Returns whether the chart type of this configuration is compatible with the specified chart.

Parameters:

chart - The chart.

See Also:

apply(ilog.views.util.styling.IlvStylable)

apply

public void apply(IlvStylable chart)
           throws IlvStylingException

Applies this configuration to the specified chart.

Parameters:

chart - The chart.

Throws:

IlvStylingException - if a problem is encountered while applying the configuration's styling to the chart.

IllegalArgumentException - if the chart type of the configuration is not compatible with the chart.

See Also:

canApply(ilog.views.util.styling.IlvStylable)

read

public void read(URL url)
          throws IOException

Initialize this configuration from the specified URL.

Parameters:

url - The URL to read the configuration from.

Throws:

IOException

write

public void write(URL url)
           throws IOException

Writes this configuration to the specified output stream.

Parameters:

url - The URL to write the configuration to.

Throws:

IOException