public interface DiagramManager
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DIAGRAM_TYPE_ACTIVITY_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_CLASS_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_COMMUNICATION_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_COMPONENT
Deprecated.
replaced by DIAGRAM_TYPE_COMPONENT_DIAGRAM
|
static java.lang.String |
DIAGRAM_TYPE_COMPONENT_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_COMPOSITE_STRUCTURE_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_CRCCARD_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_DEPLOYMENT
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_ENTITY_RELATIONSHIP_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_FREEHAND_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_INTERACTION_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_INTERACTION_OVERVIEW_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_OBJECT_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_OVERVIEW_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_PACKAGE_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_STATE_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_TEXTUAL_ANALYSIS
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_TIMING_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static java.lang.String |
DIAGRAM_TYPE_USE_CASE_DIAGRAM
Deprecated.
replaced by IDiagramTypeConstants
|
static int |
LAYOUT_AUTO |
static int |
LAYOUT_BALLOON_TREE |
static int |
LAYOUT_CIRCULAR |
static int |
LAYOUT_CIRCULAR_BBC_COMPACT_LAYOUT |
static int |
LAYOUT_CIRCULAR_BBC_ISOLATED_LAYOUT |
static int |
LAYOUT_CIRCULAR_SINGLE_CYCLE_LAYOUT |
static int |
LAYOUT_CLASSIC_ORGANIC |
static int |
LAYOUT_COMPACT |
static int |
LAYOUT_COMPACT_TREE |
static int |
LAYOUT_CUSTOMIZED |
static int |
LAYOUT_DIRECTED_TREE |
static int |
LAYOUT_HIERARCHIC |
static int |
LAYOUT_HORIZONTAL_VERTICAL_TREE |
static int |
LAYOUT_LABEL |
static int |
LAYOUT_ORGANIC |
static int |
LAYOUT_ORTHOGONAL |
static int |
LAYOUT_ROUTE_CONNECTORS_ORGANIC |
static int |
LAYOUT_ROUTE_CONNECTORS_ORTHOGONAL |
static int |
LAYOUT_SMART_ORGANIC_LAYOUT |
static int |
LAYOUT_TREE_STYLE |
Modifier and Type | Method and Description |
---|---|
void |
autoLayout(IDiagramUIModel diagram)
Deprecated.
|
GridDiagramContent |
calculateGridDiagramContent(IGridDiagramUIModel gridDiagram)
To retrieve the content of a grid daigram.
|
void |
clearHighlightAsAnimation(IDiagramUIModel diagram)
To clean up the highlighted animation on diagram.
|
IPluginAnimation |
createAnimation(IDiagramUIModel aDiagram,
IDiagramElement[] aElements)
To create animation for selected shapes in specified diagram.
|
LayoutOption.BalloonTree |
createBalloonTreeLayoutOption()
Create Balloon Tree Layout Option for configuring the Balloon Tree Layout.
|
LayoutOption.BBCCompact |
createBBCCompactLayoutOption()
Create BBC Compact Layout Option for configuring the BBC Compact Tree Layout.
|
LayoutOption.BBCIsolated |
createBBCIsolatedLayoutOption()
Create BBC Isolated Layout Option for configuring the BBC Isolated Tree Layout.
|
LayoutOption.CompactTree |
createCompactTreeLayoutOption()
Create Compact Tree Layout Option for configuring the Compact Tree Layout.
|
IDiagramElement |
createConnector(IDiagramUIModel diagram,
IModelElement connectorModel,
IDiagramElement fromDiagramElement,
IDiagramElement toDiagramElement,
java.awt.Point[] connectorPoints)
Create a connector to the diagram.
|
IDiagramElement |
createConnector(IDiagramUIModel diagram,
java.lang.String shapeType,
IDiagramElement fromDiagramElement,
IDiagramElement toDiagramElement,
java.awt.Point[] connectorPoints)
Create a connector to the diagram.
|
IDiagramUIModel |
createDiagram(java.lang.String diagramType)
Create a new diagram according to the type user specified.
|
IDiagramElement |
createDiagramElement(IDiagramUIModel diagram,
IModelElement model)
To create a diagram element (shape) for specific model element on the diagram.
|
IDiagramElement |
createDiagramElement(IDiagramUIModel diagram,
java.lang.String shapeType)
To create a diagram element (shape) on diagram, but not associate its underlying model element.
|
LayoutOption.DirectedTree |
createDirectedTreeLayoutOption()
Create Directed Tree Layout Option for configuring the Directed Tree Layout.
|
LayoutOption.Hierarchical |
createHierarchicalLayoutOption()
Create Hierarchical Layout Option for configuring the Hierarchical Layout.
|
LayoutOption.HorizontalVerticalTree |
createHorizontalVerticalTreeLayoutOption()
Create Horizontal Vertical Tree Layout Option for configuring the Horizontal Vertical Tree Layout.
|
LayoutOption.OrganicEdgeRouter |
createOrganicEdgeRouterLayoutOption()
Create Organic Edge Router Layout Option for configuring the Organic Edge Router Tree Layout.
|
LayoutOption.Organic |
createOrganicLayoutOption()
Create Organic Layout Option for configuring the Organic Tree Layout.
|
LayoutOption.OrthogonalEdgeRouter |
createOrthogonalEdgeRouterLayoutOption()
Create Orthogonal Edge Router Layout Option for configuring the Orthogonal Edge Router Tree Layout.
|
LayoutOption.Orthogonal |
createOrthogonalLayoutOption()
Create Orthogonal Layout Option for configuring the Orthogonal Layout.
|
LayoutOption.SingleCycle |
createSingleCycleLayoutOption()
Create Single Cycle Layout Option for configuring the Single Cycle Tree Layout.
|
LayoutOption.SmartOrganic |
createSmartOrganicLayoutOption()
Create Smart Organic Layout Option for configuring the Smart Organic Tree Layout.
|
IDiagramUIModel |
getActiveDiagram()
Retrieve the active diagram from in current opening project.
|
SubLevelFlowData[] |
getInOutFlowRelationships(IModelElement aModelElement)
returns the inflows, or outflows
|
SubLevelFlowType |
getModelElementSubLevelFlowType(java.lang.String aModelType)
Check the model type isn't possible to connect inflow(s) or outflow(s)
e.g.
|
IDiagramUIModel[] |
getOpenedDiagrams()
Get the diagrams which are opened (the current showing diagram and/or diagrams listed in 'switch diagram')
|
IDiagramElement[] |
getSelectedDiagramElements()
Retrieve the diagram element(s) which being selected by user in diagram.
|
void |
highlight(IDiagramElement diagramElement)
Open the diagram of the diagram element, and highlight the diagram element.
|
void |
highlight(IDiagramElement diagramElement,
boolean cancelScrollBack)
Open the diagram of the diagram element, and highlight the diagram element.
|
void |
highlightAsAnimation(IDiagramElement[] diagramElements)
Highlight the selected shapes on diagram using animation highlight style.
|
boolean |
isShowExtraResources()
To check is the diagram set to display basic resource icons or all resource icons.
|
void |
layout(IDiagramUIModel diagram,
int layoutType)
To perform layout to the specified diagram.
|
void |
openAndLayoutDiagram(IDiagramUIModel diagram,
LayoutOption layoutOption)
To perform layout and open specified diagram in Visual Paradigm.
|
void |
openDiagram(IDiagramUIModel diagramUIModel)
To open and display a diagram in project.
|
void |
openDiagramElement(IDiagramElement diagramElement)
To open a diagram containing a specific diagram element (shape).
|
void |
openDiagramElements(IDiagramElement[] diagramElements)
To open a diagram based containing the diagram elements (shapes) user specified.
|
void |
setShowExtraResources(boolean showExtraResources)
To control showing basic resource icons or all resource icons in Classic Resource Centric interface.
|
IDiagramUIModel |
syncFlowOfEventToActivityDiagram(IStepContainer flowOfEvent)
The generate activity diagram from use case flow of events/user story scenarios.
|
IDiagramUIModel |
syncFlowOfEventToSequenceDiagram(IStepContainer flowOfEvent)
The generate sequence diagram from use case flow of events/user story scenarios.
|
static final java.lang.String DIAGRAM_TYPE_ACTIVITY_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_CLASS_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_COMMUNICATION_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_COMPONENT_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_COMPOSITE_STRUCTURE_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_CRCCARD_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_DEPLOYMENT
static final java.lang.String DIAGRAM_TYPE_ENTITY_RELATIONSHIP_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_FREEHAND_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_INTERACTION_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_INTERACTION_OVERVIEW_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_OVERVIEW_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_STATE_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_TEXTUAL_ANALYSIS
static final java.lang.String DIAGRAM_TYPE_TIMING_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_USE_CASE_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_OBJECT_DIAGRAM
static final java.lang.String DIAGRAM_TYPE_PACKAGE_DIAGRAM
static final int LAYOUT_AUTO
static final int LAYOUT_CUSTOMIZED
static final int LAYOUT_HIERARCHIC
static final int LAYOUT_ORTHOGONAL
static final int LAYOUT_TREE_STYLE
static final int LAYOUT_CIRCULAR
static final int LAYOUT_ORGANIC
static final int LAYOUT_ROUTE_CONNECTORS_ORTHOGONAL
static final int LAYOUT_COMPACT
static final int LAYOUT_ROUTE_CONNECTORS_ORGANIC
static final int LAYOUT_LABEL
static final int LAYOUT_BALLOON_TREE
static final int LAYOUT_CLASSIC_ORGANIC
static final int LAYOUT_COMPACT_TREE
static final int LAYOUT_DIRECTED_TREE
static final int LAYOUT_HORIZONTAL_VERTICAL_TREE
static final int LAYOUT_SMART_ORGANIC_LAYOUT
static final int LAYOUT_CIRCULAR_BBC_COMPACT_LAYOUT
static final int LAYOUT_CIRCULAR_BBC_ISOLATED_LAYOUT
static final int LAYOUT_CIRCULAR_SINGLE_CYCLE_LAYOUT
static final java.lang.String DIAGRAM_TYPE_COMPONENT
IDiagramUIModel getActiveDiagram()
IDiagramElement[] getSelectedDiagramElements()
IDiagramUIModel[] getOpenedDiagrams()
IDiagramUIModel createDiagram(java.lang.String diagramType)
diagramType
- - See IDiagramTypeConstants for the supported diagram types.void openDiagram(IDiagramUIModel diagramUIModel)
diagramUIModel
- - the diagram to open.void openDiagramElement(IDiagramElement diagramElement)
diagramElement
- - the diagram element (shape) inside a diagram.void openDiagramElements(IDiagramElement[] diagramElements)
diagramElements
- - a collection of diagram elements (shapes) inside a diagram.void highlight(IDiagramElement diagramElement)
diagramElement
- the diagram element will be highlightedvoid highlight(IDiagramElement diagramElement, boolean cancelScrollBack)
diagramElement
- the diagram element will be highlightedcancelScrollBack
- determine whether scroll back to 'original focused' diagram element if user cancel the highlightvoid highlightAsAnimation(IDiagramElement[] diagramElements)
diagramElements
- - the shapes to be highlight on diagram.void clearHighlightAsAnimation(IDiagramUIModel diagram)
diagram
- - the diagram for clearing the animation.IDiagramElement createDiagramElement(IDiagramUIModel diagram, IModelElement model)
diagram
- - the target diagram to host the shape.model
- - the underlying model element of the shape.IDiagramElement createDiagramElement(IDiagramUIModel diagram, java.lang.String shapeType)
diagram
- - the target diagram to host the shape.shapeType
- - the shape type going to create. See com.vp.plugin.diagram.IShapeTypeConstants.IDiagramElement createConnector(IDiagramUIModel diagram, IModelElement connectorModel, IDiagramElement fromDiagramElement, IDiagramElement toDiagramElement, java.awt.Point[] connectorPoints)
connectorModel
and the from/to shape of the connector model's from/to model.diagram
- the Diagram will create and show the connector.connectorModel
- the IModelElement
of the new connector.fromDiagramElement
- the From shape of the new connector. It should be the IDiagramElement
of connectorModel
From model.toDiagramElement
- the To shape of the new connector. It should be the IDiagramElement
of connectorModel
To model.connectorPoints
- the Points of the connector. NULL
is acceptable. For more details, please refer to http://knowhow.visual-paradigm.com/?p=3049IDiagramElement createConnector(IDiagramUIModel diagram, java.lang.String shapeType, IDiagramElement fromDiagramElement, IDiagramElement toDiagramElement, java.awt.Point[] connectorPoints)
shapeType
. Normally, it is used to create the connector that have no model element. (e.g. IContainmentUIModel
)diagram
- the Diagram will create and show the connector.shapeType
- the type of the connector.fromDiagramElement
- the From shape of the new connector.toDiagramElement
- the To shape of the new connector.connectorPoints
- the Points of the connector. NULL
is acceptable. For more details, please refer to http://knowhow.visual-paradigm.com/?p=3049void setShowExtraResources(boolean showExtraResources)
showExtraResources
- boolean isShowExtraResources()
void autoLayout(IDiagramUIModel diagram)
void layout(IDiagramUIModel diagram, int layoutType)
diagram
- - The diagram to layout.layoutType
- - The type of layout to perform. Constants of layout types can be found in DiagramManager.void openAndLayoutDiagram(IDiagramUIModel diagram, LayoutOption layoutOption)
diagram
- - The diagram to layout and open.layoutOption
- - The layout setting apply to the diagram.LayoutOption.Orthogonal createOrthogonalLayoutOption()
LayoutOption.Hierarchical createHierarchicalLayoutOption()
LayoutOption.DirectedTree createDirectedTreeLayoutOption()
LayoutOption.BalloonTree createBalloonTreeLayoutOption()
LayoutOption.CompactTree createCompactTreeLayoutOption()
LayoutOption.HorizontalVerticalTree createHorizontalVerticalTreeLayoutOption()
LayoutOption.BBCCompact createBBCCompactLayoutOption()
LayoutOption.BBCIsolated createBBCIsolatedLayoutOption()
LayoutOption.SingleCycle createSingleCycleLayoutOption()
LayoutOption.Organic createOrganicLayoutOption()
LayoutOption.SmartOrganic createSmartOrganicLayoutOption()
LayoutOption.OrganicEdgeRouter createOrganicEdgeRouterLayoutOption()
LayoutOption.OrthogonalEdgeRouter createOrthogonalEdgeRouterLayoutOption()
IDiagramUIModel syncFlowOfEventToActivityDiagram(IStepContainer flowOfEvent)
flowOfEvent
- the FlowOfEventIDiagramUIModel syncFlowOfEventToSequenceDiagram(IStepContainer flowOfEvent)
flowOfEvent
- the FlowOfEventSubLevelFlowType getModelElementSubLevelFlowType(java.lang.String aModelType)
SubLevelFlowData[] getInOutFlowRelationships(IModelElement aModelElement)
GridDiagramContent calculateGridDiagramContent(IGridDiagramUIModel gridDiagram)
gridDiagram
- - the grid diagram to query.IPluginAnimation createAnimation(IDiagramUIModel aDiagram, IDiagramElement[] aElements)
aDiagram
- - the diagram for create animation.aElements
- - the shapes involved in the animation.