ObjectModelerNavigator class CATNavigController
Usage: you must use this class as is. You should never derive it.
public class CATNavigController
Class used to control navigation.
Method Index
- o
GetActivatorsVisibility()
- Retrieves the +/- sign visibility.
- o
GetAssociatedElements(CATBaseUnknown_var&)
- Retrieves nodes associated to an object.
- o
GetContainer()
- Returns the container.
- o
GetDereferenceMode()
- Retrieves the mode to manage the depth of representation.
- o
SetActivatorsVisibility(int)
- Sets the +/- sign visibility.
- o
SetDepth(int)
- Sets expansion depth under a node.
- o
SetDereferenceMode(int)
- Sets the mode to manage the display of + and - on arcs.
- o
SetNoDuplicate()
- Instances management.
Methods
o GetActivatorsVisibility
| public int GetActivatorsVisibility( | )const |
-
Retrieves the +/- sign visibility.
- Returns:
- Legal values:
- 0: signs are hidden
- otherwise
o GetAssociatedElements
| public CATListValCATBaseUnknown_var* GetAssociatedElements( | const CATBaseUnknown_var& | iObject) const |
-
Retrieves nodes associated to an object.
Role:An object visualized in a tree, see
CATINavigateObject , is represented by a node implementing
CATIGraphNode ,
CATINavigElement , and
CATINavigModify. This node is multi- represented: there are as many nodes as tree instances. This method retrieves
all the nodes associated with an object.
- Parameters:
-
- iObject
- The object associated with the nodes.
- Returns:
- The list of nodes. A node is an object implementing
CATINavigModify ,
CATINavigElement , and
CATIGraphNode. Returned pointer must be deleted.
o GetContainer
-
Returns the container.
Returned pointer must be released.
o GetDereferenceMode
| public int GetDereferenceMode( | )const |
-
Retrieves the mode to manage the depth of representation.
Role:This method retrieves the mode to manage the depth of representation.
- Returns:
- The mode.
o SetActivatorsVisibility
| public void SetActivatorsVisibility( | int | mode) |
-
Sets the +/- sign visibility.
Role: Warning: Do not use this method if node already drawn in the graph.
- Parameters:
-
- mode
- Legal values:
- 0: Hide the +/- signs
- otherwise : show the +/- signs
o SetDepth
| public void SetDepth( | int | iDepth | =1) |
-
Sets expansion depth under a node.
- Parameters:
-
- iDepth
- if iDepth < 0, expand all children till there is no one left
o SetDereferenceMode
| public void SetDereferenceMode( | int | mode) |
-
Sets the mode to manage the display of + and - on arcs.
Role:This method sets the mode to manage the depth of representation.
if mode =0 :
by default a + is always displayed on node. If you click on it,
CATINavigateObject.GetChildren method is called on node and we try to display children.
- If children exist, they are displayed and + is replace by a -.
- If there is no children, + disappear.
This behavior is same as windows explorer on network directory.
Ergonomy is not perfect but it provides best performances.
if mode =1 :
CATINavigateObject.GetChildren is always called once (even if children are not displayed) just to check if there are some children.
If there is no children, no sign is displayed on arc.
If there are some children a + is displayed on arc.
This behavior is same as windows explorer on local directory.
Ergonomy is better but it could impact performances if
CATINavigateObject.GetChildren implementation is slow.
- Parameters:
-
- mode
- The mode value to manage the depth of representation.
o SetNoDuplicate
| public void SetNoDuplicate( | ) |
-
Instances management.
Role: Warning: Do not use this method if node already drawn in the graph.
This object is included in the file: CATNavigController.h
If needed, your Imakefile.mk should include the module: CATObjectModelerNavigator
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.