pyffi :: utils :: graph :: DetailNode :: Class DetailNode
[hide private]
[frames] | no frames]

Class DetailNode

source code

object --+
         |
        DetailNode
Known Subclasses:

A node of the detail tree which can have children.

If the data must be editable, also derive the class from one of the delegate classes defined in pyffi.object_models.editable, and make sure that the get_value and set_value functions are implemented.

Instance Methods [hide private]
generator yielding DetailNodes
get_detail_child_nodes(self, edge_filter=(True, True))
Generator which yields all children of this item in the detail view (by default, all acyclic and active ones).
source code
generator yielding strs
get_detail_child_names(self, edge_filter=(True, True))
Generator which yields all child names of this item in the detail view.
source code
 
get_detail_child_edge_types(self, edge_filter=(True, True))
Generator which yields all edge types of this item in the detail view, one edge type for each child.
source code
str
get_detail_display(self)
Object used to display the instance in the detail view.
source code
 
get_detail_iterator(self, edge_filter=(True, True))
Iterate over self, all children, all grandchildren, and so on (only given edge type is followed).
source code
 
replace_global_node(self, oldnode, newnode, edge_filter=(True, True))
Replace a particular branch in the graph.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

get_detail_child_nodes(self, edge_filter=(True, True))

source code 

Generator which yields all children of this item in the detail view (by default, all acyclic and active ones).

Override this method if the node has children.

Parameters:
  • edge_filter (EdgeFilter or type(None)) - The edge type to include.
Returns: generator yielding DetailNodes
Generator for detail tree child nodes.

get_detail_child_names(self, edge_filter=(True, True))

source code 

Generator which yields all child names of this item in the detail view.

Override this method if the node has children.

Returns: generator yielding strs
Generator for detail tree child names.

get_detail_child_edge_types(self, edge_filter=(True, True))

source code 

Generator which yields all edge types of this item in the detail view, one edge type for each child.

Override this method if you rely on more than one edge type.

get_detail_display(self)

source code 

Object used to display the instance in the detail view.

Override this method if the node has data to display in the detail view.

Returns: str
A string that can be used to display the instance.

get_detail_iterator(self, edge_filter=(True, True))

source code 
Iterate over self, all children, all grandchildren, and so on (only given edge type is followed). Do not override.