Class: Glimmer::SWT::WidgetProxy

Inherits:
Object
  • Object
show all
Includes:
DataBinding::ObservableWidget, 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

Direct Known Subclasses

MenuProxy, ShellProxy, TabItemProxy, TreeProxy

Constant Summary collapse

DEFAULT_STYLES = 
{
  "text"        => [:border],
  "table"       => [:border],
  "tree"       =>  [:virtual, :border, :h_scroll, :v_scroll],
  "spinner"     => [:border],
  "styled_text" => [:border],
  "list"        => [:border, :v_scroll],
  "button"      => [:push],
  "menu_item"   => [:push],
}
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 DataBinding::ObservableWidget

#method_missing

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
 
# 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)
  DEFAULT_INITIALIZERS[underscored_widget_name]&.call(@swt_widget)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Glimmer::DataBinding::ObservableWidget

Instance Attribute Details

#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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 228

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 NameError => e
  Glimmer::Config.logger&.debug e.message
  # Glimmer::Config.logger&.debug("#{e.message}\n#{e.backtrace.join("\n")}")
  nil
rescue => e
  Glimmer::Config.logger&.debug e.message
  # Glimmer::Config.logger&.debug("#{e.message}\n#{e.backtrace.join("\n")}")
  nil
end

.widget_exists?(underscored_widget_name) ⇒ Boolean

Returns:

  • (Boolean) 


223
224
225
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 223

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



269
270
271
272
273
274
275
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 269

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.each do |widget_listener_installer|
    widget_listener_installer.call(observer)
  end
end

#async_exec(&block) ⇒ Object 



246
247
248
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 246

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) 


264
265
266
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 264

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_observation_request?(observation_request) ⇒ Boolean

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

Returns:

  • (Boolean) 


283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 283

def can_handle_observation_request?(observation_request)
  observation_request = observation_request.to_s
  if observation_request.start_with?('on_event_')
    constant_name = observation_request.sub(/^on_event_/, '')
    SWTProxy.has_constant?(constant_name)
  elsif observation_request.start_with?('on_')
    event = observation_request.sub(/^on_/, '')
    can_add_listener?(event)
  else
    false
  end
end

#content(&block) ⇒ Object 



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

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

#dispose ⇒ Object 



258
259
260
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 258

def dispose
  @swt_widget.dispose
end

#extract_args(underscored_widget_name, args) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 64

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
    [args, []]
  end
end

#get_attribute(attribute_name) ⇒ Object 



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

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 



296
297
298
299
300
301
302
303
304
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 296

def handle_observation_request(observation_request, &block)
  if observation_request.start_with?('on_event_')
    constant_name = observation_request.sub(/^on_event_/, '')
    add_swt_event_listener(constant_name, &block)
  elsif observation_request.start_with?('on_')
    event = observation_request.sub(/^on_/, '')
    add_listener(event, &block)
  end
end

#has_attribute?(attribute_name, *args) ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
83
84
85
86
87
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 80

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)
  end
end

#has_style?(style) ⇒ Boolean

Returns:

  • (Boolean) 


254
255
256
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 254

def has_style?(style)
  (@swt_widget.style & SWTProxy[style]) == SWTProxy[style]
end

#pack_same_size ⇒ Object 



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

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

#remove_observer(observer, property_name) ⇒ Object 



277
278
279
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 277

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

#set_attribute(attribute_name, *args) ⇒ Object 



89
90
91
92
93
94
95
96
97
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 89

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)
  else
    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
  end
end

#sync_exec(&block) ⇒ Object 



250
251
252
 
# File 'lib/glimmer/swt/widget_proxy.rb', line 250

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

#widget_property_listener_installers ⇒ Object 



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

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,
    },
    Java::OrgEclipseSwtWidgets::Text => {
      :text => lambda do |observer|
        on_modify_text { |modify_event|
          observer.call(@swt_widget.getText)
        }
      end,
      :caret_position => lambda do |observer|
        on_event_keydown { |event|
          observer.call(@swt_widget.getCaretPosition)
        }
        on_event_keyup { |event|
          observer.call(@swt_widget.getCaretPosition)
        }
        on_event_mousedown { |event|
          observer.call(@swt_widget.getCaretPosition)
        }
        on_event_mouseup { |event|
          observer.call(@swt_widget.getCaretPosition)
        }
      end,
      :selection => lambda do |observer|
        on_event_keydown { |event|
          observer.call(@swt_widget.getSelection)
        }
        on_event_keyup { |event|
          observer.call(@swt_widget.getSelection)
        }
        on_event_mousedown { |event|
          observer.call(@swt_widget.getSelection)
        }
        on_event_mouseup { |event|
          observer.call(@swt_widget.getSelection)
        }
      end,
      :selection_count => lambda do |observer|
        on_event_keydown { |event|
          observer.call(@swt_widget.getSelectionCount)
        }
        on_event_keyup { |event|
          observer.call(@swt_widget.getSelectionCount)
        }
        on_event_mousedown { |event|
          observer.call(@swt_widget.getSelectionCount)
        }
        on_event_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