net.sf.mpxj.mpp
Class GanttChartView

java.lang.Object
  net.sf.mpxj.AbstractView
      net.sf.mpxj.mpp.AbstractMppView
          net.sf.mpxj.mpp.GenericView
              net.sf.mpxj.mpp.GanttChartView

All Implemented Interfaces:

View

Direct Known Subclasses:

GanttChartView12, GanttChartView14, GanttChartView9

public abstract class GanttChartView
extends GenericView

This class represents the set of properties used to define the appearance of a Gantt chart view in MS Project.

Field Summary

protected boolean	m_alwaysRollupGanttBars
protected List<Filter>	m_autoFilters
protected Map<FieldType,Filter>	m_autoFiltersByType
protected GanttBarDateFormat	m_barDateFormat
protected GridLines	m_barRowsGridLines
protected GanttBarStyleException[]	m_barStyleExceptions
protected GanttBarStyle[]	m_barStyles
protected FontStyle	m_barTextBottomFontStyle
protected FontStyle	m_barTextInsideFontStyle
protected FontStyle	m_barTextLeftFontStyle
protected FontStyle	m_barTextRightFontStyle
protected FontStyle	m_barTextTopFontStyle
protected GridLines	m_bottomTierColumnGridLines
protected FontStyle	m_bottomTimescaleFontStyle
protected FontStyle	m_criticalTasksFontStyle
protected GridLines	m_currentDateGridLines
protected FontStyle	m_externalTasksFontStyle
protected int	m_ganttBarHeight
protected GridLines	m_ganttRowsGridLines
protected boolean	m_hideRollupBarsWhenSummaryExpanded
protected FontStyle	m_highlightedTasksFontStyle
protected LinkStyle	m_linkStyle
protected FontStyle	m_markedTasksFontStyle
protected GridLines	m_middleTierColumnGridLines
protected FontStyle	m_middleTimescaleFontStyle
protected FontStyle	m_milestoneTasksFontStyle
protected FontStyle	m_nonCriticalTasksFontStyle
protected Color	m_nonWorkingColor
protected String	m_nonWorkingDaysCalendarName
protected ChartPattern	m_nonWorkingPattern
protected NonWorkingTimeStyle	m_nonWorkingStyle
protected GridLines	m_pageBreakGridLines
protected boolean	m_progressLinesActualPlan
protected boolean	m_progressLinesAtCurrentDate
protected boolean	m_progressLinesAtRecurringIntervals
protected Date	m_progressLinesBeginAtDate
protected boolean	m_progressLinesBeginAtProjectStart
protected Color	m_progressLinesCurrentLineColor
protected LineStyle	m_progressLinesCurrentLineStyle
protected Color	m_progressLinesCurrentProgressPointColor
protected int	m_progressLinesCurrentProgressPointShape
protected int	m_progressLinesDateFormat
protected boolean	m_progressLinesDisplaySelected
protected Date[]	m_progressLinesDisplaySelectedDates
protected int	m_progressLinesDisplayType
protected boolean	m_progressLinesEnabled
protected FontStyle	m_progressLinesFontStyle
protected Interval	m_progressLinesInterval
protected int	m_progressLinesIntervalDailyDayNumber
protected boolean	m_progressLinesIntervalDailyWorkday
protected boolean	m_progressLinesIntervalMonthlyDay
protected int	m_progressLinesIntervalMonthlyDayDayNumber
protected int	m_progressLinesIntervalMonthlyDayMonthNumber
protected boolean	m_progressLinesIntervalMonthlyFirstLast
protected Day	m_progressLinesIntervalMonthlyFirstLastDay
protected int	m_progressLinesIntervalMonthlyFirstLastMonthNumber
protected int	m_progressLinesIntervalWeekleyWeekNumber
protected boolean[]	m_progressLinesIntervalWeeklyDay
protected Color	m_progressLinesOtherLineColor
protected LineStyle	m_progressLinesOtherLineStyle
protected Color	m_progressLinesOtherProgressPointColor
protected int	m_progressLinesOtherProgressPointShape
protected boolean	m_progressLinesShowDate
protected GridLines	m_projectFinishGridLines
protected GridLines	m_projectStartGridLines
protected FontStyle	m_projectSummaryTasksFontStyle
protected boolean	m_roundBarsToWholeDays
protected FontStyle	m_rowAndColumnFontStyle
protected GridLines	m_sheetColumnsGridLines
protected GridLines	m_sheetRowsGridLines
protected boolean	m_showBarSplits
protected boolean	m_showDrawings
protected GridLines	m_statusDateGridLines
protected FontStyle	m_summaryTasksFontStyle
protected TableFontStyle[]	m_tableFontStyles
protected TimescaleTier	m_timescaleBottomTier
protected TimescaleTier	m_timescaleMiddleTier
protected boolean	m_timescaleScaleSeparator
protected int	m_timescaleShowTiers
protected int	m_timescaleSize
protected TimescaleTier	m_timescaleTopTier
protected GridLines	m_titleHorizontalGridLines
protected GridLines	m_titleVerticalGridLines
protected GridLines	m_topTierColumnGridLines
protected FontStyle	m_topTimescaleFontStyle
protected static Integer	TIMESCALE_PROPERTIES
protected static Integer	VIEW_PROPERTIES

Fields inherited from class net.sf.mpxj.AbstractView

m_id, m_name, m_parent, m_tableName, m_type

Method Summary

boolean	getAlwaysRollupGanttBars() Retrieve the always rollup Gantt bars flag.
Filter	getAutoFilterByType(FieldType type) Retrieves the auto filter definition associated with an individual column.
List<Filter>	getAutoFilters() Retrieves a list of all auto filters associated with this view.
GanttBarDateFormat	getBarDateFormat() Retrieve the bar date format.
GridLines	getBarRowsGridLines() Retrieve a grid lines definition.
GanttBarStyleException[]	getBarStyleExceptions() Retrieve an array representing bar styles which have been defined by the user for a specific task.
GanttBarStyle[]	getBarStyles() Retrieve an array of bar styles which are applied to all Gantt chart bars, unless an exception has been defined.
FontStyle	getBarTextBottomFontStyle() Retrieve a FontStyle instance.
FontStyle	getBarTextInsideFontStyle() Retrieve a FontStyle instance.
FontStyle	getBarTextLeftFontStyle() Retrieve a FontStyle instance.
FontStyle	getBarTextRightFontStyle() Retrieve a FontStyle instance.
FontStyle	getBarTextTopFontStyle() Retrieve a FontStyle instance.
GridLines	getBottomTierColumnGridLines() Retrieve a grid lines definition.
FontStyle	getBottomTimescaleFontStyle() Retrieve a FontStyle instance.
protected TableFontStyle	getColumnFontStyle(byte[] data, int offset, Map<Integer,FontBase> fontBases) Retrieve column font details from a block of property data.
FontStyle	getCriticalTasksFontStyle() Retrieve a FontStyle instance.
GridLines	getCurrentDateGridLines() Retrieve a grid lines definition.
Filter	getDefaultFilter() Convenience method used to retrieve the default filter instance associated with this view.
String	getDefaultFilterName() Retrieve the name of the filter applied to this view.
FontStyle	getExternalTasksFontStyle() Retrieve a FontStyle instance.
protected FontStyle	getFontStyle(byte[] data, int offset, Map<Integer,FontBase> fontBases) Retrieve font details from a block of property data.
int	getGanttBarHeight() Retrieve the height of the Gantt bars in this view.
GridLines	getGanttRowsGridLines() Retrieve a grid lines definition.
String	getGroupName() Retrieve the name of the grouping applied to this view.
boolean	getHideRollupBarsWhenSummaryExpanded() Retrieve the hide rollup bars when summary expanded.
FontStyle	getHighlightedTasksFontStyle() Retrieve a FontStyle instance.
boolean	getHighlightFilter() Retrieve the highlight filter flag.
LinkStyle	getLinkStyle() Retrieve the bar link style.
FontStyle	getMarkedTasksFontStyle() Retrieve a FontStyle instance.
GridLines	getMiddleTierColumnGridLines() Retrieve a grid lines definition.
FontStyle	getMiddleTimescaleFontStyle() Retrieve a FontStyle instance.
FontStyle	getMilestoneTasksFontStyle() Retrieve a FontStyle instance.
FontStyle	getNonCriticalTasksFontStyle() Retrieve a FontStyle instance.
Color	getNonWorkingColor() Retrieve the non-working time color.
String	getNonWorkingDaysCalendarName() Retrieve the name of the calendar used to define non-working days for this view..
ChartPattern	getNonWorkingPattern() Retrieve the non-working time pattern.
NonWorkingTimeStyle	getNonWorkingStyle() Retrieve the style used to draw non-working time.
GridLines	getPageBreakGridLines() Retrieve a grid lines definition.
boolean	getProgressLinesActualPlan() Retrieve the progress lines actual plan flag.
boolean	getProgressLinesAtCurrentDate() Retrieve the progress lines at current date flag.
boolean	getProgressLinesAtRecurringIntervals() Retrieve the progress lines at recurring intervals flag.
Date	getProgressLinesBeginAtDate() Retrieve the progress lines begin at date.
boolean	getProgressLinesBeginAtProjectStart() Retrieve the progress lines begin at project start flag.
Color	getProgressLinesCurrentLineColor() Retrieve the progress lines current line color.
LineStyle	getProgressLinesCurrentLineStyle() Retrieve the progress lines current line style.
Color	getProgressLinesCurrentProgressPointColor() Retrieve the current progress point color.
int	getProgressLinesCurrentProgressPointShape() Retrieve the current progress point shape.
int	getProgressLinesDateFormat() Retrieve the progress line date format.
boolean	getProgressLinesDisplaySelected() Retrieves the flag indicating if selected dates have been supplied for progress line display.
Date[]	getProgressLinesDisplaySelectedDates() Retrieves an array of selected dates for progress line display, or returns null if no dates have been supplied.
int	getProgressLinesDisplayType() Retrieves the progress lines display type.
boolean	getProgressLinesEnabled() Retrieves the progress lines enabled flag.
FontStyle	getProgressLinesFontStyle() Retrieves the progress lines font style.
Interval	getProgressLinesInterval() Retrieves the progress line interval.
int	getProgressLinesIntervalDailyDayNumber() Retrieve the progress lines daily day number.
boolean	getProgressLinesIntervalMonthlyDay() Retrieves the progress lines monthly day of month.
int	getProgressLinesIntervalMonthlyDayDayNumber() Retrieves the progress lines monthly day number.
int	getProgressLinesIntervalMonthlyDayMonthNumber() Retrieves the progress line month number for the monthly day type.
boolean	getProgressLinesIntervalMonthlyFirstLast() Retrieves the progress lines monthly first flag.
Day	getProgressLinesIntervalMonthlyFirstLastDay() Retrieves the progress lines monthly day.
int	getProgressLinesIntervalMonthlyFirstLastMonthNumber() Retrieves the progress lines month number for the monthly first last type.
int	getProgressLinesIntervalWeekleyWeekNumber() Retrieves the progress lines weekly week number.
boolean[]	getProgressLinesIntervalWeeklyDay() Retrieves the progress lines weekly day.
Color	getProgressLinesOtherLineColor() Retrieves the progress lines other line color.
LineStyle	getProgressLinesOtherLineStyle() Retrieves the progress lines other line style.
Color	getProgressLinesOtherProgressPointColor() Retrieves the progress lines other progress point color.
int	getProgressLinesOtherProgressPointShape() Retrieves the progress lines other progress point shape.
boolean	getProgressLinesShowDate() Retrieves the progress lines show date flag.
GridLines	getProjectFinishGridLines() Retrieve a grid lines definition.
GridLines	getProjectStartGridLines() Retrieve a grid lines definition.
FontStyle	getProjectSummaryTasksFontStyle() Retrieve a FontStyle instance.
boolean	getRoundBarsToWholeDays() Retrieve the round bars to whole days flag.
FontStyle	getRowAndColumnFontStyle() Retrieve a FontStyle instance.
GridLines	getSheetColumnsGridLines() Retrieve a grid lines definition.
GridLines	getSheetRowsGridLines() Retrieve a grid lines definition.
boolean	getShowBarSplits() Retrieve the show bar splits flag.
boolean	getShowDrawings() Retrieve the show drawings flag.
boolean	getShowInMenu() Retrieve the show in menu flag.
GridLines	getStatusDateGridLines() Retrieve a grid lines definition.
FontStyle	getSummaryTasksFontStyle() Retrieve a FontStyle instance.
TableFontStyle[]	getTableFontStyles() Retrieve any column font syles which the user has defined.
int	getTableWidth() Retrieve the width ofthe table part of the view.
TimescaleTier	getTimescaleBottomTier() Retrieves a timescale tier.
TimescaleTier	getTimescaleMiddleTier() Retrieves a timescale tier.
boolean	getTimescaleScaleSeparator() Retrieve a flag indicating if a separator is shown between the major and minor scales.
int	getTimescaleShowTiers() Retrieve the number of timescale tiers to display.
int	getTimescaleSize() Retrieve the timescale size value.
TimescaleTier	getTimescaleTopTier() Retrieves a timescale tier.
GridLines	getTitleHorizontalGridLines() Retrieve a grid lines definition.
GridLines	getTitleVerticalGridLines() Retrieve a grid lines definition.
GridLines	getTopTierColumnGridLines() Retrieve a grid lines definition.
FontStyle	getTopTimescaleFontStyle() Retrieve a FontStyle instance.
boolean	isProgressLinesIntervalDailyWorkday() Retrieve the progress lines daily workday flag.
protected int	mapGanttBarHeight(int height) This method maps the encoded height of a Gantt bar to the height in pixels.
protected abstract void	processAutoFilters(byte[] data) Extract autofilter definitions.
protected abstract void	processDefaultBarStyles(net.sf.mpxj.mpp.Props props) Extract the Gantt bar styles.
protected abstract void	processExceptionBarStyles(net.sf.mpxj.mpp.Props props) Extract the exception Gantt bar styles.
protected abstract void	processProgressLines(Map<Integer,FontBase> fontBases, byte[] data) Extract progress line properties.
protected abstract void	processTableFontStyles(Map<Integer,FontBase> fontBases, byte[] data) Extract table font styles.
protected abstract void	processViewProperties(Map<Integer,FontBase> fontBases, net.sf.mpxj.mpp.Props props) Extract view properties.
String	toString() Generate a string representation of this instance.

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

getPropertiesID

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

removeAmpersand

Methods inherited from class net.sf.mpxj.AbstractView

getID, getName, getTable, getTableName, getType

Methods inherited from class java.lang.Object

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

Field Detail

m_sheetRowsGridLines

protected GridLines m_sheetRowsGridLines

m_sheetColumnsGridLines

protected GridLines m_sheetColumnsGridLines

m_titleVerticalGridLines

protected GridLines m_titleVerticalGridLines

m_titleHorizontalGridLines

protected GridLines m_titleHorizontalGridLines

m_middleTierColumnGridLines

protected GridLines m_middleTierColumnGridLines

m_bottomTierColumnGridLines

protected GridLines m_bottomTierColumnGridLines

m_ganttRowsGridLines

protected GridLines m_ganttRowsGridLines

m_barRowsGridLines

protected GridLines m_barRowsGridLines

m_currentDateGridLines

protected GridLines m_currentDateGridLines

m_pageBreakGridLines

protected GridLines m_pageBreakGridLines

m_projectStartGridLines

protected GridLines m_projectStartGridLines

m_projectFinishGridLines

protected GridLines m_projectFinishGridLines

m_statusDateGridLines

protected GridLines m_statusDateGridLines

m_topTierColumnGridLines

protected GridLines m_topTierColumnGridLines

m_ganttBarHeight

protected int m_ganttBarHeight

m_timescaleTopTier

protected TimescaleTier m_timescaleTopTier

m_timescaleMiddleTier

protected TimescaleTier m_timescaleMiddleTier

m_timescaleBottomTier

protected TimescaleTier m_timescaleBottomTier

m_timescaleScaleSeparator

protected boolean m_timescaleScaleSeparator

m_timescaleSize

protected int m_timescaleSize

m_timescaleShowTiers

protected int m_timescaleShowTiers

m_nonWorkingDaysCalendarName

protected String m_nonWorkingDaysCalendarName

m_nonWorkingColor

protected Color m_nonWorkingColor

m_nonWorkingPattern

protected ChartPattern m_nonWorkingPattern

m_nonWorkingStyle

protected NonWorkingTimeStyle m_nonWorkingStyle

m_showDrawings

protected boolean m_showDrawings

m_roundBarsToWholeDays

protected boolean m_roundBarsToWholeDays

m_showBarSplits

protected boolean m_showBarSplits

m_alwaysRollupGanttBars

protected boolean m_alwaysRollupGanttBars

m_hideRollupBarsWhenSummaryExpanded

protected boolean m_hideRollupBarsWhenSummaryExpanded

m_barDateFormat

protected GanttBarDateFormat m_barDateFormat

m_linkStyle

protected LinkStyle m_linkStyle

m_barStyles

protected GanttBarStyle[] m_barStyles

m_barStyleExceptions

protected GanttBarStyleException[] m_barStyleExceptions

m_highlightedTasksFontStyle

protected FontStyle m_highlightedTasksFontStyle

m_rowAndColumnFontStyle

protected FontStyle m_rowAndColumnFontStyle

m_nonCriticalTasksFontStyle

protected FontStyle m_nonCriticalTasksFontStyle

m_criticalTasksFontStyle

protected FontStyle m_criticalTasksFontStyle

m_summaryTasksFontStyle

protected FontStyle m_summaryTasksFontStyle

m_milestoneTasksFontStyle

protected FontStyle m_milestoneTasksFontStyle

m_topTimescaleFontStyle

protected FontStyle m_topTimescaleFontStyle

m_middleTimescaleFontStyle

protected FontStyle m_middleTimescaleFontStyle

m_bottomTimescaleFontStyle

protected FontStyle m_bottomTimescaleFontStyle

m_barTextLeftFontStyle

protected FontStyle m_barTextLeftFontStyle

m_barTextRightFontStyle

protected FontStyle m_barTextRightFontStyle

m_barTextTopFontStyle

protected FontStyle m_barTextTopFontStyle

m_barTextBottomFontStyle

protected FontStyle m_barTextBottomFontStyle

m_barTextInsideFontStyle

protected FontStyle m_barTextInsideFontStyle

m_markedTasksFontStyle

protected FontStyle m_markedTasksFontStyle

m_projectSummaryTasksFontStyle

protected FontStyle m_projectSummaryTasksFontStyle

m_externalTasksFontStyle

protected FontStyle m_externalTasksFontStyle

m_tableFontStyles

protected TableFontStyle[] m_tableFontStyles

m_progressLinesEnabled

protected boolean m_progressLinesEnabled

m_progressLinesAtCurrentDate

protected boolean m_progressLinesAtCurrentDate

m_progressLinesAtRecurringIntervals

protected boolean m_progressLinesAtRecurringIntervals

m_progressLinesInterval

protected Interval m_progressLinesInterval

m_progressLinesIntervalDailyDayNumber

protected int m_progressLinesIntervalDailyDayNumber

m_progressLinesIntervalDailyWorkday

protected boolean m_progressLinesIntervalDailyWorkday

m_progressLinesIntervalWeeklyDay

protected boolean[] m_progressLinesIntervalWeeklyDay

m_progressLinesIntervalWeekleyWeekNumber

protected int m_progressLinesIntervalWeekleyWeekNumber

m_progressLinesIntervalMonthlyDay

protected boolean m_progressLinesIntervalMonthlyDay

m_progressLinesIntervalMonthlyDayDayNumber

protected int m_progressLinesIntervalMonthlyDayDayNumber

m_progressLinesIntervalMonthlyDayMonthNumber

protected int m_progressLinesIntervalMonthlyDayMonthNumber

m_progressLinesIntervalMonthlyFirstLastDay

protected Day m_progressLinesIntervalMonthlyFirstLastDay

m_progressLinesIntervalMonthlyFirstLast

protected boolean m_progressLinesIntervalMonthlyFirstLast

m_progressLinesIntervalMonthlyFirstLastMonthNumber

protected int m_progressLinesIntervalMonthlyFirstLastMonthNumber

m_progressLinesBeginAtProjectStart

protected boolean m_progressLinesBeginAtProjectStart

m_progressLinesBeginAtDate

protected Date m_progressLinesBeginAtDate

m_progressLinesDisplaySelected

protected boolean m_progressLinesDisplaySelected

m_progressLinesDisplaySelectedDates

protected Date[] m_progressLinesDisplaySelectedDates

m_progressLinesActualPlan

protected boolean m_progressLinesActualPlan

m_progressLinesDisplayType

protected int m_progressLinesDisplayType

m_progressLinesShowDate

protected boolean m_progressLinesShowDate

m_progressLinesDateFormat

protected int m_progressLinesDateFormat

m_progressLinesFontStyle

protected FontStyle m_progressLinesFontStyle

m_progressLinesCurrentLineColor

protected Color m_progressLinesCurrentLineColor

m_progressLinesCurrentLineStyle

protected LineStyle m_progressLinesCurrentLineStyle

m_progressLinesCurrentProgressPointColor

protected Color m_progressLinesCurrentProgressPointColor

m_progressLinesCurrentProgressPointShape

protected int m_progressLinesCurrentProgressPointShape

m_progressLinesOtherLineColor

protected Color m_progressLinesOtherLineColor

m_progressLinesOtherLineStyle

protected LineStyle m_progressLinesOtherLineStyle

m_progressLinesOtherProgressPointColor

protected Color m_progressLinesOtherProgressPointColor

m_progressLinesOtherProgressPointShape

protected int m_progressLinesOtherProgressPointShape

m_autoFilters

protected List<Filter> m_autoFilters

m_autoFiltersByType

protected Map<FieldType,Filter> m_autoFiltersByType

VIEW_PROPERTIES

protected static final Integer VIEW_PROPERTIES

TIMESCALE_PROPERTIES

protected static final Integer TIMESCALE_PROPERTIES

Method Detail

processDefaultBarStyles

protected abstract void processDefaultBarStyles(net.sf.mpxj.mpp.Props props)

Extract the Gantt bar styles.

Parameters:

props - props structure containing the style definitions

processExceptionBarStyles

protected abstract void processExceptionBarStyles(net.sf.mpxj.mpp.Props props)

Extract the exception Gantt bar styles.

Parameters:

props - props structure containing the style definitions

processAutoFilters

protected abstract void processAutoFilters(byte[] data)

Extract autofilter definitions.

Parameters:

data - autofilters data block

processViewProperties

protected abstract void processViewProperties(Map<Integer,FontBase> fontBases,
                                              net.sf.mpxj.mpp.Props props)

Extract view properties.

Parameters:

fontBases - font defintions

props - Gantt chart view props

processTableFontStyles

protected abstract void processTableFontStyles(Map<Integer,FontBase> fontBases,
                                               byte[] data)

Extract table font styles.

Parameters:

fontBases - font bases

data - column data

processProgressLines

protected abstract void processProgressLines(Map<Integer,FontBase> fontBases,
                                             byte[] data)

Extract progress line properties.

Parameters:

fontBases - font bases

data - column data

getSheetColumnsGridLines

public GridLines getSheetColumnsGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getSheetRowsGridLines

public GridLines getSheetRowsGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getStatusDateGridLines

public GridLines getStatusDateGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getTitleHorizontalGridLines

public GridLines getTitleHorizontalGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getTitleVerticalGridLines

public GridLines getTitleVerticalGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getBarRowsGridLines

public GridLines getBarRowsGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getCurrentDateGridLines

public GridLines getCurrentDateGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getGanttRowsGridLines

public GridLines getGanttRowsGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getTopTierColumnGridLines

public GridLines getTopTierColumnGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getMiddleTierColumnGridLines

public GridLines getMiddleTierColumnGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getBottomTierColumnGridLines

public GridLines getBottomTierColumnGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getNonWorkingDaysCalendarName

public String getNonWorkingDaysCalendarName()

Retrieve the name of the calendar used to define non-working days for this view..

Returns:

calendar name

getPageBreakGridLines

public GridLines getPageBreakGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getProjectFinishGridLines

public GridLines getProjectFinishGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getProjectStartGridLines

public GridLines getProjectStartGridLines()

Retrieve a grid lines definition.

Returns:

grid lines definition

getGanttBarHeight

public int getGanttBarHeight()

Retrieve the height of the Gantt bars in this view.

Returns:

Gantt bar height

getTimescaleScaleSeparator

public boolean getTimescaleScaleSeparator()

Retrieve a flag indicating if a separator is shown between the major and minor scales.

Returns:

boolean flag

getTimescaleTopTier

public TimescaleTier getTimescaleTopTier()

Retrieves a timescale tier.

Returns:

timescale tier

getTimescaleMiddleTier

public TimescaleTier getTimescaleMiddleTier()

Retrieves a timescale tier.

Returns:

timescale tier

getTimescaleBottomTier

public TimescaleTier getTimescaleBottomTier()

Retrieves a timescale tier.

Returns:

timescale tier

getTimescaleSize

public int getTimescaleSize()

Retrieve the timescale size value. This is a percentage value.

Returns:

timescale size value

getTimescaleShowTiers

public int getTimescaleShowTiers()

Retrieve the number of timescale tiers to display.

Returns:

number of timescale tiers to show

getNonWorkingColor

public Color getNonWorkingColor()

Retrieve the non-working time color.

Returns:

non-working time color

getNonWorkingPattern

public ChartPattern getNonWorkingPattern()

Retrieve the non-working time pattern. This is an integer between 0 and 10 inclusive which represents the fixed set of patterns supported by MS Project.

Returns:

non-working time pattern

getNonWorkingStyle

public NonWorkingTimeStyle getNonWorkingStyle()

Retrieve the style used to draw non-working time.

Returns:

non working time style

getAlwaysRollupGanttBars

public boolean getAlwaysRollupGanttBars()

Retrieve the always rollup Gantt bars flag.

Returns:

always rollup Gantt bars flag

getBarDateFormat

public GanttBarDateFormat getBarDateFormat()

Retrieve the bar date format.

Returns:

bar date format

getHideRollupBarsWhenSummaryExpanded

public boolean getHideRollupBarsWhenSummaryExpanded()

Retrieve the hide rollup bars when summary expanded.

Returns:

hide rollup bars when summary expanded

getLinkStyle

public LinkStyle getLinkStyle()

Retrieve the bar link style.

Returns:

bar link style

getRoundBarsToWholeDays

public boolean getRoundBarsToWholeDays()

Retrieve the round bars to whole days flag.

Returns:

round bars to whole days flag

getShowBarSplits

public boolean getShowBarSplits()

Retrieve the show bar splits flag.

Returns:

show bar splits flag

getShowDrawings

public boolean getShowDrawings()

Retrieve the show drawings flag.

Returns:

show drawings flag

getBarStyleExceptions

public GanttBarStyleException[] getBarStyleExceptions()

Retrieve an array representing bar styles which have been defined by the user for a specific task.

Returns:

array of bar style exceptions

getBarStyles

public GanttBarStyle[] getBarStyles()

Retrieve an array of bar styles which are applied to all Gantt chart bars, unless an exception has been defined.

Returns:

array of bar styles

getTableWidth

public int getTableWidth()

Retrieve the width ofthe table part of the view.

Returns:

table width

getDefaultFilterName

public String getDefaultFilterName()

Retrieve the name of the filter applied to this view.

Returns:

filter name

getDefaultFilter

public Filter getDefaultFilter()

Convenience method used to retrieve the default filter instance associated with this view.

Returns:

filter instance, null if no filter associated with view

getGroupName

public String getGroupName()

Retrieve the name of the grouping applied to this view.

Returns:

group name

getHighlightFilter

public boolean getHighlightFilter()

Retrieve the highlight filter flag.

Returns:

highlight filter flag

getShowInMenu

public boolean getShowInMenu()

Retrieve the show in menu flag.

Returns:

show in menu flag

getBarTextBottomFontStyle

public FontStyle getBarTextBottomFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getBarTextInsideFontStyle

public FontStyle getBarTextInsideFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getBarTextLeftFontStyle

public FontStyle getBarTextLeftFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getBarTextRightFontStyle

public FontStyle getBarTextRightFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getBarTextTopFontStyle

public FontStyle getBarTextTopFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getCriticalTasksFontStyle

public FontStyle getCriticalTasksFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getExternalTasksFontStyle

public FontStyle getExternalTasksFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getHighlightedTasksFontStyle

public FontStyle getHighlightedTasksFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getTopTimescaleFontStyle

public FontStyle getTopTimescaleFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getMiddleTimescaleFontStyle

public FontStyle getMiddleTimescaleFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getMarkedTasksFontStyle

public FontStyle getMarkedTasksFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getMilestoneTasksFontStyle

public FontStyle getMilestoneTasksFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getBottomTimescaleFontStyle

public FontStyle getBottomTimescaleFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getNonCriticalTasksFontStyle

public FontStyle getNonCriticalTasksFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getProjectSummaryTasksFontStyle

public FontStyle getProjectSummaryTasksFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getRowAndColumnFontStyle

public FontStyle getRowAndColumnFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getSummaryTasksFontStyle

public FontStyle getSummaryTasksFontStyle()

Retrieve a FontStyle instance.

Returns:

FontStyle instance

getTableFontStyles

public TableFontStyle[] getTableFontStyles()

Retrieve any column font syles which the user has defined.

Returns:

column font styles array

getProgressLinesActualPlan

public boolean getProgressLinesActualPlan()

Retrieve the progress lines actual plan flag.

Returns:

boolean flag

getProgressLinesAtCurrentDate

public boolean getProgressLinesAtCurrentDate()

Retrieve the progress lines at current date flag.

Returns:

boolean flag

getProgressLinesAtRecurringIntervals

public boolean getProgressLinesAtRecurringIntervals()

Retrieve the progress lines at recurring intervals flag.

Returns:

boolean flag

getProgressLinesBeginAtDate

public Date getProgressLinesBeginAtDate()

Retrieve the progress lines begin at date.

Returns:

progress lines begin at date

getProgressLinesBeginAtProjectStart

public boolean getProgressLinesBeginAtProjectStart()

Retrieve the progress lines begin at project start flag.

Returns:

boolean flag

getProgressLinesCurrentLineColor

public Color getProgressLinesCurrentLineColor()

Retrieve the progress lines current line color.

Returns:

current line color

getProgressLinesCurrentLineStyle

public LineStyle getProgressLinesCurrentLineStyle()

Retrieve the progress lines current line style.

Returns:

current line style

getProgressLinesCurrentProgressPointColor

public Color getProgressLinesCurrentProgressPointColor()

Retrieve the current progress point color.

Returns:

current progress point color

getProgressLinesCurrentProgressPointShape

public int getProgressLinesCurrentProgressPointShape()

Retrieve the current progress point shape.

Returns:

current progress point shape

getProgressLinesIntervalDailyDayNumber

public int getProgressLinesIntervalDailyDayNumber()

Retrieve the progress lines daily day number.

Returns:

progress lines daily day number

isProgressLinesIntervalDailyWorkday

public boolean isProgressLinesIntervalDailyWorkday()

Retrieve the progress lines daily workday flag.

Returns:

daily workday flag

getProgressLinesDateFormat

public int getProgressLinesDateFormat()

Retrieve the progress line date format.

Returns:

progress line date format.

getProgressLinesDisplaySelected

public boolean getProgressLinesDisplaySelected()

Retrieves the flag indicating if selected dates have been supplied for progress line display.

Returns:

boolean flag

getProgressLinesDisplaySelectedDates

public Date[] getProgressLinesDisplaySelectedDates()

Retrieves an array of selected dates for progress line display, or returns null if no dates have been supplied.

Returns:

array of selected dates

getProgressLinesDisplayType

public int getProgressLinesDisplayType()

Retrieves the progress lines display type.

Returns:

progress lines display type

getProgressLinesEnabled

public boolean getProgressLinesEnabled()

Retrieves the progress lines enabled flag.

Returns:

boolean flag

getProgressLinesFontStyle

public FontStyle getProgressLinesFontStyle()

Retrieves the progress lines font style.

Returns:

progress lines font style

getProgressLinesInterval

public Interval getProgressLinesInterval()

Retrieves the progress line interval.

Returns:

progress line interval

getProgressLinesIntervalMonthlyFirstLastDay

public Day getProgressLinesIntervalMonthlyFirstLastDay()

Retrieves the progress lines monthly day.

Returns:

progress lines monthly day

getProgressLinesIntervalMonthlyFirstLastMonthNumber

public int getProgressLinesIntervalMonthlyFirstLastMonthNumber()

Retrieves the progress lines month number for the monthly first last type.

Returns:

month number

getProgressLinesIntervalMonthlyDayDayNumber

public int getProgressLinesIntervalMonthlyDayDayNumber()

Retrieves the progress lines monthly day number.

Returns:

progress lines monthly day number

getProgressLinesIntervalMonthlyDay

public boolean getProgressLinesIntervalMonthlyDay()

Retrieves the progress lines monthly day of month.

Returns:

progress lines monthly day of month

getProgressLinesIntervalMonthlyDayMonthNumber

public int getProgressLinesIntervalMonthlyDayMonthNumber()

Retrieves the progress line month number for the monthly day type.

Returns:

month number

getProgressLinesIntervalMonthlyFirstLast

public boolean getProgressLinesIntervalMonthlyFirstLast()

Retrieves the progress lines monthly first flag.

Returns:

progress lines monthly first flag

getProgressLinesOtherLineColor

public Color getProgressLinesOtherLineColor()

Retrieves the progress lines other line color.

Returns:

progress lines other line color

getProgressLinesOtherLineStyle

public LineStyle getProgressLinesOtherLineStyle()

Retrieves the progress lines other line style.

Returns:

progress lines other line style

getProgressLinesOtherProgressPointColor

public Color getProgressLinesOtherProgressPointColor()

Retrieves the progress lines other progress point color.

Returns:

progress lines other progress point color

getProgressLinesOtherProgressPointShape

public int getProgressLinesOtherProgressPointShape()

Retrieves the progress lines other progress point shape.

Returns:

progress lines other progress point shape

getProgressLinesShowDate

public boolean getProgressLinesShowDate()

Retrieves the progress lines show date flag.

Returns:

progress lines show date flag

getProgressLinesIntervalWeekleyWeekNumber

public int getProgressLinesIntervalWeekleyWeekNumber()

Retrieves the progress lines weekly week number.

Returns:

progress lines weekly week number

getProgressLinesIntervalWeeklyDay

public boolean[] getProgressLinesIntervalWeeklyDay()

Retrieves the progress lines weekly day. Note that this is designed to be used with the constants defined by the Day class, for example use Day.MONDAY.getValue() as the index into this array for the Monday flag.

Returns:

progress lines weekly day

mapGanttBarHeight

protected int mapGanttBarHeight(int height)

This method maps the encoded height of a Gantt bar to the height in pixels.

Parameters:

height - encoded height

Returns:

height in pixels

getFontStyle

protected FontStyle getFontStyle(byte[] data,
                                 int offset,
                                 Map<Integer,FontBase> fontBases)

Retrieve font details from a block of property data.

Parameters:

data - property data

offset - offset into property data

fontBases - map of font bases

Returns:

FontStyle instance

getColumnFontStyle

protected TableFontStyle getColumnFontStyle(byte[] data,
                                            int offset,
                                            Map<Integer,FontBase> fontBases)

Retrieve column font details from a block of property data.

Parameters:

data - property data

offset - offset into property data

fontBases - map of font bases

Returns:

ColumnFontStyle instance

getAutoFilters

public List<Filter> getAutoFilters()

Retrieves a list of all auto filters associated with this view.

Returns:

list of filter instances

getAutoFilterByType

public Filter getAutoFilterByType(FieldType type)

Retrieves the auto filter definition associated with an individual column. Returns null if there is no filter defined for the supplied column type.

Parameters:

type - field type

Returns:

filter instance

toString

public String toString()

Generate a string representation of this instance.

Overrides:

toString in class AbstractView

Returns:

string representation of this instance