Package | Description |
---|---|
org.tanjakostic.jcleancim.builder.ea |
Classes responsible for building in-memory UML model from EA repository (.eap model file).
|
org.tanjakostic.jcleancim.docgen.collector |
This package defines interfaces and classes responsible for collecting documentation and figures
from the UML model, or freely initialised through the API without any UML model.
|
org.tanjakostic.jcleancim.docgen.collector.impl | |
org.tanjakostic.jcleancim.docgen.writer.word |
Classes specific to writing MS documents.
|
org.tanjakostic.jcleancim.model |
Classes being created by a builder or with the API (code) to hold the in-memory UML model.
|
Modifier and Type | Method and Description |
---|---|
TextDescription |
EaHelper.getHtmlText(java.lang.String text) |
TextDescription |
EaHelper.getRawText(java.lang.String text) |
Modifier and Type | Method and Description |
---|---|
TextDescription |
ObjectDoc.getDescription()
Returns description of this model element.
|
Modifier and Type | Class and Description |
---|---|
protected static class |
AbstractPropertiesDoc.CellText |
Modifier and Type | Field and Description |
---|---|
private TextDescription |
AbstractObjectDoc._description |
private TextDescription |
ClassDocImpl._extendedDescription |
Modifier and Type | Method and Description |
---|---|
TextDescription |
ClassDocImpl.getDescription() |
TextDescription |
AbstractObjectDoc.getDescription()
This default implementation returns what has been explicitly initialised in the call to the
constructor.
|
private TextDescription |
ClassDocImpl.prependOldNameAndDeducePresenceConditionsAdditionalText(UmlClass c)
This is for 61850 presence conditions with non-machine-processable condID.
|
Modifier and Type | Method and Description |
---|---|
protected AbstractPropertiesDoc.CellText |
AbstractPropertiesDoc.deduceCellText(java.lang.String prefix,
TextDescription raw,
TextDescription html,
UmlObject o) |
private static TextDescription.TextKind |
AbstractPropertiesDoc.CellText.deduceKind(java.lang.Integer fmtIdx,
TextDescription textDesc) |
private static java.lang.String |
AbstractPropertiesDoc.CellText.deduceText(TextDescription text) |
protected boolean |
AbstractObjectDoc.useHtml(TextDescription htmlDescription)
Returns true if printing HTML is enabled and
htmlDescription is not empty. |
Constructor and Description |
---|
AbstractObjectDoc(DocgenConfig docgenCfg,
UmlObject o,
java.lang.String what,
TextDescription description,
TextDescription htmlDescription,
boolean ignoreDesc,
java.lang.String headingText)
"Centralised" constructor, allowing for instantiation both with and without a UML object, and
with and without descriptions, as follows:
|
AbstractPropertiesDoc.CellText(java.lang.Integer fmtIdx,
TextDescription textDesc)
Constructor.
|
AbstractPropertiesDoc.CellText(TextDescription text)
Creates an instance with null formatting info (all formatting will be ignored).
|
AbstractPropertiesDoc(DocgenConfig docgenCfg,
UmlObject object,
java.lang.String what,
TextDescription description,
TextDescription htmlDescription,
boolean ignoreDesc,
java.lang.String headingText,
java.lang.String introText,
java.lang.String captionText,
TableSpec colSpec,
java.lang.String tableName)
Same as
AbstractPropertiesDoc.AbstractPropertiesDoc(DocgenConfig, UmlObject, String, String, String, TableSpec, String)
, but with explicit text and html documentation parameters; this is to support chained
construction for the needs of testing where we don't have UML objects but want to print
descriptions. |
FigureDocImpl(DocgenConfig docgenCfg,
UmlDiagram d,
TextDescription description,
TextDescription htmlDescription,
java.io.File pic,
java.lang.String showsWhat,
java.lang.String caption)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
WordHelper.appendTextInNewParagraphWithStyle(Range<O> range,
TextDescription newText,
Style style) |
java.lang.String |
AbstractWordWriter.appendTextInNewParagraphWithStyle(Range<O> range,
TextDescription newText,
Style style)
You'll always use this one for regular text and tables.
|
Modifier and Type | Field and Description |
---|---|
private TextDescription |
UmlObjectData._htmlDescription |
private TextDescription |
UmlObjectData._txtDescription |
static TextDescription |
TextDescription.EMPTY_HTML |
static TextDescription |
TextDescription.EMPTY_TXT |
Modifier and Type | Method and Description |
---|---|
TextDescription |
TextDescription.appendParagraph(java.lang.String paragraph)
Returns new instance with the
paragraph appended to the original text as a
paragraph (for HTML, it will enclose paragraph into paragraph tags, and for
text, it will first append a new line character then paragraph ); or unmodified
instance if paragraph is null or empty. |
TextDescription |
UmlObject.getDescription()
Returns the raw text description for this UML object, as defined in the UML model.
|
TextDescription |
AbstractUmlObject.getDescription() |
TextDescription |
UmlObjectData.getHtmlDescription() |
TextDescription |
UmlObject.getHtmlDescription()
Returns the formatted description for this UML object, as defined in the UML model.
|
TextDescription |
AbstractUmlObject.getHtmlDescription() |
TextDescription |
UmlObjectData.getTxtDescription() |
TextDescription |
TextDescription.prepend(java.lang.String prefix)
Returns new instance with the
prefix prepended to the original text; or
unmodified instance if prefix is null or empty. |
TextDescription |
TextDescription.prepend(java.lang.String prefix,
java.lang.Object o)
Returns new instance with the
prefix prepended to the original text; or
unmodified instance if prefix is null or empty. |
Constructor and Description |
---|
UmlObjectData(java.lang.Integer id,
java.lang.String uuid,
java.lang.String name,
java.lang.String alias,
UmlStereotype stereotype,
java.lang.String eaVisibility,
TextDescription txtDoc,
TextDescription htmlDoc)
Constructor; accepts null arguments and initialises them with default values, so that all the
getters return non-null values.
|
UmlObjectData(java.lang.String name,
java.lang.String alias,
TextDescription txtDoc,
TextDescription htmlDoc)
Constructor useful when collecting model content for documentation.
|
Copyright 2009-2015 Tatjana (Tanja) Kostic