Package net.sourceforge.plantuml.project

Class GanttDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.TitledDiagram

net.sourceforge.plantuml.project.GanttDiagram

All Implemented Interfaces:

Annotated, Diagram, ToTaskDraw, WithSprite

public class GanttDiagram
extends TitledDiagram
implements ToTaskDraw, WithSprite

Field Summary

Fields inherited from class net.sourceforge.plantuml.TitledDiagram

FORCE_SMETANA

Constructor Summary

Constructors

Constructor	Description
GanttDiagram()

Method Summary

Modifier and Type	Method	Description
void	addContraint(GanttConstraint constraint)
CommandExecutionResult	addNote(Display note)
void	addSeparator(java.lang.String comment)
void	affectResource(Task result, java.lang.String description)
void	closeDayAsDate(Day day)
void	closeDayOfWeek(DayOfWeek day)
void	colorDay(Day day, HColor color)
int	daysInWeek()
CommandExecutionResult	deleteTask(Task task)
protected ImageData	exportDiagramNow(java.io.OutputStream os, int index, FileFormatOption fileFormatOption, long seed)
GanttConstraint	forceTaskOrder(Task task1, Task task2)
LoadPlanable	getDefaultPlan()
DiagramDescription	getDescription()
int	getDpi(FileFormatOption fileFormatOption)
Moment	getExistingMoment(java.lang.String id)
Task	getExistingTask(java.lang.String id)
int	getHorizontalPages()
HColorSet	getIHtmlColorSet()
int	getLoadForResource(Resource res, Day i)
int	getNbImages()	Number of images in this diagram (usually, 1)
Task	getOrCreateTask(java.lang.String codeOrShortName, java.lang.String shortName, boolean linkedToPrevious)
Resource	getResource(java.lang.String resourceName)
Day	getStartingDate()
Day	getStartingDate(int nday)
TaskDraw	getTaskDraw(Task task)
Day	getThenDate()
UmlDiagramType	getUmlDiagramType()
int	getVerticalPages()
boolean	isOpen(Day day)
void	nameDay(Day day, java.lang.String name)
void	openDayAsDate(Day day)
void	setHorizontalPages(int horizontalPages)
void	setLinksColor(HColor color)
void	setPrintInterval(Day start, Day end)
void	setPrintScale(PrintScale printScale)
void	setShowFootbox(boolean footbox)
void	setStartingDate(Day start)
CommandExecutionResult	setToday(Day date)
void	setTodayColors(CenterBorderColor colors)
void	setVerticalPages(int verticalPages)

Methods inherited from class net.sourceforge.plantuml.TitledDiagram

addSprite, getCaption, getCurrentStyleBuilder, getFooter, getHeader, getLegend, getMainFrame, getPragma, getScaleCoef, getSkinParam, getTitle, isUseSmetana, loadSkin, setCaption, setLegend, setMainFrame, setParam, setTitle, setUseSmetana

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

checkFinalError, executeCommand, exportDiagram, getMetadata, getScale, getSource, getWarningOrError, hasUrl, isOk, makeDiagramReady, seed, setScale, setSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.plantuml.core.Diagram

exportDiagram, getMetadata, getSource, getWarningOrError, hasUrl

Methods inherited from interface net.sourceforge.plantuml.WithSprite

addSprite

Constructor Detail

GanttDiagram

public GanttDiagram()

Method Detail

getDescription

public DiagramDescription getDescription()

Specified by:

getDescription in interface Diagram

getUmlDiagramType

public UmlDiagramType getUmlDiagramType()

Specified by:

getUmlDiagramType in class TitledDiagram

getHorizontalPages

public final int getHorizontalPages()

setHorizontalPages

public final void setHorizontalPages(int horizontalPages)

getVerticalPages

public final int getVerticalPages()

setVerticalPages

public final void setVerticalPages(int verticalPages)

getNbImages

public int getNbImages()

Description copied from interface: Diagram

Number of images in this diagram (usually, 1)

Specified by:

getNbImages in interface Diagram

Overrides:

getNbImages in class AbstractPSystem

Returns:

usually 1

getDpi

public final int getDpi(FileFormatOption fileFormatOption)

exportDiagramNow

protected ImageData exportDiagramNow(java.io.OutputStream os,
                                     int index,
                                     FileFormatOption fileFormatOption,
                                     long seed)
                              throws java.io.IOException

Specified by:

exportDiagramNow in class AbstractPSystem

Throws:

java.io.IOException

setPrintScale

public void setPrintScale(PrintScale printScale)

closeDayOfWeek

public void closeDayOfWeek(DayOfWeek day)

closeDayAsDate

public void closeDayAsDate(Day day)

openDayAsDate

public void openDayAsDate(Day day)

getThenDate

public Day getThenDate()

getExistingTask

public Task getExistingTask(java.lang.String id)

forceTaskOrder

public GanttConstraint forceTaskOrder(Task task1,
                                      Task task2)

getOrCreateTask

public Task getOrCreateTask(java.lang.String codeOrShortName,
                            java.lang.String shortName,
                            boolean linkedToPrevious)

addSeparator

public void addSeparator(java.lang.String comment)

addContraint

public void addContraint(GanttConstraint constraint)

getIHtmlColorSet

public HColorSet getIHtmlColorSet()

setStartingDate

public void setStartingDate(Day start)

getStartingDate

public Day getStartingDate()

getStartingDate

public Day getStartingDate(int nday)

daysInWeek

public int daysInWeek()

isOpen

public boolean isOpen(Day day)

affectResource

public void affectResource(Task result,
                           java.lang.String description)

getResource

public Resource getResource(java.lang.String resourceName)

getLoadForResource

public int getLoadForResource(Resource res,
                              Day i)

getExistingMoment

public Moment getExistingMoment(java.lang.String id)

colorDay

public void colorDay(Day day,
                     HColor color)

nameDay

public void nameDay(Day day,
                    java.lang.String name)

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)

setLinksColor

public void setLinksColor(HColor color)

getTaskDraw

public TaskDraw getTaskDraw(Task task)

Specified by:

getTaskDraw in interface ToTaskDraw

addNote

public CommandExecutionResult addNote(Display note)

getDefaultPlan

public LoadPlanable getDefaultPlan()

Specified by:

getDefaultPlan in interface ToTaskDraw

setShowFootbox

public void setShowFootbox(boolean footbox)