Interface DetailSymbolDefItem
package com.ptc.pfc.pfcDetail;
public interface DetailSymbolDefItem
extends com.ptc.pfc.pfcDetail.DetailItem
Description
This interface represents a symbol definition in a Creo Parametric model.
See Also:
DetailItemOwner.GetDetailItem(DetailType, int), DetailItemOwner.ListDetailItems(/*optional*/ DetailType, /*optional*/ Integer), DetailItemOwner.CreateDetailItem(DetailCreateInstructions), DetailItemOwner.RetrieveSymbolDefinition(String, /*optional*/ String, /*optional*/ Integer, /*optional*/ Boolean)
Direct Known Subclasses:
User Guide References:
Instructions:DetailSymbolDefItem, Instructions:DetailSymbolDefItem, Detail Symbols:DetailSymbolDefItem, Instructions:DetailSymbolDefItem, Detail Symbol Definitions Information:DetailSymbolDefItem, Detail Symbol Definitions Operations:DetailSymbolDefItem, Retrieving Symbol Definitions:DetailSymbolDefItem, Detail Symbol Group Information:DetailSymbolDefItem, Detail Symbol Group Operations:DetailSymbolDefItem, Locating and Collecting 3D Symbols and Symbol Definitions:DetailSymbolDefItem
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Methods Inherited from Interface com.ptc.pfc.pfcDetail.DetailItem :
Method Summary
Creates a detail item in the symbol definition. | |
CreateSubgroup (DetailSymbolGroupInstructions Instructions, /*optional*/ DetailSymbolGroup ParentGroup) | |
Create a subgroup in the specified symbol group. | |
/*optional*/ DetailItem | |
Returns a detail item in a symbol definition, given its id and type. | |
Returns an instructions data object describing how a symbol definition is constructed. | |
boolean | |
Determine if the subgroups stored in the symbol definition on the indicated level are exclusive. | |
/*optional*/ DetailItems | |
Lists the detail items in the symbol definition. | |
/*optional*/ DetailSymbolGroups | |
List the subgroups in the symbol definition. | |
void | |
Modifies a symbol definition. | |
void | |
Set the symbol groups exclusive at specified level. | |
void | |
Set the symbol groups independent at specified level. |
Method Detail
GetDetailItem | ||
/*optional*/ DetailItem | GetDetailItem |
Returns a detail item in a symbol definition, given its id and type.
Exceptions thrown (but not limited to):
XToolkitNotFound - This means either:
• No entities were found, OR
• No notes were found.
XToolkitOutOfMemory - Found too many (either/all of) entities, notes to be contained in the output array. Use Visit instead.
Parameters:
Type
The detail type.
Id
The integer identifier.
Returns:
The detail item, or null, if the item was not found.
ListDetailItems | ||
/*optional*/ DetailItems | ListDetailItems |
Lists the detail items in the symbol definition.
Exceptions thrown (but not limited to):
XToolkitNotFound - This means either:
• No items were found, OR
• No entities were found, OR
• No groups were found, OR
• No notes were found, OR
• No symbol definitions were found, OR
• No symbol instances were found.
XToolkitOutOfMemory - Found too many (either/all of) entities, groups, notes, symbol definitions, symbol instances to be contained in the output array. Use Visit instead.
User Guide References:
Parameters:
Type
The type of detail items to list.
Returns:
The items found, or null, if no items were found.
CreateDetailItem | ||
CreateDetailItem |
Creates a detail item in the symbol definition.
User Guide References:
Parameters:
Instructions
The data item instructions. This should be a DetailEntityInstructions or DetailNoteInstructions object.
Returns:
The detail item created in the symbol definition.
CreateFreeNote | ||
CreateFreeNote |
Parameters:
TextLines
Attach
Returns:
GetInstructions | ||
GetInstructions | () |
Returns an instructions data object describing how a symbol definition is constructed.
User Guide References:
Returns:
The instructions data object.
Modify | ||
void | Modify |
Modifies a symbol definition.
User Guide References:
Parameters:
Instructions
Data object containing modifications to the symbol definition.
Returns:
CreateSubgroup | ||
CreateSubgroup |
Create a subgroup in the specified symbol group.
If no symbol group is specificed, the subgroup is created under the top level symbol group.
Exceptions thrown (but not limited to):
XToolkitInvalidName - A group with the provided name already exists at this level.
User Guide References:
Parameters:
Instructions
The characteristics for creating the subgroup.
ParentGroup
The symbol group under which the subgroup is to be made.
Returns:
The symbol group.
ListSubgroups | ||
/*optional*/ DetailSymbolGroups | ListSubgroups | () |
List the subgroups in the symbol definition.
Exceptions thrown (but not limited to):
XToolkitNotFound - No groups are stored in the symbol definition at this level.
User Guide References:
Returns:
The list of sub symbol groups.
IsSubgroupLevelExclusive | ||
boolean | IsSubgroupLevelExclusive |
Determine if the subgroups stored in the symbol definition on the indicated level are exclusive.
User Guide References:
Parameters:
ParentGroup
The exclusiveness is determined at the level of this symbol group. If not specifed, the top level is assumed.
Returns:
true if the subgroups are exclusive and false if independent.
SetSubgroupLevelExclusive | ||
void | SetSubgroupLevelExclusive |
Set the symbol groups exclusive at specified level.
Once set exclusive, only one of the groups at this level may be active in the model at any time.
Exceptions thrown (but not limited to):
XToolkitNoChange - The status was already set to the designated value.
User Guide References:
Parameters:
ParentGroup
The symbol groups at the level of this symbol group are set exclusive. If not specified, the top level is assumed.
Returns:
SetSubgroupLevelIndependent | ||
void | SetSubgroupLevelIndependent |
Set the symbol groups independent at specified level.
Once set independent, any number of groups at this level may be active in the model at any time.
Exceptions thrown (but not limited to):
XToolkitNoChange - The status was already set to the designated value.
User Guide References:
Parameters:
ParentGroup
The symbol groups at the level of this symbol group are set independent. If not specified, the top level is assumed.
Returns: