public abstract class SaveOptions extends Object
This is an abstract base class for classes that allow the user to specify additional options when saving a project into a particular format.
Modifier and Type | Method and Description |
---|---|
List<BarStyle> |
getBarStyles()
Returns a list of
BarStyle that appear in project view. |
boolean |
getDrawNonWorkingTime()
Gets a value indicating whether non-working time should be drawn (Default value is TRUE).
|
Date |
getEndDate()
Gets a date to finish rendering to.
|
boolean |
getFitContent()
Gets a value indicating whether row height should be increased to fit content.
|
List<Gridline> |
getGridlines()
Gets a list of
Gridline that appear in project view. |
boolean |
getLegendOnEachPage()
Gets a value indicating whether legend should be shown on each page (Default value is TRUE).
|
boolean |
getMarkCriticalTasks()
Gets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
|
Color |
getNonWorkingTimeColor()
Returns non-working time color.
|
int |
getPageCount()
Gets the number of pages of project.
|
int |
getPageSize()
Gets the size of page to be rendered (Default value is PageSize.A4).
|
int |
getPresentationFormat()
Gets the
PresentationFormat (getPresentationFormat() /setPresentationFormat(int) ) in which the document will be saved. |
boolean |
getRollUpGanttBars()
Gets a value indicating whether subtasks on the summary task bar should be marked (Default value is FALSE).
|
int |
getSaveFormat()
Gets the format in which the document will be saved if this save options object is used.
|
boolean |
getShowProjectSummaryTask()
Gets a value indicating whether project summary task if set to true.
|
Date |
getStartDate()
Gets the date to start rendering from.
|
Comparator<Task> |
getTasksComparer()
Gets the comparer to sort tasks on Gantt Chart.
|
List<TextStyle> |
getTextStyles()
Gets the list of the instances of the
TextStyle class that appear in project view. |
int |
getTimescale()
Gets the minimal time period to render.
|
TimescaleTier |
getTimescaleTier()
Gets the timescale tier of the Gantt Chart view.
|
boolean |
getUseGradientBrush()
Gets a value indicating whether gradient brush should be used when rendering Gantt Chart.
|
ProjectView |
getView()
Gets a list of the view columns to render (
GanttChartColumn ). |
void |
setBarStyles(List<BarStyle> value)
Sets a list of
BarStyle that appear in project view. |
void |
setDrawNonWorkingTime(boolean value)
Sets a value indicating whether non-working time should be drawn (Default value is TRUE).
|
void |
setEndDate(Date value)
Sets a date to finish rendering to.
|
void |
setFitContent(boolean value)
Gets or sets a value indicating whether row height should be increased to fit content.
|
void |
setGridlines(List<Gridline> value)
Sets a list of
Gridline that appear in project view. |
void |
setLegendOnEachPage(boolean value)
Sets a value indicating whether legend should be shown on each page (Default value is TRUE).
|
void |
setMarkCriticalTasks(boolean value)
Sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
|
void |
setNonWorkingTimeColor(Color value)
Sets non-working time color.
|
void |
setPageSize(int value)
Sets the size of page to be rendered (Default value is PageSize.A4).
|
void |
setPresentationFormat(int value)
Sets the
PresentationFormat (getPresentationFormat() /setPresentationFormat(int) ) in which the document will be saved. |
void |
setRollUpGanttBars(boolean value)
Sets a value indicating whether subtasks on the summary task bar should be marked (Default value is FALSE).
|
void |
setShowProjectSummaryTask(boolean value)
Sets a value indicating whether project summary task if set to true.
|
void |
setStartDate(Date value)
Sets the date to start rendering from.
|
void |
setTasksComparer(Comparator<Task> value)
Sets task comparator to sort tasks on Gantt Chart.
|
void |
setTextStyles(List<TextStyle> value)
Sets a list of text styles (
TextStyle ) that appear in project view. |
void |
setTimescale(int value)
Sets the minimal time period to render.
|
void |
setTimescaleTier(TimescaleTier value)
Sets the timescale tier of the Gantt Chart view.
|
void |
setUseGradientBrush(boolean value)
Sets a value indicating whether gradient brush should be used when rendering Gantt Chart.
|
void |
setView(ProjectView value)
Sets a list of the view columns to render (
GanttChartColumn ). |
public final List<BarStyle> getBarStyles()
BarStyle
that appear in project view.List<BarStyle>
).public final void setBarStyles(List<BarStyle> value)
BarStyle
that appear in project view.value
- list of bar styles (List<BarStyle>
).public final boolean getDrawNonWorkingTime()
Gets a value indicating whether non-working time should be drawn (Default value is TRUE).
public final void setDrawNonWorkingTime(boolean value)
Sets a value indicating whether non-working time should be drawn (Default value is TRUE).
value
- true if non-working time are to be rendered, false otherwise.public final Date getEndDate()
Gets a date to finish rendering to.
Date
).public final void setEndDate(Date value)
Sets a date to finish rendering to.
value
- the end date (Date
).public final boolean getFitContent()
Gets a value indicating whether row height should be increased to fit content.
public final void setFitContent(boolean value)
Gets or sets a value indicating whether row height should be increased to fit content.
value
- true if rows height should be increased to fit content, false otherwise.public final List<Gridline> getGridlines()
Gets a list of Gridline
that appear in project view.
Gridline
).public final void setGridlines(List<Gridline> value)
Sets a list of Gridline
that appear in project view.
value
- list of gridlines (Gridline
).public final boolean getLegendOnEachPage()
Gets a value indicating whether legend should be shown on each page (Default value is TRUE).
public final void setLegendOnEachPage(boolean value)
Sets a value indicating whether legend should be shown on each page (Default value is TRUE).
value
- true if a legend are to be rendered on each page, false otherwise.public final boolean getMarkCriticalTasks()
Gets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
public final void setMarkCriticalTasks(boolean value)
Sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
value
- true if critical tasks are to be marked, false otherwise.public final Color getNonWorkingTimeColor()
java.awt.Color
).public final void setNonWorkingTimeColor(Color value)
value
- non-working time color (java.awt.Color
).public final int getPageCount()
Gets the number of pages of project.
public final int getPageSize()
Gets the size of page to be rendered (Default value is PageSize.A4).
PageSize
).public final void setPageSize(int value)
Sets the size of page to be rendered (Default value is PageSize.A4).
value
- size of page to render (PageSize
).public final int getPresentationFormat()
Gets the PresentationFormat
(getPresentationFormat()
/setPresentationFormat(int)
) in which the document will be saved.
PresentationFormat
).public final void setPresentationFormat(int value)
Sets the PresentationFormat
(getPresentationFormat()
/setPresentationFormat(int)
) in which the document will be saved.
value
- the presentation format (PresentationFormat
).public final boolean getRollUpGanttBars()
Gets a value indicating whether subtasks on the summary task bar should be marked (Default value is FALSE).
public final void setRollUpGanttBars(boolean value)
Sets a value indicating whether subtasks on the summary task bar should be marked (Default value is FALSE).
value
- true if subtasks are to be marked on the summary task bar, false otherwise.public final int getSaveFormat()
Gets the format in which the document will be saved if this save options object is used.
SaveFileFormat
).public final boolean getShowProjectSummaryTask()
Gets a value indicating whether project summary task if set to true.
public final void setShowProjectSummaryTask(boolean value)
Sets a value indicating whether project summary task if set to true.
value
- true if project summary task needs to be rendered, false otherwise.public final Date getStartDate()
Gets the date to start rendering from.
Date
).public final void setStartDate(Date value)
Sets the date to start rendering from.
value
- the start date (Date
).public final Comparator<Task> getTasksComparer()
Gets the comparer to sort tasks on Gantt Chart.
Comparator<Task>
).public final void setTasksComparer(Comparator<Task> value)
value
- task comparator (Comparator<Task>
).public final List<TextStyle> getTextStyles()
Gets the list of the instances of the TextStyle
class that appear in project view.
List<TextStyle>
).public final void setTextStyles(List<TextStyle> value)
TextStyle
) that appear in project view.value
- list of text styles (List<TextStyle>
).public final int getTimescale()
Gets the minimal time period to render. The default value is TimescaleDays
(getTimescale()
/setTimescale(int)
).
Timescale
).public final void setTimescale(int value)
Sets the minimal time period to render. The default value is TimescaleDays
(getTimescale()
/setTimescale(int)
).
value
- timescale to render (Timescale
).public final TimescaleTier getTimescaleTier()
Gets the timescale tier of the Gantt Chart view. The default value is null.
public final void setTimescaleTier(TimescaleTier value)
value
- the timescale tier of the Gantt Chart view.public boolean getUseGradientBrush()
Gets a value indicating whether gradient brush should be used when rendering Gantt Chart.
public void setUseGradientBrush(boolean value)
Sets a value indicating whether gradient brush should be used when rendering Gantt Chart.
value
- true if gradient brush is used when rendering; otherwise, false.public final ProjectView getView()
Gets a list of the view columns to render (GanttChartColumn
).
If not set then task ids, task names, start and finish are rendered only.
ProjectView
).public final void setView(ProjectView value)
Sets a list of the view columns to render (GanttChartColumn
).
If not set then task ids, task names, start and finish are rendered only.
value
- project view (ProjectView
).Copyright (c) 2008-2018 Aspose Pty Ltd. All Rights Reserved.