Package de.mid.innovator.srv2api.icw2dg

Interface DGChapter

All Superinterfaces:

ADClientAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPresOptAble, ELUUIDAble, MMLocalizAble, MMMetamodelElement

All Known Subinterfaces:

DGAdditionalHeading, DGAttachmentChapter, DGDocuStructureRoot, DGLink, DGPicture, DGRoot, DGStandardChapter, DGTemplate, DGTreeLink, DGTreeStructureRoot, DGTreeTemplate, DGVerifyChapter, DGViewChapter

public interface DGChapter
extends MMMetamodelElement, ELPresOptAble, ELNamespaceAble, MMLocalizAble

Represents a chapter in a documentation.

See Also:

• DGChapterHelper

Note:

The interface DGChapter describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	DGChapter.VAttr

Method Summary

Modifier and Type	Method	Description
List<DGStandardChapter>	assignContent(List<? extends MMMetamodelElement> seqOh)	Assign contents to this chapter.
String	getContents()	The content of this chapter.
K_NUMBER_FORMAT	getNumberFormatEVal()	Get the number format of this chapter.
<T extends DGChapter> List<T>	getOwnedChapter(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All documentation chapters owned by this documentation chapter.
DGChapter	getOwningChapter()	The documentation chapter owning this documentation chapter.
boolean	getPageBreakAfter()	Returns true if this chapter has a page break after the heading.
boolean	getPageBreakBefore()	Returns true if this chapter has a page break before the heading.
K_PARAGRAPH_JUSTIFICATION	getParagraphJustification()	The justification of the paragraph.
DGChapter	getRedefinedChapter()	The DGChapter which is redefined by this DGChapter.
<T extends DGChapter> List<T>	getRedefiningChapter(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All chapters which redefine this DGChapter.
List<DGTableColumn>	getTableColumn()	The table column using this DGChapter.
boolean	isChapterFadedOut()	Returns true if this chapter is supressed.
boolean	isHeadingSuppressed()	Returns true if this chapters heading is faded out.
void	setChapterFadedOut(boolean value)	Set the value of Attribut IsChapterFadedOut.
void	setContents(String value)	Set the value of Attribut Contents.
void	setHeadingSuppressed(boolean value)	Set the value of Attribut IsHeadingSuppressed.
void	setNumberFormatEVal(K_NUMBER_FORMAT value)	Set the value of Attribut NumberFormatEVal.
void	setPageBreakAfter(boolean value)	Set the value of Attribut PageBreakAfter.
void	setPageBreakBefore(boolean value)	Set the value of Attribut PageBreakBefore.
void	setParagraphJustification(K_PARAGRAPH_JUSTIFICATION value)	Set the value of Attribut ParagraphJustification.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELPresOptAble

getBitmap, getColor, getOwnedPresOpt

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLocalizAble

hasAnyLocalizedName, hasLocalizedName

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMMetamodelElement

getIgnoringProfile

Method Details

getContents

String getContents()
            throws InoNetException,
SrvErrorException

The content of this chapter. In the documentation configuration it is used to save a filter.

Throws:

InoNetException

SrvErrorException

setContents

void setContents(String value)
          throws InoNetException,
SrvErrorException

Set the value of Attribut Contents.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isChapterFadedOut

boolean isChapterFadedOut()
                   throws InoNetException,
SrvErrorException

Returns true if this chapter is supressed.

Throws:

InoNetException

SrvErrorException

setChapterFadedOut

void setChapterFadedOut(boolean value)
                 throws InoNetException,
SrvErrorException

Set the value of Attribut IsChapterFadedOut.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isHeadingSuppressed

boolean isHeadingSuppressed()
                     throws InoNetException,
SrvErrorException

Returns true if this chapters heading is faded out.

Throws:

InoNetException

SrvErrorException

setHeadingSuppressed

void setHeadingSuppressed(boolean value)
                   throws InoNetException,
SrvErrorException

Set the value of Attribut IsHeadingSuppressed.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getPageBreakBefore

boolean getPageBreakBefore()
                    throws InoNetException,
SrvErrorException

Returns true if this chapter has a page break before the heading.

Throws:

InoNetException

SrvErrorException

setPageBreakBefore

void setPageBreakBefore(boolean value)
                 throws InoNetException,
SrvErrorException

Set the value of Attribut PageBreakBefore.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getPageBreakAfter

boolean getPageBreakAfter()
                   throws InoNetException,
SrvErrorException

Returns true if this chapter has a page break after the heading.

Throws:

InoNetException

SrvErrorException

setPageBreakAfter

void setPageBreakAfter(boolean value)
                throws InoNetException,
SrvErrorException

Set the value of Attribut PageBreakAfter.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getNumberFormatEVal

K_NUMBER_FORMAT getNumberFormatEVal()
                             throws InoNetException,
SrvErrorException

Get the number format of this chapter.

Throws:

InoNetException

SrvErrorException

setNumberFormatEVal

void setNumberFormatEVal(K_NUMBER_FORMAT value)
                  throws InoNetException,
SrvErrorException

Set the value of Attribut NumberFormatEVal.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getParagraphJustification

K_PARAGRAPH_JUSTIFICATION getParagraphJustification()
                                             throws InoNetException,
SrvErrorException

The justification of the paragraph.

Throws:

InoNetException

SrvErrorException

setParagraphJustification

void setParagraphJustification(K_PARAGRAPH_JUSTIFICATION value)
                        throws InoNetException,
SrvErrorException

Set the value of Attribut ParagraphJustification.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

assignContent

List<DGStandardChapter> assignContent(List<? extends MMMetamodelElement> seqOh)
                               throws InoNetException,
SrvErrorException

Assign contents to this chapter.

Parameters:

seqOh - List of selected meta classes or create templates

Throws:

InoNetException

SrvErrorException

getOwnedChapter

<T extends DGChapter> List<T> getOwnedChapter(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
SrvErrorException

All documentation chapters owned by this documentation chapter.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getTableColumn

List<DGTableColumn> getTableColumn()
                            throws InoNetException,
SrvErrorException

The table column using this DGChapter.

Throws:

InoNetException

SrvErrorException

getRedefiningChapter

<T extends DGChapter> List<T> getRedefiningChapter(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                            throws InoNetException,
SrvErrorException

All chapters which redefine this DGChapter.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getRedefinedChapter

DGChapter getRedefinedChapter()
                       throws InoNetException,
SrvErrorException

The DGChapter which is redefined by this DGChapter.

Throws:

InoNetException

SrvErrorException

getOwningChapter

DGChapter getOwningChapter()
                    throws InoNetException,
SrvErrorException

The documentation chapter owning this documentation chapter.

Throws:

InoNetException

SrvErrorException