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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
|
#-------------------------------------------------------------------------------
#
# Copyright (c) 2008, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/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!
#
# Author: David C. Morrill
# Date: 02/29/2008
#
#-------------------------------------------------------------------------------
""" Defines adapter interfaces for use with the ListStrEditor.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
from __future__ import absolute_import
from traits.api import (Any, Bool, Color, Enum, Event, HasPrivateTraits, Int,
Interface, List, Str, implements, on_trait_change)
#-------------------------------------------------------------------------------
# 'IListStrAdapter' interface:
#-------------------------------------------------------------------------------
class IListStrAdapter ( Interface ):
# The index of the current item being adapted:
index = Int
# Current item being adapted:
item = Any
# The current value (if any):
value = Any
# Does the adapter know how to handler the current *item* or not:
accepts = Bool
# Does the value of *accepts* depend only upon the type of *item*?
is_cacheable = Bool
#-------------------------------------------------------------------------------
# 'AnIListStrAdapter' class:
#-------------------------------------------------------------------------------
class AnIListStrAdapter ( HasPrivateTraits ):
implements( IListStrAdapter )
#-- Implementation of the IListStrAdapter Interface ------------------------
# The index of the current item being adapted:
index = Int
# Current item being adapted:
item = Any
# The current value (if any):
value = Any
# Does the adapter know how to handler the current *item* or not:
accepts = Bool( True )
# Does the value of *accepts* depend only upon the type of *item*?
is_cacheable = Bool( True )
#-------------------------------------------------------------------------------
# 'ListStrAdapter' class:
#-------------------------------------------------------------------------------
class ListStrAdapter ( HasPrivateTraits ):
""" The base class for adapting list items to values that can be edited
by a ListStrEditor.
"""
#-- Trait Definitions ------------------------------------------------------
# Specifies the default value for a new list item:
default_value = Any( '' )
# Specifies the default text for a new list item:
default_text = Str
# The default text color for list items (even, odd, any rows):
even_text_color = Color( None, update = True )
odd_text_color = Color( None, update = True )
text_color = Color( None, update = True )
# The default background color for list items (even, odd, any rows):
even_bg_color = Color( None, update = True )
odd_bg_color = Color( None, update = True )
bg_color = Color( None, update = True )
# The name of the default image to use for list items:
image = Str( None, update = True )
# Can the text value of each list item be edited:
can_edit = Bool( True )
# Specifies where a dropped item should be placed in the list relative to
# the item it is dropped on:
dropped = Enum( 'after', 'before' )
# The index of the current item being adapter:
index = Int
# The current item being adapted:
item = Any
# The current value (if any):
value = Any
# List of optional delegated adapters:
adapters = List( IListStrAdapter, update = True )
#-- Private Trait Definitions ----------------------------------------------
# Cache of attribute handlers:
cache = Any( {} )
# Event fired when the cache is flushed:
cache_flushed = Event( update = True )
#-- Adapter methods that are sensitive to item type ------------------------
def get_can_edit ( self, object, trait, index ):
""" Returns whether the user can edit a specified *object.trait[index]*
list item. A True result indicates the value can be edited, while
a False result indicates that it cannot be edited.
"""
return self._result_for( 'get_can_edit', object, trait, index )
def get_drag ( self, object, trait, index ):
""" Returns the 'drag' value for a specified *object.trait[index]*
list item. A result of *None* means that the item cannot be dragged.
"""
return self._result_for( 'get_drag', object, trait, index )
def get_can_drop ( self, object, trait, index, value ):
""" Returns whether the specified *value* can be dropped on the
specified *object.trait[index]* list item. A value of **True** means
the *value* can be dropped; and a value of **False** indicates that
it cannot be dropped.
"""
return self._result_for( 'get_can_drop', object, trait, index, value )
def get_dropped ( self, object, trait, index, value ):
""" Returns how to handle a specified *value* being dropped on a
specified *object.trait[index]* list item. The possible return
values are:
'before'
Insert the specified *value* before the dropped on item.
'after'
Insert the specified *value* after the dropped on item.
"""
return self._result_for( 'get_dropped', object, trait, index, value )
def get_text_color ( self, object, trait, index ):
""" Returns the text color for a specified *object.trait[index]* list
item. A result of None means use the default list item text color.
"""
return self._result_for( 'get_text_color', object, trait, index )
def get_bg_color ( self, object, trait, index ):
""" Returns the background color for a specified *object.trait[index]*
list item. A result of None means use the default list item
background color.
"""
return self._result_for( 'get_bg_color', object, trait, index )
def get_image ( self, object, trait, index ):
""" Returns the name of the image to use for a specified
*object.trait[index]* list item. A result of None means no image
should be used. Otherwise, the result should either be the name of
the image, or an ImageResource item specifying the image to use.
"""
return self._result_for( 'get_image', object, trait, index )
def get_item ( self, object, trait, index ):
""" Returns the value of the *object.trait[index]* list item.
"""
return self._result_for( 'get_item', object, trait, index )
def get_text ( self, object, trait, index ):
""" Returns the text to display for a specified *object.trait[index]*
list item.
"""
return self._result_for( 'get_text', object, trait, index )
#-- Adapter methods that are not sensitive to item type --------------------
def len ( self, object, trait ):
""" Returns the number of items in the specified *object.trait* list.
"""
return len( getattr( object, trait ) )
def get_default_value ( self, object, trait ):
""" Returns a new default value for the specified *object.trait* list.
"""
return self.default_value
def get_default_text ( self, object, trait ):
""" Returns the default text for the specified *object.trait* list.
"""
return self.default_text
def get_default_image ( self, object, trait ):
""" Returns the default image for the specified *object.trait* list.
"""
return self.image
def get_default_bg_color ( self, object, trait ):
""" Returns the default background color for the specified
*object.trait* list.
"""
return self._get_bg_color()
def get_default_text_color ( self, object, trait ):
""" Returns the default text color for the specified *object.trait*
list.
"""
return self._get_text_color()
def set_text ( self, object, trait, index, text ):
""" Sets the text for a specified *object.trait[index]* list item to
*text*.
"""
getattr( object, trait )[ index ] = text
def delete ( self, object, trait, index ):
""" Deletes the specified *object.trait[index]* list item.
"""
del getattr( object, trait )[ index ]
def insert ( self, object, trait, index, value ):
""" Inserts a new value at the specified *object.trait[index]* list
index.
"""
getattr( object, trait ) [ index: index ] = [ value ]
#-- Private Adapter Implementation Methods ---------------------------------
def _get_can_edit ( self ):
return self.can_edit
def _get_drag ( self ):
return unicode( self.item )
def _get_can_drop ( self ):
return isinstance( self.value, basestring )
def _get_dropped ( self ):
return self.dropped
def _get_text_color ( self ):
if (self.index % 2) == 0:
return self.even_text_color_ or self.text_color_
return self.odd_text_color or self.text_color_
def _get_bg_color ( self ):
if (self.index % 2) == 0:
return self.even_bg_color_ or self.bg_color_
return self.odd_bg_color or self.bg_color_
def _get_image ( self ):
return self.image
def _get_item ( self ):
return self.item
def _get_text ( self ):
return unicode( self.item )
#-- Private Methods --------------------------------------------------------
def _result_for ( self, name, object, trait, index, value = None ):
""" Returns/Sets the value of the specified *name* attribute for the
specified *object.trait[index]* list item.
"""
self.index = index
self.value = value
items = getattr( object, trait )
if index >= len( items ):
self.item = item = None
else:
self.item = item = items[ index ]
item_class = item.__class__
key = '%s:%s' % ( item_class.__name__, name )
handler = self.cache.get( key )
if handler is not None:
return handler()
trait_name = name[4:]
for adapter in self.adapters:
adapter.index = index
adapter.item = item
adapter.value = value
if adapter.accepts and (adapter.trait( trait_name ) is not None):
handler = lambda: getattr( adapter.set( index = self.index,
item = self.item, value = self.value ), trait_name )
if adapter.is_cacheable:
break
return handler()
else:
for klass in item_class.__mro__:
cname = '%s_%s' % ( klass.__name__, trait_name )
if self.trait( cname ) is not None:
handler = lambda: getattr( self, cname )
break
else:
handler = getattr( self, '_' + name )
self.cache[ key ] = handler
return handler()
@on_trait_change( 'adapters.+update' )
def _flush_cache ( self ):
""" Flushes the cache when any trait on any adapter changes.
"""
self.cache = {}
self.cache_flushed = True
|
