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()
Gets the list of the instances of the
BarStyle class 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 its 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()
Gets the 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.
|
int |
getSaveFormat()
Gets the format in which the document will be saved if this save options object is used.
|
Date |
getStartDate()
Gets the date to start rendering from.
|
Comparator<Task> |
getTasksComparer()
Gets the comparer to sort tasks on Gantt chart and Task Sheet chart.
|
ICondition<Task> |
getTasksFilter()
Gets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
|
List<TextStyle> |
getTextStyles()
Gets the list of the instances of the
TextStyle class that appear in project view. |
int |
getTimescale()
Gets the
Timescale (getTimescale() /setTimescale(int) ) value which is used to control how
timescale (if present) is rendered when project is saved to graphical format. |
TimescaleTier |
getTimescaleTier()
Deprecated.
This property is not used anymore and will be removed in version 20.12. Use view's timescale settings
(*TimescaleTier properties) or SaveOptions.Timescale property to control rendering of timescale tiers.
|
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 the list of the instances of the
BarStyle class 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)
Sets a value indicating whether row height should be increased to fit its 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 the 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.
|
void |
setStartDate(Date value)
Sets the date to start rendering from.
|
void |
setTasksComparer(Comparator<Task> value)
Sets the comparer to sort tasks on Gantt chart and Task Sheet chart.
|
void |
setTasksFilter(ICondition<Task> value)
Sets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
|
void |
setTextStyles(List<TextStyle> value)
Sets the list of the instances of the
TextStyle class that appear in project view. |
void |
setTimescale(int value)
Sets the
Timescale (getTimescale() /setTimescale(int) ) value which is used to control how
timescale (if present) is rendered when project is saved to graphical format. |
void |
setTimescaleTier(TimescaleTier value)
Deprecated.
This property is not used anymore and will be removed in version 20.12. Use view's timescale settings
(*TimescaleTier properties) or SaveOptions.Timescale property to control rendering of timescale tiers.
|
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()
Gets the list of the instances of the BarStyle
class that appear in project view.
BarStyle
class that appear in project view.public final void setBarStyles(List<BarStyle> value)
Sets the list of the instances of the BarStyle
class that appear in project view.
value
- the list of the instances of the BarStyle
class that appear in project view.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
- a value indicating whether non-working time should be drawn (Default value is TRUE).public final Date getEndDate()
Gets a date to finish rendering to.
public final void setEndDate(Date value)
Sets a date to finish rendering to.
value
- a date to finish rendering to.public final boolean getFitContent()
Gets a value indicating whether row height should be increased to fit its content.
public final void setFitContent(boolean value)
Sets a value indicating whether row height should be increased to fit its content.
value
- a value indicating whether row height should be increased to fit its content.public final List<Gridline> getGridlines()
Gets a list of Gridline
that appear in project view.
Gridline
that appear in project view.public final void setGridlines(List<Gridline> value)
Sets a list of Gridline
that appear in project view.
value
- a list of Gridline
that appear in project view.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
- a value indicating whether legend should be shown on each page (Default value is TRUE).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
- a value indicating whether critical tasks should be displayed in red color (Default value is
FALSE).public final Color getNonWorkingTimeColor()
Gets the non-working time color.
public final void setNonWorkingTimeColor(Color value)
Sets the non-working time color.
value
- the non-working time 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).
public final void setPageSize(int value)
Sets the size of page to be rendered (Default value is PageSize.A4).
value
- the size of page to be rendered (Default value is PageSize.public final int getPresentationFormat()
Gets the PresentationFormat
(getPresentationFormat()
/setPresentationFormat(int)
) in which
the document will be saved.
PresentationFormat
(getPresentationFormat()
/setPresentationFormat(int)
) in
which the document will be saved.public final void setPresentationFormat(int value)
Sets the PresentationFormat
(getPresentationFormat()
/setPresentationFormat(int)
) in which
the document will be saved.
value
- the PresentationFormat
(getPresentationFormat()
/setPresentationFormat(int)
) in which the document will be saved.public final boolean getRollUpGanttBars()
Gets a value indicating whether subtasks on the summary task bar should be marked. For subtasks, the Rollup field indicates whether information on the subtask Gantt bars will be rolled up to the summary task bar. For summary tasks, the Rollup field indicates whether the summary task bar displays rolled up bars. You must have the Rollup field for summary tasks set to Yes for any subtasks to roll up to them.
public final void setRollUpGanttBars(boolean value)
Sets a value indicating whether subtasks on the summary task bar should be marked. For subtasks, the Rollup field indicates whether information on the subtask Gantt bars will be rolled up to the summary task bar. For summary tasks, the Rollup field indicates whether the summary task bar displays rolled up bars. You must have the Rollup field for summary tasks set to Yes for any subtasks to roll up to them.
value
- a value indicating whether subtasks on the summary task bar should be marked.public final int getSaveFormat()
Gets the format in which the document will be saved if this save options object is used.
public final Date getStartDate()
Gets the date to start rendering from.
public final void setStartDate(Date value)
Sets the date to start rendering from.
value
- the date to start rendering from.public final Comparator<Task> getTasksComparer()
Gets the comparer to sort tasks on Gantt chart and Task Sheet chart.
public final void setTasksComparer(Comparator<Task> value)
Sets the comparer to sort tasks on Gantt chart and Task Sheet chart.
value
- the comparer to sort tasks on Gantt chart and Task Sheet chart.public final ICondition<Task> getTasksFilter()
Gets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
public final void setTasksFilter(ICondition<Task> value)
Sets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
value
- the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage
charts.public final List<TextStyle> getTextStyles()
Gets the list of the instances of the TextStyle
class that appear in project view.
TextStyle
class that appear in project view.public final void setTextStyles(List<TextStyle> value)
Sets the list of the instances of the TextStyle
class that appear in project view.
value
- the list of the instances of the TextStyle
class that appear in project view.public final int getTimescale()
Gets the Timescale
(getTimescale()
/setTimescale(int)
) value which is used to control how
timescale (if present) is rendered when project is saved to graphical format.
Timescale
(getTimescale()
/setTimescale(int)
) value which is used to control
how timescale (if present) is rendered when project is saved to graphical format.public final void setTimescale(int value)
Sets the Timescale
(getTimescale()
/setTimescale(int)
) value which is used to control how
timescale (if present) is rendered when project is saved to graphical format.
value
- the Timescale
(getTimescale()
/setTimescale(int)
) value which is used
to control how timescale (if present) is rendered when project is saved to graphical format.@Deprecated public final TimescaleTier getTimescaleTier()
Gets the timescale tier of the Gantt Chart view. The default value is null.
@Deprecated public final void setTimescaleTier(TimescaleTier value)
Sets the timescale tier of the Gantt Chart view. The default value is null.
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
- a value indicating whether gradient brush should be used when rendering Gantt Chart.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.
GanttChartColumn
).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
- a list of the view columns to render (GanttChartColumn
).