Class: Glimmer::SWT::WidgetProxy
Direct Known Subclasses
BrowserProxy, ButtonProxy, CheckboxProxy, ComboProxy, CompositeProxy, DateTimeProxy, DisplayProxy, LabelProxy, ListProxy, MessageBoxProxy, RadioProxy, TabFolderProxy, TableColumnProxy, TableItemProxy, TextProxy
Constant Summary
collapse
- DEFAULT_INITIALIZERS =
{
"composite" => lambda do |composite_proxy|
if composite_proxy.layout.nil?
layout = GridLayoutProxy.new(composite_proxy, [])
composite_proxy.layout = layout
layout.margin_width = 15
layout.margin_height = 15
end
end,
"table_column" => lambda do |table_column_proxy|
table_column_proxy.width = 80
end,
}
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
-
#add_content_on_render(&content_block) ⇒ Object
-
#add_css_class(css_class) ⇒ Object
-
#add_css_classes(css_classes_to_add) ⇒ Object
-
#add_observer(observer, property_name) ⇒ Object
-
#apply_property_type_converters(attribute_name, args) ⇒ Object
-
#build_dom(layout = true) ⇒ Object
-
#can_handle_observation_request?(observation_request) ⇒ Boolean
-
#clear_css_classes ⇒ Object
-
#content(&block) ⇒ Object
-
#content_on_render_blocks ⇒ Object
-
#css_classes ⇒ Object
-
#default_observation_request_to_event_mapping ⇒ Object
-
#dispose ⇒ Object
-
#dom_element ⇒ Object
-
#effective_observation_request_to_event_mapping ⇒ Object
-
#element ⇒ Object
Root element representing widget.
-
#get_data(key = nil) ⇒ Object
(also: #getData, #data)
-
#handle_observation_request(keyword, &event_listener) ⇒ Object
-
#has_style?(symbol) ⇒ Boolean
-
#id ⇒ Object
-
#id=(value) ⇒ Object
-
#initialize(parent, args, block) ⇒ WidgetProxy
constructor
A new instance of WidgetProxy.
-
#listener_dom_element ⇒ Object
-
#listener_path ⇒ Object
-
#method_missing(method, *args, &block) ⇒ Object
-
#name ⇒ Object
-
#observation_request_to_event_mapping ⇒ Object
Subclasses must override with their own mappings.
-
#observation_requests ⇒ Object
-
#parent_dom_element ⇒ Object
-
#parent_path ⇒ Object
-
#post_add_content ⇒ Object
Executes at the closing of a parent widget curly braces after all children/properties have been added/set.
-
#post_dispose_child(child) ⇒ Object
Executes for the parent of a child that just got disposed.
-
#post_initialize_child(child) ⇒ Object
Executes for the parent of a child that just got added.
-
#property_type_converters ⇒ Object
-
#remove_all_listeners ⇒ Object
-
#remove_css_class(css_class) ⇒ Object
-
#remove_css_classes(css_classes_to_remove) ⇒ Object
-
#render(custom_parent_dom_element = nil) ⇒ Object
(also: #redraw)
-
#selector ⇒ Object
Subclasses can override with their own selector.
-
#set_attribute(attribute_name, *args) ⇒ Object
-
#set_data(key = nil, value) ⇒ Object
(also: #setData, #data=)
-
#set_focus ⇒ Object
(also: #setFocus)
-
#style_element ⇒ Object
TODO consider adding a default #dom method implementation for the common case, automatically relying on #element and other methods to build the dom html.
-
#widget_property_listener_installers ⇒ Object
#attribute_getter, #attribute_setter, #get_attribute
Constructor Details
#initialize(parent, args, block) ⇒ WidgetProxy
Returns a new instance of WidgetProxy.
103
104
105
106
107
108
109
110
111
112
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 103
def initialize(parent, args, block)
@parent = parent
@args = args
@block = block
@children = Set.new @enabled = true
@data = {}
DEFAULT_INITIALIZERS[self.class.underscored_widget_name(self)]&.call(self)
@parent.post_initialize_child(self) end
|
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method, *args, &block) ⇒ Object
411
412
413
414
415
416
417
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 411
def method_missing(method, *args, &block)
if method.to_s.start_with?('on_')
handle_observation_request(method, &block)
else
super(method, *args, &block)
end
end
|
Instance Attribute Details
#args ⇒ Object
Returns the value of attribute args.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def args
@args
end
|
#background ⇒ Object
Returns the value of attribute background.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def background
@background
end
|
#children ⇒ Object
Returns the value of attribute children.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def children
@children
end
|
#disposed? ⇒ Object
Also known as:
isDisposed, is_disposed
Returns the value of attribute disposed?.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def disposed?
@disposed?
end
|
#enabled ⇒ Object
Returns the value of attribute enabled.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def enabled
@enabled
end
|
#focus ⇒ Object
Returns the value of attribute focus.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def focus
@focus
end
|
#font ⇒ Object
Returns the value of attribute font.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def font
@font
end
|
#foreground ⇒ Object
Returns the value of attribute foreground.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def foreground
@foreground
end
|
#parent ⇒ Object
Returns the value of attribute parent.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def parent
@parent
end
|
#path ⇒ Object
Returns the value of attribute path.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def path
@path
end
|
#rendered ⇒ Object
Also known as:
rendered?
Returns the value of attribute rendered.
32
33
34
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 32
def rendered
@rendered
end
|
Class Method Details
.for(keyword, parent, args, block) ⇒ Object
Factory Method that translates a Glimmer DSL keyword into a WidgetProxy object
39
40
41
42
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 39
def for(keyword, parent, args, block)
the_widget_class = widget_class(keyword)
the_widget_class.respond_to?(:create) ? the_widget_class.create(keyword, parent, args, block) : the_widget_class.new(parent, args, block)
end
|
.max_id_number_for(name) ⇒ Object
61
62
63
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 61
def max_id_number_for(name)
@max_id_numbers[name] = max_id_numbers[name] || 0
end
|
.max_id_numbers ⇒ Object
65
66
67
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 65
def max_id_numbers
@max_id_numbers ||= reset_max_id_numbers!
end
|
.next_id_number_for(name) ⇒ Object
57
58
59
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 57
def next_id_number_for(name)
@max_id_numbers[name] = max_id_number_for(name) + 1
end
|
.reset_max_id_numbers! ⇒ Object
69
70
71
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 69
def reset_max_id_numbers!
@max_id_numbers = {}
end
|
73
74
75
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 73
def underscored_widget_name(widget_proxy)
widget_proxy.class.name.split(/::|\./).last.sub(/Proxy$/, '').underscore
end
|
44
45
46
47
48
49
50
51
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 44
def widget_class(keyword)
class_name_alternative = keyword.camelcase(:upper)
class_name_main = "#{class_name_alternative}Proxy"
Glimmer::SWT.const_get(class_name_main.to_sym) rescue Glimmer::SWT.const_get(class_name_alternative.to_sym)
rescue => e
puts "Widget #{keyword} was not found!"
nil
end
|
53
54
55
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 53
def widget_exists?(keyword)
!!widget_class(keyword)
end
|
Instance Method Details
#add_content_on_render(&content_block) ⇒ Object
246
247
248
249
250
251
252
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 246
def add_content_on_render(&content_block)
if rendered?
content_block.call
else
content_on_render_blocks << content_block
end
end
|
#add_css_class(css_class) ⇒ Object
304
305
306
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 304
def add_css_class(css_class)
dom_element.add_class(css_class)
end
|
#add_css_classes(css_classes_to_add) ⇒ Object
308
309
310
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 308
def add_css_classes(css_classes_to_add)
css_classes_to_add.each {|css_class| add_css_class(css_class)}
end
|
#add_observer(observer, property_name) ⇒ Object
398
399
400
401
402
403
404
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 398
def add_observer(observer, property_name)
property_listener_installers = self.class&.ancestors&.to_a.map {|ancestor| widget_property_listener_installers[ancestor]}.compact
widget_listener_installers = property_listener_installers.map{|installer| installer[property_name.to_s.to_sym]}.compact if !property_listener_installers.empty?
widget_listener_installers.to_a.each do |widget_listener_installer|
widget_listener_installer.call(observer)
end
end
|
#apply_property_type_converters(attribute_name, args) ⇒ Object
419
420
421
422
423
424
425
426
427
428
429
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 419
def apply_property_type_converters(attribute_name, args)
if args.count == 1
value = args.first
converter = property_type_converters[attribute_name.to_sym]
args[0] = converter.call(value) if converter
end
end
|
#build_dom(layout = true) ⇒ Object
254
255
256
257
258
259
260
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 254
def build_dom(layout=true)
@dom = nil
@dom = dom
@dom = @parent.layout.dom(@dom) if @parent.respond_to?(:layout) && @parent.layout
@dom
end
|
#can_handle_observation_request?(observation_request) ⇒ Boolean
357
358
359
360
361
362
363
364
365
366
367
368
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 357
def can_handle_observation_request?(observation_request)
observation_request = observation_request.to_s
if observation_request.start_with?('on_swt_')
constant_name = observation_request.sub(/^on_swt_/, '')
SWTProxy.has_constant?(constant_name)
elsif observation_request.start_with?('on_')
true end
end
|
#clear_css_classes ⇒ Object
320
321
322
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 320
def clear_css_classes
css_classes.each {|css_class| remove_css_class(css_class)}
end
|
#content(&block) ⇒ Object
#content_on_render_blocks ⇒ Object
242
243
244
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 242
def content_on_render_blocks
@content_on_render_blocks ||= []
end
|
#css_classes ⇒ Object
142
143
144
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 142
def css_classes
dom_element.attr('class').to_s.split
end
|
#default_observation_request_to_event_mapping ⇒ Object
275
276
277
278
279
280
281
282
283
284
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 275
def default_observation_request_to_event_mapping
{
'on_focus_gained' => {
event: 'focus',
},
'on_focus_lost' => {
event: 'blur',
},
}
end
|
#dispose ⇒ Object
146
147
148
149
150
151
152
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 146
def dispose
remove_all_listeners
Document.find(path).remove
parent&.post_dispose_child(self)
@disposed = true
end
|
#dom_element ⇒ Object
328
329
330
331
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 328
def dom_element
Document.find(path)
end
|
#effective_observation_request_to_event_mapping ⇒ Object
271
272
273
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 271
def effective_observation_request_to_event_mapping
default_observation_request_to_event_mapping.merge(observation_request_to_event_mapping)
end
|
#element ⇒ Object
Root element representing widget. Must be overridden by subclasses if different from div
173
174
175
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 173
def element
'div'
end
|
#get_data(key = nil) ⇒ Object
Also known as:
getData, data
136
137
138
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 136
def get_data(key=nil)
@data[key]
end
|
#handle_observation_request(keyword, &event_listener) ⇒ Object
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 374
def handle_observation_request(keyword, &event_listener)
return unless effective_observation_request_to_event_mapping.keys.include?(keyword)
event = nil
delegate = nil
effective_observation_request_to_event_mapping[keyword].to_collection.each do |mapping|
observation_requests[keyword] ||= Set.new
observation_requests[keyword] << event_listener
event = mapping[:event]
event_handler = mapping[:event_handler]
event_element_css_selector = mapping[:event_element_css_selector]
potential_event_listener = event_handler&.call(event_listener)
event_listener = potential_event_listener || event_listener
async_event_listener = lambda do |event|
Async::Task.new do
event_listener.call(event)
end
end
the_listener_dom_element = event_element_css_selector ? Element[event_element_css_selector] : listener_dom_element
delegate = the_listener_dom_element.on(event, &async_event_listener)
end
EventListenerProxy.new(element_proxy: self, event: event, selector: selector, delegate: delegate)
end
|
#has_style?(symbol) ⇒ Boolean
324
325
326
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 324
def has_style?(symbol)
@args.include?(symbol) end
|
#id=(value) ⇒ Object
Sets id explicitly. Useful in cases of wanting to maintain a stable id
295
296
297
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 295
def id=(value)
@id = value
end
|
#listener_dom_element ⇒ Object
353
354
355
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 353
def listener_dom_element
Document.find(listener_path)
end
|
#listener_path ⇒ Object
349
350
351
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 349
def listener_path
path
end
|
#name ⇒ Object
286
287
288
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 286
def name
self.class.name.split('::').last.underscore.sub(/_proxy$/, '').gsub('_', '-')
end
|
#observation_request_to_event_mapping ⇒ Object
Subclasses must override with their own mappings
267
268
269
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 267
def observation_request_to_event_mapping
{}
end
|
#observation_requests ⇒ Object
370
371
372
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 370
def observation_requests
@observation_requests ||= {}
end
|
#parent_dom_element ⇒ Object
214
215
216
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 214
def parent_dom_element
Document.find(parent_path)
end
|
#parent_path ⇒ Object
210
211
212
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 210
def parent_path
@parent.path
end
|
#post_add_content ⇒ Object
Executes at the closing of a parent widget curly braces after all children/properties have been added/set
126
127
128
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 126
def post_add_content
end
|
#post_dispose_child(child) ⇒ Object
Executes for the parent of a child that just got disposed
121
122
123
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 121
def post_dispose_child(child)
@children&.delete(child)
end
|
#post_initialize_child(child) ⇒ Object
Executes for the parent of a child that just got added
115
116
117
118
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 115
def post_initialize_child(child)
@children << child
child.render
end
|
#property_type_converters ⇒ Object
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 431
def property_type_converters
color_converter = lambda do |value|
if value.is_a?(Symbol) || value.is_a?(String)
ColorProxy.new(value)
else
value
end
end
@property_type_converters ||= {
:background => color_converter,
:foreground => color_converter,
:text => lambda do |value|
value.to_s
end,
}
end
|
#remove_all_listeners ⇒ Object
154
155
156
157
158
159
160
161
162
163
164
165
166
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 154
def remove_all_listeners
effective_observation_request_to_event_mapping.keys.each do |keyword|
effective_observation_request_to_event_mapping[keyword].to_collection.each do |mapping|
observation_requests[keyword].to_a.each do |event_listener|
event = mapping[:event]
event_handler = mapping[:event_handler]
event_element_css_selector = mapping[:event_element_css_selector]
the_listener_dom_element = event_element_css_selector ? Element[event_element_css_selector] : listener_dom_element
the_listener_dom_element.off(event)
end
end
end
end
|
#remove_css_class(css_class) ⇒ Object
312
313
314
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 312
def remove_css_class(css_class)
dom_element.remove_class(css_class)
end
|
#remove_css_classes(css_classes_to_remove) ⇒ Object
316
317
318
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 316
def remove_css_classes(css_classes_to_remove)
css_classes_to_remove.each {|css_class| remove_css_class(css_class)}
end
|
#render(custom_parent_dom_element = nil) ⇒ Object
Also known as:
redraw
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 218
def render(custom_parent_dom_element = nil)
the_parent_dom_element = custom_parent_dom_element || parent_dom_element
old_element = dom_element
brand_new = @dom.nil? || old_element.empty?
build_dom(!custom_parent_dom_element) if brand_new
the_parent_dom_element.append(@dom)
else
old_element.replace_with(@dom)
end
observation_requests&.clone&.each do |keyword, event_listener_set|
event_listener_set.each do |event_listener|
observation_requests[keyword].delete(event_listener) handle_observation_request(keyword, &event_listener)
end
end
children.each do |child|
child.render
end
@rendered = true
content_on_render_blocks.each { |content_block| content(&content_block) }
end
|
#selector ⇒ Object
Subclasses can override with their own selector
300
301
302
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 300
def selector
"#{name}##{id}"
end
|
#set_attribute(attribute_name, *args) ⇒ Object
406
407
408
409
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 406
def set_attribute(attribute_name, *args)
apply_property_type_converters(attribute_name, args)
super(attribute_name, *args) end
|
#set_data(key = nil, value) ⇒ Object
Also known as:
setData, data=
130
131
132
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 130
def set_data(key=nil, value)
@data[key] = value
end
|
#set_focus ⇒ Object
Also known as:
setFocus
205
206
207
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 205
def set_focus
self.focus = true
end
|
#style_element ⇒ Object
TODO consider adding a default #dom method implementation for the common case, automatically relying on #element and other methods to build the dom html
335
336
337
338
339
340
341
342
343
344
345
346
347
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 335
def style_element
style_element_id = "#{id}-style"
style_element_selector = "style##{style_element_id}"
element = dom_element.find(style_element_selector)
if element.empty?
new_element = Element.new(:style)
new_element.attr('id', style_element_id)
new_element.attr('class', "#{name.gsub('_', '-')}-instance-style widget-instance-style")
dom_element.prepend(new_element)
element = dom_element.find(style_element_selector)
end
element
end
|
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
|
# File 'lib/glimmer/swt/widget_proxy.rb', line 482
def widget_property_listener_installers
@swt_widget_property_listener_installers ||= {
TextProxy => {
:text => lambda do |observer|
on_modify_text { |modify_event|
observer.call(text)
}
end,
},
DateTimeProxy => {
:date_time => lambda do |observer|
on_widget_selected { |selection_event|
observer.call(date_time)
}
end
},
RadioProxy => { :selection => lambda do |observer|
on_widget_selected { |selection_event|
observer.call(selection)
}
end
},
TableProxy => {
:selection => lambda do |observer|
on_widget_selected { |selection_event|
observer.call(selection_event.table_item.get_data) }
end,
},
}
end
|