Class: Glimmer::SWT::WidgetProxy

Inherits:
Object
  • Object
show all
Includes:
Packages
Defined in:
lib/glimmer/swt/widget_proxy.rb

Overview

Proxy for SWT Widget objects

Sets default SWT styles to widgets upon inititalizing as per DEFAULT_STYLES

Also, auto-initializes widgets as per initializer blocks in DEFAULT_INITIALIZERS (e.g. setting Composite default layout)

Follows the Proxy Design Pattern

Constant Summary collapse

DEFAULT_STYLES = 
{
  "arrow"               => [:arrow],
  "button"              => [:push],
  "checkbox"            => [:check],
  "check"               => [:check],
  "drag_source"         => [:drop_copy],
  "drop_target"         => [:drop_copy],
  "list"                => [:border, :v_scroll],
  "menu_item"           => [:push],
  "radio"               => [:radio],
  "scrolled_composite"  => [:border, :h_scroll, :v_scroll],
  "spinner"             => [:border],
  "styled_text"         => [:border],
  "table"               => [:virtual, :border, :full_selection],
  "text"                => [:border],
  "toggle"              => [:toggle],
  "tree"                => [:virtual, :border, :h_scroll, :v_scroll],
}
DEFAULT_INITIALIZERS = 
{
  "composite" => lambda do |composite|
    if composite.get_layout.nil?
      layout = GridLayout.new
      layout.marginWidth = 15
      layout.marginHeight = 15
      composite.layout = layout
    end
  end,
  "scrolled_composite" => lambda do |scrolled_composite|
    scrolled_composite.expand_horizontal = true
    scrolled_composite.expand_vertical = true
  end,
  "table" => lambda do |table|
    table.setHeaderVisible(true)
    table.setLinesVisible(true)
  end,
  "table_column" => lambda do |table_column|
    table_column.setWidth(80)
  end,
  "group" => lambda do |group|
    group.layout = GridLayout.new if group.get_layout.nil?
  end,
}
KEYWORD_ALIASES = 
{
  'radio'          => 'button',
  'checkbox'       => 'button',
  'check'          => 'button',
  'toggle'         => 'button',
  'arrow'          => 'button',
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Packages

included

Constructor Details

#initialize(*init_args, swt_widget: nil) ⇒ WidgetProxy

Initializes a new SWT Widget

It is preferred to use ‘::create` method instead since it instantiates the right subclass per widget keyword

keyword, parent, swt_widget_args (including styles)

Styles is a comma separate list of symbols representing SWT styles in lower case



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 136

def initialize(*init_args, swt_widget: nil)
  if swt_widget.nil?
    underscored_widget_name, parent, args = init_args
    @parent_proxy = parent
    styles, extra_options = extract_args(underscored_widget_name, args)
    swt_widget_class = self.class.swt_widget_class_for(underscored_widget_name)
    @swt_widget = swt_widget_class.new(@parent_proxy.swt_widget, style(underscored_widget_name, styles), *extra_options)
  else
    @swt_widget = swt_widget
    underscored_widget_name = self.class.underscored_widget_name(@swt_widget)
    parent_proxy_class = self.class.widget_proxy_class(self.class.underscored_widget_name(@swt_widget.parent))
    parent = swt_widget.parent
    @parent_proxy = parent.get_data('proxy') || parent_proxy_class.new(swt_widget: parent)
  end
  if @swt_widget&.get_data('proxy').nil?
    @swt_widget.set_data('proxy', self)          
    DEFAULT_INITIALIZERS[underscored_widget_name]&.call(@swt_widget)
    @parent_proxy.post_initialize_child(self)
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object 



491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 491

def method_missing(method, *args, &block)
  if can_handle_observation_request?(method)          
    handle_observation_request(method, &block)
  else
    swt_widget.send(method, *args, &block)
  end
rescue => e
  Glimmer::Config.logger.debug {"Neither WidgetProxy nor #{swt_widget.class.name} can handle the method ##{method}"}
  super
  # TODO consider get_attribute too
end

Instance Attribute Details

#drag_source_proxy ⇒ Object (readonly)

Returns the value of attribute drag_source_proxy.



126
127
128
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 126

def drag_source_proxy
  @drag_source_proxy
end

#drag_source_style ⇒ Object

Returns the value of attribute drag_source_style.



126
127
128
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 126

def drag_source_style
  @drag_source_style
end

#drag_source_transfer ⇒ Object

Returns the value of attribute drag_source_transfer.



126
127
128
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 126

def drag_source_transfer
  @drag_source_transfer
end

#drop_target_proxy ⇒ Object (readonly)

Returns the value of attribute drop_target_proxy.



126
127
128
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 126

def drop_target_proxy
  @drop_target_proxy
end

#drop_target_transfer ⇒ Object

Returns the value of attribute drop_target_transfer.



126
127
128
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 126

def drop_target_transfer
  @drop_target_transfer
end

#parent_proxy ⇒ Object (readonly)

Returns the value of attribute parent_proxy.



126
127
128
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 126

def parent_proxy
  @parent_proxy
end

#swt_widget ⇒ Object (readonly)

Returns the value of attribute swt_widget.



126
127
128
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 126

def swt_widget
  @swt_widget
end

Class Method Details

.create(*init_args, swt_widget: nil) ⇒ Object

Instantiates the right WidgetProxy subclass for passed in keyword Args are: keyword, parent, swt_widget_args (including styles)



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 100

def create(*init_args, swt_widget: nil)
  return swt_widget.get_data('proxy') if swt_widget&.get_data('proxy')
  keyword, parent, args = init_args
  selected_widget_proxy_class = widget_proxy_class(keyword || underscored_widget_name(swt_widget))
  if init_args.empty?
    selected_widget_proxy_class.new(swt_widget: swt_widget)
  else
    selected_widget_proxy_class.new(*init_args)            
  end
end

.swt_widget_class_for(underscored_widget_name) ⇒ Object

This supports widgets in and out of basic SWT



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 361

def self.swt_widget_class_for(underscored_widget_name)
  underscored_widget_name = KEYWORD_ALIASES[underscored_widget_name] if KEYWORD_ALIASES[underscored_widget_name]
  swt_widget_name = underscored_widget_name.camelcase(:upper)
  swt_widget_class = eval(swt_widget_name)
  unless swt_widget_class.ancestors.include?(org.eclipse.swt.widgets.Widget)
    Glimmer::Config.logger.debug {"Class #{swt_widget_class} matching #{underscored_widget_name} is not a subclass of org.eclipse.swt.widgets.Widget"}
    return nil
  end
  swt_widget_class
rescue SyntaxError, NameError => e
  Glimmer::Config.logger.debug {e.full_message}
  # Glimmer::Config.logger.debug {"#{e.message}\n#{e.backtrace.join("\n")}"}
  nil
rescue => e
  Glimmer::Config.logger.debug {e.full_message}
  # Glimmer::Config.logger.debug {"#{e.message}\n#{e.backtrace.join("\n")}"}
  nil
end

.underscored_widget_name(swt_widget) ⇒ Object 



121
122
123
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 121

def underscored_widget_name(swt_widget)
  swt_widget.class.name.split(/::|\./).last.underscore        
end

.widget_exists?(underscored_widget_name) ⇒ Boolean

Returns:

  • (Boolean) 


356
357
358
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 356

def self.widget_exists?(underscored_widget_name)
  !!swt_widget_class_for(underscored_widget_name)
end

.widget_proxy_class(keyword) ⇒ Object 



111
112
113
114
115
116
117
118
119
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 111

def widget_proxy_class(keyword)
  begin
    keyword = KEYWORD_ALIASES[keyword] if KEYWORD_ALIASES[keyword]
    class_name = "#{keyword.camelcase(:upper)}Proxy".to_sym
    Glimmer::SWT.const_get(class_name)
  rescue
    Glimmer::SWT::WidgetProxy
  end        
end

Instance Method Details

#add_observer(observer, property_name) ⇒ Object

Used for data-binding only. Consider renaming or improving to avoid the confusion it causes



404
405
406
407
408
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 404

def add_observer(observer, property_name)
  property_listener_installers = @swt_widget.class.ancestors.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.first&.call(observer)
end

#async_exec(&block) ⇒ Object 



380
381
382
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 380

def async_exec(&block)
  DisplayProxy.instance.async_exec(&block)
end

#can_add_observer?(property_name) ⇒ Boolean

TODO Consider renaming these methods as they are mainly used for data-binding

Returns:

  • (Boolean) 


399
400
401
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 399

def can_add_observer?(property_name)
  @swt_widget.class.ancestors.map {|ancestor| widget_property_listener_installers[ancestor]}.compact.map(&:keys).flatten.map(&:to_s).include?(property_name.to_s)
end

#can_handle_drag_observation_request?(observation_request) ⇒ Boolean

Returns:

  • (Boolean) 


442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 442

def can_handle_drag_observation_request?(observation_request)
  return false unless swt_widget.is_a?(Control)
  potential_drag_source = @drag_source_proxy.nil?
  ensure_drag_source_proxy
  @drag_source_proxy.can_handle_observation_request?(observation_request).tap do |result|
    if potential_drag_source && !result
      @drag_source_proxy.swt_widget.dispose
      @drag_source_proxy = nil
    end
  end
rescue => e
  Glimmer::Config.logger.debug {e.full_message}
  false        
end

#can_handle_drop_observation_request?(observation_request) ⇒ Boolean

Returns:

  • (Boolean) 


457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 457

def can_handle_drop_observation_request?(observation_request)
  return false unless swt_widget.is_a?(Control)
  potential_drop_target = @drop_target_proxy.nil?
  ensure_drop_target_proxy
  @drop_target_proxy.can_handle_observation_request?(observation_request).tap do |result|
    if potential_drop_target && !result
      @drop_target_proxy.swt_widget.dispose
      @drop_target_proxy = nil
    end
  end
end

#can_handle_observation_request?(observation_request) ⇒ Boolean

TODO eliminate duplication in the following methods perhaps by relying on exceptions

Returns:

  • (Boolean) 


431
432
433
434
435
436
437
438
439
440
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 431

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_')
    event = observation_request.sub(/^on_/, '')
    can_add_listener?(event) || can_handle_drag_observation_request?(observation_request) || can_handle_drop_observation_request?(observation_request)
  end
end

#content(&block) ⇒ Object 



487
488
489
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 487

def content(&block)
  Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::SWT::WidgetExpression.new, &block)
end

#dispose ⇒ Object 



393
394
395
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 393

def dispose
  @swt_widget.dispose
end

#ensure_drag_source_proxy(style = []) ⇒ Object 



414
415
416
417
418
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 414

def ensure_drag_source_proxy(style=[])
  @drag_source_proxy ||= self.class.new('drag_source', self, style).tap do |proxy|
    proxy.set_attribute(:transfer, :text)
  end
end

#ensure_drop_target_proxy(style = []) ⇒ Object 



420
421
422
423
424
425
426
427
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 420

def ensure_drop_target_proxy(style=[])
  @drop_target_proxy ||= self.class.new('drop_target', self, style).tap do |proxy|
    proxy.set_attribute(:transfer, :text)
    proxy.on_drag_enter { |event|
      event.detail = DNDProxy[:drop_copy]
    }          
  end
end

#extract_args(underscored_widget_name, args) ⇒ Object 



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
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 167

def extract_args(underscored_widget_name, args)
  @arg_extractor_mapping ||= {
    'menu_item' => lambda do |args|
      index = args.delete(args.last) if args.last.is_a?(Numeric)
      extra_options = [index].compact
      styles = args
      [styles, extra_options]
    end,
  }
  if @arg_extractor_mapping[underscored_widget_name]
    @arg_extractor_mapping[underscored_widget_name].call(args)
  else
    extra_options = []
    style_args = args.select {|arg| arg.is_a?(Symbol) || arg.is_a?(String)}
    if style_args.any?
      style_arg_start_index = args.index(style_args.first)
      style_arg_last_index = args.index(style_args.last)
      extra_options = args[style_arg_last_index+1..-1]
      args = args[style_arg_start_index..style_arg_last_index]
    elsif args.first.is_a?(Integer)
      extra_options = args[1..-1]
      args = args[0..0]
    end
    [args, extra_options]
  end
end

#get_attribute(attribute_name) ⇒ Object 



215
216
217
218
219
220
221
222
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 215

def get_attribute(attribute_name)
  widget_custom_attribute = widget_custom_attribute_mapping[attribute_name.to_s]
  if widget_custom_attribute
    @swt_widget.send(widget_custom_attribute[:getter][:name])
  else
    @swt_widget.send(attribute_getter(attribute_name))
  end
end

#handle_observation_request(observation_request, &block) ⇒ Object 



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 469

def handle_observation_request(observation_request, &block)
  observation_request = observation_request.to_s
  if observation_request.start_with?('on_swt_')
    constant_name = observation_request.sub(/^on_swt_/, '')
    add_swt_event_listener(constant_name, &block)
  elsif observation_request.start_with?('on_')
    event = observation_request.sub(/^on_/, '')
    if can_add_listener?(event)
      event = observation_request.sub(/^on_/, '')
      add_listener(event, &block)
    elsif can_handle_drag_observation_request?(observation_request)
      @drag_source_proxy&.handle_observation_request(observation_request, &block)
    elsif can_handle_drop_observation_request?(observation_request)
      @drop_target_proxy&.handle_observation_request(observation_request, &block)
    end
  end
end

#has_attribute?(attribute_name, *args) ⇒ Boolean

Returns:

  • (Boolean) 


194
195
196
197
198
199
200
201
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 194

def has_attribute?(attribute_name, *args)
  widget_custom_attribute = widget_custom_attribute_mapping[attribute_name.to_s]
  if widget_custom_attribute
    @swt_widget.respond_to?(widget_custom_attribute[:setter][:name])
  else
    @swt_widget.respond_to?(attribute_setter(attribute_name), args) || respond_to?(ruby_attribute_setter(attribute_name), args)
  end
end

#has_style?(style) ⇒ Boolean

Returns:

  • (Boolean) 


388
389
390
391
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 388

def has_style?(style)
  comparison = interpret_style(style)
  (@swt_widget.style & comparison) == comparison
end

#pack_same_size ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 224

def pack_same_size
  bounds = @swt_widget.getBounds
  listener = on_control_resized {
    @swt_widget.setSize(bounds.width, bounds.height)
    @swt_widget.setLocation(bounds.x, bounds.y)
  }
  if @swt_widget.is_a?(Composite)
    @swt_widget.layout(true, true)
  else
    @swt_widget.pack(true)
  end
  @swt_widget.removeControlListener(listener.swt_listener)
end

#post_add_content ⇒ Object

Subclasses may override to perform post add_content work



163
164
165
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 163

def post_add_content
  # No Op by default
end

#post_initialize_child(child) ⇒ Object

Subclasses may override to perform post initialization work on an added child



158
159
160
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 158

def post_initialize_child(child)
  # No Op by default
end

#remove_observer(observer, property_name) ⇒ Object 



410
411
412
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 410

def remove_observer(observer, property_name)
  # TODO consider implementing if remove_observer is needed (consumers can remove listener via SWT API)
end

#respond_to?(method, *args, &block) ⇒ Boolean

Returns:

  • (Boolean) 


503
504
505
506
507
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 503

def respond_to?(method, *args, &block)
  super || 
    can_handle_observation_request?(method) ||
    swt_widget.respond_to?(method, *args, &block)
end

#set_attribute(attribute_name, *args) ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 203

def set_attribute(attribute_name, *args)
  widget_custom_attribute = widget_custom_attribute_mapping[attribute_name.to_s]
  if widget_custom_attribute
    widget_custom_attribute[:setter][:invoker].call(@swt_widget, args)
  elsif @swt_widget.respond_to?(attribute_setter(attribute_name), args)
    apply_property_type_converters(attribute_name, args)
    @swt_widget.send(attribute_setter(attribute_name), *args) unless @swt_widget.send(attribute_getter(attribute_name)) == args.first
  else
    send(ruby_attribute_setter(attribute_name), args)
  end
end

#sync_exec(&block) ⇒ Object 



384
385
386
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 384

def sync_exec(&block)
  DisplayProxy.instance.sync_exec(&block)
end

#widget_property_listener_installers ⇒ Object 



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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 238

def widget_property_listener_installers
  @swt_widget_property_listener_installers ||= {
    Java::OrgEclipseSwtWidgets::Control => {
      :focus => lambda do |observer|
        on_focus_gained { |focus_event|
          observer.call(true)
        }
        on_focus_lost { |focus_event|
          observer.call(false)
        }
      end,
      :selection => lambda do |observer|
        on_widget_selected { |selection_event|
          observer.call(@swt_widget.getSelection)
        } if can_handle_observation_request?(:on_widget_selected)
      end,
      :text => lambda do |observer|
        on_modify_text { |modify_event|
          observer.call(@swt_widget.getText)
        } if can_handle_observation_request?(:on_modify_text)
      end,
    },
    Java::OrgEclipseSwtWidgets::Combo => {
      :text => lambda do |observer|
        on_modify_text { |modify_event|
          observer.call(@swt_widget.getText)
        }
      end,
    },
    Java::OrgEclipseSwtWidgets::Text => {
      :text => lambda do |observer|
        on_modify_text { |modify_event|
          observer.call(@swt_widget.getText)
        }
      end,
      :caret_position => lambda do |observer|
        on_swt_keydown { |event|
          observer.call(@swt_widget.getCaretPosition)
        }
        on_swt_keyup { |event|
          observer.call(@swt_widget.getCaretPosition)
        }
        on_swt_mousedown { |event|
          observer.call(@swt_widget.getCaretPosition)
        }
        on_swt_mouseup { |event|
          observer.call(@swt_widget.getCaretPosition)
        }
      end,
      :selection => lambda do |observer|
        on_swt_keydown { |event|
          observer.call(@swt_widget.getSelection)
        }
        on_swt_keyup { |event|
          observer.call(@swt_widget.getSelection)
        }
        on_swt_mousedown { |event|
          observer.call(@swt_widget.getSelection)
        }
        on_swt_mouseup { |event|
          observer.call(@swt_widget.getSelection)
        }
      end,
      :selection_count => lambda do |observer|
        on_swt_keydown { |event|
          observer.call(@swt_widget.getSelectionCount)
        }
        on_swt_keyup { |event|
          observer.call(@swt_widget.getSelectionCount)
        }
        on_swt_mousedown { |event|
          observer.call(@swt_widget.getSelectionCount)
        }
        on_swt_mouseup { |event|
          observer.call(@swt_widget.getSelectionCount)
        }
      end,
      :top_index => lambda do |observer|
        @last_top_index = @swt_widget.getTopIndex
        on_paint_control { |event|
          if @swt_widget.getTopIndex != @last_top_index
            @last_top_index = @swt_widget.getTopIndex
            observer.call(@last_top_index)
          end
        }
      end,
    },
    Java::OrgEclipseSwtCustom::StyledText => {
      :text => lambda do |observer|
        on_modify_text { |modify_event|
          observer.call(@swt_widget.getText)
        }
      end,
    },
    Java::OrgEclipseSwtWidgets::Button => {
      :selection => lambda do |observer|
        on_widget_selected { |selection_event|
          observer.call(@swt_widget.getSelection)
        }
      end
    },
    Java::OrgEclipseSwtWidgets::MenuItem => {
      :selection => lambda do |observer|
        on_widget_selected { |selection_event|
          observer.call(@swt_widget.getSelection)
        }
      end
    },
    Java::OrgEclipseSwtWidgets::Spinner => {
      :selection => lambda do |observer|
        on_widget_selected { |selection_event|
          observer.call(@swt_widget.getSelection)
        }
      end
    },
  }
end