CIP JAVA documentation for class "com.ptc.pfc.pfcLayer.Layer"

Interface Layer

package com.ptc.pfc.pfcLayer; public interface Layer extends com.ptc.pfc.pfcModelItem.ModelItem

Description

This class describes a layer.

The possible values for the display status are as follows:

LAYER_NORMAL
LAYER_DISPLAY
LAYER_BLANK
LAYER_HIDDEN

Direct Known Subclasses:: WLayer

Method Summary
`void`	`AddItem (ModelItem Item)` Adds the specified item to the layer.
`int`	`CountUnsupportedItems ()`
`void`	`Delete ()` Deletes the layer.
`DisplayStatus`	`GetStatus ()` Get method for attribute "Status" The display status
`boolean`	`HasUnsupportedItems ()` Returns `true` if the layer contains one or more item types not supported as `ModelItem` objects in PFC. Returns `false` otherwise.
`ModelItems`	`ListItems ()` This method returns only items which are supported as `ModelItem` objects in PFC. To identify if the layer has any items not supported in PFC, use `Layer.HasUnsupportedItems()`.
`void`	`RemoveItem (ModelItem Item)` Removes the specified item from the layer.
`void`	`SetStatus (DisplayStatus value)` Set method for attribute "Status" The display status

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

ListItems

ModelItems ListItems ()

This method returns only items which are supported as ModelItem objects in PFC. To identify if the layer has any items not supported in PFC, use Layer.HasUnsupportedItems().

Exceptions thrown (but not limited to):

XToolkitNotFound - A layer with the specified name was not found.

XToolkitOutOfMemory - The layer has too many items to report.

Manual References:: ModelItem: Getting ModelItem Objects, ModelItem: Getting ModelItem Objects, ModelItem: Layer Operations, ModelItem: Layer Operations

Returns:: An array of the items on the layer

GetStatus/SetStatus

`DisplayStatus`	`GetStatus`	`()`
`void`	`SetStatus`	`(DisplayStatus value)`

The display status

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified layer was not found.

XToolkitInvalidName - You specified an invalid layer name.

XToolkitCantModify - display status of the layer cannot be changed

Manual References:: ModelItem: Layer Operations, ModelItem: Layer Operations, ModelItem: Layer Operations, ModelItem: Layer Operations

AddItem

void AddItem (ModelItem Item)

Adds the specified item to the layer.

The following items cannot be added to a layer: ITEM_SURFACE, ITEM_EDGE, ITEM_COORD_SYS, ITEM_AXIS, ITEM_SIMPREP, ITEM_DTL_SYM_DEFINITION, ITEM_DTL_OLE_OBJECT, ITEM_EXPLODED_STATE. For these items the method will throw XToolkitInvalidType exception.

Exceptions thrown(but not limited to):

XToolkitInvalidName - You specified an invalid layer name.

XToolkitInvalidType - You specified an invalid layer item type.

Manual References:: ModelItem: Layer Operations, ModelItem: Layer Operations

Parameters:

Item: The item to add

Returns:

RemoveItem

void RemoveItem (ModelItem Item)

Removes the specified item from the layer.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified layer was not found.

XToolkitInvalidName - You specified an invalid layer name.

XToolkitInvalidType - You specified an invalid layer item type.

Manual References:: ModelItem: Layer Operations, ModelItem: Layer Operations

Parameters:

Item: The layer item to remove

Returns:

Delete

void Delete ()

Deletes the layer.

Exceptions thrown (but not limited to):

XToolkitInvalidName - You specified an invalid layer name.

XToolkitNotFound - The system could not find a layer with the specified name.

Manual References:: ModelItem: Layer Operations, ModelItem: Layer Operations

Returns:

HasUnsupportedItems

boolean HasUnsupportedItems ()

Returns true if the layer contains one or more item types not supported as ModelItem objects in PFC. Returns false otherwise.

Returns:

CountUnsupportedItems

int CountUnsupportedItems ()

Manual References:: ModelItem: Layer Operations, ModelItem: Layer Operations

Returns: