1 | from plone.memoize.view import memoize |
---|
2 | |
---|
3 | from AccessControl import ClassSecurityInfo |
---|
4 | from Globals import InitializeClass |
---|
5 | from Products.DataGridField.Column import Column |
---|
6 | |
---|
7 | class HiddenColumn(Column): |
---|
8 | """ Column with non-changeable text |
---|
9 | |
---|
10 | Useful with DataGridField.fixed_row property in some use cases. |
---|
11 | """ |
---|
12 | security = ClassSecurityInfo() |
---|
13 | |
---|
14 | def __init__(self, label, default=None, label_msgid=None, visible=True): |
---|
15 | """ Create a column |
---|
16 | |
---|
17 | @param hide Hide column from displaying |
---|
18 | """ |
---|
19 | Column.__init__(self, label, default, label_msgid) |
---|
20 | self.visible = visible |
---|
21 | |
---|
22 | security.declarePublic('getMacro') |
---|
23 | def getMacro(self): |
---|
24 | """ Return macro used to render this column in view/edit """ |
---|
25 | return "referencedatagrid_hidden_cell" |
---|
26 | |
---|
27 | # Initializes class security |
---|
28 | InitializeClass(HiddenColumn) |
---|
29 | |
---|
30 | class BlockColumn(Column): |
---|
31 | """ Column with possibility to block the cell data from changing, |
---|
32 | based on the value of the row data. |
---|
33 | """ |
---|
34 | security = ClassSecurityInfo() |
---|
35 | |
---|
36 | def __init__(self, label, default=None, label_msgid=None, |
---|
37 | column_on_class=None, column_off_class=None, |
---|
38 | columns=[], invert=False, read_only=None): |
---|
39 | """ Create a column, with adding class attribute depend on value presence for the cell. |
---|
40 | |
---|
41 | @param column_on_class set class, which will be added to the <input> tag if columns has value |
---|
42 | @param column_off_class set class, which will be added to the <input> tag if columns not has value |
---|
43 | @param columns list of columns names, which values will be checked for set class attribute |
---|
44 | @param invert - invert the adding class logic |
---|
45 | @param read_only - check-on/off readOnly attribute for the <input> tag |
---|
46 | """ |
---|
47 | Column.__init__(self, label, default, label_msgid) |
---|
48 | self.column_on_class = column_on_class |
---|
49 | self.column_off_class = column_off_class |
---|
50 | self.columns = columns |
---|
51 | self.invert = invert |
---|
52 | self.read_only = read_only |
---|
53 | |
---|
54 | def passCondition(self, row_data): |
---|
55 | """ Return calculated class attribute.""" |
---|
56 | res = sum([1 for c in self.columns if row_data.get(c,0)]) |
---|
57 | return res == len(self.columns) and not self.invert |
---|
58 | |
---|
59 | security.declarePublic('getAttributesData') |
---|
60 | def getAttributesData(self, row_data): |
---|
61 | """ Return calculated class attribute.""" |
---|
62 | res = {'style_class': None, 'read_only': None} |
---|
63 | isPassCondition = self.passCondition(row_data) |
---|
64 | if self.column_on_class or self.column_off_class: |
---|
65 | res['style_class'] = isPassCondition and self.column_on_class or self.column_off_class |
---|
66 | if self.read_only: |
---|
67 | res['read_only'] = isPassCondition and True or False |
---|
68 | |
---|
69 | return res |
---|
70 | |
---|
71 | security.declarePublic('getMacro') |
---|
72 | def getMacro(self): |
---|
73 | """ Return macro used to render this column in view/edit """ |
---|
74 | return "referencedatagrid_block_cell" |
---|
75 | |
---|
76 | # Initializes class security |
---|
77 | InitializeClass(BlockColumn) |
---|
78 | |
---|
79 | class StyledColumn(Column): |
---|
80 | """ Column with styling based on events.""" |
---|
81 | security = ClassSecurityInfo() |
---|
82 | |
---|
83 | def __init__(self, label, default=None, label_msgid=None, |
---|
84 | trigger_key=None, blur_handler="", focus_handler="", |
---|
85 | class_no="", class_changed="", class_not_changed=""): |
---|
86 | """ Create a column |
---|
87 | |
---|
88 | @param trigger_key |
---|
89 | """ |
---|
90 | Column.__init__(self, label, default, label_msgid) |
---|
91 | self.trigger = trigger_key |
---|
92 | self.blur_handler = blur_handler and blur_handler + "(event)" or "" |
---|
93 | self.focus_handler = focus_handler and focus_handler + "(event)" or "" |
---|
94 | self.class_no = class_no |
---|
95 | self.class_not_changed = class_not_changed |
---|
96 | self.class_changed = class_changed |
---|
97 | |
---|
98 | security.declarePublic("getAttributes") |
---|
99 | def getAttributes(self, column_id, rows): |
---|
100 | default = None |
---|
101 | blur_handler = None |
---|
102 | focus_handler = None |
---|
103 | sclass = self.class_no |
---|
104 | |
---|
105 | if rows.has_key(self.trigger) \ |
---|
106 | and rows.has_key(column_id): |
---|
107 | focus_handler = self.focus_handler |
---|
108 | blur_handler = self.blur_handler |
---|
109 | current = rows[column_id] |
---|
110 | default = rows[self.trigger] |
---|
111 | # if default is not epty string - than it is same to original value |
---|
112 | if current == default: |
---|
113 | sclass = self.class_not_changed |
---|
114 | else: |
---|
115 | sclass = self.class_changed |
---|
116 | |
---|
117 | return {'class': sclass, |
---|
118 | 'onblur': blur_handler, |
---|
119 | 'onfocus': focus_handler, |
---|
120 | 'default': default} |
---|
121 | |
---|
122 | security.declarePublic('getMacro') |
---|
123 | def getMacro(self): |
---|
124 | """ Return macro used to render this column in view/edit """ |
---|
125 | return "referencedatagrid_styled_cell" |
---|
126 | |
---|
127 | # Initializes class security |
---|
128 | InitializeClass(StyledColumn) |
---|
129 | |
---|