Library | PackageFrames | Expand Java Toolkit

Interface AnnotationElement

package com.ptc.wfc.wfcAnnotation;

public interface AnnotationElement
  extends com.ptc.wfc.wfcLayerState.LayerItem,
          com.ptc.wfc.wfcModelItem.WModelItem


Description

 


Method Summary
AnnotationReferencesCollectAnnotationReferences (AnnotationRefFilter RefStrength, AnnotationRefFromType RefSource)
LICENSE: 222
     
SelectionsCollectQuiltReferenceSurfaces (AnnotationReference QuiltReference)
     
AnnotationGetAnnotation ()
LICENSE: 222
     
FeatureGetAnnotationFeature ()
LICENSE: 222
     
/*optional*/ StringGetAnnotationReferenceDescription (AnnotationReference Reference)
LICENSE: 222
     
AnnotationTypeGetAnnotationType ()
LICENSE: 222
     
booleanGetCopyFlag ()
LICENSE: 222
     
/*optional*/ BooleanHasMissingReferences (AnnotationRefFilter ReferenceType, AnnotationRefFromType ReferenceSource, boolean AtLeastOneMissingRef)
LICENSE: 222
     
booleanIsDependent ()
LICENSE: 222
     
booleanIsIncomplete ()
LICENSE: 222
     
booleanIsReadOnly ()
LICENSE: 222
     
/*optional*/ BooleanIsReferenceStrong (AnnotationReference Reference)
LICENSE: 222
     
voidSetAnnotationReferenceDescription (AnnotationReference Reference, String Description)
LICENSE: 222
     

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

Method Detail

GetAnnotationType

AnnotationTypeGetAnnotationType ()

LICENSE: 222

     
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 

IsReadOnly

booleanIsReadOnly ()

LICENSE: 222

     
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 

HasMissingReferences

/*optional*/ BooleanHasMissingReferences (AnnotationRefFilter ReferenceType, AnnotationRefFromType ReferenceSource, boolean AtLeastOneMissingRef)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitNotFound - The element has no references of the given type and source.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
ReferenceType
 
ReferenceSource
 
AtLeastOneMissingRef
 
Returns:
 

IsIncomplete

booleanIsIncomplete ()

LICENSE: 222

     
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 

GetCopyFlag

booleanGetCopyFlag ()

LICENSE: 222

     
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 

IsDependent

booleanIsDependent ()

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitCantAccess - The element is not owned by a data sharing feature.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 

GetAnnotation

AnnotationGetAnnotation ()

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation element does not contain an annotation.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 

GetAnnotationFeature

FeatureGetAnnotationFeature ()

LICENSE: 222

     
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 

IsReferenceStrong

/*optional*/ BooleanIsReferenceStrong (AnnotationReference Reference)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation element doesn't contain this reference.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
Reference
 
Returns:
 

GetAnnotationReferenceDescription

/*optional*/ StringGetAnnotationReferenceDescription (AnnotationReference Reference)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation element doesn't contain this reference.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
Reference
 
Returns:
 

SetAnnotationReferenceDescription

voidSetAnnotationReferenceDescription (AnnotationReference Reference, String Description)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation element doesn't contain this reference.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
Reference
 
Description
 
Returns:

CollectAnnotationReferences

AnnotationReferencesCollectAnnotationReferences (AnnotationRefFilter RefStrength, AnnotationRefFromType RefSource)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation element does not contain any references of the indicated type.

XToolkitInvalidType - References from driving dimension annotation elements cannot be accessed.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
RefStrength
 
RefSource
 
Returns:
 

CollectQuiltReferenceSurfaces

SelectionsCollectQuiltReferenceSurfaces (AnnotationReference QuiltReference)


     

Exceptions thrown (but not limited to):

XToolkitInvalidType - The input reference type was not valid.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
QuiltReference
 
Returns: