net.sf.mpxj.mpp
Class GanttBarStyleException

java.lang.Object
  extended by net.sf.mpxj.mpp.GanttBarCommonStyle
      extended by net.sf.mpxj.mpp.GanttBarStyleException

public final class GanttBarStyleException
extends GanttBarCommonStyle

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


Constructor Summary
GanttBarStyleException()
           
 
Method Summary
 int getBarStyleIndex()
          Retrieves the index of the bar style to which this exception applies.
 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 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

getBarStyleIndex

public int getBarStyleIndex()
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 wit 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


Copyright © 2012. All Rights Reserved.