IGridDiagramUIModel

All Superinterfaces:: IDiagramUIModel

public interface IGridDiagramUIModel
extends IDiagramUIModel

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MODEL_REF_PRESENTATION_ID`
`static int`	`MODEL_REF_PRESENTATION_ID_NAME`
`static int`	`MODEL_REF_PRESENTATION_NAME`
`static java.lang.String`	`PROPERTY_COLUMNS`
`static java.lang.String`	`PROPERTY_COLUMNS_ADDRESSES`
`static java.lang.String`	`PROPERTY_FILTER_TEXT`
`static java.lang.String`	`PROPERTY_FONT_SIZE`
`static java.lang.String`	`PROPERTY_GRID_DIAGRAM_ADDRESS`
`static java.lang.String`	`PROPERTY_MODEL_REF_PRESENTATION`
`static java.lang.String`	`PROPERTY_ROWS_ADDRESSES`
`static java.lang.String`	`PROPERTY_SCOPE_INCLUDE_DEPENDENT_PROJECTS`
`static java.lang.String`	`PROPERTY_SCOPE_TYPE`
`static java.lang.String`	`PROPERTY_SCOPE_VALUES`
`static java.lang.String`	`PROPERTY_SORT_COLUMN_INFOS_ADDRESSES`
`static int`	`SCOPE_ALL_DIAGRAMS`
`static int`	`SCOPE_ALL_LABELS`
`static int`	`SCOPE_DIAGRAM`
`static int`	`SCOPE_LABEL`
`static int`	`SCOPE_MODEL`
`static int`	`SCOPE_NO_DIAGRAM`
`static int`	`SCOPE_NO_LABEL`
`static int`	`SCOPE_NO_MODEL`
`static int`	`SCOPE_PROJECT`
`static java.lang.String`	`SHAPETYPE_ANCHOR`
`static java.lang.String`	`SHAPETYPE_CONSTRAINT`
`static java.lang.String`	`SHAPETYPE_CONTAINMENT`
`static java.lang.String`	`SHAPETYPE_DIAGRAM_INFO`
`static java.lang.String`	`SHAPETYPE_DIAGRAM_OVERVIEW`
`static java.lang.String`	`SHAPETYPE_GENERIC_CONNECTOR`
`static java.lang.String`	`SHAPETYPE_GENERIC_SHAPE`
`static java.lang.String`	`SHAPETYPE_NOTE`
`static java.lang.String`	`SHAPETYPE_VISIO_SHAPE`

Fields inherited from interface com.vp.plugin.diagram.IDiagramUIModel
MAX_PREVIEW_IMAGE_SIZE, MAX_ZOOM, PAINT_CONNECTOR_THROUGH_LABEL_FOLLOW_DIAGRAM, PAINT_CONNECTOR_THROUGH_LABEL_NO, PAINT_CONNECTOR_THROUGH_LABEL_YES, PROPERTY_ALIGN_TO_GRID, PROPERTY_ALIGNTOGRID, PROPERTY_ALWAYS_SHOW_REFERENCE_AND_SUBDIAGRAM_RESOURCE, PROPERTY_AUTO_FIT_SHAPES_SIZE, PROPERTY_CONNECTION_POINT_STYLE, PROPERTY_CONNECTOR_LABEL_ORIENTATION, PROPERTY_CONNECTOR_LINE_JUMPS, PROPERTY_CONNECTOR_LINE_JUMPS_SIZE, PROPERTY_CONNECTOR_STYLE, PROPERTY_CREATION_TIME, PROPERTY_DIAGRAM_BACKGROUND, PROPERTY_DIAGRAM_PREVIEW_DATA, PROPERTY_DIAGRAMBACKGROUND, PROPERTY_DOCUMENTATION, PROPERTY_EDITABLE, PROPERTY_FOLLOW_DIAGRAM_PARENT_ELEMENT, PROPERTY_GLOBAL_PALETTE_OPTION, PROPERTY_GRID_COLOR, PROPERTY_GRID_HEIGHT, PROPERTY_GRID_VISIBLE, PROPERTY_GRID_WIDTH, PROPERTY_GRIDCOLOR, PROPERTY_GRIDHEIGHT, PROPERTY_GRIDVISIBLE, PROPERTY_GRIDWIDTH, PROPERTY_HEIGHT, PROPERTY_HIDDEN_DIAGRAM_ELEMENT_IDS, PROPERTY_HIDE_EMPTY_TAGGED_VALUES, PROPERTY_HTML_DOCUMENTATION, PROPERTY_ID, PROPERTY_INITIALIZE_DIAGRAM_FOR_CREATE, PROPERTY_LAST_MODIFIED, PROPERTY_LAST_VIEW_X, PROPERTY_LAST_VIEW_Y, PROPERTY_LOCKED, PROPERTY_MAXIMIZED, PROPERTY_MODEL_ELEMENT_NAME_ALIGNMENT, PROPERTY_NAME, PROPERTY_NICK_DOCUMENTATION, PROPERTY_NICK_HTML_DOCUMENTATION, PROPERTY_NICKNAME, PROPERTY_OPENED, PROPERTY_PAINT_CONNECTOR_THROUGH_LABEL, PROPERTY_PARENT_MODEL, PROPERTY_PM_AUTHOR, PROPERTY_PM_CREATE_DATE_TIME, PROPERTY_PM_DIFFICULTY, PROPERTY_PM_DIFFICULTY_ID, PROPERTY_PM_DISCIPLINE, PROPERTY_PM_DISCIPLINE_ID, PROPERTY_PM_ITERATION, PROPERTY_PM_ITERATION_ID, PROPERTY_PM_LAST_MODIFIED, PROPERTY_PM_PHASE, PROPERTY_PM_PHASE_ID, PROPERTY_PM_PRIORITY, PROPERTY_PM_PRIORITY_ID, PROPERTY_PM_STATUS, PROPERTY_PM_STATUS_ID, PROPERTY_PM_VERSION, PROPERTY_PM_VERSION_ID, PROPERTY_QP_SCALE_X, PROPERTY_QP_SCALE_Y, PROPERTY_QP_TRANSLATE_X, PROPERTY_QP_TRANSLATE_Y, PROPERTY_QUALITY_SCORE, PROPERTY_REFERENCE_CONTAINER_ID, PROPERTY_REQUEST_LAYOUT_TYPE, PROPERTY_REQUEST_VALIDATE_SNAP_TO_GRID, PROPERTY_SHOW_ACTIVITY_STATE_NODE_CAPTION, PROPERTY_SHOW_ALLOCATED_FROM, PROPERTY_SHOW_ALLOCATED_TO, PROPERTY_SHOW_CONNECTOR_NAME, PROPERTY_SHOW_CONSTRAINTS, PROPERTY_SHOW_PACKAGE_NAME_STYLE, PROPERTY_SHOW_STEREOTYPES, PROPERTY_SHOW_TAGGED_VALUES, PROPERTY_TRANSIT_FROM, PROPERTY_TRANSIT_TO, PROPERTY_TYPE, PROPERTY_WIDTH, PROPERTY_X, PROPERTY_Y, PROPERTY_ZOOM_RATIO, PROPERTY_ZOOMRATIO, SHOW_CONNECTOR_NAME_FOLLOW_DIAGRAM, SHOW_CONNECTOR_NAME_NO, SHOW_CONNECTOR_NAME_YES, SHOW_PACKAGE_NAME_STYLE_FOLLOW_DIAGRAM, SPECIAL_ZOOM_FIT_PAGE, SPECIAL_ZOOM_FIT_PAGE_HEIGHT, SPECIAL_ZOOM_FIT_PAGE_WIDTH, WITHIN_PACKAGE_BODY, WITHIN_PACKAGE_TAB

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsModelType(java.lang.String aBuiltInModelType)`
`IGridDiagramColumn[]`	`getColumns()`
`java.lang.String[]`	`getColumnsAddress()`
`java.lang.String`	`getFilterText()`
`int`	`getFontSize()`
`java.lang.String`	`getGridDiagramAddress()`
`int`	`getModelRefPresentation()`
`java.lang.String[]`	`getModelTypes()`
`java.lang.String[]`	`getRowsAddress()`
`int`	`getScopeType()`
`IDiagramUIModel`	`getScopeValueAsDiagram()` Deprecated. Replaced by #getScopeValueAsDiagrams():IDiagramUIModel[]
`IDiagramUIModel[]`	`getScopeValueAsDiagrams()`
`IModelElement`	`getScopeValueAsModelElement()` Deprecated. Replaced by #getScopeValueAsModelElements():IModelElement[]
`IModelElement[]`	`getScopeValueAsModelElements()`
`java.lang.String[]`	`getScopeValues()`
`java.lang.String[]`	`getSortColumnInfosAddress()`
`boolean`	`isScopeIncludeDependentProjects()`
`void`	`refresh()`
`void`	`setColumns(IGridDiagramColumn[] aValues)`
`void`	`setColumnsAddress(java.lang.String[] columnsAddress)`
`void`	`setFilterText(java.lang.String filterText)`
`void`	`setFontSize(int fontSize)`
`void`	`setGridDiagramAddress(java.lang.String gridDiagramAddress)`
`void`	`setModelRefPresentation(int modelRefPresentation)`
`void`	`setModelTypes(java.lang.String[] aBuiltInModelTypes)`
`void`	`setRowsAddress(java.lang.String[] rowsAddress)`
`void`	`setScopeIncludeDependentProjects(boolean scopeIncludeDependentProjects)`
`void`	`setScopeType(int scopeType)`
`void`	`setScopeValue(IDiagramUIModel aValue)` Deprecated. Replaced by #setScopeValues(IDiagramUIModel[])
`void`	`setScopeValue(IModelElement aValue)` Deprecated. Replaced by #setScopeValues(IModelElement[])
`void`	`setScopeValues(IDiagramUIModel[] aValues)`
`void`	`setScopeValues(IModelElement[] aValues)`
`void`	`setScopeValues(java.lang.String[] scopeValues)`
`void`	`setSortColumnInfosAddress(java.lang.String[] sortColumnInfosAddress)`

Methods inherited from interface com.vp.plugin.diagram.IDiagramUIModel
addDiagramElement, addDiagramListener, addReference, closeDiagram, commentCount, commentIterator, createComment, createDiagramElement, createDiagramElement, createDiagramLayer, delete, diagramElementCount, diagramElementIterator, fireModuleAddedDiagramElement, getActiveDiagramLayer, getAllowShapeTypes, getCommentAt, getConnectionPointStyle, getConnectorLabelOrientation, getConnectorLineJumps, getConnectorLineJumpsSize, getConnectorStyle, getCreationTime, getCustomizedSortDiagramElementIds, getDefaultDiagramLayer, getDiagramBackground, getDiagramEditorHeight, getDiagramEditorWidth, getDiagramElementAt, getDiagramElementById, getDiagramLayers, getDiagramListeners, getDiagramPropertyByName, getDocumentation, getDocumentationWithReferenceModels, getGridColor, getGridHeight, getGridWidth, getHeight, getHtmlDocumentation, getHtmlDocumentationWithReferenceModels, getId, getLastCommitted, getLastCommittedUser, getLastCommittedUserName, getLastModified, getLogicalViewType, getModelElementNameAlignment, getName, getNickDocumentation, getNickDocumentationWithReferenceModels, getNickHtmlDocumentation, getNickHtmlDocumentationWithReferenceModels, getNickname, getPaintConnectorThroughLabel, getParentModel, getPmAuthor, getPmCreateDateTime, getPmDifficulty, getPmDiscipline, getPmIteration, getPmLastModified, getPmPhase, getPmPriority, getPmStatus, getPmVersion, getProject, getQualityScore, getReferenceByIndex, getSelectedDiagramElement, getSelectedDiagramElement, getShowActivityStateNodeCaption, getShowConnectorName, getShowPackageNameStyle, getType, getUserID, getViewpoint, getWidth, getX, getY, getZoomRatio, group, groupButtonInfoCount, indexOfComment, indexOfDiagramElement, isAlignToGrid, isAllowLayout, isAllowShapeType, isAlwaysShowReferenceAndSubdiagramResource, isAutoFitShapesSize, isDiagramElementEmpty, isEditable, isFollowDiagramParentElement, isGlobalPaletteOption, isGridVisible, isGroupButtonInfoEmpty, isInitializeDiagramForCreate, isLoading, isMaximized, isOpened, isRequestValidateSnapToGrid, isShowConstraints, isShowStereotypes, isShowTaggedValues, isSubDiagram, isSupportedInProductEdition, layoutDiagramElement, modified, realCloseDiagram, referenceCount, referenceIterator, removeComment, removeDiagramElement, removeDiagramElementAt, removeDiagramLayer, removeDiagramListener, removeGroupButtonInfoAt, removeReference, removeReferenceByIndex, setActiveDiagramLayer, setAlignToGrid, setAlwaysShowReferenceAndSubdiagramResource, setAutoFitShapesSize, setBounds, setConnectionPointStyle, setConnectorLabelOrientation, setConnectorLineJumps, setConnectorLineJumpsSize, setConnectorStyle, setCreationTime, setDiagramBackground, setDocumentation, setEditable, setFireModified, setFollowDiagramParentElement, setGlobalPaletteOption, setGridColor, setGridHeight, setGridVisible, setGridWidth, setHtmlDocumentation, setInitializeDiagramForCreate, setLastModified, setMaximized, setModelElementNameAlignment, setModelPropertyAsBoolean, setModelPropertyAsColor, setModelPropertyAsDouble, setModelPropertyAsInt, setModelPropertyAsString, setName, setNickDocumentation, setNickHtmlDocumentation, setNickname, setPaintConnectorThroughLabel, setPmAuthor, setPmCreateDateTime, setPmDifficulty, setPmDiscipline, setPmIteration, setPmLastModified, setPmPhase, setPmPriority, setPmStatus, setPmVersion, setQualityScore, setRequestValidateSnapToGrid, setShowActivityStateNodeCaption, setShowConnectorName, setShowConstraints, setShowPackageNameStyle, setShowStereotypes, setShowTaggedValues, setSpecialZoom, setUserID, setZoomRatio, toCommentArray, toCommentModelElementArray, toConnectorUIModelArray, toDiagramElementArray, toDiagramElementArray, toDiagramPropertyArray, toPropertiesString, toReferenceArray, toShapeUIModelArray

Field Detail
- PROPERTY_COLUMNS
```
static final java.lang.String PROPERTY_COLUMNS
```
  See Also:
  
  Constant Field Values
- SHAPETYPE_DIAGRAM_INFO
```
static final java.lang.String SHAPETYPE_DIAGRAM_INFO
```
  See Also:
  
  Constant Field Values
- SHAPETYPE_NOTE
```
static final java.lang.String SHAPETYPE_NOTE
```
  See Also:
  
  Constant Field Values
- SHAPETYPE_DIAGRAM_OVERVIEW
```
static final java.lang.String SHAPETYPE_DIAGRAM_OVERVIEW
```
  See Also:
  
  Constant Field Values
- SHAPETYPE_CONSTRAINT
```
static final java.lang.String SHAPETYPE_CONSTRAINT
```
  See Also:
  
  Constant Field Values
- SHAPETYPE_CONTAINMENT
```
static final java.lang.String SHAPETYPE_CONTAINMENT
```
  See Also:
  
  Constant Field Values
- SHAPETYPE_VISIO_SHAPE
```
static final java.lang.String SHAPETYPE_VISIO_SHAPE
```
  See Also:
  
  Constant Field Values
- SHAPETYPE_GENERIC_SHAPE
```
static final java.lang.String SHAPETYPE_GENERIC_SHAPE
```
  See Also:
  
  Constant Field Values
- SHAPETYPE_GENERIC_CONNECTOR
```
static final java.lang.String SHAPETYPE_GENERIC_CONNECTOR
```
  See Also:
  
  Constant Field Values
- SHAPETYPE_ANCHOR
```
static final java.lang.String SHAPETYPE_ANCHOR
```
  See Also:
  
  Constant Field Values
- SCOPE_PROJECT
```
static final int SCOPE_PROJECT
```
  See Also:
  
  Constant Field Values
- SCOPE_MODEL
```
static final int SCOPE_MODEL
```
  See Also:
  
  Constant Field Values
- SCOPE_ALL_DIAGRAMS
```
static final int SCOPE_ALL_DIAGRAMS
```
  See Also:
  
  Constant Field Values
- SCOPE_DIAGRAM
```
static final int SCOPE_DIAGRAM
```
  See Also:
  
  Constant Field Values
- SCOPE_ALL_LABELS
```
static final int SCOPE_ALL_LABELS
```
  See Also:
  
  Constant Field Values
- SCOPE_LABEL
```
static final int SCOPE_LABEL
```
  See Also:
  
  Constant Field Values
- SCOPE_NO_MODEL
```
static final int SCOPE_NO_MODEL
```
  See Also:
  
  Constant Field Values
- SCOPE_NO_DIAGRAM
```
static final int SCOPE_NO_DIAGRAM
```
  See Also:
  
  Constant Field Values
- SCOPE_NO_LABEL
```
static final int SCOPE_NO_LABEL
```
  See Also:
  
  Constant Field Values
- PROPERTY_ROWS_ADDRESSES
```
static final java.lang.String PROPERTY_ROWS_ADDRESSES
```
  See Also:
  
  Constant Field Values
- PROPERTY_COLUMNS_ADDRESSES
```
static final java.lang.String PROPERTY_COLUMNS_ADDRESSES
```
  See Also:
  
  Constant Field Values
- PROPERTY_SCOPE_VALUES
```
static final java.lang.String PROPERTY_SCOPE_VALUES
```
  See Also:
  
  Constant Field Values
- PROPERTY_SORT_COLUMN_INFOS_ADDRESSES
```
static final java.lang.String PROPERTY_SORT_COLUMN_INFOS_ADDRESSES
```
  See Also:
  
  Constant Field Values
- PROPERTY_GRID_DIAGRAM_ADDRESS
```
static final java.lang.String PROPERTY_GRID_DIAGRAM_ADDRESS
```
  See Also:
  
  Constant Field Values
- PROPERTY_FILTER_TEXT
```
static final java.lang.String PROPERTY_FILTER_TEXT
```
  See Also:
  
  Constant Field Values
- PROPERTY_SCOPE_TYPE
```
static final java.lang.String PROPERTY_SCOPE_TYPE
```
  See Also:
  
  Constant Field Values
- PROPERTY_SCOPE_INCLUDE_DEPENDENT_PROJECTS
```
static final java.lang.String PROPERTY_SCOPE_INCLUDE_DEPENDENT_PROJECTS
```
  See Also:
  
  Constant Field Values
- PROPERTY_FONT_SIZE
```
static final java.lang.String PROPERTY_FONT_SIZE
```
  See Also:
  
  Constant Field Values
- PROPERTY_MODEL_REF_PRESENTATION
```
static final java.lang.String PROPERTY_MODEL_REF_PRESENTATION
```
  See Also:
  
  Constant Field Values
- MODEL_REF_PRESENTATION_NAME
```
static final int MODEL_REF_PRESENTATION_NAME
```
  See Also:
  
  Constant Field Values
- MODEL_REF_PRESENTATION_ID
```
static final int MODEL_REF_PRESENTATION_ID
```
  See Also:
  
  Constant Field Values
- MODEL_REF_PRESENTATION_ID_NAME
```
static final int MODEL_REF_PRESENTATION_ID_NAME
```
  See Also:
  
  Constant Field Values

Method Detail

getColumns
```
IGridDiagramColumn[] getColumns()
```

setColumns

void setColumns(IGridDiagramColumn[] aValues)

getScopeValueAsModelElement
```
IModelElement getScopeValueAsModelElement()
```
Deprecated. Replaced by #getScopeValueAsModelElements():IModelElement[]

getScopeValueAsModelElements

IModelElement[] getScopeValueAsModelElements()

setScopeValue
```
void setScopeValue(IModelElement aValue)
```
Deprecated. Replaced by #setScopeValues(IModelElement[])

setScopeValues

void setScopeValues(IModelElement[] aValues)

getScopeValueAsDiagram
```
IDiagramUIModel getScopeValueAsDiagram()
```
Deprecated. Replaced by #getScopeValueAsDiagrams():IDiagramUIModel[]

getScopeValueAsDiagrams

IDiagramUIModel[] getScopeValueAsDiagrams()

setScopeValue
```
void setScopeValue(IDiagramUIModel aValue)
```
Deprecated. Replaced by #setScopeValues(IDiagramUIModel[])

setScopeValues

void setScopeValues(IDiagramUIModel[] aValues)

refresh
```
void refresh()
```

setModelTypes

void setModelTypes(java.lang.String[] aBuiltInModelTypes)

getModelTypes
```
java.lang.String[] getModelTypes()
```

containsModelType

boolean containsModelType(java.lang.String aBuiltInModelType)

setGridDiagramAddress

void setGridDiagramAddress(java.lang.String gridDiagramAddress)

getGridDiagramAddress

java.lang.String getGridDiagramAddress()

setRowsAddress

void setRowsAddress(java.lang.String[] rowsAddress)

getRowsAddress
```
java.lang.String[] getRowsAddress()
```

setColumnsAddress

void setColumnsAddress(java.lang.String[] columnsAddress)

getColumnsAddress
```
java.lang.String[] getColumnsAddress()
```

setFilterText

void setFilterText(java.lang.String filterText)

getFilterText
```
java.lang.String getFilterText()
```

setScopeType
```
void setScopeType(int scopeType)
```

getScopeType
```
int getScopeType()
```

setScopeIncludeDependentProjects

void setScopeIncludeDependentProjects(boolean scopeIncludeDependentProjects)

isScopeIncludeDependentProjects

boolean isScopeIncludeDependentProjects()

setSortColumnInfosAddress

void setSortColumnInfosAddress(java.lang.String[] sortColumnInfosAddress)

getSortColumnInfosAddress

java.lang.String[] getSortColumnInfosAddress()

setFontSize
```
void setFontSize(int fontSize)
```

getFontSize
```
int getFontSize()
```

setModelRefPresentation

void setModelRefPresentation(int modelRefPresentation)

getModelRefPresentation
```
int getModelRefPresentation()
```

setScopeValues

void setScopeValues(java.lang.String[] scopeValues)

getScopeValues
```
java.lang.String[] getScopeValues()
```

Interface IGridDiagramUIModel

Field Summary

Fields inherited from interface com.vp.plugin.diagram.IDiagramUIModel

Method Summary

Methods inherited from interface com.vp.plugin.diagram.IDiagramUIModel

Field Detail

PROPERTY_COLUMNS

SHAPETYPE_DIAGRAM_INFO

SHAPETYPE_NOTE

SHAPETYPE_DIAGRAM_OVERVIEW

SHAPETYPE_CONSTRAINT

SHAPETYPE_CONTAINMENT

SHAPETYPE_VISIO_SHAPE

SHAPETYPE_GENERIC_SHAPE

SHAPETYPE_GENERIC_CONNECTOR

SHAPETYPE_ANCHOR

SCOPE_PROJECT

SCOPE_MODEL

SCOPE_ALL_DIAGRAMS

SCOPE_DIAGRAM

SCOPE_ALL_LABELS

SCOPE_LABEL

SCOPE_NO_MODEL

SCOPE_NO_DIAGRAM

SCOPE_NO_LABEL

PROPERTY_ROWS_ADDRESSES

PROPERTY_COLUMNS_ADDRESSES

PROPERTY_SCOPE_VALUES

PROPERTY_SORT_COLUMN_INFOS_ADDRESSES

PROPERTY_GRID_DIAGRAM_ADDRESS

PROPERTY_FILTER_TEXT

PROPERTY_SCOPE_TYPE

PROPERTY_SCOPE_INCLUDE_DEPENDENT_PROJECTS

PROPERTY_FONT_SIZE

PROPERTY_MODEL_REF_PRESENTATION

MODEL_REF_PRESENTATION_NAME

MODEL_REF_PRESENTATION_ID

MODEL_REF_PRESENTATION_ID_NAME

Method Detail

getColumns

setColumns

getScopeValueAsModelElement

getScopeValueAsModelElements

setScopeValue

setScopeValues

getScopeValueAsDiagram

getScopeValueAsDiagrams

setScopeValue

setScopeValues

refresh

setModelTypes

getModelTypes

containsModelType

setGridDiagramAddress

getGridDiagramAddress

setRowsAddress

getRowsAddress

setColumnsAddress

getColumnsAddress

setFilterText

getFilterText

setScopeType

getScopeType

setScopeIncludeDependentProjects

isScopeIncludeDependentProjects

setSortColumnInfosAddress

getSortColumnInfosAddress

setFontSize

getFontSize

setModelRefPresentation

getModelRefPresentation

setScopeValues

getScopeValues