Module: Glimmer::UI::CustomWidget

Includes:
DataBinding::ObservableModel, SuperModule
Included in:
CustomShell
Defined in:
lib/glimmer/ui/custom_widget.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DataBinding::ObservableModel

#add_property_writer_observers, #array_object_observer_for, #ensure_array_object_observer, #has_observer?, #has_observer_for_any_property?, #notify_observers, #property_observer_hash, #property_observer_list, #remove_observer, #unregister_dependent_observers

Methods included from DataBinding::Observable

#inspect, #remove_observer

Instance Attribute Details

#body_root ⇒ Object (readonly)

Returns the value of attribute body_root.



122
123
124
 
# File 'lib/glimmer/ui/custom_widget.rb', line 122

def body_root
  @body_root
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



122
123
124
 
# File 'lib/glimmer/ui/custom_widget.rb', line 122

def options
  @options
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



122
123
124
 
# File 'lib/glimmer/ui/custom_widget.rb', line 122

def parent
  @parent
end

#swt_style ⇒ Object (readonly)

Returns the value of attribute swt_style.



122
123
124
 
# File 'lib/glimmer/ui/custom_widget.rb', line 122

def swt_style
  @swt_style
end

#swt_widget ⇒ Object (readonly)

Returns the value of attribute swt_widget.



122
123
124
 
# File 'lib/glimmer/ui/custom_widget.rb', line 122

def swt_widget
  @swt_widget
end

Class Method Details

.add_custom_widget_namespaces_for(klass) ⇒ Object 



51
52
53
54
55
 
# File 'lib/glimmer/ui/custom_widget.rb', line 51

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 



116
117
118
119
 
# File 'lib/glimmer/ui/custom_widget.rb', line 116

def after_body(&block)
  @after_body_blocks ||= []
  @after_body_blocks << block
end

.before_body(&block) ⇒ Object 



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

def before_body(&block)
  @before_body_blocks ||= []
  @before_body_blocks << block
end

.body(&block) ⇒ Object 



112
113
114
 
# File 'lib/glimmer/ui/custom_widget.rb', line 112

def body(&block)
  @body_block = block
end

.custom_widget_namespaces ⇒ Object 



65
66
67
 
# File 'lib/glimmer/ui/custom_widget.rb', line 65

def custom_widget_namespaces
  @custom_widget_namespaces ||= reset_custom_widget_namespaces
end

.def_option_attr_readers(new_options) ⇒ Object 



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

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

.for(underscored_custom_widget_name) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/glimmer/ui/custom_widget.rb', line 23

def for(underscored_custom_widget_name)
  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
        constant = result.const_get(namespace)
        return constant if constant.ancestors.include?(Glimmer::UI::CustomWidget)
        constant
      rescue => e
        # Glimmer::Config.logger&.debug "#{e.message}\n#{e.backtrace.join("\n")}"
        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")}"
  nil
end

.namespaces_for_class(m) ⇒ Object 



57
58
59
60
61
62
63
 
# File 'lib/glimmer/ui/custom_widget.rb', line 57

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, new_option_default = nil) ⇒ Object 



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

def option(new_option, new_option_default = nil)
  new_option = new_option.to_s.to_sym
  new_options = {new_option => new_option_default}
  @options = options.merge(new_options)
  def_option_attr_readers(new_options)
end

.options(*new_options) ⇒ Object

Allows defining convenience option readers 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



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/glimmer/ui/custom_widget.rb', line 79

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_readers(new_options)
  end
end

.reset_custom_widget_namespaces ⇒ Object 



69
70
71
 
# File 'lib/glimmer/ui/custom_widget.rb', line 69

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

Instance Method Details

#add_observer(observer, attribute_name) ⇒ Object 



160
161
162
163
164
165
166
 
# File 'lib/glimmer/ui/custom_widget.rb', line 160

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



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

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

#attribute_setter(attribute_name) ⇒ Object 



194
195
196
 
# File 'lib/glimmer/ui/custom_widget.rb', line 194

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

#can_add_observer?(attribute_name) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#can_handle_observation_request?(observation_request) ⇒ Boolean

Returns:

  • (Boolean) 


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

def can_handle_observation_request?(observation_request)
  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



216
217
218
219
220
221
222
 
# File 'lib/glimmer/ui/custom_widget.rb', line 216

def content(&block)
  if block_given?
    body_root.content(&block)
  else
    @content
  end
end

#dispose ⇒ Object 



224
225
226
 
# File 'lib/glimmer/ui/custom_widget.rb', line 224

def dispose
  body_root.dispose
end

#get_attribute(attribute_name) ⇒ Object 



186
187
188
189
190
191
192
 
# File 'lib/glimmer/ui/custom_widget.rb', line 186

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 



147
148
149
150
151
152
153
154
 
# File 'lib/glimmer/ui/custom_widget.rb', line 147

def handle_observation_request(observation_request, &block)
  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) 


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

def has_attribute?(attribute_name, *args)
  respond_to?(attribute_setter(attribute_name), args) ||
    @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) 


182
183
184
 
# File 'lib/glimmer/ui/custom_widget.rb', line 182

def has_instance_method?(method_name)
  respond_to?(method_name) && !method(method_name)&.source_location&.first&.include?('glimmer/dsl/engine.rb')
end

#has_style?(style) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

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

Raises:



124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/glimmer/ui/custom_widget.rb', line 124

def initialize(parent, *swt_constants, options, &content)
  @parent = parent
  @swt_style = SWT::SWTProxy[*swt_constants]
  options ||= {}
  @options = self.class.options.merge(options)
  @content = Util::ProcTracker.new(content) if content
  execute_hooks('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 = instance_exec(&body_block)
  execute_hooks('after_body')
  @swt_widget = @body_root.swt_widget
end

#set_attribute(attribute_name, *args) ⇒ Object 



173
174
175
176
177
178
179
 
# File 'lib/glimmer/ui/custom_widget.rb', line 173

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

#sync_exec(&block) ⇒ Object 



210
211
212
 
# File 'lib/glimmer/ui/custom_widget.rb', line 210

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