Package de.mid.innovator.srv2api.icw2pres

Interface PRDia

All Superinterfaces:

ADClientAble, ADFindAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELObject, ELPictureAble, ELUUIDAble, MMFormatAble, PRPresContext, PRPresElement

All Known Subinterfaces:

ACDia, BPDia, BRDia, BSDia, CLClassDia, CLComponentDia, CLCompositeStructureDia, CLDeploymentDia, CLDia, CLHierarchyAbleDia, CLRequirementDia, CLStructureDefinitionDia, CLUseCaseDia, DBDia, DRDecisionRequirementDia, ERDia, ERDiaAll, GCDia, GCDynDia, IMDia, PRAnalysisDia, PRBDia, PRDiaWhiteboard, PRVersionAbleDia, SMDia, SMPDia, SQDia

public interface PRDia
extends PRPresContext

This is a utility class for PRDia that provides static methods for creation or other purposes.

See Also:

• PRDiaHelper

Note:

The interface PRDia describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PRDia.VAttr

Method Summary

Modifier and Type	Method	Description
List<PRPresContent>	addAbleDiaEdge(List<ARG_PRAddAbleEdgeList> seq)	Add a list of model elements as edge to this diagram.
PRDiaEdge	addEdgeAndTargetNode(ADClientAble ohNode, ADClientAble ohElem, Class<? extends ELObject> kVOclEdge, Point ptPos, boolean isSourceSide)	Adds an element as edge to this diagram.
List<PRDiaEdge>	addEdgesAndTargetNodes(ADClientAble ohNode, List<? extends ADClientAble> seqElem, Class<? extends ELObject> kVOclEdge, Point ptPos, Point ptOffset, boolean isSourceSide)	Adds a list of elements as edges to this diagram.
List<ARG_PRAddAbleEdgeList>	getAddAbleDiaEdge(boolean item)	Returns a list of all model elements which may be added as edge to this diagram.
List<ARG_AddAbleEdgeListType>	getAddEdgeAndTargetNodeList(ADClientAble ohNode, Class<? extends ELObject> kVOclEdge)	Calculates all model elements which may be added as edge of the specified type.
List<PRDiaWhiteboardNode>	getDiaWhiteboardNode()	All nodes representing this diagram.
List<ADAnnotation>	getOwnedAnnotations(K_CONTROL_OPTION... behaviourFlags)	All annotations owned by this diagram.
List<PRDiaCalloutNode>	getOwnedCalloutNode()	All callout nodes owned by this diagram.
List<PRDiaAttachmentNode>	getOwnedDiaAttachmentNode()	All attachment nodes owned by this diagram.
List<PRDiaNote>	getOwnedDiaNote()	All notes owned by this diagram.
List<PRDiaFrameNode>	getOwnedFrameNode()	All frame nodes owned by this diagram.
ARG_SVGPictureRawData	getSVGPictureRawData(K_LOCALE kLocale)	Returns the SVG picture's raw data assigned to this element.
ARG_XClientForSVG	getXClientForSVG(String nameLabel, K_LOCALE kLocale)	Fills the client X structure used to generate a SVG for this presentation context and calculates a hash value.
void	setDiaFilterCriteria(boolean hideComments, boolean hideAttachments)	Modifies the criteria for visible elements inside the daigram.
void	setSVGPictureRawData(byte[] seqData, String strDiaHash, K_LOCALE kLocale, boolean isActualSVG)	Creates a SVG picture instance for this element if it does not already own a picture.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELPictureAble

getOwnedPicture, getOwnedPictures, getPictureRawData, pictureSetRawData

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMFormatAble

copyFormatDlg, copyFormatRule, getCopyFormatDlgInit, getFormat

Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRPresContext

getContextFormat, getContextValue, getCopy, getCopyToFile, getHorPage, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginUnit, getModelElementOfTransitiveOwnedPresentationElement, getModelElementOfTransitiveOwnedPresentationElement, getOrientation, getOwnedFooterText, getOwnedHeaderText, getOwnedPresContent, getPageBreakX, getPageBreakY, getPageOrder, getPageView, getVerPage, getXClient, getXClientContentModelElementList, getXClientContentModelElementList, getXClientHash, isPageViewActive, pageView, paste, pasteFromFile, setContextFormat, setContextValue, setHorPage, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setOrientation, setPageViewActive, setVerPage

Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRPresElement

getDiagramTagValue, getOpacity, getOwnedDiagramTags, getOwnedPresContentElement, getPresColor, getPresentationOfLogic, setDiagramTagValue, setOpacity, setPresColor

Method Details

getAddAbleDiaEdge

List<ARG_PRAddAbleEdgeList> getAddAbleDiaEdge(boolean item)
                                       throws InoNetException,
SrvErrorException

Returns a list of all model elements which may be added as edge to this diagram. If the parameter value is true, the list contains graphic information needed to display the edges as selection within the diagram. The parameter value false should be used if the result list is directly used as input of addAbleDiaEdge.

Parameters:

item -

Throws:

InoNetException

SrvErrorException

getAddEdgeAndTargetNodeList

List<ARG_AddAbleEdgeListType> getAddEdgeAndTargetNodeList(ADClientAble ohNode,
 Class<? extends ELObject> kVOclEdge)
                                                   throws InoNetException,
SrvErrorException

Calculates all model elements which may be added as edge of the specified type. The model elements are grouped according to their logical type and in some cases by their direction.

Parameters:

ohNode - selected node

kVOclEdge - element type of the added edge

Throws:

InoNetException

SrvErrorException

getSVGPictureRawData

ARG_SVGPictureRawData getSVGPictureRawData(K_LOCALE kLocale)
                                    throws InoNetException,
SrvErrorException

Returns the SVG picture's raw data assigned to this element.

Parameters:

kLocale - locale code used at SVG generation

Throws:

InoNetException

SrvErrorException

getXClientForSVG

ARG_XClientForSVG getXClientForSVG(String nameLabel,
 K_LOCALE kLocale)
                            throws InoNetException,
SrvErrorException

Fills the client X structure used to generate a SVG for this presentation context and calculates a hash value.

Parameters:

nameLabel - name of the color label (optional)

kLocale - locale code used at SVG generation

Throws:

InoNetException

SrvErrorException

addAbleDiaEdge

List<PRPresContent> addAbleDiaEdge(List<ARG_PRAddAbleEdgeList> seq)
                            throws InoNetException,
SrvErrorException

Add a list of model elements as edge to this diagram.

Parameters:

seq -

Throws:

InoNetException

SrvErrorException

addEdgeAndTargetNode

PRDiaEdge addEdgeAndTargetNode(ADClientAble ohNode,
 ADClientAble ohElem,
 Class<? extends ELObject> kVOclEdge,
 Point ptPos,
 boolean isSourceSide)
                        throws InoNetException,
SrvErrorException

Adds an element as edge to this diagram. The model element of the specified node is owner of the added element. The target element is added at the specified position.

Parameters:

ohNode - selected node

ohElem - element to be added as edge

kVOclEdge - element type of the added edge

ptPos - position for the additional node

isSourceSide - true, if the start node is on source side

Throws:

InoNetException

SrvErrorException

addEdgesAndTargetNodes

List<PRDiaEdge> addEdgesAndTargetNodes(ADClientAble ohNode,
 List<? extends ADClientAble> seqElem,
 Class<? extends ELObject> kVOclEdge,
 Point ptPos,
 Point ptOffset,
 boolean isSourceSide)
                                throws InoNetException,
SrvErrorException

Adds a list of elements as edges to this diagram. The model element of the specified node is owner of the added elements. The target element is added at the specified position.

Parameters:

ohNode - selected node

seqElem - list of elements to be added as edge

kVOclEdge - element type of the added edge

ptPos - position for the first additional node

ptOffset - position offset, if more than one edge is added with node

isSourceSide - true, if the start node is on source side

Throws:

InoNetException

SrvErrorException

setDiaFilterCriteria

void setDiaFilterCriteria(boolean hideComments,
 boolean hideAttachments)
                   throws InoNetException,
SrvErrorException

Modifies the criteria for visible elements inside the daigram. Elements to be hidden will be visible while the diagram is locked for modifications.

Parameters:

hideComments - flag for hiding the comments

hideAttachments - flag for hiding the attachments

Throws:

InoNetException

SrvErrorException

setSVGPictureRawData

void setSVGPictureRawData(byte[] seqData,
 String strDiaHash,
 K_LOCALE kLocale,
 boolean isActualSVG)
                   throws InoNetException,
SrvErrorException

Creates a SVG picture instance for this element if it does not already own a picture. The picture is assigned the provided binary data as raw format.

Parameters:

seqData - binary format of the SVG picture

strDiaHash - hash code at SVG generation time

kLocale - locale code used at SVG generation

isActualSVG - true if SVG exists and the diagram is marked as unchanged

Throws:

InoNetException

SrvErrorException

getOwnedDiaNote

List<PRDiaNote> getOwnedDiaNote()
                         throws InoNetException,
SrvErrorException

All notes owned by this diagram.

Throws:

InoNetException

SrvErrorException

getOwnedCalloutNode

List<PRDiaCalloutNode> getOwnedCalloutNode()
                                    throws InoNetException,
SrvErrorException

All callout nodes owned by this diagram.

Throws:

InoNetException

SrvErrorException

getOwnedFrameNode

List<PRDiaFrameNode> getOwnedFrameNode()
                                throws InoNetException,
SrvErrorException

All frame nodes owned by this diagram.

Throws:

InoNetException

SrvErrorException

getDiaWhiteboardNode

List<PRDiaWhiteboardNode> getDiaWhiteboardNode()
                                        throws InoNetException,
SrvErrorException

All nodes representing this diagram.

Throws:

InoNetException

SrvErrorException

getOwnedDiaAttachmentNode

List<PRDiaAttachmentNode> getOwnedDiaAttachmentNode()
                                             throws InoNetException,
SrvErrorException

All attachment nodes owned by this diagram.

Throws:

InoNetException

SrvErrorException

getOwnedAnnotations

List<ADAnnotation> getOwnedAnnotations(K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

All annotations owned by this diagram.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.