File: TableEditor_demo.py

package info (click to toggle)
python-traitsui 8.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 18,232 kB
  • sloc: python: 58,982; makefile: 113
file content (131 lines) | stat: -rw-r--r-- 3,764 bytes parent folder | download | duplicates (2)
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
# (C) Copyright 2004-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!

"""
**WARNING**

  This demo might not work as expected and some documented features might be
  missing.

-------------------------------------------------------------------------------

Implementation of a TableEditor demo plugin for Traits UI demo program

This demo shows the full behavior of a straightforward TableEditor.  Only
one style of TableEditor is implemented, so that is the one shown.

Please refer to the `TableEditor API docs`_ for further information.

.. _TableEditor API docs: https://docs.enthought.com/traitsui/api/traitsui.editors.table_editor.html#traitsui.editors.table_editor.TableEditor
"""
# Issue related to the demo warning: enthought/traitsui#948


from traits.api import HasTraits, HasStrictTraits, Str, Int, Regex, List

from traitsui.api import (
    View,
    Group,
    Item,
    TableEditor,
    ObjectColumn,
    ExpressionColumn,
    EvalTableFilter,
)
from traitsui.table_filter import (
    EvalFilterTemplate,
    MenuFilterTemplate,
    RuleFilterTemplate,
)


# A helper class for the 'Department' class below:
class Employee(HasTraits):
    first_name = Str()
    last_name = Str()
    age = Int()
    phone = Regex(value='000-0000', regex=r'\d\d\d[-]\d\d\d\d')

    traits_view = View(
        'first_name',
        'last_name',
        'age',
        'phone',
        title='Create new employee',
        width=0.18,
        buttons=['OK', 'Cancel'],
    )


# For readability, the TableEditor of the demo is defined here, rather than in
# the View:
table_editor = TableEditor(
    columns=[
        ObjectColumn(name='first_name', width=0.20),
        ObjectColumn(name='last_name', width=0.20),
        ExpressionColumn(
            label='Full Name',
            width=0.30,
            expression="'%s %s' % (object.first_name, " "object.last_name )",
        ),
        ObjectColumn(name='age', width=0.10, horizontal_alignment='center'),
        ObjectColumn(name='phone', width=0.20),
    ],
    deletable=True,
    sort_model=True,
    auto_size=False,
    orientation='vertical',
    edit_view=View(
        Group('first_name', 'last_name', 'age', 'phone', show_border=True),
        resizable=True,
    ),
    filters=[EvalFilterTemplate, MenuFilterTemplate, RuleFilterTemplate],
    search=EvalTableFilter(),
    show_toolbar=True,
    row_factory=Employee,
)


# The class to be edited with the TableEditor:
class Department(HasStrictTraits):

    employees = List(Employee)

    traits_view = View(
        Group(
            Item('employees', show_label=False, editor=table_editor),
            show_border=True,
        ),
        title='Department Personnel',
        width=0.4,
        height=0.4,
        resizable=True,
        buttons=['OK'],
        kind='live',
    )


# Create some employees:
employees = [
    Employee(first_name='Jason', last_name='Smith', age=32, phone='555-1111'),
    Employee(first_name='Mike', last_name='Tollan', age=34, phone='555-2222'),
    Employee(
        first_name='Dave', last_name='Richards', age=42, phone='555-3333'
    ),
    Employee(first_name='Lyn', last_name='Spitz', age=40, phone='555-4444'),
    Employee(first_name='Greg', last_name='Andrews', age=45, phone='555-5555'),
]

# Create the demo:
demo = Department(employees=employees)

# Run the demo (if invoked from the command line):
if __name__ == '__main__':
    demo.configure_traits()