Package net.sourceforge.plantuml

Class TitledDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.TitledDiagram

All Implemented Interfaces:

Annotated, Diagram

Direct Known Subclasses:

GanttDiagram, PSystemSalt, UmlDiagram

public abstract class TitledDiagram
extends AbstractPSystem
implements Diagram, Annotated

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	FORCE_SMETANA

Constructor Summary

Constructors

Constructor	Description
TitledDiagram(UmlDiagramType type)
TitledDiagram(UmlDiagramType type, ISkinSimple orig)

Method Summary

Modifier and Type	Method	Description
void	addSprite(java.lang.String name, Sprite sprite)
DisplayPositionned	getCaption()
StyleBuilder	getCurrentStyleBuilder()
DisplaySection	getFooter()
DisplaySection	getHeader()
DisplayPositionned	getLegend()
Display	getMainFrame()
Pragma	getPragma()
double	getScaleCoef(FileFormatOption fileFormatOption)
ISkinParam	getSkinParam()
DisplayPositionned	getTitle()
UmlDiagramType	getUmlDiagramType()
boolean	isUseSmetana()
CommandExecutionResult	loadSkin(java.lang.String newSkin)
void	setCaption(DisplayPositionned caption)
void	setLegend(DisplayPositionned legend)
void	setMainFrame(Display mainFrame)
void	setParam(java.lang.String key, java.lang.String value)
void	setTitle(DisplayPositionned title)
void	setUseSmetana(boolean useSmetana)

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

checkFinalError, executeCommand, exportDiagram, exportDiagramNow, getMetadata, getNbImages, 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, getDescription, getMetadata, getNbImages, getSource, getWarningOrError, hasUrl

Field Detail

FORCE_SMETANA

public static final boolean FORCE_SMETANA

See Also:

Constant Field Values

Constructor Detail

TitledDiagram

public TitledDiagram(UmlDiagramType type)

TitledDiagram

public TitledDiagram(UmlDiagramType type,
                     ISkinSimple 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(DisplayPositionned title)

getTitle

public final DisplayPositionned getTitle()

Specified by:

getTitle in interface Annotated

Overrides:

getTitle in class AbstractPSystem

setMainFrame

public final void setMainFrame(Display mainFrame)

setCaption

public final void setCaption(DisplayPositionned caption)

getCaption

public final DisplayPositionned 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 DisplayPositionned getLegend()

Specified by:

getLegend in interface Annotated

setLegend

public void setLegend(DisplayPositionned legend)

getMainFrame

public final Display getMainFrame()

Specified by:

getMainFrame in interface Annotated

setUseSmetana

public void setUseSmetana(boolean useSmetana)

isUseSmetana

public boolean isUseSmetana()

getScaleCoef

public final double getScaleCoef(FileFormatOption fileFormatOption)