CIP JAVA documentation for class "com.ptc.wfc.wfcDetail.WDetailNoteItem"

Interface WDetailNoteItem

package com.ptc.wfc.wfcDetail; public interface WDetailNoteItem extends com.ptc.wfc.wfcAnnotation.Annotation, com.ptc.pfc.pfcDetail.DetailNoteItem

Description

Extends the functionality of DetailNoteItem

This is the actual type of Detail Note Items in Object Toolkit.

Method Summary
`void`	`AddLeader (DetailLeaderAttachment LeadrAttach)` Add a leader to the specified detail note.
`void`	`AddLeaderWithArrowType (DetailLeaderAttachment LeadrAttach, LeaderArrowType Type)` `LICENSE: 222` Add a leader with arrow type to the specified detail note.
`/optional/ DetailSymbolInstItems`	`CollectSymbolInstances ()` Returns a list of all symbol instances which are declared in a detail note.
`Envelope3D`	`Get3DLineEnvelope (int LineNumber)` `LICENSE: 222` Line envelope for note. The order of coordinates in the envelope is: 0 ----------------------------1 \| \| 2 ----------------------------3 This ordering of coordinates is preserved even if the text is mirrored or applied at a rotation angle.
`AnnotationPlane`	`GetAnnotationPlane ()` `LICENSE: 222` Gets the annotation plane for the 3D notes (not applicable to 2D notes).
`DetailNoteItem`	`GetAssociativeNoteInDrawing (Drawing DrawingModel)` Get associative note in drawing for solid note.
`DetailNoteItem`	`GetAssociativeNoteInSolid ()` Get associative note in solid for drawing note.
`/optional/ Vector3D`	`GetElbowDirection ()` `LICENSE: 222` Get direction of elbow for leader of the note.
`/optional/ GTol`	`GetGTol ()` Return the geometric tolerance shown in a detail note.
`LeaderArrowTypes`	`GetLeaderArrowTypes ()` `LICENSE: 222` Gets arrow types for all the leaders in a note.
`LeaderStyle`	`GetLeaderStyle ()` `LICENSE: 222` Get style of the leader.
`Vector3D`	`GetLegacyLeaderNoteDirection ()`
`double`	`GetLegacyLeaderNoteLength ()`
`void`	`RemoveLeader (int index)` `LICENSE: 222` Remove leader from detail note.
`void`	`SetAnnotationPlane (AnnotationPlane AnnotPlane)` `LICENSE: 222` Sets the annotation plane for the 3D notes. (not applicable to 2D notes).
`void`	`SetLeaderStyle (LeaderStyle Style)` `LICENSE: 222` Set style of the leader.
`void`	`SetLeadersWithArrowType (DetailLeaderAttachments LeadrAttach, LeaderArrowTypes Types)` `LICENSE: 222` Modify note with specifed leaders and arrow types.

Methods Inherited from Interface `com.ptc.wfc.wfcLayerState.LayerItem`
`IsLayerItemVisible`, `RemoveNoUpdate`, `GetLayers`, `AddNoUpdate`

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

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.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

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

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

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

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

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WModelItem`
`DeleteUserDefinedName`, `Unhide`, `Hide`, `IsHidden`, `IsNameReadOnly`, `IsZoneFeature`, `GetDefaultName`

Methods Inherited from Interface `com.ptc.wfc.wfcAnnotation.Annotation`
`ShowInDrawing`, `Display`, `DisplayInDrawing`, `Undisplay`, `UndisplayInDrawing`, `IsShown`, `Update`, `GetTextStyle`, `SetTextStyle`, `GetTextStyleInDrawing`, `SetTextStyleInDrawing`, `UpdateAttachment`, `UpdatePosition`, `IsAssociative`, `GetAttachmentAssociativity`, `GetAnnotationElement`, `IsInactive`, `Rotate`, `ConvertLegacy`, `NeedsConversion`, `GetSecurityMarking`, `SetSecurityMarking`, `IsUsingXSecReference`

Methods Inherited from Interface com.ptc.wfc.wfcAnnotation.Annotation

ShowInDrawing, Display, DisplayInDrawing, Undisplay, UndisplayInDrawing, IsShown, Update, GetTextStyle, SetTextStyle, GetTextStyleInDrawing, SetTextStyleInDrawing, UpdateAttachment, UpdatePosition, IsAssociative, GetAttachmentAssociativity, GetAnnotationElement, IsInactive, Rotate, ConvertLegacy, NeedsConversion, GetSecurityMarking, SetSecurityMarking, IsUsingXSecReference

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailItem`
`GetDetailType`, `Delete`

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailNoteItem`
`GetSymbolDef`, `Draw`, `Show`, `Erase`, `Remove`, `GetInstructions`, `Modify`, `GetTextLines`, `SetTextLines`, `SetDisplayed`, `IsDisplayed`, `IsReadOnly`, `SetReadOnly`, `GetAttachment`, `SetFreeAttachment`, `SetOffsetAttachment`, `SetOnItemAttachment`, `SetLeaders`, `SetElbow`, `GetElbowLength`, `GetNoteTextStyle`, `SetNoteTextStyle`, `GetLineEnvelope`, `GetModelReference`, `SetURL`, `GetURL`, `GetOwner`, `KeepArrowTypeAsIs`

Methods Inherited from Interface com.ptc.pfc.pfcDetail.DetailNoteItem

GetSymbolDef, Draw, Show, Erase, Remove, GetInstructions, Modify, GetTextLines, SetTextLines, SetDisplayed, IsDisplayed, IsReadOnly, SetReadOnly, GetAttachment, SetFreeAttachment, SetOffsetAttachment, SetOnItemAttachment, SetLeaders, SetElbow, GetElbowLength, GetNoteTextStyle, SetNoteTextStyle, GetLineEnvelope, GetModelReference, SetURL, GetURL, GetOwner, KeepArrowTypeAsIs

Method Detail

GetLeaderArrowTypes

LeaderArrowTypes GetLeaderArrowTypes ()

LICENSE: 222

Gets arrow types for all the leaders in a note.

Exceptions thrown (but not limited to):

XToolkitNotFound - No leaders were found. OR The note attachment structure does not have any leader endpoints. OR This attachment is not a leader and does not include an arrow.

XToolkitNoLicense - License check failure.

XToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Note Placement, Annotations: Annotation Features and Annotations: Accessing Note Placement

Returns:

SetLeadersWithArrowType

void SetLeadersWithArrowType (DetailLeaderAttachments LeadrAttach, LeaderArrowTypes Types)

LICENSE: 222

Modify note with specifed leaders and arrow types.

Exceptions thrown (but not limited to):

XToolkitNoLicense - License check failure.

XToolkitBadContext - Invalid leader type for this note attachment.

XToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

LeadrAttach: Leader attachments.
Types: arrow types.

Returns:

AddLeader

void AddLeader (DetailLeaderAttachment LeadrAttach)

Add a leader to the specified detail note.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

LeadrAttach: The leader.

Returns:

AddLeaderWithArrowType

void AddLeaderWithArrowType (DetailLeaderAttachment LeadrAttach, LeaderArrowType Type)

LICENSE: 222

Add a leader with arrow type to the specified detail note.

Exceptions thrown (but not limited to):

XToolkitNoLicense - License check failure.

XToolkitBadContext - Invalid leader type for this note attachment.

XToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

LeadrAttach: Leader attachment
Type: arrow type.

Returns:

RemoveLeader

void RemoveLeader (int index)

LICENSE: 222

Remove leader from detail note.

Exceptions thrown (but not limited to):

XToolkitNoLicense - License check failure.

XToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

index: Index of leader. Indices starts from 0.

Returns:

GetElbowDirection

/*optional*/ Vector3D GetElbowDirection ()

LICENSE: 222

Get direction of elbow for leader of the note.

Exceptions thrown (but not limited to):

XToolkitNotFound - The note is not placed, or does not use leaders.

XToolkitCantAccess - The note uses the default elbow length (this is possible for flat-to-screen notes only).

Manual References:: Annotations: Annotation Features and Annotations: Note Properties, Annotations: Annotation Features and Annotations: Note Properties

Returns:: Direction.

GetLeaderStyle

LeaderStyle GetLeaderStyle ()

LICENSE: 222

Get style of the leader.

Exceptions thrown (but not limited to):

XToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Note Properties, Annotations: Annotation Features and Annotations: Note Properties

Returns:: Leader Style.

SetLeaderStyle

void SetLeaderStyle (LeaderStyle Style)

LICENSE: 222

Set style of the leader.

Exceptions thrown (but not limited to):

XToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Note Properties, Annotations: Annotation Features and Annotations: Note Properties

Parameters:

Style: leader style.

Returns:

SetAnnotationPlane

void SetAnnotationPlane (AnnotationPlane AnnotPlane)

LICENSE: 222

Sets the annotation plane for the 3D notes. (not applicable to 2D notes).

Exceptions thrown (but not limited to):

XToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

AnnotPlane: The annotation plane.

Returns:

GetAnnotationPlane

AnnotationPlane GetAnnotationPlane ()

LICENSE: 222

Gets the annotation plane for the 3D notes (not applicable to 2D notes).

Exceptions thrown (but not limited to):

XToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Note Placement

Returns:: The annotation plane.

GetAssociativeNoteInDrawing

DetailNoteItem GetAssociativeNoteInDrawing (Drawing DrawingModel)

Get associative note in drawing for solid note.

Exceptions thrown (but not limited to):

XToolkitBadContext - The solid model is not contained in the drawing.

XToolkitNotFound - The solid model note is not displayed in the drawing.

Parameters:

DrawingModel

Returns:: A note object owned by drawing.

GetAssociativeNoteInSolid

DetailNoteItem GetAssociativeNoteInSolid ()

Get associative note in solid for drawing note.

Exceptions thrown (but not limited to):

XToolkitNotFound - The detail note does not show a solid model note.

Returns:: A note object owned by solid.

Get3DLineEnvelope

Envelope3D Get3DLineEnvelope (int LineNumber)

LICENSE: 222

Line envelope for note. The order of coordinates in the envelope is:
0 ----------------------------1
| |
2 ----------------------------3

This ordering of coordinates is preserved even if the text is mirrored or applied at a rotation angle.

Exceptions thrown (but not limited to):

XToolkitNotFound - The indicated line does not exist.

Manual References:: Annotations: Annotation Features and Annotations: Note Properties, Annotations: Annotation Features and Annotations: Note Properties

Parameters:

LineNumber: line number.

Returns:: Line envelope.

CollectSymbolInstances

/*optional*/ DetailSymbolInstItems CollectSymbolInstances ()

Returns a list of all symbol instances which are declared in a detail note.

The instances are returned in the order they are encountered in the note text.

Exceptions thrown (but not limited to):

XToolkitNotFound - There are no symbol instances generated as a callout in this note.

Manual References:: Drawings: Detail Note Data, Drawings: Detail Note Data

Returns:: Symbol instances declared in the note.

GetLegacyLeaderNoteLength

double GetLegacyLeaderNoteLength ()

Exceptions thrown (but not limited to):

XToolkitInvalidType - This note is not a directed (normal or tangent) leader type note or is in an annotaton plane.

Manual References:: Annotations: Annotation Features and Annotations: Note Properties, Annotations: Annotation Features and Annotations: Note Properties

Returns:

GetLegacyLeaderNoteDirection

Vector3D GetLegacyLeaderNoteDirection ()

Exceptions thrown (but not limited to):

XToolkitInvalidType - This note is not a directed (normal or tangent) leader type note or is in an annotaton plane.

Manual References:: Annotations: Annotation Features and Annotations: Note Properties

Returns:

GetGTol

/*optional*/ GTol GetGTol ()

Return the geometric tolerance shown in a detail note.

Manual References:: Annotations: Annotation Features and Annotations: Note Properties, Annotations: Annotation Features and Annotations: Note Properties

Returns:: The geometric tolerance handle