CIP JAVA documentation for class "com.ptc.pfc.pfcFeature.FeatureActionListener"

Interface FeatureActionListener

package com.ptc.pfc.pfcFeature; public interface FeatureActionListener extends com.ptc.pfc.pfcBase.ActionListener

Description

This class defines an action listener for features.

Method Summary
`void`	`OnAfterCopy (Feature FromFeat, Feature ToFeat, FeatureCopyType Type)` This is the listener method called after a successful feature copy.
`void`	`OnAfterRegen (Feature Feat)` This is the notification function called after a feature has been regenerated.
`void`	`OnAfterSuppress (Feature Feat)` This is the notification function called after a feature has been suppressed from a solid.
`void`	`OnBeforeDelete (Feature Feat)` This is the action listener called before deleting a feature.
`void`	`OnBeforeParameterCreate (Feature Owner, String Name, ParamValue Value)` This is the notification function called before a parameter is created. To abort parameter creation throw exception `XCancelProEAction`.
`void`	`OnBeforeParameterDelete (Parameter Param)` This is the listener method called before deleting a parameter. To abort parameter delete operation throw exception `XCancelProEAction`.
`void`	`OnBeforeParameterModify (Parameter Param, ParamValue Value)` This is the notification function called before a parameter is modified. To abort parameter modification throw exception `XCancelProEAction`.
`void`	`OnBeforeRedefine (Feature Feat)` This is the notification function called before a feature is redefined.
`void`	`OnBeforeRegen (Feature Feat)` This is the notification function called before a feature is regenerated.
`void`	`OnBeforeSuppress (Feature Feat)` This is the notification function called before a feature is suppressed.
`void`	`OnRegenFailure (Feature Feat)` This is the notification function called when a regeneration fails.

Method Detail

OnBeforeDelete

void OnBeforeDelete (Feature Feat)

This is the action listener called before deleting a feature.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Feat: The feature about to be deleted

Returns:

OnBeforeSuppress

void OnBeforeSuppress (Feature Feat)

This is the notification function called before a feature is suppressed.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Feat: The feature to be suppressed

Returns:

OnAfterSuppress

void OnAfterSuppress (Feature Feat)

This is the notification function called after a feature has been suppressed from a solid.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

Feat: The feature that was suppressed

Returns:

OnBeforeRegen

void OnBeforeRegen (Feature Feat)

This is the notification function called before a feature is regenerated.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

Feat: The feature to be regenerated

Returns:

OnAfterRegen

void OnAfterRegen (Feature Feat)

This is the notification function called after a feature has been regenerated.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

Feat: The feature that was just regenerated

Returns:

OnRegenFailure

void OnRegenFailure (Feature Feat)

This is the notification function called when a regeneration fails.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

Feat: The feature whose regeneration failed

Returns:

OnBeforeRedefine

void OnBeforeRedefine (Feature Feat)

This is the notification function called before a feature is redefined.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Feat: The feature to be redefined

Returns:

OnAfterCopy

void OnAfterCopy (Feature FromFeat, Feature ToFeat, FeatureCopyType Type)

This is the listener method called after a successful feature copy.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

FromFeat: Feature to be copied
ToFeat: Target for copied feature
Type: Type of feature copy, for example, using the same references, flipped to a miror image, and so on.

Returns:

OnBeforeParameterCreate

void OnBeforeParameterCreate (Feature Owner, String Name, ParamValue Value)

This is the notification function called before a parameter is created. To abort parameter creation throw exception XCancelProEAction.

Manual References:: Action Listeners: Cancelling an ActionListener Operation

Parameters:

Owner: Owner feature of parameter.
Name: Name of the parameter.
Value: Value of the parameter.

Returns:

OnBeforeParameterModify

void OnBeforeParameterModify (Parameter Param, ParamValue Value)

This is the notification function called before a parameter is modified. To abort parameter modification throw exception XCancelProEAction.

Parameters:

Param: Name of the parameter.
Value: Value of the parameter.

Returns:

OnBeforeParameterDelete

void OnBeforeParameterDelete (Parameter Param)

This is the listener method called before deleting a parameter. To abort parameter delete operation throw exception XCancelProEAction.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Param: Parameter to be deleted

Returns: