|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRPTableLayout
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 |
Method Detail |
---|
void addColumn(java.lang.String type, java.lang.String Property, java.lang.String ColumnName)
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.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 columnint addColumnEx(java.lang.String type, java.lang.String Property, java.lang.String ColumnName, java.lang.String Context)
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 columnContext
- 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.
RhapsodyRuntimeException
int getCollapseFirstColumn()
java.lang.String getColumnContext(int Index)
Index
- the index of the column (index of first column is 0)
RhapsodyRuntimeException
int getColumnDefaultWidth(int Index)
Index
- the index of the column whose default width should be returned (index of first column is 0)
RhapsodyRuntimeException
int getColumnImplementationAllowNew(int Index)
Index
- the index of the column (index of first column is 0)
1
if the picker includes the New option, 0
if it does not
RhapsodyRuntimeException
int getColumnImplementationAllowSelect(int Index)
Index
- the index of the column (index of first column is 0)
1
if the picker includes the Select option, 0
if it does not
RhapsodyRuntimeException
java.lang.String getColumnImplementationCellType(int Index)
IRPTableLayout.Column.ImplementationCellType
.
Index
- the index of the column (index of first column is 0)
RhapsodyRuntimeException
java.lang.String getColumnImplementationDisplayProperty(int Index)
IRPTableLayout.Column.GeneralAttribute
.
Index
- the index of the column (index of first column is 0)
RhapsodyRuntimeException
java.lang.String getColumnImplementationGetterCode(int Index)
Index
- the index of the column (index of first column is 0)
RhapsodyRuntimeException
java.lang.String getColumnImplementationImports(int Index)
Index
- the index of the column (index of first column is 0)
RhapsodyRuntimeException
java.lang.String getColumnImplementationPickerCode(int Index)
Index
- the index of the column (index of first column is 0)
RhapsodyRuntimeException
java.lang.String getColumnImplementationSetterCode(int Index)
Index
- the index of the column (index of first column is 0)
RhapsodyRuntimeException
java.lang.String getColumnName(int Index)
Index
- the index of the column whose name should be returned (index of first column is 0)
RhapsodyRuntimeException
java.lang.String getColumnProperty(int Index)
IRPTableLayout.Column
, for example, IRPTableLayout.Column.GeneralAttribute.NAME.
Index
- the index of the column (index of first column is 0)
RhapsodyRuntimeException
java.lang.String getColumnType(int Index)
IRPTableLayout.Column
.
Index
- the index of the column (index of first column is 0)
RhapsodyRuntimeException
IRPCollection getColumns()
RhapsodyRuntimeException
IRPCollection getElementTypes()
IRPCollection getFromElementTypes()
IRPTableLayout getFromElementTypesQueryToUse()
int getFromElementTypesUseQueryOrElementsList()
int getRelationTable()
IRPCollection getResultList(IRPModelElement scope)
RhapsodyRuntimeException
IRPCollection getToElementTypes()
IRPTableLayout getToElementTypesQueryToUse()
int getToElementTypesUseQueryOrElementsList()
void removeColumn(int Index)
Index
- the index representing the position of the column in the table. The index for the fist column in the table is 0.void setCollapseFirstColumn(int collapse)
collapse
- use 1 if the first column should include collapse/expand controls, 0 otherwise.void setColumnContext(int Index, java.lang.String Context)
Index
- the index of the column (index of first column is 0)Context
- a label from the context pattern that was defined
RhapsodyRuntimeException
void setColumnDefaultWidth(int Index, int width)
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)
RhapsodyRuntimeException
void setColumnImplementationAllowNew(int Index, int value)
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 notvoid setColumnImplementationAllowSelect(int Index, int value)
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
RhapsodyRuntimeException
void setColumnImplementationCellType(int Index, java.lang.String cellType)
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.
RhapsodyRuntimeException
void setColumnImplementationDisplayProperty(int Index, java.lang.String propertyToDisplay)
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.
RhapsodyRuntimeException
void setColumnImplementationGetterCode(int Index, java.lang.String code)
Index
- the index of the column (index of first column is 0)code
- the Java code to use for the getter
RhapsodyRuntimeException
void setColumnImplementationImports(int Index, java.lang.String imports)
Index
- the index of the column (index of first column is 0)imports
- a comma-separated list of classes to import
RhapsodyRuntimeException
void setColumnImplementationPickerCode(int Index, java.lang.String code)
Index
- the index of the column (index of first column is 0)code
- the Java code to use for the picker
RhapsodyRuntimeException
void setColumnImplementationSetterCode(int Index, java.lang.String code)
Index
- the index of the column (index of first column is 0)code
- the Java code to use for the setter
RhapsodyRuntimeException
void setColumnName(int Index, java.lang.String name)
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
RhapsodyRuntimeException
void setColumnProperty(int Index, java.lang.String Property)
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.
RhapsodyRuntimeException
void setColumnType(int Index, java.lang.String type)
IRPTableLayout.Column
.
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)
RhapsodyRuntimeException
void setElementTypes(IRPCollection elements)
elements
- the element types that should be displayed in the tablevoid setFromElementTypes(IRPCollection elements)
elements
- collection of element types to use as the "from" element types for the table layoutvoid setFromElementTypesQueryToUse(IRPTableLayout query)
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.void setFromElementTypesUseQueryOrElementsList(int queryOrElementsList)
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.void setRelationTable(int relation)
relation
- use 1 if the table should be defined as a "relation table", 0 otherwise.void setToElementTypes(IRPCollection elements)
elements
- collection of element types to use as the "to" element types for the table layoutvoid setToElementTypesQueryToUse(IRPTableLayout query)
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.void setToElementTypesUseQueryOrElementsList(int queryOrElementsList)
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.int getColumnCount()
RhapsodyRuntimeException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |