net.sf.mpxj.mpp

Class GanttBarStyleException

java.lang.Object

net.sf.mpxj.mpp.GanttBarCommonStyle

net.sf.mpxj.mpp.GanttBarStyleException

public final class GanttBarStyleException
extends GanttBarCommonStyle

This class represents the default style for a Gantt chart bar.

Constructor Summary

Constructors

Constructor and Description
GanttBarStyleException()

Method Summary

Modifier and Type	Method and Description
int	getBarStyleIndex() Deprecated. use getGanttBarStyleID() to retrieve the bar style ID and getGanttBarStyleByID on the view to retrieve the style
Integer	getGanttBarStyleID() Set the ID of the Gantt Bar Style to which this exception is applied.
int	getTaskUniqueID() Retrieve the unique task ID for the task to which this style exception applies.
void	setBarStyleIndex(int index) Sets the bar style index.
void	setGanttBarStyleID(Integer value) Set the ID of the Gantt Bar Style to which this exception is applied.
void	setTaskUniqueID(int id) Sets the task unique ID.
String	toString() Generate a string representation of this instance.

Methods inherited from class net.sf.mpxj.mpp.GanttBarCommonStyle

getBottomText, getEndColor, getEndShape, getEndType, getInsideText, getLeftText, getMiddleColor, getMiddlePattern, getMiddleShape, getRightText, getStartColor, getStartShape, getStartType, getTopText, setBottomText, setEndColor, setEndShape, setEndType, setInsideText, setLeftText, setMiddleColor, setMiddlePattern, setMiddleShape, setRightText, setStartColor, setStartShape, setStartType, setTopText

Methods inherited from class java.lang.Object

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

Constructor Detail

GanttBarStyleException

public GanttBarStyleException()

Method Detail

getTaskUniqueID

public int getTaskUniqueID()

Retrieve the unique task ID for the task to which this style exception applies.

Returns:

task ID

setTaskUniqueID

public void setTaskUniqueID(int id)

Sets the task unique ID.

Parameters:

id - task unique ID

getGanttBarStyleID

public Integer getGanttBarStyleID()

Set the ID of the Gantt Bar Style to which this exception is applied.

Returns:

bar style ID

setGanttBarStyleID

public void setGanttBarStyleID(Integer value)

Set the ID of the Gantt Bar Style to which this exception is applied.

Parameters:

value - bar style ID

getBarStyleIndex

@Deprecated
public int getBarStyleIndex()

Deprecated. use getGanttBarStyleID() to retrieve the bar style ID and getGanttBarStyleByID on the view to retrieve the style

Retrieves the index of the bar style to which this exception applies. The standard bar styles are held in an array, retrieved using the GanttChartView.getBarStyles() method. The index returned by this method is an index into the array of bar styles. The significance of this is that a single bar on a Gantt chart could have one or more exceptions associated with it, but the exceptions will only be applied if the style of the bar currently being displayed matches the style recorded here in the style exception.

Returns:

bar style index

setBarStyleIndex

public void setBarStyleIndex(int index)

Sets the bar style index.

Parameters:

index - bar style index

toString

public String toString()

Generate a string representation of this instance.

Overrides:

toString in class GanttBarCommonStyle

Returns:

string representation of this instance