IDiagramUIModel

All Known Subinterfaces:

IActivityDiagramUIModel, IAnalysisDiagramUIModel, IAnalysisItemDiagramUIModel, IArchiMateDiagramUIModel, IArchitectureRoadmapUIModel, IBlockDefinitionDiagramUIModel, IBrainstormUIModel, IBreakdownStructureUIModel, IBusinessMotivationModelDiagramUIModel, IBusinessProcessDiagramUIModel, IBusinessProcessReengineeringUIModel, IBusinessRuleEditorDiagramUIModel, IChartDiagramUIModel, IClassDiagramUIModel, ICMMNDiagramUIModel, ICommunicationDiagramUIModel, ICompetitorAnalysisUIModel, IComponentDiagramUIModel, ICompositeStructureDiagramUIModel, IConversationDiagramUIModel, ICRCCardDiagramUIModel, ICustomerJourneyMapUIModel, IDataFlowDiagramUIModel, IDataTableDiagramUIModel, IDecisionModelDiagramUIModel, IDefaultPackageDiagramUIModel, IDefaultParentModelDiagramUIModel, IDeploymentDiagramUIModel, IDocumentationCabinetUIModel, IDTBDecisionTableEditorDiagramUIModel, IEAFormDiagramUIModel, IEAProcessStepDiagramUIModel, IEJBDiagramUIModel, IEPCDiagramUIModel, IERDiagramUIModel, IETLTableDiagramUIModel, IFactDiagramUIModel, IFactTypeEditorDiagramUIModel, IFishboneDiagramUIModel, IFormUIModel, IFramedInteractionDiagramUIModel, IFreehandDiagram2UIModel, IFreehandDiagramUIModel, IGridDiagramUIModel, IImplementationDiagramUIModel, IInteractionDiagramUIModel, IInteractionOverviewDiagramUIModel, IInternalBlockDiagramUIModel, IMatrixDiagramUIModel, IMaturityAnalysisUIModel, IMigrationRoadmapUIModel, IMindMapDiagramUIModel, IObjectDiagramUIModel, IOrganizationChartUIModel, IORMDiagramUIModel, IOverviewDiagramUIModel, IPackageDiagramUIModel, IParametricDiagramUIModel, IPERTChartUIModel, IPMProcessMapUIModel, IProcessCanvasUIModel, IProcessMapDiagramUIModel, IProfileDiagramUIModel, IQualityControlCanvasUIModel, IReportDiagramUIModel, IRequirementDiagramUIModel, IRootCauseAnalysisUIModel, ISoaMLServiceCategorizationDiagramUIModel, ISoaMLServiceContractDiagramUIModel, ISoaMLServiceInterfaceDiagramUIModel, ISoaMLServiceParticipantDiagramUIModel, ISoaMLServicesArchitectureDiagramUIModel, IStateDiagramUIModel, ITabularUIModel, ITermEditorDiagramUIModel, ITextualAnalysisUIModel, ITimingDiagramUIModel, IUseCaseDescriptionDiagramUIModel, IUseCaseDiagramUIModel, IUserInterfaceDiagramUIModel, IUserStoryMapDiagramUIModel, IViewEditorDiagramUIModel, IWebDiagramUIModel, IWFAndroidDiagramUIModel, IWFAndroidPhoneDiagramUIModel, IWFAndroidTabletDiagramUIModel, IWFDesktopDiagramUIModel, IWFIOSDiagramUIModel, IWFIPadDiagramUIModel, IWFIPhoneDiagramUIModel, IWFWebDiagramUIModel, IWireflowDiagramUIModel, IWireframeDiagramUIModel, IWSDLDiagramUIModel, IZachmanDiagramUIModel
```
public interface IDiagramUIModel
```

Field Summary

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

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addDiagramElement(IDiagramElement diagramElement)`
`void`	`addDiagramListener(IDiagramListener listener)` Add listener on IDiagramUIModel.
`void`	`addReference(IReference reference)`
`void`	`closeDiagram()`
`int`	`commentCount()`
`java.util.Iterator`	`commentIterator()`
`IDiagramUIModelComment`	`createComment()`
`IDiagramElement`	`createDiagramElement(java.lang.String shapeType)`
`IDiagramElement`	`createDiagramElement(java.lang.String shapeType, boolean addToDiagram)`
`IDiagramLayer`	`createDiagramLayer(java.lang.String aLayerName)`
`void`	`delete()`
`int`	`diagramElementCount()`
`java.util.Iterator`	`diagramElementIterator()`
`void`	`fireModuleAddedDiagramElement(IDiagramElement diagramElement)`
`IDiagramLayer`	`getActiveDiagramLayer()`
`java.lang.String[]`	`getAllowShapeTypes()`
`IDiagramUIModelComment`	`getCommentAt(int index)`
`int`	`getConnectionPointStyle()`
`int`	`getConnectorLabelOrientation()`
`int`	`getConnectorLineJumps()`
`int`	`getConnectorLineJumpsSize()`
`int`	`getConnectorStyle()`
`long`	`getCreationTime()`
`java.lang.String[]`	`getCustomizedSortDiagramElementIds()`
`IDiagramLayer`	`getDefaultDiagramLayer()`
`java.awt.Color`	`getDiagramBackground()`
`int`	`getDiagramEditorHeight()` if isOpened(), get Height by this function
`int`	`getDiagramEditorWidth()` if isOpened(), get Width by this function
`IDiagramElement`	`getDiagramElementAt(int index)`
`IDiagramElement`	`getDiagramElementById(java.lang.String id)`
`IDiagramLayer[]`	`getDiagramLayers()`
`IDiagramListener[]`	`getDiagramListeners()` Listeners of IDiagramUIModel.
`IDiagramProperty`	`getDiagramPropertyByName(java.lang.String name)`
`java.lang.String`	`getDocumentation()`
`java.lang.String`	`getDocumentationWithReferenceModels()`
`java.awt.Color`	`getGridColor()`
`int`	`getGridHeight()`
`int`	`getGridWidth()`
`int`	`getHeight()`
`java.lang.String`	`getHtmlDocumentation()`
`java.lang.String`	`getHtmlDocumentationWithReferenceModels()`
`java.lang.String`	`getId()`
`long`	`getLastCommitted()` Date of last commit.
`java.lang.String`	`getLastCommittedUser()` User Email of last commit.
`java.lang.String`	`getLastCommittedUserName()` User Name of last commit.
`long`	`getLastModified()`
`java.lang.String`	`getLogicalViewType()`
`int`	`getModelElementNameAlignment()`
`java.lang.String`	`getName()`
`java.lang.String`	`getNickDocumentation()`
`java.lang.String`	`getNickDocumentationWithReferenceModels()`
`java.lang.String`	`getNickHtmlDocumentation()`
`java.lang.String`	`getNickHtmlDocumentationWithReferenceModels()`
`java.lang.String`	`getNickname()` Retrieve the nickname of this `IDiagramUIModel` for current nickname of project.
`int`	`getPaintConnectorThroughLabel()`
`IModelElement`	`getParentModel()`
`java.lang.String`	`getPmAuthor()`
`java.lang.String`	`getPmCreateDateTime()`
`IPMDifficulty`	`getPmDifficulty()`
`IPMDiscipline`	`getPmDiscipline()`
`IPMIteration`	`getPmIteration()`
`java.lang.String`	`getPmLastModified()`
`IPMPhase`	`getPmPhase()`
`IPMPriority`	`getPmPriority()`
`IPMStatus`	`getPmStatus()`
`IPMVersion`	`getPmVersion()`
`IProject`	`getProject()`
`int`	`getQualityScore()`
`IReference`	`getReferenceByIndex(int index)`
`IDiagramElement[]`	`getSelectedDiagramElement()`
`IDiagramElement[]`	`getSelectedDiagramElement(java.lang.String shapeType)`
`int`	`getShowActivityStateNodeCaption()`
`int`	`getShowConnectorName()`
`int`	`getShowPackageNameStyle()`
`java.lang.String`	`getType()`
`java.lang.String`	`getUserID()`
`IViewpoint`	`getViewpoint()`
`int`	`getWidth()`
`int`	`getX()`
`int`	`getY()`
`double`	`getZoomRatio()`
`IShapeGroup`	`group(IShapeGroupable[] aGroupables)`
`int`	`groupButtonInfoCount()`
`int`	`indexOfComment(IDiagramUIModelComment comment)`
`int`	`indexOfDiagramElement(IDiagramElement diagramElement)`
`boolean`	`isAlignToGrid()`
`boolean`	`isAllowLayout()`
`boolean`	`isAllowShapeType(java.lang.String shapeType)`
`boolean`	`isAlwaysShowReferenceAndSubdiagramResource()`
`boolean`	`isAutoFitShapesSize()`
`boolean`	`isDiagramElementEmpty()`
`boolean`	`isEditable()`
`boolean`	`isFollowDiagramParentElement()`
`boolean`	`isGlobalPaletteOption()`
`boolean`	`isGridVisible()`
`boolean`	`isGroupButtonInfoEmpty()`
`boolean`	`isInitializeDiagramForCreate()`
`boolean`	`isLoading()` Determines whether the Diagram is loading from project
`boolean`	`isMaximized()`
`boolean`	`isOpened()`
`boolean`	`isRequestValidateSnapToGrid()`
`boolean`	`isShowConstraints()`
`boolean`	`isShowStereotypes()`
`boolean`	`isShowTaggedValues()`
`boolean`	`isSubDiagram()`
`boolean`	`isSupportedInProductEdition()`
`void`	`layoutDiagramElement(IDiagramElement[] elements)`
`void`	`modified()`
`void`	`realCloseDiagram()`
`int`	`referenceCount()`
`java.util.Iterator`	`referenceIterator()` Returns an iterator over the model elements `IReference`.
`void`	`removeComment(IDiagramUIModelComment comment)`
`void`	`removeDiagramElement(IDiagramElement diagramElement)` Deprecated.
`void`	`removeDiagramElementAt(int index)` Deprecated.
`void`	`removeDiagramLayer(IDiagramLayer aLayer)`
`void`	`removeDiagramListener(IDiagramListener listener)` Remove listener from IDiagramUIModel
`void`	`removeGroupButtonInfoAt(int index)`
`void`	`removeReference(IReference reference)`
`void`	`removeReferenceByIndex(int index)`
`void`	`setActiveDiagramLayer(IDiagramLayer aLayer)`
`void`	`setAlignToGrid(boolean alignToGrid)`
`void`	`setAlwaysShowReferenceAndSubdiagramResource(boolean alwaysShowReferenceAndSubdiagramResource)`
`void`	`setAutoFitShapesSize(boolean autoFitShapesSize)`
`void`	`setBounds(int x, int y, int w, int h)`
`void`	`setConnectionPointStyle(int connectionPointStyle)`
`void`	`setConnectorLabelOrientation(int connectorLabelOrientation)`
`void`	`setConnectorLineJumps(int connectorLineJumps)`
`void`	`setConnectorLineJumpsSize(int connectorLineJumpsSize)`
`void`	`setConnectorStyle(int connectorStyle)`
`void`	`setCreationTime(long creationTime)` Deprecated. Date time of Creation/LastModified is non-editable
`void`	`setDiagramBackground(java.awt.Color diagramBackground)`
`void`	`setDocumentation(java.lang.String documentation)`
`void`	`setEditable(boolean editable)`
`void`	`setFireModified(boolean fire)`
`void`	`setFollowDiagramParentElement(boolean followDiagramParentElement)`
`void`	`setGlobalPaletteOption(boolean globalPaletteOption)`
`void`	`setGridColor(java.awt.Color gridColor)`
`void`	`setGridHeight(int gridHeight)`
`void`	`setGridVisible(boolean gridVisible)`
`void`	`setGridWidth(int gridWidth)`
`void`	`setHtmlDocumentation(java.lang.String htmlDocumentation)`
`void`	`setInitializeDiagramForCreate(boolean initializeDiagramForCreate)`
`void`	`setLastModified(long lastModified)` Deprecated. Date time of Creation/LastModified is non-editable
`void`	`setMaximized(boolean maximized)`
`void`	`setModelElementNameAlignment(int modelElementNameAlignment)`
`void`	`setModelPropertyAsBoolean(java.lang.String name, boolean value)`
`void`	`setModelPropertyAsColor(java.lang.String name, java.awt.Color value)`
`void`	`setModelPropertyAsDouble(java.lang.String name, double value)`
`void`	`setModelPropertyAsInt(java.lang.String name, int value)`
`void`	`setModelPropertyAsString(java.lang.String name, java.lang.String value)`
`void`	`setName(java.lang.String name)`
`void`	`setNickDocumentation(java.lang.String documentation)`
`void`	`setNickHtmlDocumentation(java.lang.String htmlDocumentation)`
`void`	`setNickname(java.lang.String aName)` Set the nickname of this `IDiagramUIModel` for current nickname of project.
`void`	`setPaintConnectorThroughLabel(int paintConnectorThroughLabel)`
`void`	`setPmAuthor(java.lang.String pmAuthor)`
`void`	`setPmCreateDateTime(java.lang.String pmCreateDateTime)`
`void`	`setPmDifficulty(IPMDifficulty pmDifficulty)`
`void`	`setPmDiscipline(IPMDiscipline pmDiscipline)`
`void`	`setPmIteration(IPMIteration pmIteration)`
`void`	`setPmLastModified(java.lang.String pmLastModified)`
`void`	`setPmPhase(IPMPhase pmPhase)`
`void`	`setPmPriority(IPMPriority pmPriority)`
`void`	`setPmStatus(IPMStatus pmStatus)`
`void`	`setPmVersion(IPMVersion pmVersion)`
`void`	`setQualityScore(int aQualityScore)`
`void`	`setRequestValidateSnapToGrid(boolean requestValidateSnapToGrid)`
`void`	`setShowActivityStateNodeCaption(int showActivityStateNodeCaption)`
`void`	`setShowConnectorName(int showConnectorName)`
`void`	`setShowConstraints(boolean showConstraints)`
`void`	`setShowPackageNameStyle(int showPackageNameStyle)`
`void`	`setShowStereotypes(boolean showStereotypes)`
`void`	`setShowTaggedValues(boolean showTaggedValues)`
`void`	`setSpecialZoom(int specialZoom)`
`void`	`setUserID(java.lang.String userID)`
`void`	`setZoomRatio(double zoomRatio)`
`IDiagramUIModelComment[]`	`toCommentArray()`
`IComment[]`	`toCommentModelElementArray()` Deprecated.
`IConnectorUIModel[]`	`toConnectorUIModelArray()`
`IDiagramElement[]`	`toDiagramElementArray()`
`IDiagramElement[]`	`toDiagramElementArray(java.lang.String shapeType)`
`IDiagramProperty[]`	`toDiagramPropertyArray()`
`java.lang.String`	`toPropertiesString()`
`IReference[]`	`toReferenceArray()`
`IShapeUIModel[]`	`toShapeUIModelArray()`

Field Detail
- MAX_PREVIEW_IMAGE_SIZE
```
static final java.awt.Dimension MAX_PREVIEW_IMAGE_SIZE
```
- MAX_ZOOM
```
static final double MAX_ZOOM
```
  See Also:
  
  Constant Field Values
- PROPERTY_OPENED
```
static final java.lang.String PROPERTY_OPENED
```
  See Also:
  
  Constant Field Values
- PROPERTY_ZOOMRATIO
```
static final java.lang.String PROPERTY_ZOOMRATIO
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- PROPERTY_REFERENCE_CONTAINER_ID
```
static final java.lang.String PROPERTY_REFERENCE_CONTAINER_ID
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_STATUS_ID
```
@Deprecated
static final java.lang.String PROPERTY_PM_STATUS_ID
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- PROPERTY_PM_DIFFICULTY_ID
```
@Deprecated
static final java.lang.String PROPERTY_PM_DIFFICULTY_ID
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- PROPERTY_PM_PRIORITY_ID
```
@Deprecated
static final java.lang.String PROPERTY_PM_PRIORITY_ID
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- PROPERTY_PM_VERSION_ID
```
@Deprecated
static final java.lang.String PROPERTY_PM_VERSION_ID
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- PROPERTY_PM_ITERATION_ID
```
@Deprecated
static final java.lang.String PROPERTY_PM_ITERATION_ID
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- PROPERTY_PM_PHASE_ID
```
@Deprecated
static final java.lang.String PROPERTY_PM_PHASE_ID
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- PROPERTY_PM_DISCIPLINE_ID
```
@Deprecated
static final java.lang.String PROPERTY_PM_DISCIPLINE_ID
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- PROPERTY_PM_STATUS
```
static final java.lang.String PROPERTY_PM_STATUS
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_DIFFICULTY
```
static final java.lang.String PROPERTY_PM_DIFFICULTY
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_PRIORITY
```
static final java.lang.String PROPERTY_PM_PRIORITY
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_VERSION
```
static final java.lang.String PROPERTY_PM_VERSION
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_ITERATION
```
static final java.lang.String PROPERTY_PM_ITERATION
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_PHASE
```
static final java.lang.String PROPERTY_PM_PHASE
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_DISCIPLINE
```
static final java.lang.String PROPERTY_PM_DISCIPLINE
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_AUTHOR
```
static final java.lang.String PROPERTY_PM_AUTHOR
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_CREATE_DATE_TIME
```
static final java.lang.String PROPERTY_PM_CREATE_DATE_TIME
```
  See Also:
  
  Constant Field Values
- PROPERTY_PM_LAST_MODIFIED
```
static final java.lang.String PROPERTY_PM_LAST_MODIFIED
```
  See Also:
  
  Constant Field Values
- PROPERTY_SHOW_PACKAGE_NAME_STYLE
```
static final java.lang.String PROPERTY_SHOW_PACKAGE_NAME_STYLE
```
  See Also:
  
  Constant Field Values
- PROPERTY_SHOW_CONNECTOR_NAME
```
static final java.lang.String PROPERTY_SHOW_CONNECTOR_NAME
```
  See Also:
  
  Constant Field Values
- PROPERTY_PAINT_CONNECTOR_THROUGH_LABEL
```
static final java.lang.String PROPERTY_PAINT_CONNECTOR_THROUGH_LABEL
```
  See Also:
  
  Constant Field Values
- PROPERTY_TRANSIT_FROM
```
static final java.lang.String PROPERTY_TRANSIT_FROM
```
  See Also:
  
  Constant Field Values
- PROPERTY_TRANSIT_TO
```
static final java.lang.String PROPERTY_TRANSIT_TO
```
  See Also:
  
  Constant Field Values
- WITHIN_PACKAGE_BODY
```
static final int WITHIN_PACKAGE_BODY
```
  See Also:
  
  Constant Field Values
- WITHIN_PACKAGE_TAB
```
static final int WITHIN_PACKAGE_TAB
```
  See Also:
  
  Constant Field Values
- SHOW_PACKAGE_NAME_STYLE_FOLLOW_DIAGRAM
```
static final int SHOW_PACKAGE_NAME_STYLE_FOLLOW_DIAGRAM
```
  See Also:
  
  Constant Field Values
- SHOW_CONNECTOR_NAME_YES
```
static final int SHOW_CONNECTOR_NAME_YES
```
  See Also:
  
  Constant Field Values
- SHOW_CONNECTOR_NAME_NO
```
static final int SHOW_CONNECTOR_NAME_NO
```
  See Also:
  
  Constant Field Values
- SHOW_CONNECTOR_NAME_FOLLOW_DIAGRAM
```
static final int SHOW_CONNECTOR_NAME_FOLLOW_DIAGRAM
```
  See Also:
  
  Constant Field Values
- PAINT_CONNECTOR_THROUGH_LABEL_NO
```
static final int PAINT_CONNECTOR_THROUGH_LABEL_NO
```
  See Also:
  
  Constant Field Values
- PAINT_CONNECTOR_THROUGH_LABEL_YES
```
static final int PAINT_CONNECTOR_THROUGH_LABEL_YES
```
  See Also:
  
  Constant Field Values
- PAINT_CONNECTOR_THROUGH_LABEL_FOLLOW_DIAGRAM
```
static final int PAINT_CONNECTOR_THROUGH_LABEL_FOLLOW_DIAGRAM
```
  See Also:
  
  Constant Field Values
- PROPERTY_SHOW_ACTIVITY_STATE_NODE_CAPTION
```
static final java.lang.String PROPERTY_SHOW_ACTIVITY_STATE_NODE_CAPTION
```
  See Also:
  
  Constant Field Values
- PROPERTY_EDITABLE
```
static final java.lang.String PROPERTY_EDITABLE
```
  See Also:
  
  Constant Field Values
- PROPERTY_REQUEST_LAYOUT_TYPE
```
static final java.lang.String PROPERTY_REQUEST_LAYOUT_TYPE
```
  See Also:
  
  Constant Field Values
- PROPERTY_FOLLOW_DIAGRAM_PARENT_ELEMENT
```
static final java.lang.String PROPERTY_FOLLOW_DIAGRAM_PARENT_ELEMENT
```
  See Also:
  
  Constant Field Values
- PROPERTY_AUTO_FIT_SHAPES_SIZE
```
static final java.lang.String PROPERTY_AUTO_FIT_SHAPES_SIZE
```
  See Also:
  
  Constant Field Values
- PROPERTY_SHOW_TAGGED_VALUES
```
static final java.lang.String PROPERTY_SHOW_TAGGED_VALUES
```
  See Also:
  
  Constant Field Values
- PROPERTY_SHOW_STEREOTYPES
```
static final java.lang.String PROPERTY_SHOW_STEREOTYPES
```
  See Also:
  
  Constant Field Values
- PROPERTY_SHOW_CONSTRAINTS
```
static final java.lang.String PROPERTY_SHOW_CONSTRAINTS
```
  See Also:
  
  Constant Field Values
- PROPERTY_ALIGN_TO_GRID
```
static final java.lang.String PROPERTY_ALIGN_TO_GRID
```
  See Also:
  
  Constant Field Values
- PROPERTY_GRID_VISIBLE
```
static final java.lang.String PROPERTY_GRID_VISIBLE
```
  See Also:
  
  Constant Field Values
- PROPERTY_GRID_WIDTH
```
static final java.lang.String PROPERTY_GRID_WIDTH
```
  See Also:
  
  Constant Field Values
- PROPERTY_GRID_HEIGHT
```
static final java.lang.String PROPERTY_GRID_HEIGHT
```
  See Also:
  
  Constant Field Values
- PROPERTY_GRID_COLOR
```
static final java.lang.String PROPERTY_GRID_COLOR
```
  See Also:
  
  Constant Field Values
- PROPERTY_DIAGRAM_BACKGROUND
```
static final java.lang.String PROPERTY_DIAGRAM_BACKGROUND
```
  See Also:
  
  Constant Field Values
- PROPERTY_CONNECTOR_STYLE
```
static final java.lang.String PROPERTY_CONNECTOR_STYLE
```
  See Also:
  
  Constant Field Values
- PROPERTY_CONNECTOR_LINE_JUMPS
```
static final java.lang.String PROPERTY_CONNECTOR_LINE_JUMPS
```
  See Also:
  
  Constant Field Values
- PROPERTY_CONNECTOR_LINE_JUMPS_SIZE
```
static final java.lang.String PROPERTY_CONNECTOR_LINE_JUMPS_SIZE
```
  See Also:
  
  Constant Field Values
- PROPERTY_CONNECTION_POINT_STYLE
```
static final java.lang.String PROPERTY_CONNECTION_POINT_STYLE
```
  See Also:
  
  Constant Field Values
- PROPERTY_CONNECTOR_LABEL_ORIENTATION
```
static final java.lang.String PROPERTY_CONNECTOR_LABEL_ORIENTATION
```
  See Also:
  
  Constant Field Values
- PROPERTY_MODEL_ELEMENT_NAME_ALIGNMENT
```
static final java.lang.String PROPERTY_MODEL_ELEMENT_NAME_ALIGNMENT
```
  See Also:
  
  Constant Field Values
- PROPERTY_ZOOM_RATIO
```
static final java.lang.String PROPERTY_ZOOM_RATIO
```
  See Also:
  
  Constant Field Values
- SPECIAL_ZOOM_FIT_PAGE
```
static final int SPECIAL_ZOOM_FIT_PAGE
```
  See Also:
  
  Constant Field Values
- SPECIAL_ZOOM_FIT_PAGE_WIDTH
```
static final int SPECIAL_ZOOM_FIT_PAGE_WIDTH
```
  See Also:
  
  Constant Field Values
- SPECIAL_ZOOM_FIT_PAGE_HEIGHT
```
static final int SPECIAL_ZOOM_FIT_PAGE_HEIGHT
```
  See Also:
  
  Constant Field Values
- PROPERTY_MAXIMIZED
```
static final java.lang.String PROPERTY_MAXIMIZED
```
  See Also:
  
  Constant Field Values
- PROPERTY_X
```
static final java.lang.String PROPERTY_X
```
  See Also:
  
  Constant Field Values
- PROPERTY_Y
```
static final java.lang.String PROPERTY_Y
```
  See Also:
  
  Constant Field Values
- PROPERTY_WIDTH
```
static final java.lang.String PROPERTY_WIDTH
```
  See Also:
  
  Constant Field Values
- PROPERTY_HEIGHT
```
static final java.lang.String PROPERTY_HEIGHT
```
  See Also:
  
  Constant Field Values
- PROPERTY_QUALITY_SCORE
```
static final java.lang.String PROPERTY_QUALITY_SCORE
```
  See Also:
  
  Constant Field Values
- PROPERTY_LAST_VIEW_X
```
static final java.lang.String PROPERTY_LAST_VIEW_X
```
  See Also:
  
  Constant Field Values
- PROPERTY_LAST_VIEW_Y
```
static final java.lang.String PROPERTY_LAST_VIEW_Y
```
  See Also:
  
  Constant Field Values
- PROPERTY_QP_TRANSLATE_X
```
static final java.lang.String PROPERTY_QP_TRANSLATE_X
```
  See Also:
  
  Constant Field Values
- PROPERTY_QP_TRANSLATE_Y
```
static final java.lang.String PROPERTY_QP_TRANSLATE_Y
```
  See Also:
  
  Constant Field Values
- PROPERTY_QP_SCALE_X
```
static final java.lang.String PROPERTY_QP_SCALE_X
```
  See Also:
  
  Constant Field Values
- PROPERTY_QP_SCALE_Y
```
static final java.lang.String PROPERTY_QP_SCALE_Y
```
  See Also:
  
  Constant Field Values
- PROPERTY_CREATION_TIME
```
static final java.lang.String PROPERTY_CREATION_TIME
```
  See Also:
  
  Constant Field Values
- PROPERTY_LAST_MODIFIED
```
static final java.lang.String PROPERTY_LAST_MODIFIED
```
  See Also:
  
  Constant Field Values
- PROPERTY_DIAGRAM_PREVIEW_DATA
```
static final java.lang.String PROPERTY_DIAGRAM_PREVIEW_DATA
```
  See Also:
  
  Constant Field Values
- PROPERTY_GLOBAL_PALETTE_OPTION
```
static final java.lang.String PROPERTY_GLOBAL_PALETTE_OPTION
```
  See Also:
  
  Constant Field Values
- PROPERTY_ALWAYS_SHOW_REFERENCE_AND_SUBDIAGRAM_RESOURCE
```
static final java.lang.String PROPERTY_ALWAYS_SHOW_REFERENCE_AND_SUBDIAGRAM_RESOURCE
```
  See Also:
  
  Constant Field Values
- PROPERTY_LOCKED
```
static final java.lang.String PROPERTY_LOCKED
```
  See Also:
  
  Constant Field Values
- PROPERTY_INITIALIZE_DIAGRAM_FOR_CREATE
```
static final java.lang.String PROPERTY_INITIALIZE_DIAGRAM_FOR_CREATE
```
  See Also:
  
  Constant Field Values
- PROPERTY_REQUEST_VALIDATE_SNAP_TO_GRID
```
static final java.lang.String PROPERTY_REQUEST_VALIDATE_SNAP_TO_GRID
```
  See Also:
  
  Constant Field Values
- PROPERTY_HIDDEN_DIAGRAM_ELEMENT_IDS
```
static final java.lang.String PROPERTY_HIDDEN_DIAGRAM_ELEMENT_IDS
```
  See Also:
  
  Constant Field Values
- PROPERTY_PARENT_MODEL
```
static final java.lang.String PROPERTY_PARENT_MODEL
```
  See Also:
  
  Constant Field Values
- PROPERTY_NAME
```
static final java.lang.String PROPERTY_NAME
```
  See Also:
  
  Constant Field Values
- PROPERTY_ID
```
static final java.lang.String PROPERTY_ID
```
  See Also:
  
  Constant Field Values
- PROPERTY_ALIGNTOGRID
```
static final java.lang.String PROPERTY_ALIGNTOGRID
```
  See Also:
  
  Constant Field Values
- PROPERTY_GRIDVISIBLE
```
static final java.lang.String PROPERTY_GRIDVISIBLE
```
  See Also:
  
  Constant Field Values
- PROPERTY_GRIDWIDTH
```
static final java.lang.String PROPERTY_GRIDWIDTH
```
  See Also:
  
  Constant Field Values
- PROPERTY_GRIDHEIGHT
```
static final java.lang.String PROPERTY_GRIDHEIGHT
```
  See Also:
  
  Constant Field Values
- PROPERTY_TYPE
```
static final java.lang.String PROPERTY_TYPE
```
  See Also:
  
  Constant Field Values
- PROPERTY_GRIDCOLOR
```
static final java.lang.String PROPERTY_GRIDCOLOR
```
  See Also:
  
  Constant Field Values
- PROPERTY_DIAGRAMBACKGROUND
```
static final java.lang.String PROPERTY_DIAGRAMBACKGROUND
```
  See Also:
  
  Constant Field Values
- PROPERTY_HTML_DOCUMENTATION
```
static final java.lang.String PROPERTY_HTML_DOCUMENTATION
```
  See Also:
  
  Constant Field Values
- PROPERTY_DOCUMENTATION
```
static final java.lang.String PROPERTY_DOCUMENTATION
```
  See Also:
  
  Constant Field Values
- PROPERTY_NICK_DOCUMENTATION
```
static final java.lang.String PROPERTY_NICK_DOCUMENTATION
```
  See Also:
  
  Constant Field Values
- PROPERTY_NICKNAME
```
static final java.lang.String PROPERTY_NICKNAME
```
  See Also:
  
  Constant Field Values
- PROPERTY_NICK_HTML_DOCUMENTATION
```
static final java.lang.String PROPERTY_NICK_HTML_DOCUMENTATION
```
  See Also:
  
  Constant Field Values
- PROPERTY_SHOW_ALLOCATED_FROM
```
static final java.lang.String PROPERTY_SHOW_ALLOCATED_FROM
```
  See Also:
  
  Constant Field Values
- PROPERTY_SHOW_ALLOCATED_TO
```
static final java.lang.String PROPERTY_SHOW_ALLOCATED_TO
```
  See Also:
  
  Constant Field Values
- PROPERTY_HIDE_EMPTY_TAGGED_VALUES
```
static final java.lang.String PROPERTY_HIDE_EMPTY_TAGGED_VALUES
```
  See Also:
  
  Constant Field Values

Method Detail

getId
```
java.lang.String getId()
```

getType
```
java.lang.String getType()
```

setName
```
void setName(java.lang.String name)
```

getName
```
java.lang.String getName()
```

setNickname
```
void setNickname(java.lang.String aName)
```
Set the nickname of this IDiagramUIModel for current nickname of project. An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234

Parameters:

aName - the new nickname of this IDiagramUIModel.

getNickname
```
java.lang.String getNickname()
```
Retrieve the nickname of this IDiagramUIModel for current nickname of project. An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234

Returns:

the nickname of this IDiagramUIModel.

setDocumentation

void setDocumentation(java.lang.String documentation)

getDocumentation
```
java.lang.String getDocumentation()
```

getDocumentationWithReferenceModels

java.lang.String getDocumentationWithReferenceModels()

setHtmlDocumentation

void setHtmlDocumentation(java.lang.String htmlDocumentation)

getHtmlDocumentation

java.lang.String getHtmlDocumentation()

getHtmlDocumentationWithReferenceModels

java.lang.String getHtmlDocumentationWithReferenceModels()

setNickDocumentation

void setNickDocumentation(java.lang.String documentation)

getNickDocumentation

java.lang.String getNickDocumentation()

getNickDocumentationWithReferenceModels

java.lang.String getNickDocumentationWithReferenceModels()

setNickHtmlDocumentation

void setNickHtmlDocumentation(java.lang.String htmlDocumentation)

getNickHtmlDocumentation

java.lang.String getNickHtmlDocumentation()

getNickHtmlDocumentationWithReferenceModels

java.lang.String getNickHtmlDocumentationWithReferenceModels()

setUserID

void setUserID(java.lang.String userID)

getUserID
```
java.lang.String getUserID()
```

getWidth
```
int getWidth()
```

getHeight
```
int getHeight()
```

getX
```
int getX()
```

getY
```
int getY()
```

setBounds

void setBounds(int x,
               int y,
               int w,
               int h)

getDiagramEditorWidth
```
int getDiagramEditorWidth()
```
if isOpened(), get Width by this function

getDiagramEditorHeight
```
int getDiagramEditorHeight()
```
if isOpened(), get Height by this function

isOpened
```
boolean isOpened()
```

isAllowShapeType

boolean isAllowShapeType(java.lang.String shapeType)

getAllowShapeTypes

java.lang.String[] getAllowShapeTypes()

createDiagramElement

IDiagramElement createDiagramElement(java.lang.String shapeType)

createDiagramElement

IDiagramElement createDiagramElement(java.lang.String shapeType,
                                     boolean addToDiagram)

toShapeUIModelArray
```
IShapeUIModel[] toShapeUIModelArray()
```

toConnectorUIModelArray

IConnectorUIModel[] toConnectorUIModelArray()

toDiagramElementArray

IDiagramElement[] toDiagramElementArray()

toDiagramElementArray

IDiagramElement[] toDiagramElementArray(java.lang.String shapeType)

diagramElementIterator

java.util.Iterator diagramElementIterator()

isDiagramElementEmpty
```
boolean isDiagramElementEmpty()
```

addDiagramElement

boolean addDiagramElement(IDiagramElement diagramElement)

removeDiagramElement

void removeDiagramElement(IDiagramElement diagramElement)

Deprecated.

removeDiagramElementAt

void removeDiagramElementAt(int index)

Deprecated.

diagramElementCount
```
int diagramElementCount()
```

getDiagramElementAt

IDiagramElement getDiagramElementAt(int index)

indexOfDiagramElement

int indexOfDiagramElement(IDiagramElement diagramElement)

getDiagramElementById

IDiagramElement getDiagramElementById(java.lang.String id)

fireModuleAddedDiagramElement

void fireModuleAddedDiagramElement(IDiagramElement diagramElement)

getSelectedDiagramElement

IDiagramElement[] getSelectedDiagramElement()

getSelectedDiagramElement

IDiagramElement[] getSelectedDiagramElement(java.lang.String shapeType)

modified
```
void modified()
```

setFireModified
```
void setFireModified(boolean fire)
```

setModelPropertyAsString

void setModelPropertyAsString(java.lang.String name,
                              java.lang.String value)

setModelPropertyAsBoolean

void setModelPropertyAsBoolean(java.lang.String name,
                               boolean value)

setModelPropertyAsInt

void setModelPropertyAsInt(java.lang.String name,
                           int value)

setModelPropertyAsColor

void setModelPropertyAsColor(java.lang.String name,
                             java.awt.Color value)

setModelPropertyAsDouble

void setModelPropertyAsDouble(java.lang.String name,
                              double value)

getDiagramPropertyByName

IDiagramProperty getDiagramPropertyByName(java.lang.String name)

toDiagramPropertyArray

IDiagramProperty[] toDiagramPropertyArray()

setShowPackageNameStyle

void setShowPackageNameStyle(int showPackageNameStyle)

getShowPackageNameStyle
```
int getShowPackageNameStyle()
```

setShowConnectorName

void setShowConnectorName(int showConnectorName)

getShowConnectorName
```
int getShowConnectorName()
```

setPaintConnectorThroughLabel

void setPaintConnectorThroughLabel(int paintConnectorThroughLabel)

getPaintConnectorThroughLabel
```
int getPaintConnectorThroughLabel()
```

setShowActivityStateNodeCaption

void setShowActivityStateNodeCaption(int showActivityStateNodeCaption)

getShowActivityStateNodeCaption
```
int getShowActivityStateNodeCaption()
```

setEditable
```
void setEditable(boolean editable)
```

isEditable
```
boolean isEditable()
```

setFollowDiagramParentElement

void setFollowDiagramParentElement(boolean followDiagramParentElement)

isFollowDiagramParentElement
```
boolean isFollowDiagramParentElement()
```

setAutoFitShapesSize

void setAutoFitShapesSize(boolean autoFitShapesSize)

isAutoFitShapesSize
```
boolean isAutoFitShapesSize()
```

setShowTaggedValues

void setShowTaggedValues(boolean showTaggedValues)

isShowTaggedValues
```
boolean isShowTaggedValues()
```

setShowStereotypes

void setShowStereotypes(boolean showStereotypes)

isShowStereotypes
```
boolean isShowStereotypes()
```

setShowConstraints

void setShowConstraints(boolean showConstraints)

isShowConstraints
```
boolean isShowConstraints()
```

setAlignToGrid

void setAlignToGrid(boolean alignToGrid)

isAlignToGrid
```
boolean isAlignToGrid()
```

setGridVisible

void setGridVisible(boolean gridVisible)

isGridVisible
```
boolean isGridVisible()
```

setGridWidth
```
void setGridWidth(int gridWidth)
```

getGridWidth
```
int getGridWidth()
```

setGridHeight
```
void setGridHeight(int gridHeight)
```

getGridHeight
```
int getGridHeight()
```

setGridColor

void setGridColor(java.awt.Color gridColor)

getGridColor
```
java.awt.Color getGridColor()
```

setDiagramBackground

void setDiagramBackground(java.awt.Color diagramBackground)

getDiagramBackground
```
java.awt.Color getDiagramBackground()
```

setConnectorStyle

void setConnectorStyle(int connectorStyle)

getConnectorStyle
```
int getConnectorStyle()
```

setConnectorLineJumps

void setConnectorLineJumps(int connectorLineJumps)

getConnectorLineJumps
```
int getConnectorLineJumps()
```

setConnectorLineJumpsSize

void setConnectorLineJumpsSize(int connectorLineJumpsSize)

getConnectorLineJumpsSize
```
int getConnectorLineJumpsSize()
```

setConnectionPointStyle

void setConnectionPointStyle(int connectionPointStyle)

getConnectionPointStyle
```
int getConnectionPointStyle()
```

setConnectorLabelOrientation

void setConnectorLabelOrientation(int connectorLabelOrientation)

getConnectorLabelOrientation
```
int getConnectorLabelOrientation()
```

setModelElementNameAlignment

void setModelElementNameAlignment(int modelElementNameAlignment)

getModelElementNameAlignment
```
int getModelElementNameAlignment()
```

setZoomRatio
```
void setZoomRatio(double zoomRatio)
```

getZoomRatio
```
double getZoomRatio()
```

setSpecialZoom
```
void setSpecialZoom(int specialZoom)
```

setMaximized
```
void setMaximized(boolean maximized)
```

isMaximized
```
boolean isMaximized()
```

setCreationTime
```
void setCreationTime(long creationTime)
```
Deprecated. Date time of Creation/LastModified is non-editable

getCreationTime
```
long getCreationTime()
```

setLastModified
```
void setLastModified(long lastModified)
```
Deprecated. Date time of Creation/LastModified is non-editable

getLastModified
```
long getLastModified()
```

getLastCommitted
```
long getLastCommitted()
```
Date of last commit.

getLastCommittedUser
```
java.lang.String getLastCommittedUser()
```
User Email of last commit.

getLastCommittedUserName
```
java.lang.String getLastCommittedUserName()
```
User Name of last commit.

setQualityScore

void setQualityScore(int aQualityScore)

getQualityScore
```
int getQualityScore()
```

getParentModel
```
IModelElement getParentModel()
```

isSubDiagram
```
boolean isSubDiagram()
```

setGlobalPaletteOption

void setGlobalPaletteOption(boolean globalPaletteOption)

isGlobalPaletteOption
```
boolean isGlobalPaletteOption()
```

setAlwaysShowReferenceAndSubdiagramResource

void setAlwaysShowReferenceAndSubdiagramResource(boolean alwaysShowReferenceAndSubdiagramResource)

isAlwaysShowReferenceAndSubdiagramResource

boolean isAlwaysShowReferenceAndSubdiagramResource()

setInitializeDiagramForCreate

void setInitializeDiagramForCreate(boolean initializeDiagramForCreate)

isInitializeDiagramForCreate
```
boolean isInitializeDiagramForCreate()
```

setRequestValidateSnapToGrid

void setRequestValidateSnapToGrid(boolean requestValidateSnapToGrid)

isRequestValidateSnapToGrid
```
boolean isRequestValidateSnapToGrid()
```

setPmStatus
```
void setPmStatus(IPMStatus pmStatus)
```

getPmStatus
```
IPMStatus getPmStatus()
```

setPmDifficulty

void setPmDifficulty(IPMDifficulty pmDifficulty)

getPmDifficulty
```
IPMDifficulty getPmDifficulty()
```

setPmPriority

void setPmPriority(IPMPriority pmPriority)

getPmPriority
```
IPMPriority getPmPriority()
```

setPmVersion

void setPmVersion(IPMVersion pmVersion)

getPmVersion
```
IPMVersion getPmVersion()
```

setPmIteration

void setPmIteration(IPMIteration pmIteration)

getPmIteration
```
IPMIteration getPmIteration()
```

setPmPhase
```
void setPmPhase(IPMPhase pmPhase)
```

getPmPhase
```
IPMPhase getPmPhase()
```

setPmDiscipline

void setPmDiscipline(IPMDiscipline pmDiscipline)

getPmDiscipline
```
IPMDiscipline getPmDiscipline()
```

setPmAuthor

void setPmAuthor(java.lang.String pmAuthor)

getPmAuthor
```
java.lang.String getPmAuthor()
```

setPmCreateDateTime

void setPmCreateDateTime(java.lang.String pmCreateDateTime)

getPmCreateDateTime
```
java.lang.String getPmCreateDateTime()
```

setPmLastModified

void setPmLastModified(java.lang.String pmLastModified)

getPmLastModified
```
java.lang.String getPmLastModified()
```

getLogicalViewType
```
java.lang.String getLogicalViewType()
```

removeGroupButtonInfoAt

void removeGroupButtonInfoAt(int index)

groupButtonInfoCount
```
int groupButtonInfoCount()
```

isGroupButtonInfoEmpty
```
boolean isGroupButtonInfoEmpty()
```

isAllowLayout
```
boolean isAllowLayout()
```

layoutDiagramElement

void layoutDiagramElement(IDiagramElement[] elements)

addDiagramListener
```
void addDiagramListener(IDiagramListener listener)
```
Add listener on IDiagramUIModel.

Parameters:

listener - listener of IDiagramUIModel

See Also:

IDiagramListener, IDiagramListener2

removeDiagramListener
```
void removeDiagramListener(IDiagramListener listener)
```
Remove listener from IDiagramUIModel

Parameters:

listener - listener of IDiagramUIModel

See Also:

IDiagramListener, IDiagramListener2

getDiagramListeners
```
IDiagramListener[] getDiagramListeners()
```
Listeners of IDiagramUIModel.

Returns:

listeners of IDiagramUIModel

See Also:

IDiagramListener, IDiagramListener2

delete
```
void delete()
```

closeDiagram
```
void closeDiagram()
```

realCloseDiagram
```
void realCloseDiagram()
```

addReference

void addReference(IReference reference)

removeReference

void removeReference(IReference reference)

getReferenceByIndex

IReference getReferenceByIndex(int index)

removeReferenceByIndex

void removeReferenceByIndex(int index)

referenceCount
```
int referenceCount()
```

referenceIterator
```
java.util.Iterator referenceIterator()
```
Returns an iterator over the model elements IReference.

toReferenceArray
```
IReference[] toReferenceArray()
```

createComment
```
IDiagramUIModelComment createComment()
```

removeComment

void removeComment(IDiagramUIModelComment comment)

getCommentAt

IDiagramUIModelComment getCommentAt(int index)

indexOfComment

int indexOfComment(IDiagramUIModelComment comment)

commentCount
```
int commentCount()
```

commentIterator
```
java.util.Iterator commentIterator()
```

toCommentArray

IDiagramUIModelComment[] toCommentArray()

toCommentModelElementArray
```
IComment[] toCommentModelElementArray()
```
Deprecated.

Returns the Diagram.comments as IComment[]

getViewpoint
```
IViewpoint getViewpoint()
```

getDiagramLayers
```
IDiagramLayer[] getDiagramLayers()
```

createDiagramLayer

IDiagramLayer createDiagramLayer(java.lang.String aLayerName)

removeDiagramLayer

void removeDiagramLayer(IDiagramLayer aLayer)

setActiveDiagramLayer

void setActiveDiagramLayer(IDiagramLayer aLayer)

getActiveDiagramLayer
```
IDiagramLayer getActiveDiagramLayer()
```

getDefaultDiagramLayer
```
IDiagramLayer getDefaultDiagramLayer()
```

group

IShapeGroup group(IShapeGroupable[] aGroupables)

getCustomizedSortDiagramElementIds

java.lang.String[] getCustomizedSortDiagramElementIds()

toPropertiesString
```
java.lang.String toPropertiesString()
```

isSupportedInProductEdition
```
boolean isSupportedInProductEdition()
```

getProject
```
IProject getProject()
```

isLoading
```
boolean isLoading()
```
Determines whether the Diagram is loading from project

Returns:

true means is loading from project

Interface IDiagramUIModel

Field Summary

Method Summary

Field Detail

MAX_PREVIEW_IMAGE_SIZE

MAX_ZOOM

PROPERTY_OPENED

PROPERTY_ZOOMRATIO

PROPERTY_REFERENCE_CONTAINER_ID

PROPERTY_PM_STATUS_ID

PROPERTY_PM_DIFFICULTY_ID

PROPERTY_PM_PRIORITY_ID

PROPERTY_PM_VERSION_ID

PROPERTY_PM_ITERATION_ID

PROPERTY_PM_PHASE_ID

PROPERTY_PM_DISCIPLINE_ID

PROPERTY_PM_STATUS

PROPERTY_PM_DIFFICULTY

PROPERTY_PM_PRIORITY

PROPERTY_PM_VERSION

PROPERTY_PM_ITERATION

PROPERTY_PM_PHASE

PROPERTY_PM_DISCIPLINE

PROPERTY_PM_AUTHOR

PROPERTY_PM_CREATE_DATE_TIME

PROPERTY_PM_LAST_MODIFIED

PROPERTY_SHOW_PACKAGE_NAME_STYLE

PROPERTY_SHOW_CONNECTOR_NAME

PROPERTY_PAINT_CONNECTOR_THROUGH_LABEL

PROPERTY_TRANSIT_FROM

PROPERTY_TRANSIT_TO

WITHIN_PACKAGE_BODY

WITHIN_PACKAGE_TAB

SHOW_PACKAGE_NAME_STYLE_FOLLOW_DIAGRAM

SHOW_CONNECTOR_NAME_YES

SHOW_CONNECTOR_NAME_NO

SHOW_CONNECTOR_NAME_FOLLOW_DIAGRAM

PAINT_CONNECTOR_THROUGH_LABEL_NO

PAINT_CONNECTOR_THROUGH_LABEL_YES

PAINT_CONNECTOR_THROUGH_LABEL_FOLLOW_DIAGRAM

PROPERTY_SHOW_ACTIVITY_STATE_NODE_CAPTION

PROPERTY_EDITABLE

PROPERTY_REQUEST_LAYOUT_TYPE

PROPERTY_FOLLOW_DIAGRAM_PARENT_ELEMENT

PROPERTY_AUTO_FIT_SHAPES_SIZE

PROPERTY_SHOW_TAGGED_VALUES

PROPERTY_SHOW_STEREOTYPES

PROPERTY_SHOW_CONSTRAINTS

PROPERTY_ALIGN_TO_GRID

PROPERTY_GRID_VISIBLE

PROPERTY_GRID_WIDTH

PROPERTY_GRID_HEIGHT

PROPERTY_GRID_COLOR

PROPERTY_DIAGRAM_BACKGROUND

PROPERTY_CONNECTOR_STYLE

PROPERTY_CONNECTOR_LINE_JUMPS

PROPERTY_CONNECTOR_LINE_JUMPS_SIZE

PROPERTY_CONNECTION_POINT_STYLE

PROPERTY_CONNECTOR_LABEL_ORIENTATION

PROPERTY_MODEL_ELEMENT_NAME_ALIGNMENT

PROPERTY_ZOOM_RATIO

SPECIAL_ZOOM_FIT_PAGE

SPECIAL_ZOOM_FIT_PAGE_WIDTH

SPECIAL_ZOOM_FIT_PAGE_HEIGHT

PROPERTY_MAXIMIZED

PROPERTY_X

PROPERTY_Y

PROPERTY_WIDTH

PROPERTY_HEIGHT

PROPERTY_QUALITY_SCORE

PROPERTY_LAST_VIEW_X

PROPERTY_LAST_VIEW_Y

PROPERTY_QP_TRANSLATE_X

PROPERTY_QP_TRANSLATE_Y

PROPERTY_QP_SCALE_X

PROPERTY_QP_SCALE_Y

PROPERTY_CREATION_TIME

PROPERTY_LAST_MODIFIED

PROPERTY_DIAGRAM_PREVIEW_DATA

PROPERTY_GLOBAL_PALETTE_OPTION