net.sourceforge.plantuml

Class TitledDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.TitledDiagram

All Implemented Interfaces:

Annotated, Diagram

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 and Description
static boolean	FORCE_ELK
static boolean	FORCE_SMETANA

Constructor Summary

Constructors

Constructor and Description
TitledDiagram(UmlSource source, UmlDiagramType type, java.util.Map<java.lang.String,java.lang.String> orig)

Method Summary

Modifier and Type	Method and Description
void	addSprite(java.lang.String name, Sprite sprite)
HColor	calculateBackColor()
ImageBuilder	createImageBuilder(FileFormatOption fileFormatOption)
void	exportDiagramGraphic(UGraphic ug, FileFormatOption fileFormatOption)
DisplayPositioned	getCaption()
StyleBuilder	getCurrentStyleBuilder()
ClockwiseTopRightBottomLeft	getDefaultMargins()
DisplaySection	getFooter()
DisplaySection	getHeader()
DisplayPositioned	getLegend()
Display	getMainFrame()
Pragma	getPragma()
ISkinParam	getSkinParam()
protected abstract TextBlock	getTextMainBlock(FileFormatOption fileFormatOption)
DisplayPositionned	getTitle()
Display	getTitleDisplay()
UmlDiagramType	getUmlDiagramType()
boolean	isUseElk()
boolean	isUseSmetana()
CommandExecutionResult	loadSkin(java.lang.String newSkin)
protected ColorMapper	muteColorMapper(ColorMapper init)
void	setCaption(DisplayPositioned caption)
void	setLegend(DisplayPositioned legend)
void	setMainFrame(Display mainFrame)
void	setParam(java.lang.String key, java.lang.String value)
void	setTitle(DisplayPositioned title)
void	setUseElk(boolean useElk)
void	setUseSmetana(boolean useSmetana)

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

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

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

Field Detail

FORCE_SMETANA

public static boolean FORCE_SMETANA

FORCE_ELK

public static boolean FORCE_ELK

Constructor Detail

TitledDiagram

public TitledDiagram(UmlSource source,
                     UmlDiagramType type,
                     java.util.Map<java.lang.String,java.lang.String> orig)

Method Detail

getPragma

public Pragma getPragma()

getCurrentStyleBuilder

public final StyleBuilder getCurrentStyleBuilder()

getUmlDiagramType

public final UmlDiagramType getUmlDiagramType()

getSkinParam

public final ISkinParam getSkinParam()

setParam

public void setParam(java.lang.String key,
                     java.lang.String value)

addSprite

public void addSprite(java.lang.String name,
                      Sprite sprite)

loadSkin

public CommandExecutionResult loadSkin(java.lang.String newSkin)
                                throws java.io.IOException

Throws:

java.io.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(Display mainFrame)

setCaption

public final void setCaption(DisplayPositioned caption)

getCaption

public final DisplayPositioned getCaption()

Specified by:

getCaption in interface Annotated

getHeader

public final DisplaySection getHeader()

Specified by:

getHeader in interface Annotated

getFooter

public final DisplaySection getFooter()

Specified by:

getFooter in interface Annotated

getLegend

public final DisplayPositioned getLegend()

Specified by:

getLegend in interface Annotated

setLegend

public void setLegend(DisplayPositioned legend)

getMainFrame

public final Display 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 java.io.IOException

Overrides:

createImageBuilder in class AbstractPSystem

Throws:

java.io.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