CIP JAVA documentation for class "com.ptc.pfc.pfcTable.Table"

Interface Table

package com.ptc.pfc.pfcTable; public interface Table extends com.ptc.pfc.pfcModelItem.ModelItem

Description

This interface represents a drawing table in a Creo Parametric model.

See Also:: ModelItemOwner.ListItems(/*optional*/ ModelItemType), ModelItemOwner.GetItemById(ModelItemType, int), TableOwner.CreateTable(TableCreateInstructions), TableOwner.RetrieveTable(TableRetrieveInstructions)

Direct Known Subclasses:: WTable

Method Summary
`boolean`	`CheckIfIsFromFormat (int SheetNumber)` Identifies if the drawing table was created by the format.
`void`	`DeleteColumn (int Column, /optional/ Boolean Repaint)` Deletes a column in the table.
`void`	`DeleteRow (int Row, /optional/ Boolean Repaint)` Deletes a row in the table.
`void`	`Display ()` Displays the table, if it has been erased.
`void`	`Erase ()` Erases the table.
`/optional/ ComponentPath`	`GetCellComponentModel (TableCell Cell)` Returns the component model referred to by a cell in a repeat region of a table. This function will not return a valid result if the cell has the attribute "NO DUPLICATE" or "NO DUPLICATE/LEVEL" as there is no unique path available. In that case use the functions `Table.GetCellTopModel(TableCell)` (for Top level model) or `Table.GetCellReferenceModel(TableCell)`.
`/optional/ ModelItem`	`GetCellNote (TableCell Cell)` Returns the detail note contained in the table cell.
`/optional/ Model`	`GetCellReferenceModel (TableCell Cell)` Returns the reference component referred to by this cell in a repeat region drawing table. Differs from `Table.GetCellComponentModel(TableCell)` in that this function will return the reference object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL".
`/optional/ Assembly`	`GetCellTopModel (TableCell Cell)` Returns the top model referred to by this cell in a repeat region drawing table. Differs from `Table.GetCellComponentModel(TableCell)` in that this function will return the object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL".
`int`	`GetColumnCount ()` Returns the number of columns in the table.
`double`	`GetColumnSize (int SegmentId, int Column)` Returns the width of the drawing table column.
`TableInfo`	`GetInfo (int SegmentId)` Returns information about the drawing table.
`int`	`GetRowCount ()` Returns the number of rows in the table.
`double`	`GetRowSize (int SegmentId, int Row)` Returns the height of the row.
`int`	`GetSegmentCount ()` Returns the number of segments in the table.
`int`	`GetSegmentSheet (int SegmentNumber)` Returns the sheet where a particuar table segment lies.
`stringseq`	`GetText (TableCell Cell, ParamMode Mode)` Returns the text in a drawing table cell.
`void`	`InsertColumn (double Width, /optional/ Integer InsertAfterColumn, /optional/ Boolean Repaint)` Inserts a column in the drawing table.
`void`	`InsertRow (double Height, /optional/ Integer InsertAfterRow, /optional/ Boolean Repaint)` Inserts a new row into the table.
`boolean`	`IsCommentCell (TableCell Cell)` Determines if a table cell is a comment cell in a repeat region.
`void`	`MergeRegion (TableCell UpperLeft, TableCell LowerRight, /optional/ Boolean Repaint)` Merges a rectangular section of table cells.
`void`	`MoveSegment (int SegmentNumber, Point3D NewPosition, /optional/ Boolean Repaint)` Moves a segment of the table.
`void`	`RotateClockwise (RotationDegree Rotation, /optional/ Boolean Repaint)` Rotates a table clockwise.
`void`	`SetText (TableCell Cell, stringseq Lines)` Sets the text in the table cell.
`void`	`SubdivideRegion (TableCell UpperLeft, TableCell LowerRight, /optional/ Boolean Repaint)` Removes all merges in the specified region of previously merged cells.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Method Detail

GetRowCount

int GetRowCount ()

Returns the number of rows in the table.

Exceptions thrown (but not limited to):

XToolkitNotExist - The specified table or drawing does not exist.

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Returns:: The number of rows.

GetColumnCount

int GetColumnCount ()

Returns the number of columns in the table.

Exceptions thrown (but not limited to):

XToolkitNotExist - The specified table or drawing does not exist.

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Returns:: The number of columns.

Display

void Display ()

Displays the table, if it has been erased.

See Also:: Table.Erase()

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Returns:

Erase

void Erase ()

Erases the table.

See Also:: Table.Display()

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Returns:

RotateClockwise

void RotateClockwise (RotationDegree Rotation, /*optional*/ Boolean Repaint)

Rotates a table clockwise.

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

Rotation: The amount of rotation.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Returns:

CheckIfIsFromFormat

boolean CheckIfIsFromFormat (int SheetNumber)

Identifies if the drawing table was created by the format.

SheetNumber is ignored in this method.

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Parameters:

SheetNumber: The sheet number.

Returns:: true if the table was created by applying the drawing format.

GetInfo

TableInfo GetInfo (int SegmentId)

Returns information about the drawing table.

See Also:: Table.GetSegmentCount()

Manual References:: Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

Parameters:

SegmentId: The segment identifier. Segment ids start at 0.

Returns:: The table information, including the rotation, column and row information, and outline.

InsertRow

void InsertRow (double Height, /*optional*/ Integer InsertAfterRow, /*optional*/ Boolean Repaint)

Inserts a new row into the table.

See Also:: Table.GetRowCount()

Parameters:

Height: The row height. This argument should be in number of characters, even if the table was created using a height type of TABLESIZE_BY_LENGTH.
InsertAfterRow: The row number. Enter 0 to insert a new first row. Row numbers range from 1 to the number of rows.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Returns:

InsertColumn

void InsertColumn (double Width, /*optional*/ Integer InsertAfterColumn, /*optional*/ Boolean Repaint)

Inserts a column in the drawing table.

See Also:: Table.GetColumnCount()

Parameters:

Width: The width of the inserted column.
InsertAfterColumn: The column number to insert after. Pass 0 to insert as the first column. Column numbers range from 1 to the number of columns.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Returns:

GetRowSize

double GetRowSize (int SegmentId, int Row)

Returns the height of the row.

See Also:: Table.GetRowCount(), Table.GetSegmentCount()

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Parameters:

SegmentId: The segment identifier. Segment ids range start at 0.
Row: The row number. Row numbers range from 1 to the number of rows.

Returns:: The row height.

GetColumnSize

double GetColumnSize (int SegmentId, int Column)

Returns the width of the drawing table column.

See Also:: Table.GetColumnCount(), Table.GetSegmentCount()

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Parameters:

SegmentId: The segment identifier. Segment identifiers start at 0.
Column: The column number. Column numbers range from 1 to the number of columns.

Returns:: The column size.

MergeRegion

void MergeRegion (TableCell UpperLeft, TableCell LowerRight, /*optional*/ Boolean Repaint)

Merges a rectangular section of table cells.

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

UpperLeft: The table cell on the upper left of the region.
LowerRight: The table cell on the lower right of the region.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Returns:

SubdivideRegion

void SubdivideRegion (TableCell UpperLeft, TableCell LowerRight, /*optional*/ Boolean Repaint)

Removes all merges in the specified region of previously merged cells.

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

UpperLeft: The upper left table cell to remesh.
LowerRight: The lower right table cell to remesh.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Returns:

DeleteRow

void DeleteRow (int Row, /*optional*/ Boolean Repaint)

Deletes a row in the table.

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

Row
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Returns:

DeleteColumn

void DeleteColumn (int Column, /*optional*/ Boolean Repaint)

Deletes a column in the table.

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

Column
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Returns:

GetSegmentCount

int GetSegmentCount ()

Returns the number of segments in the table.

Manual References:: Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

Returns:: The number of segments.

GetSegmentSheet

int GetSegmentSheet (int SegmentNumber)

Returns the sheet where a particuar table segment lies.

Exceptions thrown (but not limited to):

XToolkitBadContext - A -1 segment ID was used for a multiple segment table.

See Also:: Table.GetSegmentCount()

Manual References:: Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

Parameters:

SegmentNumber: The segement identifier. Segment ids start at 0.

Returns:: The sheet number.

MoveSegment

void MoveSegment (int SegmentNumber, Point3D NewPosition, /*optional*/ Boolean Repaint)

Moves a segment of the table.

Exceptions thrown (but not limited to):

XToolkitBadContext - A -1 segment ID was used for a multiple segment table.

Manual References:: Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

Parameters:

SegmentNumber: The segment identifier. Segment ids start from 0.
NewPosition: The new location for the drawing table segment.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Returns:

SetText

void SetText (TableCell Cell, stringseq Lines)

Sets the text in the table cell.

Exceptions thrown (but not limited to):

XToolkitBadContext - A -1 segment ID was used for a multiple segment table.

See Also:: pfcTable.TableCell_Create(int, int)

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

Cell: The table cell.
Lines: The text for the table cell.

Returns:

IsCommentCell

boolean IsCommentCell (TableCell Cell)

Determines if a table cell is a comment cell in a repeat region.

Manual References:: Drawings: Repeat Regions, Drawings: Repeat Regions

Parameters:

Cell: The table cell.

Returns:: Whether or not the cell is a comment cell.

GetText

stringseq GetText (TableCell Cell, ParamMode Mode)

Returns the text in a drawing table cell.

If no text is found in the table cell, this method will throw a XToolkitGeneralError exception.

See Also:: pfcTable.TableCell_Create(int, int)

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Parameters:

Cell: The table cell.
Mode: The mode used to retrieve the text.

Returns:: Sequence of text in the table cell.

GetCellComponentModel

/*optional*/ ComponentPath GetCellComponentModel (TableCell Cell)

Returns the component model referred to by a cell in a repeat region of a table. This function will not return a valid result if the cell has the attribute "NO DUPLICATE" or "NO DUPLICATE/LEVEL" as there is no unique path available. In that case use the functions Table.GetCellTopModel(TableCell) (for Top level model) or Table.GetCellReferenceModel(TableCell).

Exceptions thrown (but not limited to):

XToolkitNotFound - The table cell does not contain a reference to a component model.

See Also:: pfcTable.TableCell_Create(int, int)

Manual References:: Drawings: Repeat Regions, Drawings: Repeat Regions

Parameters:

Cell: The table cell.

Returns:: The full path to the component referenced by the cell.

GetCellNote

/*optional*/ ModelItem GetCellNote (TableCell Cell)

Returns the detail note contained in the table cell.

Exceptions thrown (but not limited to):

XToolkitEmpty - The cell is empty.

See Also:: pfcTable.TableCell_Create(int, int)

Manual References:: Drawings: Drawing Tables Information

Parameters:

Cell: The table cell.

Returns:: The detail note item.

GetCellTopModel

/*optional*/ Assembly GetCellTopModel (TableCell Cell)

Returns the top model referred to by this cell in a repeat region drawing table. Differs from Table.GetCellComponentModel(TableCell) in that this function will return the object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL".

Exceptions thrown (but not limited to):

XToolkitNotFound - The cell does not have an associated model.

See Also:: pfcTable.TableCell_Create(int, int)

Manual References:: Drawings: Repeat Regions, Drawings: Repeat Regions

Parameters:

Cell: The table cell.

Returns:: The top model for the region.

GetCellReferenceModel

/*optional*/ Model GetCellReferenceModel (TableCell Cell)

Returns the reference component referred to by this cell in a repeat region drawing table. Differs from Table.GetCellComponentModel(TableCell) in that this function will return the reference object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL".

Exceptions thrown (but not limited to):

XToolkitNotFound - The cell does not have an associated model.

See Also:: pfcTable.TableCell_Create(int, int)

Manual References:: Drawings: Repeat Regions, Drawings: Repeat Regions

Parameters:

Cell: The table cell.

Returns:: The model of record for the cell.