Class: Glimmer::SWT::Custom::Shape

Inherits:
Object
  • Object
show all
Includes:
Packages, Properties
Defined in:
lib/glimmer/swt/custom/shape.rb

Overview

Represents a shape (graphics) to be drawn on a control/widget/canvas/display That is because Shape is drawn on a parent as graphics and doesn’t have an SWT widget for itself

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Properties

#attribute_getter, #attribute_setter, #normalized_attribute, #ruby_attribute_setter

Methods included from Packages

included

Constructor Details

#initialize(parent, keyword, *args, &property_block) ⇒ Shape

Returns a new instance of Shape.



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/glimmer/swt/custom/shape.rb', line 96

def initialize(parent, keyword, *args, &property_block)
  @parent = parent
  @name = keyword
  @method_name = self.class.method_name(keyword, args)
  @options = self.class.arg_options(args, extract: true)
  @args = args
  @properties = {}
  @parent.shapes << self
  post_add_content if property_block.nil?
end

Instance Attribute Details

#args ⇒ Object (readonly)

Returns the value of attribute args.



94
95
96
 
# File 'lib/glimmer/swt/custom/shape.rb', line 94

def args
  @args
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



94
95
96
 
# File 'lib/glimmer/swt/custom/shape.rb', line 94

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



94
95
96
 
# File 'lib/glimmer/swt/custom/shape.rb', line 94

def options
  @options
end

#paint_listener_proxy ⇒ Object (readonly)

Returns the value of attribute paint_listener_proxy.



94
95
96
 
# File 'lib/glimmer/swt/custom/shape.rb', line 94

def paint_listener_proxy
  @paint_listener_proxy
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



94
95
96
 
# File 'lib/glimmer/swt/custom/shape.rb', line 94

def parent
  @parent
end

Class Method Details

.arg_options(args, extract: false) ⇒ Object 



59
60
61
62
63
 
# File 'lib/glimmer/swt/custom/shape.rb', line 59

def arg_options(args, extract: false)
  arg_options_method = extract ? :pop : :last
  options = args.send(arg_options_method) if args.last.is_a?(Hash)
  options.nil? ? {} : options.symbolize_keys
end

.flyweigh_patterns ⇒ Object 



89
90
91
 
# File 'lib/glimmer/swt/custom/shape.rb', line 89

def flyweigh_patterns
  @flyweigh_patterns ||= {}
end

.flyweight_method_names ⇒ Object 



77
78
79
 
# File 'lib/glimmer/swt/custom/shape.rb', line 77

def flyweight_method_names
  @flyweight_method_names ||= {}
end

.gc_instance_methods ⇒ Object 



45
46
47
 
# File 'lib/glimmer/swt/custom/shape.rb', line 45

def gc_instance_methods
  @gc_instance_methods ||= org.eclipse.swt.graphics.GC.instance_methods.map(&:to_s)
end

.keywords ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'lib/glimmer/swt/custom/shape.rb', line 49

def keywords
  @keywords ||= gc_instance_methods.select do |method_name|
    !method_name.end_with?('=') && (method_name.start_with?('draw_') || method_name.start_with?('fill_'))
  end.reject do |method_name|
    gc_instance_methods.include?("#{method_name}=") || gc_instance_methods.include?("set_#{method_name}")
  end.map do |method_name|
    method_name.gsub(/(draw|fill|gradient|round)_/, '')
  end.uniq.compact.to_a
end

.method_name(keyword, args) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/glimmer/swt/custom/shape.rb', line 65

def method_name(keyword, args)
  method_arg_options = arg_options(args)
  unless flyweight_method_names.keys.include?([keyword, method_arg_options])
    keyword = keyword.to_s
    gradient = 'gradient_' if method_arg_options[:gradient]
    round = 'round_' if method_arg_options[:round]
    gc_instance_method_name_prefix = !['polyline', 'point', 'image', 'focus'].include?(keyword) && (method_arg_options[:fill] || method_arg_options[:gradient]) ? 'fill_' : 'draw_'
    flyweight_method_names[[keyword, method_arg_options]] = "#{gc_instance_method_name_prefix}#{gradient}#{round}#{keyword}"
  end
  flyweight_method_names[[keyword, method_arg_options]]
end

.pattern(*args) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/glimmer/swt/custom/shape.rb', line 81

def pattern(*args)
  found_pattern = flyweigh_patterns[args]
  if found_pattern.nil? || found_pattern.is_disposed
    found_pattern = flyweigh_patterns[args] = org.eclipse.swt.graphics.Pattern.new(*args)
  end
  found_pattern
end

.valid?(parent, keyword, *args, &block) ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/glimmer/swt/custom/shape.rb', line 41

def valid?(parent, keyword, *args, &block)
  gc_instance_methods.include?(method_name(keyword, args))
end

Instance Method Details

#amend_method_name_options_based_on_properties ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/glimmer/swt/custom/shape.rb', line 209

def amend_method_name_options_based_on_properties
  if has_some_background? && !has_some_foreground?
    @options[:fill] = true
  elsif !has_some_background? && has_some_foreground?
    @options[:fill] = false
  elsif @name == 'rectangle' && has_some_background? && has_some_foreground?
    @options[:fill] = true
    @options[:gradient] = true
  end
  if @name == 'rectangle' && @args.size > 4 && @args.last.is_a?(Numeric)
    @options[:round] = true
  end
  @method_name = self.class.method_name(@name, @args + [@options])
end

#apply_property_arg_conversions(method_name, property, args) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/glimmer/swt/custom/shape.rb', line 137

def apply_property_arg_conversions(method_name, property, args)
  args = args.dup
  the_java_method = org.eclipse.swt.graphics.GC.java_class.declared_instance_methods.detect {|m| m.name == method_name}
  if (args.first.is_a?(Symbol) || args.first.is_a?(String))
    if the_java_method.parameter_types.first == Color.java_class
      args[0] = ColorProxy.new(args[0])
    end
    if the_java_method.parameter_types.first == Java::int.java_class
      args[0] = SWTProxy.constant(args[0])
    end
  end
  if args.first.is_a?(ColorProxy)
    args[0] = args[0].swt_color
  end
  if args.first.is_a?(Hash) && the_java_method.parameter_types.first == Font.java_class
    args[0] = FontProxy.new(args[0])
  end
  if args.first.is_a?(FontProxy)
    args[0] = args[0].swt_font
  end
  if args.first.is_a?(TransformProxy)
    args[0] = args[0].swt_transform
  end
  if ['setBackgroundPattern', 'setForegroundPattern'].include?(method_name.to_s)
    args.each_with_index do |arg, i|
      if arg.is_a?(Symbol) || arg.is_a?(String)
        args[i] = ColorProxy.new(arg).swt_color
      elsif arg.is_a?(ColorProxy)
        args[i] = arg.swt_color
      end
    end
    new_args = [DisplayProxy.instance.swt_display] + args
    args[0] = pattern(*new_args, type: method_name.to_s.match(/set(.+)Pattern/)[1])
    args[1..-1] = []
  end
  args
end

#apply_shape_arg_conversions(method_name, args) ⇒ Object 



175
176
177
178
179
180
 
# File 'lib/glimmer/swt/custom/shape.rb', line 175

def apply_shape_arg_conversions(method_name, args)
  if args.size > 1 && (method_name.include?('polygon') || method_name.include?('polyline'))
    args[0] = args.dup
    args[1..-1] = []
  end
end

#apply_shape_arg_defaults(method_name, args) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/glimmer/swt/custom/shape.rb', line 182

def apply_shape_arg_defaults(method_name, args)
  if method_name.include?('round_rectangle') && args.size.between?(4, 5)
    (6 - args.size).times {args << 60}
  elsif method_name.include?('rectangle') && gradient? && args.size == 4
    args << true
  elsif (method_name.include?('text') || method_name.include?('string')) && !@properties.keys.map(&:to_s).include?('background') && args.size == 3
    args << true
  end
  if method_name.include?('image') && args.first.is_a?(String)
    args[0] = ImageProxy.new(args[0])
  end
  if method_name.include?('image') && args.first.is_a?(ImageProxy)
    @image = args[0] = args[0].swt_image
  end
end

#dispose ⇒ Object 



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/glimmer/swt/custom/shape.rb', line 249

def dispose
  paint_listener_proxy&.unregister
  @background_pattern&.dispose
  @background_pattern = nil
  @foreground_pattern&.dispose
  @foreground_pattern = nil
  @image&.dispose
  @image = nil
  @parent.shapes.delete(self)
end

#draw? ⇒ Boolean

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/glimmer/swt/custom/shape.rb', line 107

def draw?
  !fill?
end

#fill? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/glimmer/swt/custom/shape.rb', line 111

def fill?
  @options[:fill]
end

#get_attribute(attribute_name) ⇒ Object 



236
237
238
 
# File 'lib/glimmer/swt/custom/shape.rb', line 236

def get_attribute(attribute_name)
  @properties.symbolize_keys[attribute_name.to_s.to_sym]
end

#gradient? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/glimmer/swt/custom/shape.rb', line 115

def gradient?
  @options[:gradient]
end

#has_attribute?(attribute_name, *args) ⇒ Boolean

Returns:

  • (Boolean) 


224
225
226
 
# File 'lib/glimmer/swt/custom/shape.rb', line 224

def has_attribute?(attribute_name, *args)
  self.class.gc_instance_methods.include?(attribute_setter(attribute_name))
end

#has_some_background? ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/glimmer/swt/custom/shape.rb', line 123

def has_some_background?
  @properties.keys.map(&:to_s).include?('background') || @properties.keys.map(&:to_s).include?('background_pattern')
end

#has_some_foreground? ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/glimmer/swt/custom/shape.rb', line 127

def has_some_foreground?
  @properties.keys.map(&:to_s).include?('foreground') || @properties.keys.map(&:to_s).include?('foreground_pattern')
end

#paint(paint_event) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/glimmer/swt/custom/shape.rb', line 272

def paint(paint_event)
  @properties['background'] = [@parent.background] if fill? && !has_some_background?
  @properties['foreground'] = [@parent.foreground] if @parent.respond_to?(:foreground) && draw? && !has_some_foreground?
  @properties['font'] = [@parent.font] if @parent.respond_to?(:font) && draw? && !@properties.keys.map(&:to_s).include?('font')
  @properties['transform'] = [nil] if @parent.respond_to?(:transform) && !@properties.keys.map(&:to_s).include?('transform')
  @properties.each do |property, args|
    method_name = attribute_setter(property)
    converted_args = apply_property_arg_conversions(method_name, property, args)
    paint_event.gc.send(method_name, *converted_args)
    if property == 'transform' && args.first.is_a?(TransformProxy)
      args.first.swt_transform.dispose
    end
  end
  apply_shape_arg_conversions(@method_name, @args)
  apply_shape_arg_defaults(@method_name, @args)
  tolerate_shape_extra_args(@method_name, @args)
  paint_event.gc.send(@method_name, *@args)
end

#pattern(*args, type: nil) ⇒ Object 



240
241
242
243
244
245
246
247
 
# File 'lib/glimmer/swt/custom/shape.rb', line 240

def pattern(*args, type: nil)
  instance_variable_name = "@#{type}_pattern"
  the_pattern = instance_variable_get(instance_variable_name)
  if the_pattern.nil?
    the_pattern = self.class.pattern(*args)
  end
  the_pattern
end

#post_add_content ⇒ Object 



131
132
133
134
135
 
# File 'lib/glimmer/swt/custom/shape.rb', line 131

def post_add_content
  amend_method_name_options_based_on_properties
  setup_painting
  @content_added = true
end

#round? ⇒ Boolean

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/glimmer/swt/custom/shape.rb', line 119

def round?
  @options[:round]
end

#set_attribute(attribute_name, *args) ⇒ Object 



228
229
230
231
232
233
234
 
# File 'lib/glimmer/swt/custom/shape.rb', line 228

def set_attribute(attribute_name, *args)
  @properties[attribute_name] = args
  if @content_added && !@parent.is_disposed
    @parent.resetup_shape_painting
    @parent.redraw
  end
end

#setup_painting ⇒ Object 



260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/glimmer/swt/custom/shape.rb', line 260

def setup_painting
  # TODO consider moving this method to parent (making the logic polymorphic)
  return if @parent.is_disposed
  if parent.respond_to?(:swt_display)
    @paint_listener_proxy = @parent.on_swt_paint(&method(:paint))
  elsif parent.respond_to?(:swt_image)
    paint(parent) # treat parent as paint event since you don't do repaints with images, it's a one time deal.
  elsif parent.respond_to?(:swt_widget)
    @paint_listener_proxy = @parent.on_paint_control(&method(:paint))
  end
end

#tolerate_shape_extra_args(method_name, args) ⇒ Object

Tolerates shape extra args added by user by mistake (e.g. happens when switching from round rectangle to a standard one without removing all extra args)



200
201
202
203
204
205
206
207
 
# File 'lib/glimmer/swt/custom/shape.rb', line 200

def tolerate_shape_extra_args(method_name, args)
  the_java_method_arg_count = org.eclipse.swt.graphics.GC.java_class.declared_instance_methods.select do |m|
    m.name == method_name.camelcase(:lower)
  end.map(&:parameter_types).map(&:size).max
  if args.size > the_java_method_arg_count
    args[the_java_method_arg_count..-1] = []
  end
end