module Glimmer::UI::CustomWidget

Attributes

body_root[R]

<- end of class methods

options[R]

<- end of class methods

parent[R]

<- end of class methods

parent_proxy[R]

<- end of class methods

swt_style[R]

<- end of class methods

Public Class Methods

add_custom_widget_namespaces_for(klass) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 135
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
custom_widget_namespaces() click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 149
def custom_widget_namespaces
  @custom_widget_namespaces ||= reset_custom_widget_namespaces
end
for(underscored_custom_widget_name) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 107
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&.respond_to?(:ancestors) && constant&.ancestors&.to_a.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
included(klass) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 99
def included(klass)
  klass.extend(ClassMethods)
  unless klass.name.include?('Glimmer::UI::CustomShell')
    klass.include(Glimmer)
    Glimmer::UI::CustomWidget.add_custom_widget_namespaces_for(klass)
  end
end
namespaces_for_class(m) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 141
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
new(parent, args, options, &content) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 163
def initialize(parent, args, options, &content)
  @parent = parent
  options = args.delete_at(-1) if args.is_a?(Array) && args.last.is_a?(Hash)
  if args.is_a?(Hash)
    options = args
    args = []
  end
  options ||= {}
  args = options.delete('swt_style').split(',').map(&:to_sym) if options['swt_style']
  @args = args
  @swt_style = SWT::SWTProxy[*@args]
  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)
  @parent ||= @body_root.parent
  raise Glimmer::Error, 'Invalid custom widget for having an empty body! Please fill body block!' if @body_root.nil?
  execute_hooks('after_body')
end
reset_custom_widget_namespaces() click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 153
def reset_custom_widget_namespaces
  @custom_widget_namespaces = Set[Object, Glimmer::UI]
end

Public Instance Methods

add_observer(observer, attribute_name) click to toggle source
Calls superclass method
# File lib/glimmer/ui/custom_widget.rb, line 215
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) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 260
def async_exec(&block)
  SWT::DisplayProxy.instance.async_exec(&block)
end
attribute_setter(attribute_name) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 252
def attribute_setter(attribute_name)
  "#{attribute_name}="
end
can_add_observer?(attribute_name) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 211
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) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 191
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) click to toggle source

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

# File lib/glimmer/ui/custom_widget.rb, line 271
def content(&block)
  if block_given?
    Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Opal::CustomWidgetExpression.new, self.class.keyword, &block)
  else
    @content
  end
end
get_attribute(attribute_name) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 244
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) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 201
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) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 223
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) click to toggle source

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

# File lib/glimmer/ui/custom_widget.rb, line 237
def has_instance_method?(method_name)
  respond_to?(method_name) and
    !body_root&.respond_to?(method_name) 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?(symbol) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 256
def has_style?(symbol)
  @args.include?(symbol) # not a very solid implementation. Bring SWT constants eventually
end
local_respond_to?(method, *args, &block)
Alias for: respond_to?
method_missing(method, *args, &block) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 279
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
post_initialize_child(child) click to toggle source

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

# File lib/glimmer/ui/custom_widget.rb, line 187
def post_initialize_child(child)
  # No Op by default
end
respond_to?(method, *args, &block) click to toggle source
Calls superclass method
# File lib/glimmer/ui/custom_widget.rb, line 288
def respond_to?(method, *args, &block)
  super or
    can_handle_observation_request?(method) or
    body_root.respond_to?(method, *args, &block)
end
Also aliased as: local_respond_to?
set_attribute(attribute_name, *args) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 228
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) click to toggle source

sync_exec kept for API compatibility reasons

# File lib/glimmer/ui/custom_widget.rb, line 265
def sync_exec(&block)
  SWT::DisplayProxy.instance.async_exec(&block)
end

Private Instance Methods

execute_hooks(hook_name) click to toggle source
# File lib/glimmer/ui/custom_widget.rb, line 296
def execute_hooks(hook_name)
  self.class.instance_variable_get("@#{hook_name}_blocks")&.each do |hook_block|
    instance_exec(&hook_block)
  end
end