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
|
""" An extensible workbench window. """
# Standard library imports.
import logging
# Enthought library imports.
import enthought.pyface.workbench.api as pyface
from enthought.envisage.api import IExtensionPointUser, IExtensionRegistry
from enthought.envisage.api import IServiceRegistry
from enthought.envisage.api import ExtensionPoint, ServiceRegistry
from enthought.envisage.ui.action.api import ActionSet
from enthought.pyface.action.api import StatusBarManager
from enthought.traits.api import Delegate, Instance, List, Property, implements
# Local imports.
from workbench_action_manager_builder import WorkbenchActionManagerBuilder
from workbench_editor_manager import WorkbenchEditorManager
# Logging.
logger = logging.getLogger(__name__)
class WorkbenchWindow(pyface.WorkbenchWindow):
""" An extensible workbench window. """
implements(IServiceRegistry, IExtensionPointUser)
# Extension point Ids.
ACTION_SETS = 'enthought.envisage.ui.workbench.action_sets'
VIEWS = 'enthought.envisage.ui.workbench.views'
PERSPECTIVES = 'enthought.envisage.ui.workbench.perspectives'
SERVICE_OFFERS = 'enthought.envisage.ui.workbench.service_offers'
#### 'WorkbenchWindow' interface ##########################################
# The application that the window is part of.
#
# This is equivalent to 'self.workbench.application', and is provided just
# as a convenience since windows often want access to the application.
application = Delegate('workbench', modify=True)
# The action sets that provide the toolbars, menus groups and actions
# used in the window.
action_sets = List(Instance(ActionSet))
# The service registry for 'per window' services.
service_registry = Instance(IServiceRegistry, factory=ServiceRegistry)
#### 'IExtensionPointUser' interface ######################################
# The extension registry that the object's extension points are stored in.
extension_registry = Property(Instance(IExtensionRegistry))
#### Private interface ####################################################
# The workbench menu and tool bar builder.
#
# The builder is used to create the window's tool bar and menu bar by
# combining all of the contributed action sets.
_action_manager_builder = Instance(WorkbenchActionManagerBuilder)
# Contributed action sets (each contribution is actually a factory).
_action_sets = ExtensionPoint(id=ACTION_SETS)
# Contributed views (each contribution is actually a factory).
_views = ExtensionPoint(id=VIEWS)
# Contributed perspectives (each contribution is actually a factory).
_perspectives = ExtensionPoint(id=PERSPECTIVES)
# Contributed service offers.
_service_offers = ExtensionPoint(id=SERVICE_OFFERS)
# The Ids of the services that were automatically registered.
_service_ids = List
###########################################################################
# 'IExtensionPointUser' interface.
###########################################################################
def _get_extension_registry(self):
""" Trait property getter. """
return self.application
###########################################################################
# 'pyface.Window' interface.
###########################################################################
#### Trait initializers ###################################################
def _menu_bar_manager_default(self):
""" Trait initializer. """
return self._action_manager_builder.create_menu_bar_manager('MenuBar')
def _status_bar_manager_default(self):
""" Trait initializer. """
return StatusBarManager()
def _tool_bar_managers_default(self):
""" Trait initializer. """
return self._action_manager_builder.create_tool_bar_managers('ToolBar')
#### Trait change handlers ################################################
def _opening_changed(self):
""" Static trait change handler. """
self._service_ids = self._register_service_offers(self._service_offers)
return
def _closed_changed(self):
""" Static trait change handler. """
self._unregister_service_offers(self._service_ids)
return
###########################################################################
# 'pyface.WorkbenchWindow' interface.
###########################################################################
#### Trait initializers ###################################################
def _editor_manager_default(self):
""" Trait initializer. """
return WorkbenchEditorManager(window=self)
def _icon_default(self):
""" Trait initializer. """
return self.workbench.application.icon
def _perspectives_default(self):
""" Trait initializer. """
return [factory() for factory in self._perspectives]
def _title_default(self):
""" Trait initializer. """
return self.workbench.application.name
def _views_default(self):
""" Trait initializer. """
return [factory(window=self) for factory in self._views]
###########################################################################
# 'WorkbenchWindow' interface.
###########################################################################
def _action_sets_default(self):
""" Trait initializer. """
return [factory(window=self) for factory in self._action_sets]
###########################################################################
# 'IServiceRegistry' interface.
###########################################################################
def get_service(self, protocol, query='', minimize='', maximize=''):
""" Return at most one service that matches the specified query. """
service = self.service_registry.get_service(
protocol, query, minimize, maximize
)
return service
def get_service_properties(self, service_id):
""" Return the dictionary of properties associated with a service. """
return self.service_registry.get_service_properties(service_id)
def get_services(self, protocol, query='', minimize='', maximize=''):
""" Return all services that match the specified query. """
services = self.service_registry.get_services(
protocol, query, minimize, maximize
)
return services
def register_service(self, protocol, obj, properties=None):
""" Register a service. """
service_id = self.service_registry.register_service(
protocol, obj, properties
)
return service_id
def set_service_properties(self, service_id, properties):
""" Set the dictionary of properties associated with a service. """
self.service_registry.set_service_properties(service_id, properties)
return
def unregister_service(self, service_id):
""" Unregister a service. """
self.service_registry.unregister_service(service_id)
return
###########################################################################
# Private interface.
###########################################################################
def __action_manager_builder_default(self):
""" Trait initializer. """
action_manager_builder = WorkbenchActionManagerBuilder(
window=self, action_sets=self.action_sets
)
return action_manager_builder
def _register_service_offers(self, service_offers):
""" Register all service offers. """
return map(self._register_service_offer, service_offers)
def _register_service_offer(self, service_offer):
""" Register a service offer. """
# Add the window to the service offer properties (this is so that it
# is available to the factory when it is called to create the actual
# service).
service_offer.properties['window'] = self
service_id = self.register_service(
protocol = service_offer.protocol,
obj = service_offer.factory,
properties = service_offer.properties
)
return service_id
def _unregister_service_offers(self, service_ids):
""" Unregister all service offers. """
# Unregister the services in the reverse order that we registered
# them.
service_ids_copy = service_ids[:]
service_ids_copy.reverse()
for service_id in service_ids_copy:
self.unregister_service(service_id)
return
#### EOF ######################################################################
|
