1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
|
"""
Tree editor for hierarchal data
Demonstrates using the TreeEditor to display a hierarchically organized data
structure.
In this case, the tree has the following hierarchy:
- Partner
- Company
- Department
- Employee
The TreeEditor generates a hierarchical tree control, consisting of nodes. It is
useful for cases where objects contain lists of other objects.
The tree control is displayed in one pane of the editor, and a user interface
for the selected object is displayed in the other pane. The layout orientation
of the tree and the object editor is determined by the *orientation* parameter
of TreeEditor(), which can be 'horizontal' or 'vertical'.
You must specify the types of nodes that can appear in the tree using the
*nodes* parameter, which must be a list of instances of TreeNode (or of
subclasses of TreeNode).
You must specify the classes whose instances the node type applies to. Use the
**node_for** attribute of TreeNode to specify a list of classes; often, this
list contains only one class. You can have more than one node type that applies
to a particular class; in this case, each object of that class is represented by
multiple nodes, one for each applicable node type.
See the Traits User Manual for more details.
"""
# FIXME: provide accessible copy or equivalent of factories_advanced_extra.rst
from traits.api import HasTraits, Str, Regex, List, Instance
from traitsui.api import Item, View, TreeEditor, TreeNode
class Employee(HasTraits):
""" Defines a company employee. """
name = Str('<unknown>')
title = Str
phone = Regex(regex = r'\d\d\d-\d\d\d\d')
def default_title(self):
self.title = 'Senior Engineer'
class Department(HasTraits):
""" Defines a department with employees. """
name = Str('<unknown>')
employees = List(Employee)
class Company(HasTraits):
""" Defines a company with departments and employees. """
name = Str('<unknown>')
departments = List(Department)
employees = List(Employee)
# Create an empty view for objects that have no data to display:
no_view = View()
# Define the TreeEditor used to display the hierarchy:
tree_editor = TreeEditor(
nodes = [
# The first node specified is the top level one
TreeNode(node_for = [ Company ],
auto_open = True,
# child nodes are
children = '',
label = 'name', # label with Company name
view = View([ 'name' ])
),
TreeNode(node_for = [ Company ],
auto_open = True,
children = 'departments',
label = '=Departments', # constant label
view = no_view,
add = [ Department ],
),
TreeNode(node_for = [ Company ],
auto_open = True,
children = 'employees',
label = '=Employees', # constant label
view = no_view,
add = [ Employee ]
),
TreeNode(node_for = [ Department ],
auto_open = True,
children = 'employees',
label = 'name', # label with Department name
view = View([ 'name' ]),
add = [ Employee ]
),
TreeNode(node_for = [ Employee ],
auto_open = True,
label = 'name', # label with Employee name
view = View([ 'name', 'title', 'phone' ])
)
]
)
class Partner(HasTraits):
""" Defines a business partner."""
name = Str('<unknown>')
company = Instance(Company)
view = View(
Item(name = 'company',
editor = tree_editor,
show_label = False
),
title = 'Company Structure',
buttons = [ 'OK' ],
resizable = True,
style = 'custom',
width = .3,
height = 500
)
# Create an example data structure:
jason = Employee(name = 'Jason',
title = 'Senior Engineer',
phone = '536-1057')
mike = Employee(name = 'Mike',
title = 'Senior Engineer',
phone = '536-1057')
dave = Employee(name = 'Dave',
title = 'Senior Software Developer',
phone = '536-1057')
martin = Employee(name = 'Martin',
title = 'Senior Engineer',
phone = '536-1057')
duncan = Employee(name = 'Duncan',
title = 'Consultant',
phone = '526-1057')
# Create the demo:
demo = Partner(
name = 'Enthought, Inc.',
company = Company(
name = 'Enthought',
employees = [ dave, martin, duncan, jason, mike ],
departments = [
Department(
name = 'Business',
employees = [ jason, mike ]
),
Department(
name = 'Scientific',
employees = [ dave, martin, duncan ]
)
]
)
)
# Run the demo (if invoked from the command line):
if __name__ == '__main__':
demo.configure_traits()
|