IDiagramLegend

All Superinterfaces:: IModelElement, IModelElementParent

public interface IDiagramLegend
extends IModelElement

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_COLOR_LEGENDS`
`static java.lang.String`	`PROP_CONNECTOR_LEGENDS`
`static java.lang.String`	`PROP_DIAGRAM_ID`
`static java.lang.String`	`PROP_SHAPE_LEGENDS`

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addColorLegend(IColorLegend colorLegend)`
`void`	`addConnectorLegend(IConnectorLegend connectorLegend)`
`void`	`addShapeLegend(IShapeLegend shapeLegend)`
`int`	`colorLegendCount()`
`java.util.Iterator`	`colorLegendIterator()` Returns an iterator over the model elements `IColorLegend`.
`int`	`connectorLegendCount()`
`java.util.Iterator`	`connectorLegendIterator()` Returns an iterator over the model elements `IConnectorLegend`.
`IColorLegend`	`getColorLegendByIndex(int index)`
`IConnectorLegend`	`getConnectorLegendByIndex(int index)`
`java.lang.String`	`getDiagramId()`
`IShapeLegend`	`getShapeLegendByIndex(int index)`
`void`	`removeColorLegend(IColorLegend colorLegend)`
`void`	`removeColorLegendByIndex(int index)`
`void`	`removeConnectorLegend(IConnectorLegend connectorLegend)`
`void`	`removeConnectorLegendByIndex(int index)`
`void`	`removeShapeLegend(IShapeLegend shapeLegend)`
`void`	`removeShapeLegendByIndex(int index)`
`void`	`setDiagramId(java.lang.String diagramId)`
`int`	`shapeLegendCount()`
`java.util.Iterator`	`shapeLegendIterator()` Returns an iterator over the model elements `IShapeLegend`.
`IColorLegend[]`	`toColorLegendArray()`
`IConnectorLegend[]`	`toConnectorLegendArray()`
`IShapeLegend[]`	`toShapeLegendArray()`

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, getNickname, 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, setNickname, 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_DIAGRAM_ID
```
static final java.lang.String PROP_DIAGRAM_ID
```
  See Also:
  
  Constant Field Values
- PROP_COLOR_LEGENDS
```
static final java.lang.String PROP_COLOR_LEGENDS
```
  See Also:
  
  Constant Field Values
- PROP_SHAPE_LEGENDS
```
static final java.lang.String PROP_SHAPE_LEGENDS
```
  See Also:
  
  Constant Field Values
- PROP_CONNECTOR_LEGENDS
```
static final java.lang.String PROP_CONNECTOR_LEGENDS
```
  See Also:
  
  Constant Field Values

Method Detail

setDiagramId

void setDiagramId(java.lang.String diagramId)

getDiagramId
```
java.lang.String getDiagramId()
```

addColorLegend

void addColorLegend(IColorLegend colorLegend)

removeColorLegend

void removeColorLegend(IColorLegend colorLegend)

getColorLegendByIndex

IColorLegend getColorLegendByIndex(int index)

removeColorLegendByIndex

void removeColorLegendByIndex(int index)

colorLegendCount
```
int colorLegendCount()
```

colorLegendIterator
```
java.util.Iterator colorLegendIterator()
```
Returns an iterator over the model elements IColorLegend.

toColorLegendArray
```
IColorLegend[] toColorLegendArray()
```

addShapeLegend

void addShapeLegend(IShapeLegend shapeLegend)

removeShapeLegend

void removeShapeLegend(IShapeLegend shapeLegend)

getShapeLegendByIndex

IShapeLegend getShapeLegendByIndex(int index)

removeShapeLegendByIndex

void removeShapeLegendByIndex(int index)

shapeLegendCount
```
int shapeLegendCount()
```

shapeLegendIterator
```
java.util.Iterator shapeLegendIterator()
```
Returns an iterator over the model elements IShapeLegend.

toShapeLegendArray
```
IShapeLegend[] toShapeLegendArray()
```

addConnectorLegend

void addConnectorLegend(IConnectorLegend connectorLegend)

removeConnectorLegend

void removeConnectorLegend(IConnectorLegend connectorLegend)

getConnectorLegendByIndex

IConnectorLegend getConnectorLegendByIndex(int index)

removeConnectorLegendByIndex

void removeConnectorLegendByIndex(int index)

connectorLegendCount
```
int connectorLegendCount()
```

connectorLegendIterator
```
java.util.Iterator connectorLegendIterator()
```
Returns an iterator over the model elements IConnectorLegend.

toConnectorLegendArray

IConnectorLegend[] toConnectorLegendArray()

Interface IDiagramLegend

Field Summary

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

Method Summary

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

Field Detail

PROP_DIAGRAM_ID

PROP_COLOR_LEGENDS

PROP_SHAPE_LEGENDS

PROP_CONNECTOR_LEGENDS

Method Detail

setDiagramId

getDiagramId

addColorLegend

removeColorLegend

getColorLegendByIndex

removeColorLegendByIndex

colorLegendCount

colorLegendIterator

toColorLegendArray

addShapeLegend

removeShapeLegend

getShapeLegendByIndex

removeShapeLegendByIndex

shapeLegendCount

shapeLegendIterator

toShapeLegendArray

addConnectorLegend

removeConnectorLegend

getConnectorLegendByIndex

removeConnectorLegendByIndex

connectorLegendCount

connectorLegendIterator

toConnectorLegendArray