Package net.sourceforge.plantuml

Class UmlDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.TitledDiagram

net.sourceforge.plantuml.UmlDiagram

All Implemented Interfaces:

Annotated, Diagram, WarningHandler, WithSprite

Direct Known Subclasses:

ActivityDiagram3, BoardDiagram, BpmDiagram, CucaDiagram, FilesDiagram, FlowDiagram, GitDiagram, Help, ListSpriteDiagram, MindMapDiagram, NwDiagram, SequenceDiagram, StdlibDiagram, TimingDiagram, WBSDiagram, WireDiagram

public abstract class UmlDiagram
extends TitledDiagram
implements Diagram, Annotated, WithSprite

Field Summary

Fields inherited from class net.sourceforge.plantuml.TitledDiagram

FORCE_ELK, FORCE_SMETANA

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected final void	exportCmap(SuggestedFile suggestedFile, int index, ImageData cmapdata)
protected abstract ImageData	exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
protected final ImageData	exportDiagramNow(OutputStream os, int index, FileFormatOption fileFormatOption)
final DisplayPositioned	getFooterOrHeaderTeoz(FontParam param)
final int	getMinwidth()
Previous	getPrevious()
String	getWarningOrError()
final boolean	isRotation()
void	setHideEmptyDescription(boolean hideEmptyDescription)
final void	setMinwidth(int minwidth)
final void	setRotation(boolean rotation)

Methods inherited from class net.sourceforge.plantuml.TitledDiagram

addSprite, addWarning, calculateBackColor, createImageBuilder, exportDiagramGraphic, getCaption, getCurrentStyleBuilder, getDefaultMargins, getFlashData, getFooter, getHeader, getLegend, getMainFrame, getPragma, getSkinParam, getTextMainBlock, getTitle, getTitleDisplay, getUmlDiagramType, getWarnings, isSkinParamUsed, isUseElk, isUseSmetana, loadSkin, muteColorMapper, setCaption, setLegend, setMainFrame, setParam, setSkinParamUsed, setTitle, setUseElk, setUseSmetana, updateFooter, updateHeader

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

checkFinalError, executeCommand, exportDiagram, getInstallationRequirement, getMetadata, getNamespaceSeparator, getNbImages, getPreprocessingArtifact, getRequiredPass, getScale, getSource, getSplitPagesHorizontal, getSplitPagesVertical, 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.Annotated

getCaption, getFooter, getHeader, getLegend, getMainFrame, getTitle

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

exportDiagram, exportDiagramGraphic, getDescription, getInstallationRequirement, getMetadata, getNbImages, getSource, getSplitPagesHorizontal, getSplitPagesVertical, getTitleDisplay, hasUrl

Methods inherited from interface net.sourceforge.plantuml.WithSprite

addSprite

Constructor Details

UmlDiagram

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

Method Details

getMinwidth

public final int getMinwidth()

setMinwidth

public final void setMinwidth(int minwidth)

isRotation

public final boolean isRotation()

setRotation

public final void setRotation(boolean rotation)

getFooterOrHeaderTeoz

public final DisplayPositioned getFooterOrHeaderTeoz(FontParam param)

exportDiagramNow

protected final ImageData exportDiagramNow(OutputStream os,
 int index,
 FileFormatOption fileFormatOption)
                                    throws IOException

Specified by:

exportDiagramNow in class AbstractPSystem

Throws:

IOException

exportCmap

protected final void exportCmap(SuggestedFile suggestedFile,
 int index,
 ImageData cmapdata)
                         throws FileNotFoundException

Throws:

FileNotFoundException

exportDiagramInternal

protected abstract ImageData exportDiagramInternal(OutputStream os,
 int index,
 FileFormatOption fileFormatOption)
                                            throws IOException

Throws:

IOException

getWarningOrError

public String getWarningOrError()

Specified by:

getWarningOrError in interface Diagram

Overrides:

getWarningOrError in class AbstractPSystem

setHideEmptyDescription

public void setHideEmptyDescription(boolean hideEmptyDescription)

getPrevious

public Previous getPrevious()