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. An instance of any derived class from SaveOptions class is passed to the stream Save or string Save overloads for the user to define custom options when saving a document.
Modifier and Type | Method and Description |
---|---|
List<BarStyle> |
getBarStyles()
Returns a list of
BarStyle that appear in project view. |
boolean |
getDrawNonWorkingTime()
Draws non-working time (Default value is TRUE).
|
Date |
getEndDate()
Returns the date to finish rendering to.
|
boolean |
getFitContent()
Increases row height to fit content if set to true.
|
List<Gridline> |
getGridlines()
Returns a list of
Gridline that appear in project view. |
boolean |
getLegendOnEachPage()
Shows legend on each page (Default value is TRUE).
|
boolean |
getMarkCriticalTasks()
Display critical tasks 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()
Specifies size of page to be rendered (Default value is PageSize.A4).
|
int |
getPresentationFormat()
Specifies the
PresentationFormat in which the document will be saved. |
boolean |
getRollUpGanttBars()
Marks subtasks on the summary task bar (Default value is FALSE).
|
int |
getSaveFormat()
Specifies the format in which the document will be saved if this save options object is used.
|
boolean |
getShowProjectSummaryTask()
Renders project summary task if set to true.
|
Date |
getStartDate()
Returns the date to start rendering from.
|
Comparator<Task> |
getTasksComparer()
Returns task comparator to sort tasks on Gantt Chart.
|
List<TextStyle> |
getTextStyles()
Returns a list of text styles (
TextStyle ) that appear in project view. |
int |
getTimescale()
The minimal time period to render.
|
TimescaleTier |
getTimescaleTier()
Returns the timescale tier of the Gantt Chart view.
|
boolean |
getUseGradientBrush()
Determines whether to use gradient brush when rendering Gantt Chart.
|
ProjectView |
getView()
Stores 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)
Determines whether to render non-working time or not.
|
void |
setEndDate(Date value)
Sets the date to finish rendering to.
|
void |
setFitContent(boolean value)
Increases row height to fit content if setInternal to true, remains fixed otherwise.
|
void |
setGridlines(List<Gridline> value)
Sets a list of
Gridline that appear in project view. |
void |
setLegendOnEachPage(boolean value)
Determines whether to shows legend on each page or not (Default value is TRUE).
|
void |
setMarkCriticalTasks(boolean value)
Determines whether to display critical tasks in red color (Default value is FALSE).
|
void |
setNonWorkingTimeColor(Color value)
Sets non-working time color.
|
void |
setPageSize(int value)
Specifies size of page to be rendered (Default value is PageSize.A4).
|
void |
setPresentationFormat(int value)
Sets the presentation format in which the document will be saved.
|
void |
setRollUpGanttBars(boolean value)
Determines whether to mark subtasks on the summary task bar.
|
void |
setShowProjectSummaryTask(boolean value)
Sets whether to render project summary task or not.
|
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)
Determines whether to use gradient brush when rendering Gantt Chart.
|
void |
setView(ProjectView value)
Sets a project view to render.
|
public List<BarStyle> getBarStyles()
BarStyle
that appear in project view.List<BarStyle>
).public void setBarStyles(List<BarStyle> value)
BarStyle
that appear in project view.value
- list of bar styles (List<BarStyle>
).public boolean getDrawNonWorkingTime()
Draws non-working time (Default value is TRUE).
public void setDrawNonWorkingTime(boolean value)
value
- true if non-working time are to be rendered, false otherwise.public Date getEndDate()
Date
).public void setEndDate(Date value)
value
- the end date (Date
).public boolean getFitContent()
Increases row height to fit content if set to true.
public void setFitContent(boolean value)
value
- true if rows height should be increased to fit content, false otherwise.public List<Gridline> getGridlines()
Gridline
that appear in project view.Gridline
).public void setGridlines(List<Gridline> value)
Gridline
that appear in project view.value
- list of gridlines (Gridline
).public boolean getLegendOnEachPage()
Shows legend on each page (Default value is TRUE).
public void setLegendOnEachPage(boolean value)
value
- true if a legend are to be rendered on each page, false otherwise.public boolean getMarkCriticalTasks()
Display critical tasks in red color (Default value is FALSE).
public void setMarkCriticalTasks(boolean value)
Determines whether to display critical tasks in red color (Default value is FALSE).
value
- true if critical tasks are to be marked, false otherwise.public Color getNonWorkingTimeColor()
java.awt.Color
).public void setNonWorkingTimeColor(Color value)
value
- non-working time color (java.awt.Color
).public int getPageCount()
Gets the number of pages of project.
public int getPageSize()
Specifies size of page to be rendered (Default value is PageSize.A4).
PageSize
).public void setPageSize(int value)
value
- size of page to render (PageSize
).public int getPresentationFormat()
Specifies the PresentationFormat
in which the document will be saved.
PresentationFormat
).public void setPresentationFormat(int value)
value
- the presentation format (PresentationFormat
).public boolean getRollUpGanttBars()
Marks subtasks on the summary task bar (Default value is FALSE).
public void setRollUpGanttBars(boolean value)
value
- true if subtasks are to be marked on the summary task bar, false otherwise.public int getSaveFormat()
Specifies the format in which the document will be saved if this save options object is used.
SaveFileFormat
).public boolean getShowProjectSummaryTask()
Renders project summary task if set to true.
public void setShowProjectSummaryTask(boolean value)
value
- true if project summary task needs to be rendered, false otherwise.public Date getStartDate()
Date
).public void setStartDate(Date value)
value
- the start date (Date
).public Comparator<Task> getTasksComparer()
Returns task comparator to sort tasks on Gantt Chart.
Comparator<Task>
).public void setTasksComparer(Comparator<Task> value)
value
- task comparator (Comparator<Task>
).public List<TextStyle> getTextStyles()
TextStyle
) that appear in project view.List<TextStyle>
).public void setTextStyles(List<TextStyle> value)
TextStyle
) that appear in project view.value
- list of text styles (List<TextStyle>
).public int getTimescale()
The minimal time period to render.
The default value is TimescaleDays
.
Timescale
).public void setTimescale(int value)
value
- timescale to render (Timescale
).public TimescaleTier getTimescaleTier()
public void setTimescaleTier(TimescaleTier value)
value
- the timescale tier of the Gantt Chart view.public boolean getUseGradientBrush()
Determines whether to use gradient brush when rendering Gantt Chart.
public void setUseGradientBrush(boolean value)
value
- true if gradient brush is used when rendering; otherwise, false.public ProjectView getView()
Stores a list of the view columns to render (GanttChartColumn
).
If not setInternal then task ids, task names, start and finish are rendered only.
ProjectView
).public void setView(ProjectView value)
value
- project view (ProjectView
).Copyright (c) 2008-2018 Aspose Pty Ltd. All Rights Reserved.