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 = 
{
  "text"        => [:border],
  "table"       => [:virtual, :border, :full_selection],
  "tree"       =>  [:virtual, :border, :h_scroll, :v_scroll],
  "spinner"     => [:border],
  "styled_text" => [:border],
  "list"        => [:border, :v_scroll],
  "button"      => [:push],
  "menu_item"   => [:push],
  "drag_source" => [:drop_copy],
  "drop_target" => [:drop_copy],
}
DEFAULT_INITIALIZERS = 
{
  "composite" => lambda do |composite|
    composite.setLayout(GridLayout.new)
  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.setLayout(GridLayout.new)
  end,
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Packages

included

Constructor Details

#initialize(underscored_widget_name, parent, args) ⇒ WidgetProxy

Initializes a new SWT Widget

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



57
58
59
60
61
62
63
64
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 57

def initialize(underscored_widget_name, parent, args)
  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.swt_widget, style(underscored_widget_name, styles), *extra_options)
  @swt_widget.set_data('proxy', self)
  DEFAULT_INITIALIZERS[underscored_widget_name]&.call(@swt_widget)
  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 



398
399
400
401
402
403
404
405
406
407
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 398

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
end

Instance Attribute Details

#drag_source_proxy ⇒ Object (readonly)

Returns the value of attribute drag_source_proxy.



52
53
54
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 52

def drag_source_proxy
  @drag_source_proxy
end

#drag_source_style ⇒ Object

Returns the value of attribute drag_source_style.



52
53
54
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 52

def drag_source_style
  @drag_source_style
end

#drag_source_transfer ⇒ Object

Returns the value of attribute drag_source_transfer.



52
53
54
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 52

def drag_source_transfer
  @drag_source_transfer
end

#drop_target_proxy ⇒ Object (readonly)

Returns the value of attribute drop_target_proxy.



52
53
54
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 52

def drop_target_proxy
  @drop_target_proxy
end

#drop_target_transfer ⇒ Object

Returns the value of attribute drop_target_transfer.



52
53
54
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 52

def drop_target_transfer
  @drop_target_transfer
end

#swt_widget ⇒ Object (readonly)

Returns the value of attribute swt_widget.



52
53
54
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 52

def swt_widget
  @swt_widget
end

Class Method Details

.swt_widget_class_for(underscored_widget_name) ⇒ Object

This supports widgets in and out of basic SWT



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 265

def self.swt_widget_class_for(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

.widget_exists?(underscored_widget_name) ⇒ Boolean

Returns:

  • (Boolean) 


260
261
262
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 260

def self.widget_exists?(underscored_widget_name)
  !!swt_widget_class_for(underscored_widget_name)
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



311
312
313
314
315
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 311

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 



283
284
285
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 283

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) 


306
307
308
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 306

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) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 349

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) 


364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 364

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) 


338
339
340
341
342
343
344
345
346
347
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 338

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 



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

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

#dispose ⇒ Object 



300
301
302
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 300

def dispose
  @swt_widget.dispose
end

#ensure_drag_source_proxy(style = []) ⇒ Object 



321
322
323
324
325
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 321

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 



327
328
329
330
331
332
333
334
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 327

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 



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

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 



119
120
121
122
123
124
125
126
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 119

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 



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 376

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) 


98
99
100
101
102
103
104
105
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 98

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) 


291
292
293
294
295
296
297
298
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 291

def has_style?(style)
  begin
    comparison = SWTProxy[style]
  rescue
    comparison = DNDProxy[style]
  end
  (@swt_widget.style & comparison) == comparison
end

#pack_same_size ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 128

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_initialize_child(child) ⇒ Object

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



67
68
69
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 67

def post_initialize_child(child)
  # No Op by default
end

#remove_observer(observer, property_name) ⇒ Object 



317
318
319
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 317

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) 


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

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 



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 107

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 



287
288
289
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 287

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

#widget_property_listener_installers ⇒ Object 



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

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