CIP JAVA documentation for class "com.ptc.pfc.pfcSheet.SheetOwner"

Interface SheetOwner

package com.ptc.pfc.pfcSheet; public interface SheetOwner extends jxobject

Description

This interface represents a model containing sheets.

Direct Known Subclasses:: Model2D

Method Summary
`int`	`AddSheet ()` Adds a sheet to the model.
`void`	`DeleteSheet (int SheetNumber)` Removes a sheet from the model.
`int`	`GetCurrentSheetNumber ()` Get method for attribute "CurrentSheetNumber" The current sheet number.
`int`	`GetNumberOfSheets ()` Get method for attribute "NumberOfSheets" The number of sheets in the model.
`View2D`	`GetSheetBackgroundView (int SheetNumber)` Returns the background view for the given sheet.
`/optional/ SheetData`	`GetSheetData (int SheetNumber)` Returns information about the specified sheet.
`/optional/ DrawingFormat`	`GetSheetFormat (int SheetNumber)` Returns the drawing format used for the particular sheet.
`ModelDescriptor`	`GetSheetFormatDescr (int SheetNumber)` Returns the model descriptor of the drawing format used for the particular sheet.
`/optional/ SheetInfo`	`GetSheetInfo (int SheetNumber)` Returns information about the specified sheet.
`double`	`GetSheetScale (int SheetNumber, /optional/ Model DrawingModel)` Returns the scale of the drawing on particular sheet.
`Transform3D`	`GetSheetTransform (int SheetNumber)` Returns the transformation matrix for the sheet.
`Unit`	`GetSheetUnits (int SheetNumber)` Returns the length units for the given sheet.
`void`	`RegenerateSheet (int SheetNumber)` Regenerates a specified sheet.
`void`	`ReorderSheet (int FromSheetNumber, int To)` Reorders the given sheet to a new sheet number.
`void`	`SetCurrentSheetNumber (int value)` Set method for attribute "CurrentSheetNumber" The current sheet number.
`void`	`SetSheetFormat (int SheetNumber, DrawingFormat Format, /optional/ Integer FormatSheetNumber, /optional/ Model DrawingModel)` Applies the specified format to a drawing sheet.
`void`	`SetSheetScale (int SheetNumber, double Scale, /optional/ Model DrawingModel)` Sets the scale for a model on the sheet.

Method Detail

GetNumberOfSheets

int GetNumberOfSheets ()

The number of sheets in the model.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

GetCurrentSheetNumber/SetCurrentSheetNumber

`int`	`GetCurrentSheetNumber`	`()`
`void`	`SetCurrentSheetNumber`	`(int value)`

The current sheet number.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

AddSheet

int AddSheet ()

Adds a sheet to the model.

Exceptions thrown (but not limited to):

XToolkitNotFound - The function failed because you do not have the required modules.

XToolkitInvalidItem - The function did nothing because the model already has the maximum number of sheets allowed.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Returns:: The number of the new sheet added.

ReorderSheet

void ReorderSheet (int FromSheetNumber, int To)

Reorders the given sheet to a new sheet number.

Reordering will cause other affected sheets to change their sheet numbers as well.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

FromSheetNumber: The sheet number to reorder. Sheet numbers range from 1 to the number of sheets.
To: The new sheet number for the sheet.

Returns:

GetSheetData

/*optional*/ SheetData GetSheetData (int SheetNumber)

Returns information about the specified sheet.

This method is deprecated. Use SheetOwner.GetSheetInfo(int) instead.

Manual References:: Drawings: Drawing Sheet Information

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The sheet data, including size, orientation, and units.

GetSheetInfo

/*optional*/ SheetInfo GetSheetInfo (int SheetNumber)

Returns information about the specified sheet.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The sheet info including size, orientation, and units.

GetSheetTransform

Transform3D GetSheetTransform (int SheetNumber)

Returns the transformation matrix for the sheet.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The transformation matrix for the sheet.

RegenerateSheet

void RegenerateSheet (int SheetNumber)

Regenerates a specified sheet.

The sheet must be displayed.

Manual References:: Drawings: Drawing Operations, Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:

DeleteSheet

void DeleteSheet (int SheetNumber)

Removes a sheet from the model.

Exceptions thrown (but not limited to):

XToolkitNotFound - The function failed because you do not have the required modules.

XToolkitInvalidItem - The function did nothing because the specified sheet is not in the specified drawing.

XToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

SheetNumber: The number of the sheet to remove.

Returns:

GetSheetScale

double GetSheetScale (int SheetNumber, /*optional*/ Model DrawingModel)

Returns the scale of the drawing on particular sheet.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.
DrawingModel: The model used to measure the scale. If null, the function uses the current model in the drawing.

Returns:: The sheet scale. If no models are used in the drawing, the scale is 1.0.

SetSheetScale

void SetSheetScale (int SheetNumber, double Scale, /*optional*/ Model DrawingModel)

Sets the scale for a model on the sheet.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.
Scale: The scale to use.
DrawingModel: The drawing model to scale. Pass null to use the current drawing model.

Returns:

GetSheetFormat

/*optional*/ DrawingFormat GetSheetFormat (int SheetNumber)

Returns the drawing format used for the particular sheet.

Exceptions thrown (but not limited to):

XToolkitNotFound - Format for the sheet was not found.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The drawing format, or null, if no format is assigned to the sheet.

SetSheetFormat

void SetSheetFormat (int SheetNumber, DrawingFormat Format, /*optional*/ Integer FormatSheetNumber, /*optional*/ Model DrawingModel)

Applies the specified format to a drawing sheet.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

SheetNumber: The sheet number to apply the format. Sheet numbers range from 1 to the number of sheets.
Format: The drawing format to apply.
FormatSheetNumber: The sheet number of the format to apply. This number can range from 1 to the number of sheets in the format. Pass null to use the first format sheet.
DrawingModel: The drawing model (used when resolving parameters in the format). Pass null to use the current drawing model.

Returns:

GetSheetBackgroundView

View2D GetSheetBackgroundView (int SheetNumber)

Returns the background view for the given sheet.

The sheet background view is used for the placement of items in the drawing without associating them to a particular model view.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information, Drawings: Obtaining Drawing Views, Drawings: Instructions

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 up to the number of sheets.

Returns:: The background view object.

GetSheetUnits

Unit GetSheetUnits (int SheetNumber)

Returns the length units for the given sheet.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 up to the number of sheets.

Returns:: The units.

GetSheetFormatDescr

ModelDescriptor GetSheetFormatDescr (int SheetNumber)

Returns the model descriptor of the drawing format used for the particular sheet.

Exceptions thrown (but not limited to):

XToolkitNotFound - Format for the sheet was not found.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The model descriptor of the drawing format.