com.vp.plugin.model

Interface IRDTableOfContentsTemplate

All Superinterfaces:

IModelElement, IModelElementParent

public interface IRDTableOfContentsTemplate
extends IModelElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_HEIGHTS
static java.lang.String	PROP_LEVEL_STYLES
static java.lang.String	PROP_MAX_LEVEL
static java.lang.String	PROP_ROW_STYLES
static java.lang.String	PROP_ROWS
static java.lang.String	PROP_TOC_STYLE

Fields inherited from interface com.vp.plugin.model.IModelElement

MODEL_QUALITY_SCORE_IGNORE, MODEL_QUALITY_SCORE_RECALCULATE, PROP_DOCUMENTATION, PROP_NAME, PROP_QUALITY_REASON, PROP_QUALITY_SCORE

Method Summary

Methods

Modifier and Type	Method and Description
void	addRDTableOfContentRow(IRDTableOfContentRow child)
void	addRow(IRDTableOfContentRow row)
void	addValueSpecification(IValueSpecification child)
IRDTableOfContentRow	createRDTableOfContentRow()
IValueSpecification	createValueSpecification()
java.lang.String	getHeights()
java.lang.String[]	getLevelStyles()
int	getMaxLevel()
java.lang.String	getNickname() Deprecated. replaced by #getName()
IRDTableOfContentRow	getRDTableOfContentRowByIndex(int index)
IRDTableOfContentRow	getRDTableOfContentRowByName(java.lang.String name)
IRDTableOfContentRow	getRowByIndex(int index)
java.lang.String[]	getRowStyles()
java.lang.String	getTocStyle()
IValueSpecification	getValueSpecificationByIndex(int index)
IValueSpecification	getValueSpecificationByName(java.lang.String name)
int	rDTableOfContentRowCount()
java.util.Iterator	rDTableOfContentRowIterator()
void	removeRDTableOfContentRow(IRDTableOfContentRow child)
void	removeRDTableOfContentRowByIndex(int index)
void	removeRow(IRDTableOfContentRow row)
void	removeRowByIndex(int index)
void	removeValueSpecification(IValueSpecification child)
void	removeValueSpecificationByIndex(int index)
void	reorderRDTableOfContentRow(IRDTableOfContentRow[] childs)
void	reorderValueSpecification(IValueSpecification[] childs)
int	rowCount()
java.util.Iterator	rowIterator() Returns an iterator over the model elements IRDTableOfContentRow.
void	setHeights(java.lang.String heights)
void	setLevelStyles(java.lang.String[] levelStyles)
void	setMaxLevel(int maxLevel)
void	setNickname(java.lang.String nickname) Deprecated. replaced by #setName(String)
void	setRowStyles(java.lang.String[] rowStyles)
void	setTocStyle(java.lang.String tocStyle)
IRDTableOfContentRow[]	toRDTableOfContentRowArray()
IRDTableOfContentRow[]	toRowArray()
IValueSpecification[]	toValueSpecificationArray()
int	valueSpecificationCount()
java.util.Iterator	valueSpecificationIterator()

Methods inherited from interface com.vp.plugin.model.IModelElement

addChild, addPropertyChangeListener, addStereotype, addStereotype, addSubDiagram, canModify, childCount, childCount, childCount, childIterator, childIterator, childIterator, constraintsIterator, createChild, delete, disposeTransientModel, duplicate, fromChartRelationshipCount, fromChartRelationshipIterator, fromRelationshipCount, fromRelationshipEndCount, fromRelationshipEndIterator, fromRelationshipIterator, getAddress, getChildById, getChildByIndex, getChildByIndex, getChildByName, getChildByName, getDescription, getDescriptionWithReferenceModels, getDiagramElements, getDisplayQualityScore, getDocumentation, getDocumentationWithReferenceModels, getHTMLDescription, getHTMLDescription, getHTMLDescriptionWithReferenceModels, getHTMLDescriptionWithReferenceModels, getHTMLDocumentation, getHTMLDocumentation, getHTMLDocumentationWithReferenceModels, getHTMLDocumentationWithReferenceModels, getId, getMasterView, getMirrorSource, getModelPropertyByName, getModelQualityDetails, getModelType, getName, getNickDescription, getNickDescriptionWithReferenceModels, getNickDocumentation, getNickDocumentationWithReferenceModels, getNickHTMLDescription, getNickHTMLDescription, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDocumentation, getNickHTMLDocumentation, getNickHTMLDocumentationWithReferenceModels, getNickHTMLDocumentationWithReferenceModels, getNickPropertyValue, getParent, getProject, getQualityReason, getQualityScore, getReferencedBys, getReferencingModels, getSubDiagramAt, getTaggedValues, hasStereotype, indexOfSubDiagram, isMirrorModelElement, isTransientModel, removeChild, removeChildByIndex, removePropertyChangeListener, removeStereotype, removeStereotype, removeSubDiagram, setDescription, setDocumentation, setHTMLDescription, setHTMLDocumentation, setName, setNickDescription, setNickDocumentation, setNickHTMLDescription, setNickHTMLDocumentation, setTaggedValues, stereotypeCount, stereotypeModelIterator, subDiagramCount, subDiagramIterator, toChartRelationshipCount, toChartRelationshipIterator, toChildArray, toChildArray, toChildArray, toFromChartRelationshipArray, toFromRelationshipArray, toFromRelationshipEndArray, toModelPropertyArray, toPropertiesString, toRelationshipCount, toRelationshipEndCount, toRelationshipEndIterator, toRelationshipIterator, toStereotypeModelArray, toSubDiagramArray, toToChartRelationshipArray, toToRelationshipArray, toToRelationshipEndArray

Field Detail

PROP_HEIGHTS

static final java.lang.String PROP_HEIGHTS

See Also:

Constant Field Values

PROP_MAX_LEVEL

static final java.lang.String PROP_MAX_LEVEL

See Also:

Constant Field Values

PROP_LEVEL_STYLES

static final java.lang.String PROP_LEVEL_STYLES

See Also:

Constant Field Values

PROP_ROWS

static final java.lang.String PROP_ROWS

See Also:

Constant Field Values

PROP_TOC_STYLE

static final java.lang.String PROP_TOC_STYLE

See Also:

Constant Field Values

PROP_ROW_STYLES

static final java.lang.String PROP_ROW_STYLES

See Also:

Constant Field Values

Method Detail

addRDTableOfContentRow

void addRDTableOfContentRow(IRDTableOfContentRow child)

removeRDTableOfContentRow

void removeRDTableOfContentRow(IRDTableOfContentRow child)

getRDTableOfContentRowByIndex

IRDTableOfContentRow getRDTableOfContentRowByIndex(int index)

removeRDTableOfContentRowByIndex

void removeRDTableOfContentRowByIndex(int index)

reorderRDTableOfContentRow

void reorderRDTableOfContentRow(IRDTableOfContentRow[] childs)

rDTableOfContentRowCount

int rDTableOfContentRowCount()

rDTableOfContentRowIterator

java.util.Iterator rDTableOfContentRowIterator()

toRDTableOfContentRowArray

IRDTableOfContentRow[] toRDTableOfContentRowArray()

createRDTableOfContentRow

IRDTableOfContentRow createRDTableOfContentRow()

getRDTableOfContentRowByName

IRDTableOfContentRow getRDTableOfContentRowByName(java.lang.String name)

addValueSpecification

void addValueSpecification(IValueSpecification child)

removeValueSpecification

void removeValueSpecification(IValueSpecification child)

getValueSpecificationByIndex

IValueSpecification getValueSpecificationByIndex(int index)

removeValueSpecificationByIndex

void removeValueSpecificationByIndex(int index)

reorderValueSpecification

void reorderValueSpecification(IValueSpecification[] childs)

valueSpecificationCount

int valueSpecificationCount()

valueSpecificationIterator

java.util.Iterator valueSpecificationIterator()

toValueSpecificationArray

IValueSpecification[] toValueSpecificationArray()

createValueSpecification

IValueSpecification createValueSpecification()

getValueSpecificationByName

IValueSpecification getValueSpecificationByName(java.lang.String name)

setNickname

void setNickname(java.lang.String nickname)

Deprecated. replaced by #setName(String)

Description copied from interface: IModelElement

Set the nickname of this IModelElement for current nickname of project. An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234

Specified by:

setNickname in interface IModelElement

Parameters:

nickname - the new nickname of this IModelElement.

getNickname

java.lang.String getNickname()

Deprecated. replaced by #getName()

Description copied from interface: IModelElement

Retrieve the nickname of this IModelElement for current nickname of project. An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234

Specified by:

getNickname in interface IModelElement

Returns:

the nickname of this IModelElement.

setHeights

void setHeights(java.lang.String heights)

getHeights

java.lang.String getHeights()

setMaxLevel

void setMaxLevel(int maxLevel)

getMaxLevel

int getMaxLevel()

setLevelStyles

void setLevelStyles(java.lang.String[] levelStyles)

getLevelStyles

java.lang.String[] getLevelStyles()

addRow

void addRow(IRDTableOfContentRow row)

removeRow

void removeRow(IRDTableOfContentRow row)

getRowByIndex

IRDTableOfContentRow getRowByIndex(int index)

removeRowByIndex

void removeRowByIndex(int index)

rowCount

int rowCount()

rowIterator

java.util.Iterator rowIterator()

Returns an iterator over the model elements IRDTableOfContentRow.

toRowArray

IRDTableOfContentRow[] toRowArray()

setTocStyle

void setTocStyle(java.lang.String tocStyle)

getTocStyle

java.lang.String getTocStyle()

setRowStyles

void setRowStyles(java.lang.String[] rowStyles)

getRowStyles

java.lang.String[] getRowStyles()