CIP JAVA documentation for class "com.ptc.pfc.pfcModel.ModelActionListener"

Interface ModelActionListener

package com.ptc.pfc.pfcModel; public interface ModelActionListener extends com.ptc.pfc.pfcBase.ActionListener

Description

This class defines an action listener for models that notifies you when operations on a model occur.

Method Summary
`void`	`OnAfterModelCopy (Model FromMdl, /optional/ Model ToMdl)` The listener method called after successful execution of a copy command.
`void`	`OnAfterModelCopyAll (Model FromMdl, /optional/ Model ToMdl)` This is the listener method called after successful copying of any model (not just an explicit copy of a single model).
`void`	`OnAfterModelCreate (Model Mdl)` This is the listener method called after successful creation of a model.
`void`	`OnAfterModelDelete (Model Mdl)` This is the listener method called after successful deletion of a model.
`void`	`OnAfterModelDeleteAll (ModelDescriptor Descr)` The listener method called after successful deletion of any model, (not just an explicit deletion of a single model).
`void`	`OnAfterModelErase (Model Mdl)` This is the listener method called after successful erasing of a model.
`void`	`OnAfterModelEraseAll (ModelDescriptor Descr)` This is the listener method called after successful erasure of any model, (not just an explicit erasure of a single model).
`void`	`OnAfterModelRename (Model FromMdl, /optional/ Model ToMdl)` This is the listener method called after successful renaming of a model.
`void`	`OnAfterModelRetrieve (Model Mdl)` This is the listener method called after successful retrieval of a model.
`void`	`OnAfterModelRetrieveAll (ModelDescriptor Descr)` This is the listener method called after successful retrieval of any model, (not just an explicit retrieval of a single model).
`void`	`OnAfterModelSave (ModelDescriptor Descr)` This is the listener mothod called after successful saving of a model.
`void`	`OnAfterModelSaveAll (ModelDescriptor Descr)` This is the listener method called after successful saving of any model, (not just an explicit save of a single model).
`void`	`OnBeforeModelDisplay (Model Mdl)` The listener method called before a model is displayed.
`void`	`OnBeforeParameterCreate (Model Owner, String Name, ParamValue Value)` This is the listener method called before creating a parameter. 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 listener method called before modifying a parameter. To abort parameter modification throw exception `XCancelProEAction`.

Method Detail

OnAfterModelSave

void OnAfterModelSave (ModelDescriptor Descr)

This is the listener mothod called after successful saving of a model.

This listener method is called only for models which are explicitly saved, not for dependent models.

Manual References:: Action Listeners: Model Level Action listeners, Action Listeners: Model Level Action listeners

Parameters:

Descr: The descriptor of the saved model

Returns:

OnAfterModelSaveAll

void OnAfterModelSaveAll (ModelDescriptor Descr)

This is the listener method called after successful saving of any model, (not just an explicit save of a single model).

For example, when saving an assembly and all the component parts in it, this method is called once for each model saved.

Manual References:: Action Listeners: Model Level Action listeners

Parameters:

Descr: The model descriptor of the saved part

Returns:

OnAfterModelCopy

void OnAfterModelCopy (Model FromMdl, /*optional*/ Model ToMdl)

The listener method called after successful execution of a copy command.

This method is deprecated. Use ModelEventActionListener.OnAfterModelCopy(ModelDescriptor, ModelDescriptor) for better performance. This listener method is called only for models which are explicity copied, not for dependent models.

Parameters:

FromMdl: Source model that was copied.
ToMdl: Target model created by copying.

Returns:

OnAfterModelCopyAll

void OnAfterModelCopyAll (Model FromMdl, /*optional*/ Model ToMdl)

This is the listener method called after successful copying of any model (not just an explicit copy of a single model).

This method is deprecated. Use ModelEventActionListener.OnAfterModelCopyAll(ModelDescriptor, ModelDescriptor) for better performance. For example, when copying an assembly and all the component parts in it, this method will be called once for each model copied.

Parameters:

FromMdl: Source model that was copied.
ToMdl: Target model created by copying.

Returns:

OnAfterModelRename

void OnAfterModelRename (Model FromMdl, /*optional*/ Model ToMdl)

This is the listener method called after successful renaming of a model.

This method is deprecated. Use ModelEventActionListener.OnAfterModelRename(ModelDescriptor, ModelDescriptor) for better performance. This listener method is called only for models which are explicitly renamed, not for dependent models.

Parameters:

FromMdl: Model that was renamed.
ToMdl: The newly renamed model.

Returns:

OnAfterModelErase

void OnAfterModelErase (Model Mdl)

This is the listener method called after successful erasing of a model.

This method is deprecated. Use ModelEventActionListener.OnAfterModelErase(ModelDescriptor) for better performance. This listener method is called only for models which are explicitly erased, not for dependent models. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Mdl: Model that was erased.

Returns:

OnAfterModelEraseAll

void OnAfterModelEraseAll (ModelDescriptor Descr)

This is the listener method called after successful erasure of any model, (not just an explicit erasure of a single model).

For example, when erasing an assembly and all the component parts in it, this method is called once for each model erased. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Manual References:: Action Listeners: Model Level Action listeners

Parameters:

Descr: The model descriptor of the erased model

Returns:

OnAfterModelDelete

void OnAfterModelDelete (Model Mdl)

This is the listener method called after successful deletion of a model.

This method is deprecated. Use ModelEventActionListener.OnAfterModelDelete(ModelDescriptor) for better performance. This listener method is caled only for models which are explicitly deleted, not for dependent models. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Mdl: Model that was deleted.

Returns:

OnAfterModelDeleteAll

void OnAfterModelDeleteAll (ModelDescriptor Descr)

The listener method called after successful deletion of any model, (not just an explicit deletion of a single model).

For example, when deleting an assembly and all the component parts in it, called once for each model deleted. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Manual References:: Action Listeners: Model Level Action listeners

Parameters:

Descr: The model descriptor of the deleted part

Returns:

OnAfterModelRetrieve

void OnAfterModelRetrieve (Model Mdl)

This is the listener method called after successful retrieval of a model.

This listener method is called only for models which are explicitly retrieved, not for dependent models. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Manual References:: Action Listeners: Model Level Action listeners, Action Listeners: Model Level Action listeners

Parameters:

Mdl: Name of the retrieved model

Returns:

OnAfterModelRetrieveAll

void OnAfterModelRetrieveAll (ModelDescriptor Descr)

This is the listener method called after successful retrieval of any model, (not just an explicit retrieval of a single model).

For example, when retrieving an assembly and all the component parts in it, this method is called once for each model retrieved. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Descr: The model descriptor of the retrieved part

Returns:

OnBeforeModelDisplay

void OnBeforeModelDisplay (Model Mdl)

The listener method called before a model is displayed.

This method is blocked for asynchronous mode, because it causes a significant slowdown when changing the display of a model (rotating or moving).

Manual References:: Action Listeners: Model Level Action listeners, Action Listeners: Model Level Action listeners

Parameters:

Mdl: Name of the model to be displayed

Returns:

OnAfterModelCreate

void OnAfterModelCreate (Model Mdl)

This is the listener method called after successful creation of a model.

This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Manual References:: Action Listeners: Model Level Action listeners, Action Listeners: Model Level Action listeners

Parameters:

Mdl: Model just created

Returns:

OnBeforeParameterCreate

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

This is the listener method called before creating a parameter. To abort parameter creation throw exception XCancelProEAction.

Manual References:: Action Listeners: Cancelling an ActionListener Operation

Parameters:

Owner: Owner model of parameter
Name: Name of parameter
Value: Value of parameter

Returns:

OnBeforeParameterModify

void OnBeforeParameterModify (Parameter Param, ParamValue Value)

This is the listener method called before modifying a parameter. To abort parameter modification throw exception XCancelProEAction.

Manual References:: Action Listeners: Cancelling an ActionListener Operation

Parameters:

Param: Parameter to be modified
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: Cancelling an ActionListener Operation

Parameters:

Param: Name of parameter to be deleted

Returns: