com.telelogic.rhapsody.core
Interface IRPTableLayout

All Superinterfaces:
IRPModelElement, IRPUnit

public interface IRPTableLayout
extends IRPUnit


Nested Class Summary
static class IRPTableLayout.Column
          This class holds constant values to be used with addColumn method.
static class IRPTableLayout.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
 void addColumn(java.lang.String type, java.lang.String Property, java.lang.String ColumnName)
          Adds a new column to the table layout.
 int addColumnEx(java.lang.String type, java.lang.String Property, java.lang.String ColumnName, java.lang.String Context)
          Adds a new column to the table layout.
 int getCollapseFirstColumn()
          Checks whether the first column of the layout includes controls for collapsing and expanding rows that have the same value in the first column.
 java.lang.String getColumnContext(int Index)
          Returns the context pattern label that was specified for the column.
 int getColumnCount()
          Returns the number of columns in the table layout.
 int getColumnDefaultWidth(int Index)
          Returns the default width that was defined for the specified column.
 int getColumnImplementationAllowNew(int Index)
          Checks whether the user-defined picker for the specified column includes the New option in its list.
 int getColumnImplementationAllowSelect(int Index)
          Checks whether the user-defined picker for the specified column includes the Select option in its list.
 java.lang.String getColumnImplementationCellType(int Index)
          Returns the type of information that is displayed in the column's cells - string, model element, or list of model elements.
 java.lang.String getColumnImplementationDisplayProperty(int Index)
          Returns the type of element information that is displayed when the cell value type is set to model element or list of model elements.
 java.lang.String getColumnImplementationGetterCode(int Index)
          Returns the Java code for the getter for the cells in the specified column.
 java.lang.String getColumnImplementationImports(int Index)
          For columns that use customized cell behavior, this method returns the list of imports specified for the column.
 java.lang.String getColumnImplementationPickerCode(int Index)
          Returns the Java code for the picker for the cells in the specified column.
 java.lang.String getColumnImplementationSetterCode(int Index)
          Returns the Java code for the setter for the cells in the specified column.
 java.lang.String getColumnName(int Index)
          Returns the name of the specified column.
 java.lang.String getColumnProperty(int Index)
          Returns the Property of the specified column.
 IRPCollection getColumns()
           
 java.lang.String getColumnType(int Index)
          Returns the type of the specified table column.
 IRPCollection getElementTypes()
          Returns a collection of the element types that were specified to be displayed in the table.
 IRPCollection getFromElementTypes()
          For "relation tables", returns a collection of the element types specified as the "from" element types.
 IRPTableLayout getFromElementTypesQueryToUse()
          For "relation tables", returns the query that was specified to determine the "from" element types.
 int getFromElementTypesUseQueryOrElementsList()
          For "relation tables", checks whether a query or collection of element types was used to specify the "from" element types.
 int getRelationTable()
          Checks whether the table was defined as a "relation table".
 IRPCollection getResultList(IRPModelElement scope)
          method GetResultList
 IRPCollection getToElementTypes()
          For "relation tables", returns a collection of the element types specified as the "to" element types.
 IRPTableLayout getToElementTypesQueryToUse()
          For "relation tables", returns the query that was specified to determine the "to" element types.
 int getToElementTypesUseQueryOrElementsList()
          For "relation tables", checks whether a query or collection of element types was used to specify the "to" element types.
 void removeColumn(int Index)
          Removes the specified column from the table layout.
 void setCollapseFirstColumn(int collapse)
          Specifies whether or not the fist column should include controls for collapsing and expanding rows that have the same value in the first column.
 void setColumnContext(int Index, java.lang.String Context)
          If you have defined a context pattern, this method can be used to specify a label from the context pattern, for the specified column.
 void setColumnDefaultWidth(int Index, int width)
          Sets the default width of the specified column.
 void setColumnImplementationAllowNew(int Index, int value)
          For columns that use customized cell behavior, this method can be used to include the New option in the list provided by the picker.
 void setColumnImplementationAllowSelect(int Index, int value)
          For columns that use customized cell behavior, this method can be used to include the Select option in the list provided by the picker.
 void setColumnImplementationCellType(int Index, java.lang.String cellType)
          For columns that use customized cell behavior, this method is used to specify the type of information that will be displayed in the column's cells - string, model element, or list of model elements.
 void setColumnImplementationDisplayProperty(int Index, java.lang.String propertyToDisplay)
          For columns that use customized cell behavior, this method is used to specify the type of element information that should be displayed when the cell value type is set to model element or list of model elements, for example, the name or value of the element.
 void setColumnImplementationGetterCode(int Index, java.lang.String code)
          For columns that use customized cell behavior, this method is used to specify the Java code for the getter for the cells in the column.
 void setColumnImplementationImports(int Index, java.lang.String imports)
          For columns that use customized cell behavior, this method can be used to specify classes required by your code.
 void setColumnImplementationPickerCode(int Index, java.lang.String code)
          For columns that use customized cell behavior, this method is used to specify the Java code for the picker for the cells in the column.
 void setColumnImplementationSetterCode(int Index, java.lang.String code)
          For columns that use customized cell behavior, this method is used to specify the Java code for the setter for the cells in the column.
 void setColumnName(int Index, java.lang.String name)
          Sets the name of the specified column.
 void setColumnProperty(int Index, java.lang.String Property)
          Sets the Property of the specified column.
 void setColumnType(int Index, java.lang.String type)
          Sets the type of the specified table column.
 void setElementTypes(IRPCollection elements)
          Specifies the list of element types that should be displayed in the table.
 void setFromElementTypes(IRPCollection elements)
          For "relation tables", specifies the list of element types to use as the "from" element types.
 void setFromElementTypesQueryToUse(IRPTableLayout query)
          For "relation tables", specifies the query to use to determine the "from" element types for the table layout.
 void setFromElementTypesUseQueryOrElementsList(int queryOrElementsList)
          For "relation tables", specifies whether a query or collection of element types should be used to determine the "from" element types for the table layout.
 void setRelationTable(int relation)
          Specifies whether the table should be defined as a "relation table".
 void setToElementTypes(IRPCollection elements)
          For "relation tables", specifies the list of element types to use as the "to" element types for the table layout.
 void setToElementTypesQueryToUse(IRPTableLayout query)
          For "relation tables", specifies the query to use to determine the "to" element types for the table layout.
 void setToElementTypesUseQueryOrElementsList(int queryOrElementsList)
          For "relation tables", specifies whether a query or collection of element types should be used to determine the "to" element types for the table 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

addColumn

void addColumn(java.lang.String type,
               java.lang.String Property,
               java.lang.String ColumnName)
Adds a new column to the table layout.

Parameters:
type - the column Type (equivalent to Type field in the UI) - the valid values for this parameter are the constants that are defined in the class IRPTableLayout.Column, for example, IRPTableLayout.Column.ANNOTATION_ATTRIBUTE.
Property - the column Property (equivalent to Property field in the UI) - the valid values for this parameter are the constants defined in the classes nested beneath the class IRPTableLayout.Column. The nested class to use depends upon the value used for the "type" parameter.
For example, if the value of the "type" parameter is IRPTableLayout.Column.ANNOTATION_ATTRIBUTE, the valid values for the "Property" parameter are the constants defined in the nested class IRPTableLayout.Column.AnnotationAttribute, such as IRPTableLayout.Column.AnnotationAttribute.ID and IRPTableLayout.Column.AnnotationAttribute.SPECIFICATION.

However, if you specified TAG, TAG_EDIT, TAG_EDIT_STRICT, or USER_DEFINED_METHOD as the "type" parameter, you must provide a string that reflects the full path of the relevant tag or the name of the relevant plugin method.

For TAG, TAG_EDIT, and TAG_EDIT_STRICT, use the string that is returned when you call the method getFullPathName for the tag.

If you specified USER_DEFINED_METHOD as the type, the Property parameter should take the form pluginName.method. (If you do not specify the plugin name, all plugins will be searched until a method with the specified name is found).

ColumnName - the text to use as the heading for the column

addColumnEx

int addColumnEx(java.lang.String type,
                java.lang.String Property,
                java.lang.String ColumnName,
                java.lang.String Context)
Adds a new column to the table layout. Differs from the addColumn method in that it allows you to also specify a label from a context pattern and it returns the index of the new column added.

Parameters:
type - the type to use for the column (one of the constants defined in the class IRPTableLayout.Column, for example, IRPTableLayout.Column.GENERAL_ATTRIBUTE)
Property - the Property to use for the specified column. The values that can be used for this parameter are the constants defined in the classes nested under IRPTableLayout.Column, for example, IRPTableLayout.Column.GeneralAttribute.NAME. Note that the Property must match the column type. For example, if the type of the column was set to IRPTableLayout.Column.ANNOTATION_ATTRIBUTE, the available values for the Property of the column are the constants defined in the class IRPTableLayout.Column.AnnotationAttribute, such as IRPTableLayout.Column.AnnotationAttribute.ID and IRPTableLayout.Column.AnnotationAttribute.SPECIFICATION.
ColumnName - the text to use as the heading for the column
Context - a label from the context pattern that was defined. If you do not want to specify a context pattern label, use an empty string for this parameter.
Returns:
the index of the new column that was created (index of first column is 0)
Throws:
RhapsodyRuntimeException

getCollapseFirstColumn

int getCollapseFirstColumn()
Checks whether the first column of the layout includes controls for collapsing and expanding rows that have the same value in the first column.

Returns:
1 if the first column includes collapse/expand controls, 0 otherwise

getColumnContext

java.lang.String getColumnContext(int Index)
Returns the context pattern label that was specified for the column.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
the context pattern label that was specified for the column
Throws:
RhapsodyRuntimeException

getColumnDefaultWidth

int getColumnDefaultWidth(int Index)
Returns the default width that was defined for the specified column.

Parameters:
Index - the index of the column whose default width should be returned (index of first column is 0)
Returns:
the default width defined for the specified column (in pixels)
Throws:
RhapsodyRuntimeException

getColumnImplementationAllowNew

int getColumnImplementationAllowNew(int Index)
Checks whether the user-defined picker for the specified column includes the New option in its list.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
1 if the picker includes the New option, 0 if it does not
Throws:
RhapsodyRuntimeException

getColumnImplementationAllowSelect

int getColumnImplementationAllowSelect(int Index)
Checks whether the user-defined picker for the specified column includes the Select option in its list.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
1 if the picker includes the Select option, 0 if it does not
Throws:
RhapsodyRuntimeException

getColumnImplementationCellType

java.lang.String getColumnImplementationCellType(int Index)
Returns the type of information that is displayed in the column's cells - string, model element, or list of model elements. The value returned will be one of the constants defined in the class IRPTableLayout.Column.ImplementationCellType.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
the type of information that is displayed in the column's cells (one of the constants defined in the class IRPTableLayout.Column.ImplementationCellType, for example, IRPTableLayout.Column.ImplementationCellType.MODEL_ELEMENT)
Throws:
RhapsodyRuntimeException

getColumnImplementationDisplayProperty

java.lang.String getColumnImplementationDisplayProperty(int Index)
Returns the type of element information that is displayed when the cell value type is set to model element or list of model elements. The value returned will be one of the constants defined in the class IRPTableLayout.Column.GeneralAttribute.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
the type of element information that is displayed when the cell value type is set to model element or list of model elements (one of the constants defined in the class IRPTableLayout.Column.GeneralAttribute, for example, IRPTableLayout.Column.GeneralAttribute.NAME)
Throws:
RhapsodyRuntimeException

getColumnImplementationGetterCode

java.lang.String getColumnImplementationGetterCode(int Index)
Returns the Java code for the getter for the cells in the specified column.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
the Java code for the getter for the cells in the column
Throws:
RhapsodyRuntimeException

getColumnImplementationImports

java.lang.String getColumnImplementationImports(int Index)
For columns that use customized cell behavior, this method returns the list of imports specified for the column.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
comma-separated list of the imports specified for the column
Throws:
RhapsodyRuntimeException

getColumnImplementationPickerCode

java.lang.String getColumnImplementationPickerCode(int Index)
Returns the Java code for the picker for the cells in the specified column.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
the Java code for the picker for the cells in the column
Throws:
RhapsodyRuntimeException

getColumnImplementationSetterCode

java.lang.String getColumnImplementationSetterCode(int Index)
Returns the Java code for the setter for the cells in the specified column.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
the Java code for the setter for the cells in the column
Throws:
RhapsodyRuntimeException

getColumnName

java.lang.String getColumnName(int Index)
Returns the name of the specified column.

Parameters:
Index - the index of the column whose name should be returned (index of first column is 0)
Returns:
the name of the specified column
Throws:
RhapsodyRuntimeException

getColumnProperty

java.lang.String getColumnProperty(int Index)
Returns the Property of the specified column. Corresponds to the Property field on the Columns tab for table layouts. The value returned will be one of the constants defined in the classes nested under IRPTableLayout.Column, for example, IRPTableLayout.Column.GeneralAttribute.NAME.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
the Property of the specified column. Value returned will be one of the constants defined in the classes nested under IRPTableLayout.Column, for example, IRPTableLayout.Column.GeneralAttribute.NAME
Throws:
RhapsodyRuntimeException

getColumnType

java.lang.String getColumnType(int Index)
Returns the type of the specified table column. The value returned will be one of the constants defined in the class IRPTableLayout.Column.

Parameters:
Index - the index of the column (index of first column is 0)
Returns:
the type of the table column (one of the constants defined in the class IRPTableLayout.Column, for example, IRPTableLayout.Column.ANNOTATION_ATTRIBUTE)
Throws:
RhapsodyRuntimeException

getColumns

IRPCollection getColumns()
Returns:
collection of columns
Throws:
RhapsodyRuntimeException

getElementTypes

IRPCollection getElementTypes()
Returns a collection of the element types that were specified to be displayed in the table. The collection consists of strings (from the list of types displayed on the ElementTypes tab of the Features window for table layouts).

Returns:
the element types that were specified to be displayed in the table

getFromElementTypes

IRPCollection getFromElementTypes()
For "relation tables", returns a collection of the element types specified as the "from" element types. The collection consists of strings (from the list of types displayed on the From Element Types tab of the Features window for table layouts).

Returns:
the types specified as the "from" element types for the table layout

getFromElementTypesQueryToUse

IRPTableLayout getFromElementTypesQueryToUse()
For "relation tables", 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 table layout

getFromElementTypesUseQueryOrElementsList

int getFromElementTypesUseQueryOrElementsList()
For "relation tables", 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 IRPTableLayout.QueryOrElementsList: QUERY if a query was used, ELEMENTS_LIST if a collection of element types was used.

getRelationTable

int getRelationTable()
Checks whether the table was defined as a "relation table".

Returns:
1 if the table was defined as a "relation table", 0 otherwise

getResultList

IRPCollection getResultList(IRPModelElement scope)
method GetResultList

Throws:
RhapsodyRuntimeException

getToElementTypes

IRPCollection getToElementTypes()
For "relation tables", returns a collection of the element types specified as the "to" element types. The collection consists of strings (from the list of types displayed on the To Element Types tab of the Features window for table layouts).

Returns:
the types specified as the "to" element types for the table layout

getToElementTypesQueryToUse

IRPTableLayout getToElementTypesQueryToUse()
For "relation tables", 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 table layout

getToElementTypesUseQueryOrElementsList

int getToElementTypesUseQueryOrElementsList()
For "relation tables", 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 IRPTableLayout.QueryOrElementsList: QUERY if a query was used, ELEMENTS_LIST if a collection of element types was used.

removeColumn

void removeColumn(int Index)
Removes the specified column from the table layout.

Parameters:
Index - the index representing the position of the column in the table. The index for the fist column in the table is 0.

setCollapseFirstColumn

void setCollapseFirstColumn(int collapse)
Specifies whether or not the fist column should include controls for collapsing and expanding rows that have the same value in the first column.

Parameters:
collapse - use 1 if the first column should include collapse/expand controls, 0 otherwise.

setColumnContext

void setColumnContext(int Index,
                      java.lang.String Context)
If you have defined a context pattern, this method can be used to specify a label from the context pattern, for the specified column.

Parameters:
Index - the index of the column (index of first column is 0)
Context - a label from the context pattern that was defined
Throws:
RhapsodyRuntimeException

setColumnDefaultWidth

void setColumnDefaultWidth(int Index,
                           int width)
Sets the default width of the specified column. If a user double-clicks the column border after manually changing the width, the width will return to this value.

Parameters:
Index - the index of the column whose default width should be set (index of first column is 0)
width - the default width to use for the column (in pixels)
Throws:
RhapsodyRuntimeException

setColumnImplementationAllowNew

void setColumnImplementationAllowNew(int Index,
                                     int value)
For columns that use customized cell behavior, this method can be used to include the New option in the list provided by the picker.

Parameters:
Index - the index of the column (index of first column is 0)
value - use 1 if the New option should be included in the list, 0 if it should not

setColumnImplementationAllowSelect

void setColumnImplementationAllowSelect(int Index,
                                        int value)
For columns that use customized cell behavior, this method can be used to include the Select option in the list provided by the picker.

Parameters:
Index - the index of the column (index of first column is 0)
value - use 1 if the Select option should be included in the list, 0 if it should not
Throws:
RhapsodyRuntimeException

setColumnImplementationCellType

void setColumnImplementationCellType(int Index,
                                     java.lang.String cellType)
For columns that use customized cell behavior, this method is used to specify the type of information that will be displayed in the column's cells - string, model element, or list of model elements.

Parameters:
Index - the index of the column (index of first column is 0)
cellType - the type of information that will be displayed in the column's cells. The valid values for this parameter are the constants that are defined in the class IRPTableLayout.Column.ImplementationCellType, for example IRPTableLayout.Column.ImplementationCellType.MODEL_ELEMENT.
Throws:
RhapsodyRuntimeException

setColumnImplementationDisplayProperty

void setColumnImplementationDisplayProperty(int Index,
                                            java.lang.String propertyToDisplay)
For columns that use customized cell behavior, this method is used to specify the type of element information that should be displayed when the cell value type is set to model element or list of model elements, for example, the name or value of the element.

Parameters:
Index - the index of the column (index of first column is 0)
propertyToDisplay - the type of element information that should be displayed for the element or elements in the cell. The valid values for this parameter are the constants defined in the class IRPTableLayout.Column.GeneralAttribute, such as IRPTableLayout.Column.GeneralAttribute.NAME.
Throws:
RhapsodyRuntimeException

setColumnImplementationGetterCode

void setColumnImplementationGetterCode(int Index,
                                       java.lang.String code)
For columns that use customized cell behavior, this method is used to specify the Java code for the getter for the cells in the column.

Parameters:
Index - the index of the column (index of first column is 0)
code - the Java code to use for the getter
Throws:
RhapsodyRuntimeException

setColumnImplementationImports

void setColumnImplementationImports(int Index,
                                    java.lang.String imports)
For columns that use customized cell behavior, this method can be used to specify classes required by your code. Corresponds to the Imports field in the User Defined Implementation dialog. The list of imports should be comma-separated.

Parameters:
Index - the index of the column (index of first column is 0)
imports - a comma-separated list of classes to import
Throws:
RhapsodyRuntimeException

setColumnImplementationPickerCode

void setColumnImplementationPickerCode(int Index,
                                       java.lang.String code)
For columns that use customized cell behavior, this method is used to specify the Java code for the picker for the cells in the column.

Parameters:
Index - the index of the column (index of first column is 0)
code - the Java code to use for the picker
Throws:
RhapsodyRuntimeException

setColumnImplementationSetterCode

void setColumnImplementationSetterCode(int Index,
                                       java.lang.String code)
For columns that use customized cell behavior, this method is used to specify the Java code for the setter for the cells in the column.

Parameters:
Index - the index of the column (index of first column is 0)
code - the Java code to use for the setter
Throws:
RhapsodyRuntimeException

setColumnName

void setColumnName(int Index,
                   java.lang.String name)
Sets the name of the specified column.

Parameters:
Index - the index of the column whose name should be set (index of first column is 0)
name - the name to use for the column
Throws:
RhapsodyRuntimeException

setColumnProperty

void setColumnProperty(int Index,
                       java.lang.String Property)
Sets the Property of the specified column. Corresponds to the Property field on the Columns tab for table layouts.

Parameters:
Index - the index of the column (index of first column is 0)
Property - the Property to use for the specified column. The values that can be used for this parameter are the constants defined in the classes nested under IRPTableLayout.Column, for example, IRPTableLayout.Column.GeneralAttribute.NAME. Note that the Property must match the column type. For example, if the type of the column was set to IRPTableLayout.Column.ANNOTATION_ATTRIBUTE, the available values for the Property of the column are the constants defined in the class IRPTableLayout.Column.AnnotationAttribute, such as IRPTableLayout.Column.AnnotationAttribute.ID and IRPTableLayout.Column.AnnotationAttribute.SPECIFICATION.
Throws:
RhapsodyRuntimeException

setColumnType

void setColumnType(int Index,
                   java.lang.String type)
Sets the type of the specified table column. The type must be one of the constants defined in the class IRPTableLayout.Column.

Parameters:
Index - the index of the column (index of first column is 0)
type - the type to use for the column (one of the constants defined in the class IRPTableLayout.Column, for example, IRPTableLayout.Column.GENERAL_ATTRIBUTE)
Throws:
RhapsodyRuntimeException

setElementTypes

void setElementTypes(IRPCollection elements)
Specifies the list of element types that should be displayed in the table. The parameter must be a collection of strings (from the list of types displayed on the ElementTypes tab of the Features window for table layouts).

Parameters:
elements - the element types that should be displayed in the table

setFromElementTypes

void setFromElementTypes(IRPCollection elements)
For "relation tables", specifies the list of element types to use as the "from" element types. The parameter must be a collection of strings (from the list of types displayed on the From Element Types tab of the Features window for table layouts).

Parameters:
elements - collection of element types to use as the "from" element types for the table layout

setFromElementTypesQueryToUse

void setFromElementTypesQueryToUse(IRPTableLayout query)
For "relation tables", specifies the query to use to determine the "from" element types for the table layout.

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

setFromElementTypesUseQueryOrElementsList

void setFromElementTypesUseQueryOrElementsList(int queryOrElementsList)
For "relation tables", specifies whether a query or collection of element types should be used to determine the "from" element types for the table layout.

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

setRelationTable

void setRelationTable(int relation)
Specifies whether the table should be defined as a "relation table".

Parameters:
relation - use 1 if the table should be defined as a "relation table", 0 otherwise.

setToElementTypes

void setToElementTypes(IRPCollection elements)
For "relation tables", specifies the list of element types to use as the "to" element types for the table layout. 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 table layouts).

Parameters:
elements - collection of element types to use as the "to" element types for the table layout

setToElementTypesQueryToUse

void setToElementTypesQueryToUse(IRPTableLayout query)
For "relation tables", specifies the query to use to determine the "to" element types for the table layout.

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

setToElementTypesUseQueryOrElementsList

void setToElementTypesUseQueryOrElementsList(int queryOrElementsList)
For "relation tables", specifies whether a query or collection of element types should be used to determine the "to" element types for the table layout.

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

getColumnCount

int getColumnCount()
Returns the number of columns in the table layout.

Returns:
the number of columns in the table layout
Throws:
RhapsodyRuntimeException