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 



310
311
312
313
314
315
316
317
318
 
# File 'lib/glimmer/ui/custom_widget.rb', line 310

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 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.



169
170
171
 
# File 'lib/glimmer/ui/custom_widget.rb', line 169

def body_root
  @body_root
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



169
170
171
 
# File 'lib/glimmer/ui/custom_widget.rb', line 169

def options
  @options
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



169
170
171
 
# File 'lib/glimmer/ui/custom_widget.rb', line 169

def parent
  @parent
end

#parent_proxy ⇒ Object (readonly)

Returns the value of attribute parent_proxy.



169
170
171
 
# File 'lib/glimmer/ui/custom_widget.rb', line 169

def parent_proxy
  @parent_proxy
end

#swt_style ⇒ Object (readonly)

Returns the value of attribute swt_style.



169
170
171
 
# File 'lib/glimmer/ui/custom_widget.rb', line 169

def swt_style
  @swt_style
end

#swt_widget ⇒ Object (readonly)

Returns the value of attribute swt_widget.



169
170
171
 
# File 'lib/glimmer/ui/custom_widget.rb', line 169

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

.current_custom_widgets ⇒ Object

Current custom widgets being rendered. Useful to yoke all observers evaluated during rendering of their custom widgets for automatical disposal on_widget_disposed



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

def current_custom_widgets
  @current_custom_widgets ||= []
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 



235
236
237
238
239
240
241
 
# File 'lib/glimmer/ui/custom_widget.rb', line 235

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



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

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

#attribute_setter(attribute_name) ⇒ Object 



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

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

#can_add_observer?(attribute_name) ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/glimmer/ui/custom_widget.rb', line 231

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) 


211
212
213
214
215
216
217
218
219
 
# File 'lib/glimmer/ui/custom_widget.rb', line 211

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



302
303
304
305
306
307
308
 
# File 'lib/glimmer/ui/custom_widget.rb', line 302

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) 


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

def disposed?
  swt_widget.isDisposed
end

#get_attribute(attribute_name) ⇒ Object 



265
266
267
268
269
270
271
 
# File 'lib/glimmer/ui/custom_widget.rb', line 265

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 



221
222
223
224
225
226
227
228
229
 
# File 'lib/glimmer/ui/custom_widget.rb', line 221

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) 


243
244
245
246
 
# File 'lib/glimmer/ui/custom_widget.rb', line 243

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) 


257
258
259
260
261
262
263
 
# File 'lib/glimmer/ui/custom_widget.rb', line 257

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) 


281
282
283
 
# File 'lib/glimmer/ui/custom_widget.rb', line 281

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

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

Raises:

  • (Glimmer::Error) 


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

def initialize(parent, *swt_constants, options, &content)
  Glimmer::UI::CustomWidget.current_custom_widgets << 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
      observer_registrations.compact.each(&:deregister)
      observer_registrations.clear
    end
  end
  post_add_content if content.nil?
end

#local_respond_to? ⇒ Object 



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

alias local_respond_to? respond_to?

#observer_registrations ⇒ Object 



207
208
209
 
# File 'lib/glimmer/ui/custom_widget.rb', line 207

def observer_registrations
  @observer_registrations ||= []
end

#post_add_content ⇒ Object 



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

def post_add_content
  Glimmer::UI::CustomWidget.current_custom_widgets.delete(self)
end

#post_initialize_child(child) ⇒ Object

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



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

def post_initialize_child(child)
  # No Op by default
end

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

Returns:

  • (Boolean) 


321
322
323
324
325
 
# File 'lib/glimmer/ui/custom_widget.rb', line 321

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 



248
249
250
251
252
253
254
 
# File 'lib/glimmer/ui/custom_widget.rb', line 248

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 



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

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

#timer_exec(delay_in_millis, &block) ⇒ Object 



296
297
298
 
# File 'lib/glimmer/ui/custom_widget.rb', line 296

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