Package net.sourceforge.plantuml.help

Class Help

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.TitledDiagram

net.sourceforge.plantuml.UmlDiagram

net.sourceforge.plantuml.help.Help

All Implemented Interfaces:

Annotated, Diagram, WarningHandler, WithSprite

public class Help
extends UmlDiagram

Field Summary

Fields inherited from class net.sourceforge.plantuml.TitledDiagram

FORCE_ELK, FORCE_SMETANA

Constructor Summary

Constructors

Constructor	Description
Help(UmlSource source, PreprocessingArtifact preprocessing)

Method Summary

Modifier and Type	Method	Description
void	add(CharSequence line)
ImageBuilder	createImageBuilder(FileFormatOption fileFormatOption)
protected ImageData	exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormat)
ClockwiseTopRightBottomLeft	getDefaultMargins()
DiagramDescription	getDescription()
protected TextBlock	getTextMainBlock(FileFormatOption fileFormatOption)

Methods inherited from class net.sourceforge.plantuml.UmlDiagram

exportCmap, exportDiagramError, exportDiagramNow, getFailureText2, getFlashData, getFooterOrHeaderTeoz, getMinwidth, getPrevious, getWarningOrError, isRotation, setHideEmptyDescription, setMinwidth, setRotation

Methods inherited from class net.sourceforge.plantuml.TitledDiagram

addSprite, addWarning, calculateBackColor, exportDiagramGraphic, getCaption, getCurrentStyleBuilder, getFooter, getHeader, getLegend, getMainFrame, getPragma, getSkinParam, getTitle, getTitleDisplay, getUmlDiagramType, getWarnings, isUseElk, isUseSmetana, loadSkin, muteColorMapper, setCaption, setLegend, setMainFrame, setParam, setTitle, setUseElk, setUseSmetana

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

checkFinalError, executeCommand, exportDiagram, 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, getMetadata, getNbImages, getSource, getSplitPagesHorizontal, getSplitPagesVertical, getTitleDisplay, hasUrl

Methods inherited from interface net.sourceforge.plantuml.WithSprite

addSprite

Constructor Details

Help

public Help(UmlSource source,
 PreprocessingArtifact preprocessing)

Method Details

getDescription

public DiagramDescription getDescription()

createImageBuilder

public ImageBuilder createImageBuilder(FileFormatOption fileFormatOption)
                                throws IOException

Overrides:

createImageBuilder in class TitledDiagram

Throws:

IOException

exportDiagramInternal

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

Specified by:

exportDiagramInternal in class UmlDiagram

Throws:

IOException

add

public void add(CharSequence line)

getDefaultMargins

public ClockwiseTopRightBottomLeft getDefaultMargins()

Overrides:

getDefaultMargins in class TitledDiagram

getTextMainBlock

protected TextBlock getTextMainBlock(FileFormatOption fileFormatOption)

Specified by:

getTextMainBlock in class TitledDiagram