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
|
from common.PropertyNames import *
from abc import ABCMeta, abstractmethod
import traceback
from ui.event.CommonListener import *
'''
@author rpiterman
DataAware objects are used to live-synchronize UI and DataModel/DataObject.
It is used as listener on UI events, to keep the DataObject up to date.
This class, as a base abstract class, sets a frame of functionality,
delegating the data Object get/set methods to a Value object,
and leaving the UI get/set methods abstract.
Note that event listenning is *not* a part of this model.
the updateData() or updateUI() methods should be porogramatically called.
in child classes, the updateData() will be binded to UI event calls.
<br><br>
This class holds references to a Data Object and a Value object.
The Value object "knows" how to get and set a value from the
Data Object.
'''
class DataAware(object):
__metaclass__ = ABCMeta
'''
creates a DataAware object for the given data object and Value object.
@param dataObject_
@param value_
'''
def __init__(self, dataObject_, field_):
self._dataObject = dataObject_
self._field = field_
'''
sets the given value to the UI control
@param newValue the value to set to the ui control.
'''
@abstractmethod
def setToUI (self,newValue):
pass
'''
gets the current value from the UI control.
@return the current value from the UI control.
'''
@abstractmethod
def getFromUI (self):
pass
'''
updates the UI control according to the
current state of the data object.
'''
def updateUI(self):
data = getattr(self._dataObject, self._field)
ui = self.getFromUI()
if data is not ui:
try:
self.setToUI(data)
except Exception, ex:
traceback.print_exc()
#TODO tell user...
'''
updates the DataObject according to
the current state of the UI control.
'''
def updateData(self):
try:
data = getattr(self._dataObject, self._field)
ui = self.getFromUI()
if data is not ui:
if isinstance(ui,tuple):
#Selected Element listbox
ui = ui[0]
setattr(self._dataObject, self._field, ui)
except Exception:
traceback.print_exc()
'''
given a collection containing DataAware objects,
calls updateUI() on each memebr of the collection.
@param dataAwares a collection containing DataAware objects.
'''
@classmethod
def updateUIs(self, dataAwares):
for i in dataAwares:
i.updateUI()
'''
Given a collection containing DataAware objects,
sets the given DataObject to each DataAware object
in the given collection
@param dataAwares a collection of DataAware objects.
@param dataObject new data object to set to the DataAware
objects in the given collection.
@param updateUI if true, calls updateUI() on each DataAware object.
'''
def setDataObject(self, dataObject, updateUI):
if dataObject is not None:
if not (type(self._field) is not
type(dataObject)):
raise ClassCastException (
"can not cast new DataObject to original Class")
self._dataObject = dataObject
if updateUI:
self.updateUI()
'''
Given a collection containing DataAware objects,
sets the given DataObject to each DataAware object
in the given collection
@param dataAwares a collection of DataAware objects.
@param dataObject new data object to set to the DataAware objects
in the given collection.
@param updateUI if true, calls updateUI() on each DataAware object.
'''
@classmethod
def setDataObjects(self, dataAwares, dataObject, updateUI):
for i in dataAwares:
i.setDataObject(dataObject, updateUI)
|
