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, WithSprite

public class Help
extends UmlDiagram

Field Summary

Fields inherited from class net.sourceforge.plantuml.UmlDiagram

FORCE_JDOT

Constructor Summary

Constructors

Constructor and Description
Help()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.CharSequence line)
protected ImageData	exportDiagramInternal(java.io.OutputStream os, int index, FileFormatOption fileFormat)
DiagramDescription	getDescription()
UmlDiagramType	getUmlDiagramType()

Methods inherited from class net.sourceforge.plantuml.UmlDiagram

addSprite, exportCmap, exportDiagramError, exportDiagramNow, getAnimation, getFailureText2, getFlashData, getFooterOrHeaderTeoz, getMinwidth, getPragma, getScaleCoef, getSkinParam, getWarningOrError, isHideUnlinkedData, isRotation, isUseJDot, loadSkin, setAnimation, setHideEmptyDescription, setHideUnlinkedData, setMinwidth, setParam, setRotation, setUseJDot

Methods inherited from class net.sourceforge.plantuml.TitledDiagram

getCaption, getFooter, getHeader, getLegend, getMainFrame, getTitle, setCaption, setLegend, setMainFrame, setTitle

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

checkFinalError, executeCommand, exportDiagram, getMetadata, getNbImages, getScale, getSource, 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.Annotated

getCaption, getFooter, getHeader, getLegend, getMainFrame, getTitle

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

exportDiagram, getMetadata, getNbImages, getSource, hasUrl

Constructor Detail

Help

public Help()

Method Detail

getDescription

public DiagramDescription getDescription()

getUmlDiagramType

public UmlDiagramType getUmlDiagramType()

Specified by:

getUmlDiagramType in class UmlDiagram

exportDiagramInternal

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

Specified by:

exportDiagramInternal in class UmlDiagram

Throws:

java.io.IOException

add

public void add(java.lang.CharSequence line)