Class GanttDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.TitledDiagram

net.sourceforge.plantuml.project.GanttDiagram

All Implemented Interfaces:

Annotated, Diagram, GanttStyle, ToTaskDraw, WarningHandler, WithSprite

public class GanttDiagram
extends TitledDiagram
implements ToTaskDraw, WithSprite, GanttStyle

Field Summary

Fields inherited from class TitledDiagram

FORCE_ELK, FORCE_SMETANA

Constructor Summary

Constructors

Constructor	Description
GanttDiagram(UmlSource source, PreprocessingArtifact preprocessing)

Method Summary

Modifier and Type	Method	Description
void	addContraint(GanttConstraint constraint)
CommandExecutionResult	addGroup(TaskCode code)
CommandExecutionResult	addNote(Display note, Stereotype stereotype)
void	addSeparator(String comment)
void	addVerticalSeparatorBefore(Day day)
boolean	affectResource(Task result, String description)
CommandExecutionResult	changeLanguage(String lang)
String	checkFinalError()
void	closeDayAsDate(Day day, String task)
void	closeDayOfWeek(DayOfWeek day, String task)
void	colorDay(DayOfWeek day, HColor color)
void	colorDay(Day day, HColor color)
int	daysInWeek()
CommandExecutionResult	deleteTask(Task task)
CommandExecutionResult	endGroup()
protected ImageData	exportDiagramNow(OutputStream os, int index, FileFormatOption fileFormatOption)
GanttConstraint	forceTaskOrder(Task task1, Task task2)
List<TaskDrawRegular>	getAllTasksForResource(Resource res)
ClockwiseTopRightBottomLeft	getDefaultMargins()
LoadPlanable	getDefaultPlan()
StyleSignatureBasic	getDefaultStyleDefinitionArrow()
DiagramDescription	getDescription()
final int	getDpi(FileFormatOption fileFormatOption)
Day	getEndingDate()
Moment	getExistingMoment(String id)
Task	getExistingTask(String id)
HColorSet	getIHtmlColorSet()
Task	getIt()
int	getLoadForResource(Resource res, Day i)
Task	getOrCreateTask(TaskCode code, boolean linkedToPrevious)
Resource	getResource(String resourceName)
Day	getStartingDate()
final Style	getStyle(SName param)
final Style	getStyle(SName param1, SName param2)
TaskDraw	getTaskDraw(Task task)
protected TextBlock	getTextMainBlock(FileFormatOption fileFormatOption)
Day	getThenDate()
final Resource	getThey()
Day	getToday()
CommandExecutionResult	hideResourceFootbox()
CommandExecutionResult	hideResourceName()
boolean	isOpen(Day day)
void	nameDay(Day day, String name)
void	openDayAsDate(Day day, String task)
void	openDayOfWeek(DayOfWeek day, String task)
void	setFactorScale(double factorScale)
void	setHideClosed(boolean hideClosed)
void	setIt(Task result)
void	setLabelStrategy(LabelStrategy strategy)
void	setPrintInterval(Day start, Day end)
void	setPrintScale(PrintScale printScale)
void	setProjectStartingDate(Day start)
void	setShowFootbox(boolean footbox)
void	setTaskDefaultCompletion(int defaultCompletion)
final void	setThey(Resource they)
CommandExecutionResult	setToday(Day date)
void	setTodayColors(CenterBorderColor colors)
void	setWeeklyHeaderStrategy(WeeklyHeaderStrategy weeklyHeaderStrategy)
void	setWeekNumberStrategy(DayOfWeek firstDayOfWeek, int minimalDaysInFirstWeek)

Methods inherited from class TitledDiagram

addSprite, addWarning, calculateBackColor, createImageBuilder, exportDiagramGraphic, getCaption, getCurrentStyleBuilder, getFooter, getHeader, getLegend, getMainFrame, getPragma, getSkinParam, getTitle, getTitleDisplay, getUmlDiagramType, getWarnings, isUseElk, isUseSmetana, loadSkin, muteColorMapper, setCaption, setLegend, setMainFrame, setParam, setTitle, setUseElk, setUseSmetana

Methods inherited from class AbstractPSystem

executeCommand, exportDiagram, getMetadata, getNamespaceSeparator, getNbImages, getPreprocessingArtifact, getRequiredPass, getScale, getSource, getSplitPagesHorizontal, getSplitPagesVertical, getWarningOrError, hasUrl, isOk, makeDiagramReady, seed, setNamespaceSeparator, setScale, setSplitPagesHorizontal, setSplitPagesVertical, startingPass

Methods inherited from class Object

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

Methods inherited from interface Diagram

exportDiagram, exportDiagramGraphic, getMetadata, getNbImages, getSource, getSplitPagesHorizontal, getSplitPagesVertical, getTitleDisplay, getWarningOrError, hasUrl

Methods inherited from interface WithSprite

addSprite

Constructor Details

GanttDiagram

public GanttDiagram(UmlSource source,
 PreprocessingArtifact preprocessing)

Method Details

changeLanguage

public CommandExecutionResult changeLanguage(String lang)

getDescription

public DiagramDescription getDescription()

Specified by:

getDescription in interface Diagram

setWeekNumberStrategy

public void setWeekNumberStrategy(DayOfWeek firstDayOfWeek,
 int minimalDaysInFirstWeek)

getDpi

public final int getDpi(FileFormatOption fileFormatOption)

exportDiagramNow

protected ImageData exportDiagramNow(OutputStream os,
 int index,
 FileFormatOption fileFormatOption)
                              throws IOException

Specified by:

exportDiagramNow in class AbstractPSystem

Throws:

IOException

setPrintScale

public void setPrintScale(PrintScale printScale)

setFactorScale

public void setFactorScale(double factorScale)

checkFinalError

public String checkFinalError()

Overrides:

checkFinalError in class AbstractPSystem

getTextMainBlock

protected TextBlock getTextMainBlock(FileFormatOption fileFormatOption)

Specified by:

getTextMainBlock in class TitledDiagram

getStyle

public final Style getStyle(SName param)

Specified by:

getStyle in interface GanttStyle

getStyle

public final Style getStyle(SName param1,
 SName param2)

Specified by:

getStyle in interface GanttStyle

getDefaultStyleDefinitionArrow

public StyleSignatureBasic getDefaultStyleDefinitionArrow()

closeDayOfWeek

public void closeDayOfWeek(DayOfWeek day,
 String task)

openDayOfWeek

public void openDayOfWeek(DayOfWeek day,
 String task)

closeDayAsDate

public void closeDayAsDate(Day day,
 String task)

openDayAsDate

public void openDayAsDate(Day day,
 String task)

getThenDate

public Day getThenDate()

getExistingTask

public Task getExistingTask(String id)

forceTaskOrder

public GanttConstraint forceTaskOrder(Task task1,
 Task task2)

getOrCreateTask

public Task getOrCreateTask(TaskCode code,
 boolean linkedToPrevious)

addSeparator

public void addSeparator(String comment)

addGroup

public CommandExecutionResult addGroup(TaskCode code)

endGroup

public CommandExecutionResult endGroup()

addContraint

public void addContraint(GanttConstraint constraint)

getIHtmlColorSet

public HColorSet getIHtmlColorSet()

Specified by:

getIHtmlColorSet in interface ToTaskDraw

setProjectStartingDate

public void setProjectStartingDate(Day start)

getStartingDate

public Day getStartingDate()

getEndingDate

public Day getEndingDate()

daysInWeek

public int daysInWeek()

isOpen

public boolean isOpen(Day day)

affectResource

public boolean affectResource(Task result,
 String description)

getResource

public Resource getResource(String resourceName)

getLoadForResource

public int getLoadForResource(Resource res,
 Day i)

getExistingMoment

public Moment getExistingMoment(String id)

colorDay

public void colorDay(Day day,
 HColor color)

colorDay

public void colorDay(DayOfWeek day,
 HColor color)

nameDay

public void nameDay(Day day,
 String name)

getToday

public Day getToday()

setTodayColors

public void setTodayColors(CenterBorderColor colors)

setToday

public CommandExecutionResult setToday(Day date)

deleteTask

public CommandExecutionResult deleteTask(Task task)

setPrintInterval

public void setPrintInterval(Day start,
 Day end)

getTaskDraw

public TaskDraw getTaskDraw(Task task)

Specified by:

getTaskDraw in interface ToTaskDraw

addNote

public CommandExecutionResult addNote(Display note,
 Stereotype stereotype)

getDefaultPlan

public LoadPlanable getDefaultPlan()

Specified by:

getDefaultPlan in interface ToTaskDraw

setShowFootbox

public void setShowFootbox(boolean footbox)

getDefaultMargins

public ClockwiseTopRightBottomLeft getDefaultMargins()

Overrides:

getDefaultMargins in class TitledDiagram

setLabelStrategy

public void setLabelStrategy(LabelStrategy strategy)

setWeeklyHeaderStrategy

public void setWeeklyHeaderStrategy(WeeklyHeaderStrategy weeklyHeaderStrategy)

hideResourceName

public CommandExecutionResult hideResourceName()

hideResourceFootbox

public CommandExecutionResult hideResourceFootbox()

addVerticalSeparatorBefore

public void addVerticalSeparatorBefore(Day day)

setTaskDefaultCompletion

public void setTaskDefaultCompletion(int defaultCompletion)

getAllTasksForResource

public List<TaskDrawRegular> getAllTasksForResource(Resource res)

setIt

public void setIt(Task result)

getIt

public Task getIt()

getThey

public final Resource getThey()

setThey

public final void setThey(Resource they)

setHideClosed

public void setHideClosed(boolean hideClosed)