Package net.sourceforge.plantuml

Class TitledDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.TitledDiagram

All Implemented Interfaces:

Annotated, Diagram, WarningHandler

Direct Known Subclasses:

ChronologyDiagram, GanttDiagram, JsonDiagram, PSystemEbnf, PSystemRegex, PSystemSalt, UmlDiagram

public abstract class TitledDiagram
extends AbstractPSystem
implements Diagram, Annotated

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	FORCE_ELK
static boolean	FORCE_SMETANA

Constructor Summary

Constructors

Constructor	Description
TitledDiagram(UmlSource source, UmlDiagramType type, Previous previous, PreprocessingArtifact preprocessing)

Method Summary

Modifier and Type	Method	Description
void	addSprite(String name, Sprite sprite)
void	addWarning(Warning warning)
HColor	calculateBackColor()
ImageBuilder	createImageBuilder(FileFormatOption fileFormatOption)
void	exportDiagramGraphic(UGraphic ug, FileFormatOption fileFormatOption)
final DisplayPositioned	getCaption()
final StyleBuilder	getCurrentStyleBuilder()
ClockwiseTopRightBottomLeft	getDefaultMargins()
String	getFlashData()
final DisplayPositioned	getFooter()
final DisplayPositioned	getHeader()
final DisplayPositioned	getLegend()
final DisplayPositioned	getMainFrame()
final Pragma	getPragma()
final ISkinParam	getSkinParam()
protected abstract TextBlock	getTextMainBlock(FileFormatOption fileFormatOption)
final DisplayPositionned	getTitle()
final Display	getTitleDisplay()
final UmlDiagramType	getUmlDiagramType()
Collection<Warning>	getWarnings()
boolean	isSkinParamUsed()
boolean	isUseElk()
boolean	isUseSmetana()
CommandExecutionResult	loadSkin(String newSkin)
protected ColorMapper	muteColorMapper(ColorMapper init)
final void	setCaption(DisplayPositioned caption)
void	setLegend(DisplayPositioned legend)
final void	setMainFrame(DisplayPositioned mainFrame)
void	setParam(String key, String value)
void	setSkinParamUsed(boolean skinParamUsed)
final void	setTitle(DisplayPositioned title)
void	setUseElk(boolean useElk)
void	setUseSmetana(boolean useSmetana)
void	updateFooter(LineLocation location, Display display, HorizontalAlignment horizontalAlignment)
void	updateHeader(LineLocation location, Display display, HorizontalAlignment horizontalAlignment)

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

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

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, getDescription, getInstallationRequirement, getMetadata, getNbImages, getSource, getSplitPagesHorizontal, getSplitPagesVertical, getWarningOrError, hasUrl

Field Details

FORCE_SMETANA

public static boolean FORCE_SMETANA

FORCE_ELK

public static boolean FORCE_ELK

Constructor Details

TitledDiagram

public TitledDiagram(UmlSource source,
 UmlDiagramType type,
 Previous previous,
 PreprocessingArtifact preprocessing)

Method Details

getCurrentStyleBuilder

public final StyleBuilder getCurrentStyleBuilder()

getUmlDiagramType

public final UmlDiagramType getUmlDiagramType()

getSkinParam

public final ISkinParam getSkinParam()

isSkinParamUsed

public boolean isSkinParamUsed()

setSkinParamUsed

public void setSkinParamUsed(boolean skinParamUsed)

setParam

public void setParam(String key,
 String value)

addSprite

public void addSprite(String name,
 Sprite sprite)

loadSkin

public CommandExecutionResult loadSkin(String newSkin)
                                throws IOException

Throws:

IOException

setTitle

public final void setTitle(DisplayPositioned title)

getTitle

public final DisplayPositionned getTitle()

Specified by:

getTitle in interface Annotated

Overrides:

getTitle in class AbstractPSystem

getTitleDisplay

public final Display getTitleDisplay()

Specified by:

getTitleDisplay in interface Diagram

Overrides:

getTitleDisplay in class AbstractPSystem

setMainFrame

public final void setMainFrame(DisplayPositioned mainFrame)

setCaption

public final void setCaption(DisplayPositioned caption)

getCaption

public final DisplayPositioned getCaption()

Specified by:

getCaption in interface Annotated

getHeader

public final DisplayPositioned getHeader()

Specified by:

getHeader in interface Annotated

getFooter

public final DisplayPositioned getFooter()

Specified by:

getFooter in interface Annotated

updateFooter

public void updateFooter(LineLocation location,
 Display display,
 HorizontalAlignment horizontalAlignment)

updateHeader

public void updateHeader(LineLocation location,
 Display display,
 HorizontalAlignment horizontalAlignment)

getLegend

public final DisplayPositioned getLegend()

Specified by:

getLegend in interface Annotated

setLegend

public void setLegend(DisplayPositioned legend)

getMainFrame

public final DisplayPositioned getMainFrame()

Specified by:

getMainFrame in interface Annotated

setUseSmetana

public void setUseSmetana(boolean useSmetana)

setUseElk

public void setUseElk(boolean useElk)

isUseElk

public boolean isUseElk()

isUseSmetana

public boolean isUseSmetana()

getDefaultMargins

public ClockwiseTopRightBottomLeft getDefaultMargins()

Overrides:

getDefaultMargins in class AbstractPSystem

createImageBuilder

public ImageBuilder createImageBuilder(FileFormatOption fileFormatOption)
                                throws IOException

Overrides:

createImageBuilder in class AbstractPSystem

Throws:

IOException

calculateBackColor

public HColor calculateBackColor()

muteColorMapper

protected ColorMapper muteColorMapper(ColorMapper init)

Overrides:

muteColorMapper in class AbstractPSystem

getTextMainBlock

protected abstract TextBlock getTextMainBlock(FileFormatOption fileFormatOption)

exportDiagramGraphic

public void exportDiagramGraphic(UGraphic ug,
 FileFormatOption fileFormatOption)

Specified by:

exportDiagramGraphic in interface Diagram

Overrides:

exportDiagramGraphic in class AbstractPSystem

getPragma

public final Pragma getPragma()

addWarning

public void addWarning(Warning warning)

Specified by:

addWarning in interface WarningHandler

Overrides:

addWarning in class AbstractPSystem

getWarnings

public Collection<Warning> getWarnings()

Specified by:

getWarnings in interface WarningHandler

Overrides:

getWarnings in class AbstractPSystem

getFlashData

public String getFlashData()