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
-
#add_observer(observer, attribute_name) ⇒ Object
-
#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.
-
#attribute_setter(attribute_name) ⇒ Object
-
#can_add_observer?(attribute_name) ⇒ Boolean
-
#can_handle_observation_request?(observation_request) ⇒ Boolean
-
#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.
-
#get_attribute(attribute_name) ⇒ Object
-
#handle_observation_request(observation_request, &block) ⇒ Object
-
#has_attribute?(attribute_name, *args) ⇒ Boolean
-
#has_instance_method?(method_name) ⇒ Boolean
This method ensures it has an instance method not coming from Glimmer DSL.
-
#has_style?(style) ⇒ Boolean
-
#initialize(parent, *swt_constants, options, &content) ⇒ Object
-
#local_respond_to? ⇒ Object
-
#method_missing(method, *args, &block) ⇒ Object
-
#post_initialize_child(child) ⇒ Object
Subclasses may override to perform post initialization work on an added child.
-
#respond_to?(method, *args, &block) ⇒ Boolean
-
#set_attribute(attribute_name, *args) ⇒ Object
-
#sync_exec(&block) ⇒ Object
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method, *args, &block) ⇒ Object
257
258
259
260
261
262
263
|
# File 'lib/glimmer/ui/custom_widget.rb', line 257
def method_missing(method, *args, &block)
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
Returns the value of attribute body_root.
144
145
146
|
# File 'lib/glimmer/ui/custom_widget.rb', line 144
def body_root
@body_root
end
|
#options ⇒ Object
Returns the value of attribute options.
144
145
146
|
# File 'lib/glimmer/ui/custom_widget.rb', line 144
def options
@options
end
|
#parent ⇒ Object
Returns the value of attribute parent.
144
145
146
|
# File 'lib/glimmer/ui/custom_widget.rb', line 144
def parent
@parent
end
|
#swt_style ⇒ Object
Returns the value of attribute swt_style.
144
145
146
|
# File 'lib/glimmer/ui/custom_widget.rb', line 144
def swt_style
@swt_style
end
|
Returns the value of attribute swt_widget.
144
145
146
|
# File 'lib/glimmer/ui/custom_widget.rb', line 144
def swt_widget
@swt_widget
end
|
Class Method Details
.after_body(&block) ⇒ Object
138
139
140
141
|
# File 'lib/glimmer/ui/custom_widget.rb', line 138
def after_body(&block)
@after_body_blocks ||= []
@after_body_blocks << block
end
|
.before_body(&block) ⇒ Object
129
130
131
132
|
# File 'lib/glimmer/ui/custom_widget.rb', line 129
def before_body(&block)
@before_body_blocks ||= []
@before_body_blocks << block
end
|
.body(&block) ⇒ Object
134
135
136
|
# File 'lib/glimmer/ui/custom_widget.rb', line 134
def body(&block)
@body_block = block
end
|
84
85
86
|
# File 'lib/glimmer/ui/custom_widget.rb', line 84
def custom_widget_namespaces
@custom_widget_namespaces ||= reset_custom_widget_namespaces
end
|
.def_option_attr_accessors(new_options) ⇒ Object
116
117
118
119
120
121
122
123
124
125
126
127
|
# File 'lib/glimmer/ui/custom_widget.rb', line 116
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
|
.for(underscored_custom_widget_name) ⇒ Object
42
43
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
|
# File 'lib/glimmer/ui/custom_widget.rb', line 42
def for(underscored_custom_widget_name)
= underscored_custom_widget_name.
to_s.
split(/__/).map do |namespace|
namespace.camelcase(:upper)
end
custom_widget_namespaces.each do |base|
.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
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
76
77
78
79
80
81
82
|
# File 'lib/glimmer/ui/custom_widget.rb', line 76
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
109
110
111
112
113
114
|
# File 'lib/glimmer/ui/custom_widget.rb', line 109
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
98
99
100
101
102
103
104
105
106
107
|
# File 'lib/glimmer/ui/custom_widget.rb', line 98
def options(*new_options)
new_options = new_options.compact.map(&:to_s).map(&:to_sym)
if new_options.empty?
@options ||= {} 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
|
88
89
90
|
# File 'lib/glimmer/ui/custom_widget.rb', line 88
def reset_custom_widget_namespaces
@custom_widget_namespaces = Set[Object, Glimmer::UI]
end
|
Instance Method Details
#add_observer(observer, attribute_name) ⇒ Object
191
192
193
194
195
196
197
|
# File 'lib/glimmer/ui/custom_widget.rb', line 191
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
239
240
241
|
# File 'lib/glimmer/ui/custom_widget.rb', line 239
def async_exec(&block)
SWT::DisplayProxy.instance.async_exec(&block)
end
|
#attribute_setter(attribute_name) ⇒ Object
228
229
230
|
# File 'lib/glimmer/ui/custom_widget.rb', line 228
def attribute_setter(attribute_name)
"#{attribute_name}="
end
|
#can_add_observer?(attribute_name) ⇒ Boolean
187
188
189
|
# File 'lib/glimmer/ui/custom_widget.rb', line 187
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
167
168
169
170
171
172
173
174
175
|
# File 'lib/glimmer/ui/custom_widget.rb', line 167
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
249
250
251
252
253
254
255
|
# File 'lib/glimmer/ui/custom_widget.rb', line 249
def content(&block)
if block_given?
body_root.content(&block)
else
@content
end
end
|
#get_attribute(attribute_name) ⇒ Object
220
221
222
223
224
225
226
|
# File 'lib/glimmer/ui/custom_widget.rb', line 220
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
177
178
179
180
181
182
183
184
185
|
# File 'lib/glimmer/ui/custom_widget.rb', line 177
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_/, '') 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
199
200
201
202
|
# File 'lib/glimmer/ui/custom_widget.rb', line 199
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
213
214
215
216
217
218
|
# File 'lib/glimmer/ui/custom_widget.rb', line 213
def has_instance_method?(method_name)
respond_to?(method_name) &&
!swt_widget.respond_to?(method_name) &&
!method(method_name)&.source_location&.first&.include?('glimmer/dsl/engine.rb') &&
!method(method_name)&.source_location&.first&.include?('glimmer/swt/widget_proxy.rb')
end
|
#has_style?(style) ⇒ Boolean
232
233
234
|
# File 'lib/glimmer/ui/custom_widget.rb', line 232
def has_style?(style)
(swt_style & SWT::SWTProxy[style]) == SWT::SWTProxy[style]
end
|
#initialize(parent, *swt_constants, options, &content) ⇒ Object
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
# File 'lib/glimmer/ui/custom_widget.rb', line 146
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)
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
@swt_widget.set_data('custom_widget', self)
execute_hooks('after_body')
end
|
#local_respond_to? ⇒ Object
265
|
# File 'lib/glimmer/ui/custom_widget.rb', line 265
alias local_respond_to? respond_to?
|
#post_initialize_child(child) ⇒ Object
Subclasses may override to perform post initialization work on an added child
163
164
165
|
# File 'lib/glimmer/ui/custom_widget.rb', line 163
def post_initialize_child(child)
end
|
#respond_to?(method, *args, &block) ⇒ Boolean
266
267
268
269
270
|
# File 'lib/glimmer/ui/custom_widget.rb', line 266
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
204
205
206
207
208
209
210
|
# File 'lib/glimmer/ui/custom_widget.rb', line 204
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
243
244
245
|
# File 'lib/glimmer/ui/custom_widget.rb', line 243
def sync_exec(&block)
SWT::DisplayProxy.instance.sync_exec(&block)
end
|