Package net.sourceforge.plantuml.gantt

Class GanttDiagram

java.lang.Object

net.sourceforge.plantuml.core.AbstractDiagram

net.sourceforge.plantuml.UgDiagram

net.sourceforge.plantuml.TitledDiagram

net.sourceforge.plantuml.gantt.GanttDiagram

All Implemented Interfaces:

Annotated, Diagram, GanttStyle, WarningHandler, WithSprite

public class GanttDiagram
extends TitledDiagram
implements GanttStyle

Field Summary

Fields inherited from class net.sourceforge.plantuml.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(LocalDate day)
CommandExecutionResult	addWorkingTimeRange(TimeRange timeRange)
boolean	affectResource(Task result, String description)
CommandExecutionResult	changeLanguage(String lang)
String	checkFinalError()
void	closeDayAsDate(LocalDate day, String task)
void	closeDayOfWeek(DayOfWeek day, String task)
void	colorDay(DayOfWeek day, HColor color)
void	colorDay(LocalDate day, HColor color)
int	daysInMonth()
int	daysInWeek()
CommandExecutionResult	deleteTask(Task task)
Duration	durationOfDays(int totalDays)
Duration	durationOfDaysAndHours(int totalDays, int totalHours)
CommandExecutionResult	endGroup()
GanttConstraint	forceTaskOrder(Task task1, Task task2)
List<TaskDrawRegular>	getAllTasksForResource(Resource res)
ClockwiseTopRightBottomLeft	getDefaultMargins()
PiecewiseConstant	getDefaultPlan()
StyleSignatureBasic	getDefaultStyleDefinitionArrow()
DiagramDescription	getDescription()
final int	getDpi(FileFormatOption fileFormatOption)
Moment	getExistingMoment(String id)
Task	getExistingTask(String id)
HColorSet	getIHtmlColorSet()
Task	getIt()
PiecewiseConstant	getLoadPlanableForTask(String taskId)
LocalDate	getMaxDay()
TimePoint	getMaxTimePoint()
LocalDate	getMinDay()
TimePoint	getMinTimePoint()
Task	getOrCreateTask(TaskCode code, boolean linkedToPrevious)
Resource	getResource(String resourceName)
final Style	getStyle(SName param)
final Style	getStyle(SName param1, SName param2)
TextBlock	getTextBlock(int num, FileFormatOption fileFormatOption)
TimePoint	getThenDate()
final Resource	getThey()
LocalDate	getToday()
CommandExecutionResult	hideResourceFootbox()
CommandExecutionResult	hideResourceName()
boolean	isOpen(LocalDate day)
void	nameDay(LocalDate day, String name)
void	openDayAsDate(LocalDate 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(LocalDate start, LocalDate end)
void	setPrintScale(PrintScale printScale)
void	setShowFootbox(boolean footbox)
void	setTaskDefaultCompletion(int defaultCompletion)
final void	setThey(Resource they)
CommandExecutionResult	setToday(LocalDate date)
void	setTodayColors(CenterBorderColor colors)
void	setWeeklyHeaderStrategy(WeeklyHeaderStrategy weeklyHeaderStrategy, int weekStartingNumber)
void	setWeekNumberStrategy(DayOfWeek firstDayOfWeek, int minimalDaysInFirstWeek)
CommandExecutionResult	updateStartingPoint(LocalDate start)

Methods inherited from class net.sourceforge.plantuml.TitledDiagram

addChrome, addSprite, addWarning, calculateBackColor, exportCmap, getCaption, getCurrentStyleBuilder, getDiagramType, getFooter, getFooterOrHeaderTeoz, getHeader, getLegend, getMainFrame, getNamespaceSeparator, getPragma, getPrevious, getSkinParam, getTitle, getTitleDisplay, getWarningOrError, getWarnings, isHandwritten, isSkinParamUsed, isUseElk, isUseSmetana, loadSkin, muteColorMapper, setCaption, setHideEmptyDescription, setLegend, setMainFrame, setNamespaceSeparator, setParam, setSkinParamUsed, setTitle, setUseElk, setUseSmetana, updateFooter, updateHeader

Methods inherited from class net.sourceforge.plantuml.UgDiagram

exportDiagram, getExporter

Methods inherited from class net.sourceforge.plantuml.core.AbstractDiagram

executeCommand, explain, exportGraphml, exportScxml, exportTxt, exportXmi, getFlashData, getInstallationRequirement, getMd5map, getMetadata, getNbImages, getPathSystem, getPreprocessingArtifact, getRequiredPass, getRootCause, getScale, getSource, getSplitPagesHorizontal, getSplitPagesVertical, hasUrl, isIncomplete, makeDiagramReady, seed, setScale, setSplitPagesHorizontal, setSplitPagesVertical, startingPass

Methods inherited from class java.lang.Object

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

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)

setPrintScale

public void setPrintScale(PrintScale printScale)

setFactorScale

public void setFactorScale(double factorScale)

checkFinalError

public String checkFinalError()

Specified by:

checkFinalError in interface Diagram

Overrides:

checkFinalError in class AbstractDiagram

getTextBlock

public TextBlock getTextBlock(int num,
 FileFormatOption fileFormatOption)

Specified by:

getTextBlock in class UgDiagram

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(LocalDate day,
 String task)

openDayAsDate

public void openDayAsDate(LocalDate day,
 String task)

getThenDate

public TimePoint getThenDate()

getExistingTask

public Task getExistingTask(String id)

forceTaskOrder

public GanttConstraint forceTaskOrder(Task task1,
 Task task2)

getOrCreateTask

public Task getOrCreateTask(TaskCode code,
 boolean linkedToPrevious)

getLoadPlanableForTask

public PiecewiseConstant getLoadPlanableForTask(String taskId)

addSeparator

public void addSeparator(String comment)

addGroup

public CommandExecutionResult addGroup(TaskCode code)

endGroup

public CommandExecutionResult endGroup()

addContraint

public void addContraint(GanttConstraint constraint)

updateStartingPoint

public CommandExecutionResult updateStartingPoint(LocalDate start)

getMinDay

public LocalDate getMinDay()

getMaxDay

public LocalDate getMaxDay()

getMinTimePoint

public TimePoint getMinTimePoint()

getMaxTimePoint

public TimePoint getMaxTimePoint()

daysInWeek

public int daysInWeek()

daysInMonth

public int daysInMonth()

isOpen

public boolean isOpen(LocalDate day)

affectResource

public boolean affectResource(Task result,
 String description)

getResource

public Resource getResource(String resourceName)

getExistingMoment

public Moment getExistingMoment(String id)

colorDay

public void colorDay(LocalDate day,
 HColor color)

colorDay

public void colorDay(DayOfWeek day,
 HColor color)

nameDay

public void nameDay(LocalDate day,
 String name)

getToday

public LocalDate getToday()

setTodayColors

public void setTodayColors(CenterBorderColor colors)

setToday

public CommandExecutionResult setToday(LocalDate date)

deleteTask

public CommandExecutionResult deleteTask(Task task)

setPrintInterval

public void setPrintInterval(LocalDate start,
 LocalDate end)

addNote

public CommandExecutionResult addNote(Display note,
 Stereotype stereotype)

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,
 int weekStartingNumber)

hideResourceName

public CommandExecutionResult hideResourceName()

hideResourceFootbox

public CommandExecutionResult hideResourceFootbox()

addVerticalSeparatorBefore

public void addVerticalSeparatorBefore(LocalDate 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)

getDefaultPlan

public PiecewiseConstant getDefaultPlan()

getIHtmlColorSet

public HColorSet getIHtmlColorSet()

addWorkingTimeRange

public CommandExecutionResult addWorkingTimeRange(TimeRange timeRange)

durationOfDays

public Duration durationOfDays(int totalDays)

durationOfDaysAndHours

public Duration durationOfDaysAndHours(int totalDays,
 int totalHours)