Module: Glimmer::UI::CustomWidget

Includes:
DataBinding::ObservableModel, SuperModule
Included in:
SWT::Custom::CheckboxGroup, SWT::Custom::CodeText, SWT::Custom::RadioGroup, CustomShell
Defined in:
lib/glimmer/ui/custom_widget.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



307
308
309
310
311
312
313
314
315
 
# File 'lib/glimmer/ui/custom_widget.rb', line 307

def method_missing(method, *args, &block)
  # TODO Consider supporting a glimmer error silencing option for methods defined here
  # but fail the glimmer DSL for the right reason to avoid seeing noise in the log output
  if block && can_handle_observation_request?(method)
    handle_observation_request(method, &block)
  else
    body_root.send(method, *args, &block)
  end
end

Instance Attribute Details

#body_root ⇒ Object (readonly)

Returns the value of attribute body_root.



164
165
166
 
# File 'lib/glimmer/ui/custom_widget.rb', line 164

def body_root
  @body_root
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



164
165
166
 
# File 'lib/glimmer/ui/custom_widget.rb', line 164

def options
  @options
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



164
165
166
 
# File 'lib/glimmer/ui/custom_widget.rb', line 164

def parent
  @parent
end

#parent_proxy ⇒ Object (readonly)

Returns the value of attribute parent_proxy.



164
165
166
 
# File 'lib/glimmer/ui/custom_widget.rb', line 164

def parent_proxy
  @parent_proxy
end

#swt_style ⇒ Object (readonly)

Returns the value of attribute swt_style.



164
165
166
 
# File 'lib/glimmer/ui/custom_widget.rb', line 164

def swt_style
  @swt_style
end

#swt_widget ⇒ Object (readonly)

Returns the value of attribute swt_widget.



164
165
166
 
# File 'lib/glimmer/ui/custom_widget.rb', line 164

def swt_widget
  @swt_widget
end

Class Method Details

.add_custom_widget_namespaces_for(klass) ⇒ Object 



92
93
94
95
96
 
# File 'lib/glimmer/ui/custom_widget.rb', line 92

def add_custom_widget_namespaces_for(klass)
  Glimmer::UI::CustomWidget.namespaces_for_class(klass).drop(1).each do |namespace|
    Glimmer::UI::CustomWidget.custom_widget_namespaces << namespace
  end
end

.after_body(&block) ⇒ Object 



159
160
161
 
# File 'lib/glimmer/ui/custom_widget.rb', line 159

def after_body(&block)
  @after_body_block = block
end

.before_body(&block) ⇒ Object 



151
152
153
 
# File 'lib/glimmer/ui/custom_widget.rb', line 151

def before_body(&block)
  @before_body_block = block
end

.body(&block) ⇒ Object 



155
156
157
 
# File 'lib/glimmer/ui/custom_widget.rb', line 155

def body(&block)
  @body_block = block
end

.custom_widget_namespaces ⇒ Object 



106
107
108
 
# File 'lib/glimmer/ui/custom_widget.rb', line 106

def custom_widget_namespaces
  @custom_widget_namespaces ||= reset_custom_widget_namespaces
end

.def_option_attr_accessors(new_options) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/glimmer/ui/custom_widget.rb', line 138

def def_option_attr_accessors(new_options)
  new_options.each do |option, default|
    class_eval <<-end_eval, __FILE__, __LINE__
      def #{option}
        options[:#{option}]
      end
      def #{option}=(option_value)
        self.options[:#{option}] = option_value
      end
    end_eval
  end
end

.flyweight_custom_widget_classes ⇒ Object

Flyweight Design Pattern memoization cache. Can be cleared if memory is needed.



78
79
80
 
# File 'lib/glimmer/ui/custom_widget.rb', line 78

def flyweight_custom_widget_classes
  @flyweight_custom_widget_classes ||= {}
end

.for(underscored_custom_widget_name) ⇒ Object 



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
 
# File 'lib/glimmer/ui/custom_widget.rb', line 44

def for(underscored_custom_widget_name)
  unless flyweight_custom_widget_classes.keys.include?(underscored_custom_widget_name)
    begin
      extracted_namespaces = underscored_custom_widget_name.
        to_s.
        split(/__/).map do |namespace|
          namespace.camelcase(:upper)
        end
      custom_widget_namespaces.each do |base|
        extracted_namespaces.reduce(base) do |result, namespace|
          if !result.constants.include?(namespace)
            namespace = result.constants.detect {|c| c.to_s.upcase == namespace.to_s.upcase } || namespace
          end
          begin
            flyweight_custom_widget_classes[underscored_custom_widget_name] = constant = result.const_get(namespace)
            return constant if constant.ancestors.include?(Glimmer::UI::CustomWidget)
            flyweight_custom_widget_classes[underscored_custom_widget_name] = constant
          rescue => e
            # Glimmer::Config.logger.debug {"#{e.message}\n#{e.backtrace.join("\n")}"}
            flyweight_custom_widget_classes[underscored_custom_widget_name] = result
          end
        end
      end
      raise "#{underscored_custom_widget_name} has no custom widget class!"
    rescue => e
      Glimmer::Config.logger.debug {e.message}
      Glimmer::Config.logger.debug {"#{e.message}\n#{e.backtrace.join("\n")}"}
      flyweight_custom_widget_classes[underscored_custom_widget_name] = nil
    end
  end
  flyweight_custom_widget_classes[underscored_custom_widget_name]
end

.keyword ⇒ Object

Returns keyword to use for this custom widget



83
84
85
 
# File 'lib/glimmer/ui/custom_widget.rb', line 83

def keyword
  self.name.underscore.gsub('::', '__')
end

.namespaces_for_class(m) ⇒ Object 



98
99
100
101
102
103
104
 
# File 'lib/glimmer/ui/custom_widget.rb', line 98

def namespaces_for_class(m)
  return [m] if m.name.nil?
  namespace_constants = m.name.split(/::/).map(&:to_sym)
  namespace_constants.reduce([Object]) do |output, namespace_constant|
    output += [output.last.const_get(namespace_constant)]
  end[1..-1].uniq.reverse
end

.option(new_option, default: nil) ⇒ Object 



131
132
133
134
135
136
 
# File 'lib/glimmer/ui/custom_widget.rb', line 131

def option(new_option, default: nil)
  new_option = new_option.to_s.to_sym
  new_options = {new_option => default}
  @options = options.merge(new_options)
  def_option_attr_accessors(new_options)
end

.options(*new_options) ⇒ Object

Allows defining convenience option accessors for an array of option names Example: ‘options :color1, :color2` defines `#color1` and `#color2` where they return the instance values `options` and `options` respectively. Can be called multiple times to set more options additively. When passed no arguments, it returns list of all option names captured so far



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/glimmer/ui/custom_widget.rb', line 120

def options(*new_options)
  new_options = new_options.compact.map(&:to_s).map(&:to_sym)
  if new_options.empty?
    @options ||= {} # maps options to defaults
  else
    new_options = new_options.reduce({}) {|new_options_hash, new_option| new_options_hash.merge(new_option => nil)}
    @options = options.merge(new_options)
    def_option_attr_accessors(new_options)
  end
end

.reset_custom_widget_namespaces ⇒ Object 



110
111
112
 
# File 'lib/glimmer/ui/custom_widget.rb', line 110

def reset_custom_widget_namespaces
  @custom_widget_namespaces = Set[Object, Glimmer::UI]
end

.shortcut_keyword ⇒ Object

Returns shortcut keyword to use for this custom widget (keyword minus namespace)



88
89
90
 
# File 'lib/glimmer/ui/custom_widget.rb', line 88

def shortcut_keyword
  self.name.underscore.gsub('::', '__').split('__').last
end

Instance Method Details

#add_observer(observer, attribute_name) ⇒ Object 



232
233
234
235
236
237
238
 
# File 'lib/glimmer/ui/custom_widget.rb', line 232

def add_observer(observer, attribute_name)
  if has_instance_method?(attribute_name)
    super
  else
    @body_root.add_observer(observer, attribute_name)
  end
end

#async_exec(&block) ⇒ Object

TODO see if it is worth it to eliminate duplication of async_exec/sync_exec delegation to DisplayProxy, via a module



285
286
287
 
# File 'lib/glimmer/ui/custom_widget.rb', line 285

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

#attribute_setter(attribute_name) ⇒ Object 



270
271
272
 
# File 'lib/glimmer/ui/custom_widget.rb', line 270

def attribute_setter(attribute_name)
  "#{attribute_name}="
end

#can_add_observer?(attribute_name) ⇒ Boolean

Returns:

  • (Boolean) 


228
229
230
 
# File 'lib/glimmer/ui/custom_widget.rb', line 228

def can_add_observer?(attribute_name)
  has_instance_method?(attribute_name) || has_instance_method?("#{attribute_name}?") || @body_root.can_add_observer?(attribute_name)
end

#can_handle_observation_request?(observation_request) ⇒ Boolean

Returns:

  • (Boolean) 


208
209
210
211
212
213
214
215
216
 
# File 'lib/glimmer/ui/custom_widget.rb', line 208

def can_handle_observation_request?(observation_request)
  observation_request = observation_request.to_s
  result = false
  if observation_request.start_with?('on_updated_')
    property = observation_request.sub(/^on_updated_/, '')
    result = can_add_observer?(property)
  end
  result || body_root&.can_handle_observation_request?(observation_request)
end

#content(&block) ⇒ Object

Returns content block if used as an attribute reader (no args) Otherwise, if a block is passed, it adds it as content to this custom widget



299
300
301
302
303
304
305
 
# File 'lib/glimmer/ui/custom_widget.rb', line 299

def content(&block)
  if block_given?
    Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::SWT::CustomWidgetExpression.new, self.class.keyword, &block)
  else
    @content
  end
end

#disposed? ⇒ Boolean

Returns:

  • (Boolean) 


274
275
276
 
# File 'lib/glimmer/ui/custom_widget.rb', line 274

def disposed?
  swt_widget.isDisposed
end

#get_attribute(attribute_name) ⇒ Object 



262
263
264
265
266
267
268
 
# File 'lib/glimmer/ui/custom_widget.rb', line 262

def get_attribute(attribute_name)
  if has_instance_method?(attribute_name)
    send(attribute_name)
  else
    @body_root.get_attribute(attribute_name)
  end
end

#handle_observation_request(observation_request, &block) ⇒ Object 



218
219
220
221
222
223
224
225
226
 
# File 'lib/glimmer/ui/custom_widget.rb', line 218

def handle_observation_request(observation_request, &block)
  observation_request = observation_request.to_s
  if observation_request.start_with?('on_updated_')
    property = observation_request.sub(/^on_updated_/, '') # TODO look into eliminating duplication from above
    add_observer(DataBinding::Observer.proc(&block), property) if can_add_observer?(property)
  else
    body_root.handle_observation_request(observation_request, &block)
  end
end

#has_attribute?(attribute_name, *args) ⇒ Boolean

Returns:

  • (Boolean) 


240
241
242
243
 
# File 'lib/glimmer/ui/custom_widget.rb', line 240

def has_attribute?(attribute_name, *args)
  has_instance_method?(attribute_setter(attribute_name)) ||
    @body_root.has_attribute?(attribute_name, *args)
end

#has_instance_method?(method_name) ⇒ Boolean

This method ensures it has an instance method not coming from Glimmer DSL

Returns:

  • (Boolean) 


254
255
256
257
258
259
260
 
# File 'lib/glimmer/ui/custom_widget.rb', line 254

def has_instance_method?(method_name)
  respond_to?(method_name) and
    !swt_widget&.respond_to?(method_name) and
    (method(method_name) rescue nil) and
    !method(method_name)&.source_location&.first&.include?('glimmer/dsl/engine.rb') and
    !method(method_name)&.source_location&.first&.include?('glimmer/swt/widget_proxy.rb')
end

#has_style?(style) ⇒ Boolean

Returns:

  • (Boolean) 


278
279
280
 
# File 'lib/glimmer/ui/custom_widget.rb', line 278

def has_style?(style)
  (swt_style & SWT::SWTProxy[style]) == SWT::SWTProxy[style]
end

#initialize(parent, *swt_constants, options, &content) ⇒ Object

Raises:

  • (Glimmer::Error) 


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
 
# File 'lib/glimmer/ui/custom_widget.rb', line 166

def initialize(parent, *swt_constants, options, &content)
  SWT::DisplayProxy.current_custom_widgets_and_shapes << self
  @parent_proxy = @parent = parent
  @parent_proxy = @parent&.get_data('proxy') if @parent.respond_to?(:get_data) && @parent.get_data('proxy')
  @swt_style = SWT::SWTProxy[*swt_constants]
  options ||= {}
  @options = self.class.options.merge(options)
  @content = Util::ProcTracker.new(content) if content
  auto_exec { execute_hook('before_body') }
  body_block = self.class.instance_variable_get("@body_block")
  raise Glimmer::Error, 'Invalid custom widget for having no body! Please define body block!' if body_block.nil?
  @body_root = auto_exec { instance_exec(&body_block) }
  raise Glimmer::Error, 'Invalid custom widget for having an empty body! Please fill body block!' if @body_root.nil?
  @swt_widget = @body_root.swt_widget
  auto_exec do
    @swt_widget.set_data('custom_widget', self)
  end
  auto_exec { execute_hook('after_body') }
  auto_exec do
    @dispose_listener_registration = @body_root.on_widget_disposed do
      unless @body_root.shell_proxy.last_shell_closing?
        observer_registrations.compact.each(&:deregister)
        observer_registrations.clear
      end
    end
  end
  post_add_content if content.nil?
end

#local_respond_to? ⇒ Object 



317
 
# File 'lib/glimmer/ui/custom_widget.rb', line 317

alias local_respond_to? respond_to?

#observer_registrations ⇒ Object 



204
205
206
 
# File 'lib/glimmer/ui/custom_widget.rb', line 204

def observer_registrations
  @observer_registrations ||= []
end

#post_add_content ⇒ Object 



200
201
202
 
# File 'lib/glimmer/ui/custom_widget.rb', line 200

def post_add_content
  SWT::DisplayProxy.current_custom_widgets_and_shapes.delete(self)
end

#post_initialize_child(child) ⇒ Object

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



196
197
198
 
# File 'lib/glimmer/ui/custom_widget.rb', line 196

def post_initialize_child(child)
  # No Op by default
end

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

Returns:

  • (Boolean) 


318
319
320
321
322
 
# File 'lib/glimmer/ui/custom_widget.rb', line 318

def respond_to?(method, *args, &block)
  super or
    can_handle_observation_request?(method) or
    body_root.respond_to?(method, *args, &block)
end

#set_attribute(attribute_name, *args) ⇒ Object 



245
246
247
248
249
250
251
 
# File 'lib/glimmer/ui/custom_widget.rb', line 245

def set_attribute(attribute_name, *args)
  if has_instance_method?(attribute_setter(attribute_name))
    send(attribute_setter(attribute_name), *args)
  else
    @body_root.set_attribute(attribute_name, *args)
  end
end

#sync_exec(&block) ⇒ Object 



289
290
291
 
# File 'lib/glimmer/ui/custom_widget.rb', line 289

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

#timer_exec(delay_in_millis, &block) ⇒ Object 



293
294
295
 
# File 'lib/glimmer/ui/custom_widget.rb', line 293

def timer_exec(delay_in_millis, &block)
  SWT::DisplayProxy.instance.timer_exec(delay_in_millis, &block)
end