Package de.mid.innovator.srv2api.icw2pres

Interface PRPresContext

All Superinterfaces:

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

All Known Subinterfaces:

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

public interface PRPresContext
extends PRPresElement, ADFindAble, ELPictureAble

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

Note:

The interface PRPresContext 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	PRPresContext.VAttr

Method Summary

Modifier and Type	Method	Description
String	getContextFormat()	Returns the format of the presentation context.
String	getContextValue()	The string value of this presentation context.
List<String>	getCopy(List<? extends ELElement> seqSel, boolean ownedElementTransitive)	Fills the copy buffer with the specified elements.
Path	getCopyToFile(List<? extends ELElement> seqSel, boolean ownedElementTransitive)	Fills the copy file buffer with the specified elements.
int	getHorPage()	Returns the number of horizontal pages of the presentation context.
int	getMarginBottom()	Returns the bottom margin of the presentation context.
int	getMarginLeft()	Returns the left margin of the presentation context.
int	getMarginRight()	Returns the right margin of the presentation context.
int	getMarginTop()	Returns the top margin of the presentation context.
K_UNIT	getMarginUnit()	The unit of the margins in print view.
<T extends MEModelElement> List<T>	getModelElementOfTransitiveOwnedPresentationElement(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	returns the model elements assigned to presentation elements transitively owned by this presentation context.
<T extends MEModelElement> List<T>	getModelElementOfTransitiveOwnedPresentationElement(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getModelElementOfTransitiveOwnedPresentationElement and filters its return values according to the given stereotype value.
K_ORIENTATION	getOrientation()	Returns the orientation of the presentation context.
PRPresText	getOwnedFooterText()	The footer text of this context.
PRPresText	getOwnedHeaderText()	The header text of this context.
<T extends PRPresContent> List<T>	getOwnedPresContent(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All presentation contents owned by this presentation context.
String	getPageBreakX()	The string of all page break x coordinates for this presentation context.
String	getPageBreakY()	The string of all page break y coordinates for this presentation context.
K_PAGEORDER	getPageOrder()	The order of pages in print view.
ARG_PageViewContext	getPageView()	Get all page view informations for this presentation context.
int	getVerPage()	Returns the number of vertical pages of the presentation context.
ARG_XClientOut	getXClient(String nameLabel, boolean dispCompleteness, boolean withAddAbleEdge, boolean withAddAbleCompartments, MESection ohSection)	Fills the client X structure for this presentation context.
<T extends ADClientAble> List<T>	getXClientContentModelElementList(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Calculates the displayed presentation contents of this PRPresContext and returns the corresponding model elements.
<T extends ADClientAble> List<T>	getXClientContentModelElementList(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getXClientContentModelElementList and filters its return values according to the given stereotype value.
ARG_XClientHashOut	getXClientHash(String nameLabel, String strHash)	Fills the client X structure for this presentation context and calculates a hash value.
boolean	isPageViewActive()	true, if page view is active for this presentation context.
void	pageView(K_ORIENTATION orientation, int marginLeft, int marginRight, int marginTop, int marginBottom, int horPage, int verPage, K_PAGEORDER pageOrder, K_UNIT marginUnit, boolean isPageViewActive, String format, List<Integer> seqPageBreakX, List<Integer> seqPageBreakY, ARG_PageViewTextLine valHeader, ARG_PageViewTextLine valFooter)	Set all page view informations for this presentation context.
List<ELElement>	paste(List<? extends ELElement> seqSel, List<String> seqVList, boolean checkConstraint, Point pos)	Pastes the content of the copy buffer in this presentation context.
List<ELElement>	pasteFromFile(List<? extends ELElement> seqSel, Path file, boolean checkConstraint, Point pos)	Pastes the content of the copy file buffer in this presentation context.
void	setContextFormat(String value)	Set the value of Attribut ContextFormat.
void	setContextValue(String value)	Set the value of Attribut ContextValue.
void	setHorPage(int value)	Set the value of Attribut HorPage.
void	setMarginBottom(int value)	Set the value of Attribut MarginBottom.
void	setMarginLeft(int value)	Set the value of Attribut MarginLeft.
void	setMarginRight(int value)	Set the value of Attribut MarginRight.
void	setMarginTop(int value)	Set the value of Attribut MarginTop.
void	setOrientation(K_ORIENTATION value)	Set the value of Attribut Orientation.
void	setPageViewActive(boolean value)	Set the value of Attribut IsPageViewActive.
void	setVerPage(int value)	Set the value of Attribut VerPage.

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.PRPresElement

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

Method Details

getContextFormat

String getContextFormat()
                 throws InoNetException,
SrvErrorException

Returns the format of the presentation context.

Throws:

InoNetException

SrvErrorException

setContextFormat

void setContextFormat(String value)
               throws InoNetException,
SrvErrorException

Set the value of Attribut ContextFormat.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getOrientation

K_ORIENTATION getOrientation()
                      throws InoNetException,
SrvErrorException

Returns the orientation of the presentation context.

Throws:

InoNetException

SrvErrorException

setOrientation

void setOrientation(K_ORIENTATION value)
             throws InoNetException,
SrvErrorException

Set the value of Attribut Orientation.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMarginLeft

int getMarginLeft()
           throws InoNetException,
SrvErrorException

Returns the left margin of the presentation context.

Throws:

InoNetException

SrvErrorException

setMarginLeft

void setMarginLeft(int value)
            throws InoNetException,
SrvErrorException

Set the value of Attribut MarginLeft.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMarginRight

int getMarginRight()
            throws InoNetException,
SrvErrorException

Returns the right margin of the presentation context.

Throws:

InoNetException

SrvErrorException

setMarginRight

void setMarginRight(int value)
             throws InoNetException,
SrvErrorException

Set the value of Attribut MarginRight.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMarginTop

int getMarginTop()
          throws InoNetException,
SrvErrorException

Returns the top margin of the presentation context.

Throws:

InoNetException

SrvErrorException

setMarginTop

void setMarginTop(int value)
           throws InoNetException,
SrvErrorException

Set the value of Attribut MarginTop.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMarginBottom

int getMarginBottom()
             throws InoNetException,
SrvErrorException

Returns the bottom margin of the presentation context.

Throws:

InoNetException

SrvErrorException

setMarginBottom

void setMarginBottom(int value)
              throws InoNetException,
SrvErrorException

Set the value of Attribut MarginBottom.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getHorPage

int getHorPage()
        throws InoNetException,
SrvErrorException

Returns the number of horizontal pages of the presentation context.

Throws:

InoNetException

SrvErrorException

setHorPage

void setHorPage(int value)
         throws InoNetException,
SrvErrorException

Set the value of Attribut HorPage.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getVerPage

int getVerPage()
        throws InoNetException,
SrvErrorException

Returns the number of vertical pages of the presentation context.

Throws:

InoNetException

SrvErrorException

setVerPage

void setVerPage(int value)
         throws InoNetException,
SrvErrorException

Set the value of Attribut VerPage.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getContextValue

String getContextValue()
                throws InoNetException,
SrvErrorException

The string value of this presentation context.

Throws:

InoNetException

SrvErrorException

setContextValue

void setContextValue(String value)
              throws InoNetException,
SrvErrorException

Set the value of Attribut ContextValue.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getPageOrder

K_PAGEORDER getPageOrder()
                  throws InoNetException,
SrvErrorException

The order of pages in print view.

Throws:

InoNetException

SrvErrorException

getMarginUnit

K_UNIT getMarginUnit()
              throws InoNetException,
SrvErrorException

The unit of the margins in print view.

Throws:

InoNetException

SrvErrorException

isPageViewActive

boolean isPageViewActive()
                  throws InoNetException,
SrvErrorException

true, if page view is active for this presentation context.

Throws:

InoNetException

SrvErrorException

setPageViewActive

void setPageViewActive(boolean value)
                throws InoNetException,
SrvErrorException

Set the value of Attribut IsPageViewActive.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getPageBreakX

String getPageBreakX()
              throws InoNetException,
SrvErrorException

The string of all page break x coordinates for this presentation context.

Throws:

InoNetException

SrvErrorException

getPageBreakY

String getPageBreakY()
              throws InoNetException,
SrvErrorException

The string of all page break y coordinates for this presentation context.

Throws:

InoNetException

SrvErrorException

getModelElementOfTransitiveOwnedPresentationElement

<T extends MEModelElement> List<T> getModelElementOfTransitiveOwnedPresentationElement(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                                                throws InoNetException,
SrvErrorException

returns the model elements assigned to presentation elements transitively owned by this presentation context.

Parameters:

returnType - Specifies the type of elements to be returned.

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

Throws:

InoNetException

SrvErrorException

getModelElementOfTransitiveOwnedPresentationElement

<T extends MEModelElement> List<T> getModelElementOfTransitiveOwnedPresentationElement(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                                                                throws InoNetException,
SrvErrorException

The method calls getModelElementOfTransitiveOwnedPresentationElement and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

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

Throws:

InoNetException

SrvErrorException

getXClientContentModelElementList

<T extends ADClientAble> List<T> getXClientContentModelElementList(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                            throws InoNetException,
SrvErrorException

Calculates the displayed presentation contents of this PRPresContext and returns the corresponding model elements. For a PRDiaWhiteboard the transitive results of all displayed diagrams are returned, too.

Parameters:

returnType - Specifies the type of elements to be returned.

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

Throws:

InoNetException

SrvErrorException

getXClientContentModelElementList

<T extends ADClientAble> List<T> getXClientContentModelElementList(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                                            throws InoNetException,
SrvErrorException

The method calls getXClientContentModelElementList and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

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

Throws:

InoNetException

SrvErrorException

getCopy

List<String> getCopy(List<? extends ELElement> seqSel,
 boolean ownedElementTransitive)
              throws InoNetException,
SrvErrorException

Fills the copy buffer with the specified elements.

Parameters:

seqSel - sequence of elements to copy

ownedElementTransitive - extend seqSel by its transitive content

Throws:

InoNetException

SrvErrorException

getCopyToFile

Path getCopyToFile(List<? extends ELElement> seqSel,
 boolean ownedElementTransitive)
            throws InoNetException,
SrvErrorException

Fills the copy file buffer with the specified elements.

Parameters:

seqSel - sequence of elements to copy

ownedElementTransitive - extend seqSel by its transitive content

Throws:

InoNetException

SrvErrorException

getPageView

ARG_PageViewContext getPageView()
                         throws InoNetException,
SrvErrorException

Get all page view informations for this presentation context.

Throws:

InoNetException

SrvErrorException

getXClientHash

ARG_XClientHashOut getXClientHash(String nameLabel,
 String strHash)
                           throws InoNetException,
SrvErrorException

Fills the client X structure for this presentation context and calculates a hash value.

Parameters:

nameLabel - name of the color label (optional)

strHash - old hash value (optional)

Throws:

InoNetException

SrvErrorException

getXClient

ARG_XClientOut getXClient(String nameLabel,
 boolean dispCompleteness,
 boolean withAddAbleEdge,
 boolean withAddAbleCompartments,
 MESection ohSection)
                   throws InoNetException,
SrvErrorException

Fills the client X structure for this presentation context.

Parameters:

nameLabel - name of the color label

dispCompleteness - calculate the display completeness

withAddAbleEdge - show all add able edges

withAddAbleCompartments - show all add able compartments

ohSection - model section (optional)

Throws:

InoNetException

SrvErrorException

pageView

void pageView(K_ORIENTATION orientation,
 int marginLeft,
 int marginRight,
 int marginTop,
 int marginBottom,
 int horPage,
 int verPage,
 K_PAGEORDER pageOrder,
 K_UNIT marginUnit,
 boolean isPageViewActive,
 String format,
 List<Integer> seqPageBreakX,
 List<Integer> seqPageBreakY,
 ARG_PageViewTextLine valHeader,
 ARG_PageViewTextLine valFooter)
       throws InoNetException,
SrvErrorException

Set all page view informations for this presentation context.

Parameters:

orientation - Returns the orientation of the presentation context.

marginLeft - Returns the left margin of the presentation context.

marginRight - Returns the right margin of the presentation context.

marginTop - Returns the top margin of the presentation context.

marginBottom - Returns the bottom margin of the presentation context.

horPage - Returns the number of horizontal pages of the presentation context.

verPage - Returns the number of vertical pages of the presentation context.

pageOrder - The order of pages in print view.

marginUnit - The unit of the margins in print view.

isPageViewActive - isTrue, if page view is active for this LINK(ocl,PRPresContext,presentation context).

format - Returns the format of the presentation context.

seqPageBreakX - list of all page break x coordinates for this LINK(ocl,PRPresContext,presentation context).

seqPageBreakY - list of all page break y coordinates for this LINK(ocl,PRPresContext,presentation context).

valHeader - header text line of this LINK(ocl,PRPresContext,presentation context).

valFooter - footer text line of this LINK(ocl,PRPresContext,presentation context).

Throws:

InoNetException

SrvErrorException

paste

List<ELElement> paste(List<? extends ELElement> seqSel,
 List<String> seqVList,
 boolean checkConstraint,
 Point pos)
               throws InoNetException,
SrvErrorException

Pastes the content of the copy buffer in this presentation context.

Parameters:

seqSel - Liste der markierten Elemente

seqVList - Stringliste des ASCII-Datei

checkConstraint - prüft ob Konfiguration verletzt wird

pos - new position

Throws:

InoNetException

SrvErrorException

pasteFromFile

List<ELElement> pasteFromFile(List<? extends ELElement> seqSel,
 Path file,
 boolean checkConstraint,
 Point pos)
                       throws InoNetException,
SrvErrorException

Pastes the content of the copy file buffer in this presentation context.

Parameters:

seqSel - Liste der markierten Elemente

file - content of paste buffer (result of copyToFile-command)

checkConstraint - prüft ob Konfiguration verletzt wird

pos - new position

Throws:

InoNetException

SrvErrorException

getOwnedPresContent

<T extends PRPresContent> List<T> getOwnedPresContent(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                               throws InoNetException,
SrvErrorException

All presentation contents owned by this presentation context.

Parameters:

returnType - Specifies the type of elements to be returned.

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwnedHeaderText

PRPresText getOwnedHeaderText()
                       throws InoNetException,
SrvErrorException

The header text of this context.

Throws:

InoNetException

SrvErrorException

getOwnedFooterText

PRPresText getOwnedFooterText()
                       throws InoNetException,
SrvErrorException

The footer text of this context.

Throws:

InoNetException

SrvErrorException