com.telelogic.rhapsody.core
Interface IRPMatrixLayout

All Superinterfaces:
IRPModelElement, IRPUnit

public interface IRPMatrixLayout
extends IRPUnit


Nested Class Summary
static class IRPMatrixLayout.QueryOrElementsList
          This class contains constant values for use with the methods setFromElementTypesUseQueryOrElementsList and setToElementTypesUseQueryOrElementsList.
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPCollection getCellElementTypes()
          Returns a collection of the element types that were specified to be displayed in the cells of the matrix.
 IRPCollection getFromElementTypes()
          Returns a collection of the "from" element types specified to be displayed in the matrix.
 IRPTableLayout getFromElementTypesQueryToUse()
          Returns the query that was specified to determine the "from" element types.
 int getFromElementTypesUseQueryOrElementsList()
          Checks whether a query or collection of element types was used to specify the "from" element types.
 IRPCollection getToElementTypes()
          Returns a collection of the "to" element types specified to be displayed in the matrix.
 IRPTableLayout getToElementTypesQueryToUse()
          Returns the query that was specified to determine the "to" element types.
 int getToElementTypesUseQueryOrElementsList()
          Checks whether a query or collection of element types was used to specify the "to" element types.
 void setCellElementTypes(IRPCollection pCollection)
          Specifies the element types to display in the cells of the matrix.
 void setFromElementTypes(IRPCollection pCollection)
          Specifies the "from" element types that should be displayed in the matrix.
 void setFromElementTypesQueryToUse(IRPTableLayout query)
          Specifies the query to use to determine the "from" element types for the matrix layout.
 void setFromElementTypesUseQueryOrElementsList(int queryOrElementsList)
          Specifies whether a query or collection of element types should be used to determine the "from" element types for the matrix layout.
 void setToElementTypes(IRPCollection pCollection)
          Specifies the "to" element types that should be displayed in the matrix.
 void setToElementTypesQueryToUse(IRPTableLayout query)
          Specifies the query to use to determine the "to" element types for the matrix layout.
 void setToElementTypesUseQueryOrElementsList(int queryOrElementsList)
          Specifies whether a query or collection of element types should be used to determine the "to" element types for the matrix layout.
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPUnit
copyToAnotherProject, getAddToModelMode, getCMHeader, getCMState, getCurrentDirectory, getFilename, getIncludeInNextLoad, getIsStub, getLanguage, getLastModifiedTime, getNestedSaveUnits, getNestedSaveUnitsCount, getStructureDiagrams, isReadOnly, isReferenceUnit, isSeparateSaveUnit, load, moveToAnotherProjectLeaveAReference, referenceToAnotherProject, save, setCMHeader, setFilename, setIncludeInNextLoad, setLanguage, setReadOnly, setSeparateSaveUnit, setUnitPath, unload
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPModelElement
addAssociation, addDependency, addDependencyBetween, addDependencyTo, addLinkToElement, addNewAggr, addProperty, addRedefines, addRemoteDependencyTo, addSpecificStereotype, addStereotype, becomeTemplateInstantiationOf, changeTo, clone, createOSLCLink, deleteDependency, deleteFromProject, deleteOSLCLink, errorMessage, findElementsByFullName, findNestedElement, findNestedElementRecursive, getAllTags, getAnnotations, getAssociationClasses, getBinaryID, getConstraints, getConstraintsByHim, getControlledFiles, getDecorationStyle, getDependencies, getDescription, getDescriptionHTML, getDescriptionPlainText, getDescriptionRTF, getDisplayName, getDisplayNameRTF, getErrorMessage, getFullPathName, getFullPathNameIn, getGUID, getHyperLinks, getIconFileName, getInterfaceName, getIsExternal, getIsOfMetaClass, getIsShowDisplayName, getIsUnresolved, getLocalTags, getMainDiagram, getMetaClass, getName, getNestedElements, getNestedElementsByMetaClass, getNestedElementsRecursive, getNewTermStereotype, getOfTemplate, getOSLCLinks, getOverlayIconFileName, getOverriddenProperties, getOverriddenPropertiesByPattern, getOwnedDependencies, getOwner, getProject, getPropertyValue, getPropertyValueConditional, getPropertyValueConditionalExplicit, getPropertyValueExplicit, getRedefines, getReferences, getRemoteDependencies, getRemoteURI, getRequirementTraceabilityHandle, getSaveUnit, getStereotype, getStereotypes, getTag, getTemplateParameters, getTi, getToolTipHTML, getUserDefinedMetaClass, hasNestedElements, hasPanelWidget, highLightElement, isATemplate, isDescriptionRTF, isDisplayNameRTF, isModified, isRemote, locateInBrowser, lockOnDesignManager, openFeaturesDialog, removeProperty, removeRedefines, removeStereotype, setDecorationStyle, setDescription, setDescriptionAndHyperlinks, setDescriptionHTML, setDescriptionRTF, setDisplayName, setDisplayNameRTF, setGUID, setIsShowDisplayName, setMainDiagram, setName, setOfTemplate, setOwner, setPropertyValue, setRequirementTraceabilityHandle, setStereotype, setTagContextValue, setTagElementValue, setTagValue, setTi, synchronizeTemplateInstantiation, unlockOnDesignManager
 

Method Detail

getCellElementTypes

IRPCollection getCellElementTypes()
Returns a collection of the element types that were specified to be displayed in the cells of the matrix. The collection consists of strings (from the list of types displayed on the Cell Element Types tab of the Features window for matrix layouts).

Returns:
the element types that were specified to be displayed in the cells of the matrix

getFromElementTypes

IRPCollection getFromElementTypes()
Returns a collection of the "from" element types specified to be displayed in the matrix. The collection consists of strings (from the list of types displayed on the From Element Types tab of the Features window for matrix layouts).

Returns:
the "from" element types specified to be displayed in the matrix

getFromElementTypesQueryToUse

IRPTableLayout getFromElementTypesQueryToUse()
Returns the query that was specified to determine the "from" element types.

Returns:
the query that was specified to determine the "from" element types for the matrix layout

getFromElementTypesUseQueryOrElementsList

int getFromElementTypesUseQueryOrElementsList()
Checks whether a query or collection of element types was used to specify the "from" element types.

Returns:
one of the constants contained in the class IRPMatrixLayout.QueryOrElementsList: QUERY if a query was used, ELEMENTS_LIST if a collection of element types was used.

getToElementTypes

IRPCollection getToElementTypes()
Returns a collection of the "to" element types specified to be displayed in the matrix. The collection consists of strings (from the list of types displayed on the To Element Types tab of the Features window for matrix layouts).

Returns:
the "to" element types specified to be displayed in the matrix

getToElementTypesQueryToUse

IRPTableLayout getToElementTypesQueryToUse()
Returns the query that was specified to determine the "to" element types.

Returns:
the query that was specified to determine the "to" element types for the matrix layout

getToElementTypesUseQueryOrElementsList

int getToElementTypesUseQueryOrElementsList()
Checks whether a query or collection of element types was used to specify the "to" element types.

Returns:
one of the constants contained in the class IRPMatrixLayout.QueryOrElementsList: QUERY if a query was used, ELEMENTS_LIST if a collection of element types was used.

setCellElementTypes

void setCellElementTypes(IRPCollection pCollection)
Specifies the element types to display in the cells of the matrix. The parameter must be a collection of strings (from the list of types displayed on the Cell Element Types tab of the Features window for matrix layouts).

Parameters:
pCollection - the element types to display in the cells of the matrix

setFromElementTypes

void setFromElementTypes(IRPCollection pCollection)
Specifies the "from" element types that should be displayed in the matrix. The parameter must be a collection of strings (from the list of element types displayed on the From Element Types tab of the Features window for matrix layouts).

Parameters:
pCollection - the "from" element types that should be displayed in the matrix

setFromElementTypesQueryToUse

void setFromElementTypesQueryToUse(IRPTableLayout query)
Specifies the query to use to determine the "from" element types for the matrix layout.

Parameters:
query - the query to use to determine the "from" element types for the matrix layout. To clear a previous query, use null for the parameter.

setFromElementTypesUseQueryOrElementsList

void setFromElementTypesUseQueryOrElementsList(int queryOrElementsList)
Specifies whether a query or collection of element types should be used to determine the "from" element types for the matrix layout.

Parameters:
queryOrElementsList - one of the constants contained in the class IRPMatrixLayout.QueryOrElementsList: QUERY if a query should be used, ELEMENTS_LIST if a collection of element types should be used.

setToElementTypes

void setToElementTypes(IRPCollection pCollection)
Specifies the "to" element types that should be displayed in the matrix. The parameter must be a collection of strings (from the list of types displayed on the To Element Types tab of the Features window for matrix layouts).

Parameters:
pCollection - the "to" element types that should be displayed in the matrix

setToElementTypesQueryToUse

void setToElementTypesQueryToUse(IRPTableLayout query)
Specifies the query to use to determine the "to" element types for the matrix layout.

Parameters:
query - the query to use to determine the "to" element types for the matrix layout. To clear a previous query, use null for the parameter.

setToElementTypesUseQueryOrElementsList

void setToElementTypesUseQueryOrElementsList(int queryOrElementsList)
Specifies whether a query or collection of element types should be used to determine the "to" element types for the matrix layout.

Parameters:
queryOrElementsList - one of the constants contained in the class IRPMatrixLayout.QueryOrElementsList: QUERY if a query should be used, ELEMENTS_LIST if a collection of element types should be used.