All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerNavigator Interface CATINavigElement

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATINavigElement
 

Usage: you can reimplement this interface by deriving the supplied CATNodeExtension adapter class.


interface CATINavigElement

Interface to manage tree node modifications.

Role:This interface enables you to specify or apply behaviors for a node associated with your object. If to be visualized in object tree, an object must implement the CATINavigateObject interface, this interface implementation is not mandatory. Nodes associated with an object have a default implementation of this interface, such as the CATINavigModify and CATIGraphNode interfaces.

You can re-implement the Processxxx methods, but in most cases their default behavior is sufficient. However, the three others: Update , GetController , and GetAssociatedInstance cannot be re-implemented, you can only use it.

This implementation, full or partial, is not done on the object itself but on an object, named MyObject_node, where MyObject is the name of the object.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.


Method Index


o GetAssociatedInstance()
Retrieves the instance associated with the node.
o GetController()
Retrieves the tree controller.
o GetFatherContainer()
Returns the father container.
o ProcessAfterAction()
Defines behavior after double-click of the node.
o ProcessAfterExpand()
Defines behavior after expand of the node.
o ProcessAfterExtSelect()
Defines behavior after selection of several nodes.
o ProcessAfterMethod()
Defines behavior when the contextual menu is asked on the node.
o ProcessAfterSelect()
Defines behavior after selection of the node.
o Update()
Updates node.

Methods


o GetAssociatedInstance
public virtual CATNavigInstance* GetAssociatedInstance()=0
Retrieves the instance associated with the node.
Role: This method retrieves the object associated with the node.
Returns:
The associated instance.
Lifecycle rules deviation: This method doesn't AddRef the returned value.
o GetController
public virtual const CATNavigController* GetController()=0
Retrieves the tree controller.
Returns:
The tree controller.
Lifecycle rules deviation: This method doesn't AddRef the returned value.
o GetFatherContainer
public virtual CATINavigContainer* GetFatherContainer()=0
Returns the father container. Returned pointer must be released.
o ProcessAfterAction
public virtual void ProcessAfterAction()=0
Defines behavior after double-click of the node.
Role:This method defines the behavior after double-click of the node. Refer to the CATNodeExtension.ProcessAfterAction method for the default implementation.
o ProcessAfterExpand
public virtual void ProcessAfterExpand()=0
Defines behavior after expand of the node.
Role:This method defines the behavior when the end user clicks on the +/- icons of the node. Refer to the CATNodeExtension.ProcessAfterExpand method for the default implementation.
This method can be also used to produce an expand/collapse of the node.
o ProcessAfterExtSelect
public virtual void ProcessAfterExtSelect()=0
Defines behavior after selection of several nodes.
Role:This method defines the behavior after selection of several nodes. Refer to the CATNodeExtension.ProcessAfterExtSelect method for the default implementation.
o ProcessAfterMethod
public virtual void ProcessAfterMethod()=0
Defines behavior when the contextual menu is asked on the node.
Role:This method defines the behavior when the contextual menu is asked on the node. Refer to the CATNodeExtension.ProcessAfterMethod method for the default implementation.
You may not have to re-implement this method, the contextual menu defined through the CATIContextualMenu or CATIContextualSubMenu interfaces is the contextual menu of an object, in 3D such as in the object tree.
o ProcessAfterSelect
public virtual void ProcessAfterSelect()=0
Defines behavior after selection of the node.
Role:This method defines the behavior after selection of the node. Refer to the CATNodeExtension.ProcessAfterSelect method for the default implementation.
o Update
public virtual void Update()=0
Updates node.
Role:This method is useful when an update of the node is necessary. You have used methods of the CATIGraphNode interface to modify a visual aspect of the node, a call to this method is necessary to update the visualization of the node.

This object is included in the file: CATINavigElement.h
If needed, your Imakefile.mk should include the module: CATObjectModelerNavigator

Copyright © 2003, Dassault Systèmes. All rights reserved.