glimmer-dsl-swt 4.20.12.2 → 4.20.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94916ca37afe49d1a86e6cdc4dbc26ea0c427aeb367933bff3545cff184af89c
-  data.tar.gz: 9f661b2400af578023b997e2fd157a2ed83f9472be8e87a06a8e05f03b8c4510
+  metadata.gz: 52a35ca793ca95839f0f328a465b2d9dafc008d5434520b92e2411ce19bde4ad
+  data.tar.gz: 7ec9d1550c1aedcb265761bb3f8c6b295a7d1d28af1944b81dcd4c8a4eb9e0f3
 SHA512:
-  metadata.gz: ae954846060d6f0128a1a0451cfabedd7b5911585c14276223660a8ed1783951e2c21207c03375b79c7c1fd56155f1611259c755964b4929cdbdd2c1c8751280
-  data.tar.gz: fffe1578254cc9f8fa633f519d4948a3f8f94712d5e5e16167ecbb3faf7d1cc7d37da40bd73a4bbb755aa75091682f50df450589e1c1b8a8bc8a582e67be7c4f
+  metadata.gz: bf6b815412f32c1a8d986c2f927f845abbebdc051adf9edfb64dfa4472715ef08970bc05dd69833de7311e596b01dc21735570175ffb74b08bc8c1888ebe46d0
+  data.tar.gz: fb05c6d864f98d744e57507c0c00145d1b19f689f76b4970d1c6901390ff94a8c4eea0bc81c6b7c3fb27371c3b46e23c28a9911853654d9adb97a77dbffa62d6

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+### 4.20.13.1
+
+- Supporting having a `drag_source` that is dragged and not dropped at a target go back to its original position
+- Fix issue of dragged shape getting obscured by ensuring that it is rendered on top of all other shapes
+- Fix issue with shapes obscured by shapes on top of them getting preference when dragged (surprising behavior). Now, the top-most shapes get dragged first if they overlap with others.
+
+### 4.20.13.0
+
+- Shape `drag_and_move true` property to make shapes movable via dragging
+- Shape `drag_source true` and `on_drop {|event| }` built-in support for drag and drop
+- Refactor Hello, Canvas Drag and Drop! to use new Shape built-in support for drag and drop
+
+### 4.20.12.4
+
+- Update Hello, Shape! to take advantage of shape listeners (on mouse click, change color)
+
+### 4.20.12.3
+
+- Make Custom Shapes support on_event listeners just like Shapes
+- Update Hello, Custom Shape! to take advantage of custom shape listeners (on mouse click, change color)
+
 ### 4.20.12.2
 
 - Make Shape listeners check inclusion against all sub-shapes

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for SWT 4.20.12.2
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for SWT 4.20.13.1
 ## JRuby Desktop Development GUI Framework
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-swt.svg)](http://badge.fury.io/rb/glimmer-dsl-swt)
 [![Travis CI](https://travis-ci.com/AndyObtiva/glimmer-dsl-swt.svg?branch=master)](https://travis-ci.com/github/AndyObtiva/glimmer-dsl-swt)
@@ -15,7 +15,7 @@
 [<img src="https://covers.oreillystatic.com/images/9780596519650/lrg.jpg" width=105 /><br />
 Featured in JRuby Cookbook](http://shop.oreilly.com/product/9780596519650.do) and [Chalmers/Gothenburg University Software Engineering Master's Lecture Material](http://www.cse.chalmers.se/~bergert/slides/guest_lecture_DSLs.pdf)
 
-[Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) 4.20.12.2 includes [SWT 4.20](https://download.eclipse.org/eclipse/downloads/drops4/R-4.20-202106111600/), which was released on June 11, 2021. Gem version numbers are in sync with the SWT library versions. The first two digits represent the SWT version number. The last two digits represent the minor and patch versions of Glimmer DSL for SWT. Note that SWT now supports AARCH64 on Mac and Linux, but it is not fully tested in Glimmer DSL for SWT yet, so deem its support experimental for the time being without guarantees for functionality until declared otherwise (report any issues you may encounter).
+[Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) 4.20.13.1 includes [SWT 4.20](https://download.eclipse.org/eclipse/downloads/drops4/R-4.20-202106111600/), which was released on June 11, 2021. Gem version numbers are in sync with the SWT library versions. The first two digits represent the SWT version number. The last two digits represent the minor and patch versions of Glimmer DSL for SWT. Note that SWT now supports AARCH64 on Mac and Linux, but it is not fully tested in Glimmer DSL for SWT yet, so deem its support experimental for the time being without guarantees for functionality until declared otherwise (report any issues you may encounter).
 
 **Starting in version 4.20.0.0, [Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) comes with the new [***Shine***](/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md#shine) syntax** for highly intuitive and visually expressive View/Model Attribute Mapping, relying on `<=>` for bidirectional (two-way) data-binding and `<=` for unidirectional (one-way) data-binding, providing an alternative to the `bind` keyword (keep in mind that it is still a beta, so default back to `bind` whenever needed).
 
@@ -326,7 +326,7 @@ jgem install glimmer-dsl-swt
 
 Or this command if you want a specific version:
 ```
-jgem install glimmer-dsl-swt -v 4.20.12.2
+jgem install glimmer-dsl-swt -v 4.20.13.1
 ```
 
 `jgem` is JRuby's version of `gem` command.
@@ -354,7 +354,7 @@ Note: if you're using activerecord or activesupport, keep in mind that Glimmer u
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-swt', '~> 4.20.12.2'
+gem 'glimmer-dsl-swt', '~> 4.20.13.1'
 ```
 
 And, then run:
@@ -375,7 +375,7 @@ glimmer
 ```
 
 ```
-Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.20.12.2
+Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.20.13.1
       
 Usage: glimmer [--bundler] [--pd] [--quiet] [--debug] [--log-level=VALUE] [[ENV_VAR=VALUE]...] [[-jruby-option]...] (application.rb or task[task_args]) [[application2.rb]...]
 

data/VERSION

@@ -1 +1 @@
-4.20.12.2
+4.20.13.1

data/lib/glimmer/dsl/swt/dsl.rb

@@ -39,7 +39,7 @@ module Glimmer
         SWT,
         %w[
           layout
-          widget_listener
+          listener
           combo_selection_data_binding
           checkbox_group_selection_data_binding
           radio_group_selection_data_binding

data/lib/glimmer/dsl/swt/{widget_listener_expression.rb → listener_expression.rb}

@@ -22,17 +22,17 @@
 require 'glimmer/dsl/expression'
 require 'glimmer/swt/display_proxy'
 require 'glimmer/swt/custom/shape'
+require 'glimmer/ui/custom_shape'
 
 module Glimmer
   module DSL
     module SWT
-      class WidgetListenerExpression < Expression
-        include_package 'org.eclipse.swt.widgets'
-  
+      # Widget, Shape, and Display listener experssion
+      class ListenerExpression < Expression
         def can_interpret?(parent, keyword, *args, &block)
           Glimmer::Config.logger.debug {"keyword starts with on_: #{keyword.start_with?('on_')}"}
           return false unless keyword.start_with?('on_')
-          proper_parent = parent.respond_to?(:swt_widget) || parent.is_a?(Glimmer::SWT::DisplayProxy) || parent.is_a?(Glimmer::SWT::Custom::Shape)
+          proper_parent = parent.respond_to?(:swt_widget) || parent.is_a?(Glimmer::SWT::DisplayProxy) || parent.is_a?(Glimmer::SWT::Custom::Shape) || parent.is_a?(Glimmer::UI::CustomShape)
           Glimmer::Config.logger.debug {"parent #{parent} is a widget, shape, or display: #{proper_parent}"}
           return false unless proper_parent
           Glimmer::Config.logger.debug {"block exists?: #{!block.nil?}"}

data/lib/glimmer/swt/custom/drawable.rb

@@ -120,6 +120,10 @@ module Glimmer
                 paintable_shapes.each do |shape|
                   shape.paint(paint_event)
                 end
+                # When dragging, render dragged shape again on top of everything else.
+                if !@image_double_buffered && Glimmer::SWT::Custom::Shape.dragging?
+                  Glimmer::SWT::Custom::Shape.dragged_shape.paint(paint_event)
+                end
               end
               if @image_double_buffered
                 if @image_proxy_buffer.nil?

data/lib/glimmer/swt/custom/shape.rb

@@ -62,7 +62,12 @@ module Glimmer
       class Shape
         include Properties
         
+        DropEvent = Struct.new(:x, :y, :dragged_shape, :dragged_shape_original_x, :dragged_shape_original_y, :dragging_x, :dragging_y, :drop_shapes, keyword_init: true)
+        
         class << self
+          attr_accessor :dragging, :dragging_x, :dragging_y, :dragged_shape, :dragged_shape_original_x, :dragged_shape_original_y
+          alias dragging? dragging
+        
           def create(parent, keyword, *args, &property_block)
             potential_shape_class_name = keyword.to_s.camelcase(:upper).to_sym
             if constants.include?(potential_shape_class_name)
@@ -127,6 +132,11 @@ module Glimmer
           def flyweight_patterns
             @flyweight_patterns ||= {}
           end
+          
+          # shapes that have defined on_drop expecting to received a dragged shape
+          def drop_shapes
+            @drop_shapes ||= []
+          end
         end
         
         attr_reader :drawable, :parent, :name, :args, :options, :shapes, :properties
@@ -218,6 +228,11 @@ module Glimmer
           contain?(x, y)
         end
 
+        def include_with_children?(x, y)
+          included = include?(x, y)
+          included ||= expanded_shapes.detect { |shape| shape.include?(x, y) }
+        end
+
         # Indicates if a shape's x, y, width, height differ from its bounds calculation (e.g. arc / polygon)
         def irregular?
           false
@@ -509,6 +524,7 @@ module Glimmer
         def set_attribute(attribute_name, *args)
           options = args.last if args.last.is_a?(Hash)
           args.pop if !options.nil? && !options[:redraw].nil?
+          options ||= {}
           perform_redraw = @perform_redraw
           perform_redraw = options[:redraw] if perform_redraw.nil? && !options.nil?
           perform_redraw ||= true
@@ -529,11 +545,12 @@ module Glimmer
             @properties[ruby_attribute_getter_name] = args
             amend_method_name_options_based_on_properties! if @content_added && new_property
             property_change = true
+            calculated_paint_args_changed! if container?
           end
           if @content_added && perform_redraw && !drawable.is_disposed
             redrawn = false
             unless property_change
-              @calculated_paint_args = false
+              calculated_paint_args_changed!(children: false)
               if is_a?(PathSegment)
                 root_path&.calculated_path_args = @calculated_path_args = false
                 calculated_args_changed!
@@ -549,7 +566,7 @@ module Glimmer
             end
             # TODO consider redrawing an image proxy's gc in the future
             # TODO consider ensuring only a single redraw happens for a hierarchy of nested shapes
-            drawable.redraw unless redrawn || drawable.is_a?(ImageProxy)
+            drawable.redraw if !redrawn && !drawable.is_a?(ImageProxy)
           end
         end
         
@@ -570,11 +587,35 @@ module Glimmer
         
         def handle_observation_request(observation_request, &block)
           shape_block = lambda do |event|
-            included = include?(event.x, event.y)
-            included ||= shapes.to_a.detect { |shape| shape.include?(event.x, event.y) }
-            block.call(event) if included
+            block.call(event) if include_with_children?(event.x, event.y)
+          end
+          if observation_request == 'on_drop'
+            Shape.drop_shapes << self
+            handle_observation_request('on_mouse_up') do |event|
+              if Shape.dragged_shape
+                drop_event = DropEvent.new(
+                  dragged_shape: Shape.dragged_shape,
+                  dragged_shape_original_x: Shape.dragged_shape_original_x,
+                  dragged_shape_original_y: Shape.dragged_shape_original_y,
+                  dragging_x: Shape.dragging_x,
+                  dragging_y: Shape.dragging_y,
+                  drop_shapes: Shape.drop_shapes,
+                  x: event.x,
+                  y: event.y
+                )
+                begin
+                  shape_block.call(drop_event)
+                rescue => e
+                  Glimmer::Config.logger.error e.full_message
+                ensure
+                  Shape.dragging = false
+                  Shape.dragged_shape = nil
+                end
+              end
+            end
+          else
+            drawable.handle_observation_request(observation_request, &shape_block)
           end
-          drawable.handle_observation_request(observation_request, &shape_block)
         end
         
         # Sets data just like SWT widgets
@@ -597,7 +638,7 @@ module Glimmer
             set_attribute(method_name, *args)
           elsif has_attribute?(method_name)
             get_attribute(method_name)
-          else
+          else # TODO support proxying calls to handle_observation_request for listeners just like WidgetProxy
             super
           end
         end
@@ -611,6 +652,79 @@ module Glimmer
             super
           end
         end
+          
+        def drag_and_move=(drag_and_move_value)
+          drag_and_move_old_value = @drag_and_move
+          @drag_and_move = drag_and_move_value
+          if @drag_and_move && !drag_and_move_old_value
+            @on_drag_detected = handle_observation_request('on_drag_detected') do |event|
+              Shape.dragging = true
+              Shape.dragging_x = event.x
+              Shape.dragging_y = event.y
+              Shape.dragged_shape = self
+              Shape.dragged_shape_original_x = x
+              Shape.dragged_shape_original_y = y
+            end
+            @drawable_on_mouse_move = drawable.handle_observation_request('on_mouse_move') do |event|
+              if Shape.dragging && Shape.dragged_shape == self
+                Shape.dragged_shape.move_by((event.x - Shape.dragging_x), (event.y - Shape.dragging_y))
+                Shape.dragging_x = event.x
+                Shape.dragging_y = event.y
+              end
+            end
+            @drawable_on_mouse_up = drawable.handle_observation_request('on_mouse_up') do |event|
+              if Shape.dragging && Shape.dragged_shape == self
+                Shape.dragging = false
+              end
+            end
+          elsif !@drag_and_move && drag_and_move_old_value
+            @on_drag_detected.deregister
+            @drawable_on_mouse_move.deregister
+            @drawable_on_mouse_up.deregister
+          end
+        end
+            
+        def drag_and_move
+          @drag_and_move
+        end
+        
+        def drag_source=(drag_source_value)
+          drag_source_old_value = @drag_source
+          @drag_source = drag_source_value
+          if @drag_source && !drag_source_old_value
+            @on_drag_detected = handle_observation_request('on_drag_detected') do |event|
+              Shape.dragging = true
+              Shape.dragging_x = event.x
+              Shape.dragging_y = event.y
+              Shape.dragged_shape = self
+              Shape.dragged_shape_original_x = x
+              Shape.dragged_shape_original_y = y
+            end
+            @drawable_on_mouse_move = drawable.handle_observation_request('on_mouse_move') do |event|
+              if Shape.dragging && Shape.dragged_shape == self
+                Shape.dragged_shape.move_by((event.x - Shape.dragging_x), (event.y - Shape.dragging_y))
+                Shape.dragging_x = event.x
+                Shape.dragging_y = event.y
+              end
+            end
+            @drawable_on_mouse_up = drawable.handle_observation_request('on_mouse_up') do |event|
+              if Shape.dragging && Shape.dragged_shape == self && !Shape.drop_shapes.detect {|shape| shape.include_with_children?(event.x, event.y)}
+                Shape.dragging = false
+                Shape.dragged_shape.x = Shape.dragged_shape_original_x
+                Shape.dragged_shape.y = Shape.dragged_shape_original_y
+                Shape.dragged_shape = nil
+              end
+            end
+          elsif !@drag_source && drag_source_old_value
+            @on_drag_detected.deregister
+            @drawable_on_mouse_move.deregister
+            @drawable_on_mouse_up.deregister
+          end
+        end
+            
+        def drag_source
+          @drag_source
+        end
         
         def pattern(*args, type: nil)
           instance_variable_name = "@#{type}_pattern"
@@ -790,7 +904,7 @@ module Glimmer
             extent_args << extent_flags unless extent_flags.nil?
             self.extent = paint_event.gc.send("#{@name}Extent", *extent_args)
           end
-          if !@extent.nil? && (old_extent&.x != @extent&.x || old_extent&.y != @extent&.y)
+          if !@extent.nil? && (old_extent&.x != @extent&.x || old_extent&.y != @extent&.y) # TODO add a check to text content changing too
             calculated_args_changed!
             parent.calculated_args_changed_for_defaults! if parent.is_a?(Shape)
           end
@@ -812,6 +926,12 @@ module Glimmer
           shapes.each(&:calculated_args_changed!) if children
         end
         
+        def calculated_paint_args_changed!(children: true)
+          @calculated_paint_args = nil
+          @all_parent_properties = nil
+          shapes.each(&:calculated_paint_args_changed!) if children
+        end
+        
         # Notifies object that calculated args changed for defaults. Returns true if redrawing and false otherwise.
         def calculated_args_changed_for_defaults!
           has_default_dimensions = default_width? || default_height?
@@ -1205,7 +1325,8 @@ module Glimmer
                 end
               end
             else
-              @properties = all_parent_properties.merge(@properties)
+              @original_properties ||= @properties
+              @properties = all_parent_properties.merge(@original_properties)
               @properties['background'] = [@drawable.background] if fill? && !has_some_background?
               @properties['foreground'] = [@drawable.foreground] if @drawable.respond_to?(:foreground) && draw? && !has_some_foreground?
               # TODO regarding alpha, make sure to reset it to parent stored alpha once we allow setting shape properties on parents directly without shapes

data/lib/glimmer/ui/custom_shape.rb

@@ -254,6 +254,16 @@ module Glimmer
         end
       end
       
+      # TODO consider bringing observer_registrations method from CustomWidget if needed
+
+      def can_handle_observation_request?(observation_request)
+        body_root&.can_handle_observation_request?(observation_request)
+      end
+
+      def handle_observation_request(observation_request, &block)
+        body_root.handle_observation_request(observation_request, &block)
+      end
+      
       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

data/samples/hello/hello_canvas_drag_and_drop.rb

@@ -25,6 +25,21 @@ class HelloCanvasDragAndDrop
         }
       
         background :white
+        
+        10.times do |n|
+          an_oval = oval((rand*300).to_i, (rand*200).to_i, 50, 50) {
+            background rgb(255, 165, 0)
+            
+            # declare shape as a drag source, which unlike `drag_and_move true`, it means the shape now
+            # goes back to original position if not dropped at an on_drop shape target
+            drag_source true
+            
+            # unspecified width and height become max width and max height by default
+            oval(0, 0) {
+              foreground :black
+            }
+          }
+        end
                                                           
         @drop_square = rectangle(150, 260, 50, 50) {
           background :white
@@ -43,55 +58,26 @@ class HelloCanvasDragAndDrop
           }
         
           on_mouse_move do
-            if @dragging
-              @drop_square_border.foreground = :red
-            end
+            @drop_square_border.foreground = :red if Glimmer::SWT::Custom::Shape.dragging?
           end
           
-          on_mouse_up do
-            if @dragging
-              ball_count = @number_shape.string.to_i
-              @number_shape.dispose
-              @drop_square.content {
-                @number_shape = text {
-                  x :default
-                  y :default
-                  string (ball_count + 1).to_s
-                }
+          on_drop do |drop_event|
+            # drop_event attributes: :x, :y, :dragged_shape, :dragged_shape_original_x, :dragged_shape_original_y, :dragging_x, :dragging_y, :drop_shapes
+            ball_count = @number_shape.string.to_i
+            @number_shape.dispose
+            @drop_square.content {
+              @number_shape = text {
+                x :default
+                y :default
+                string (ball_count + 1).to_s
               }
-              @dragging.dispose
-            end
+            }
+            drop_event.dragged_shape.dispose
           end
         }
-                                         
-        10.times do |n|
-          an_oval = oval((rand*300).to_i, (rand*200).to_i, 50, 50) {
-            background rgb(255, 165, 0)
-            
-            # unspecified width and height become max width and max height by default
-            oval(0, 0) {
-              foreground :black
-            }
-
-            on_drag_detected do |event|
-              @dragging = an_oval
-              @last_x = event.x
-              @last_y = event.y
-            end
-          }
-        end
-                                         
+                                                                                  
         on_mouse_up do
           @drop_square_border.foreground = :black
-          @dragging = nil
-        end
-              
-        on_mouse_move do |event|
-          if @dragging
-            @dragging.move_by((event.x - @last_x), (event.y - @last_y))
-            @last_x = event.x
-            @last_y = event.y
-          end
         end
       }
     }

data/samples/hello/hello_custom_shape.rb

@@ -65,8 +65,14 @@ class HelloCustomShape
           y_location = (rand*HEIGHT/2).to_i%HEIGHT + (rand*15).to_i
           foreground_color = rgb(rand*255, rand*255, rand*255)
           
-          stick_figure(x: x_location, y: y_location, width: 35+n*2, height: 35+n*2) {
+          a_stick_figure = stick_figure(x: x_location, y: y_location, width: 35+n*2, height: 35+n*2) {
             foreground foreground_color
+            drag_and_move true
+            
+            # on mouse click, change color
+            on_mouse_up do
+              a_stick_figure.foreground = rgb(rand*255, rand*255, rand*255)
+            end
           }
         }
       }

data/samples/hello/hello_shape.rb

@@ -37,8 +37,14 @@ class HelloShape
           y_location = (rand*125).to_i%200 + (rand*15).to_i
           foreground_color = rgb(rand*255, rand*255, rand*255)
           
-          stick_figure(x_location, y_location, 35+n*2, 35+n*2) {
+          a_stick_figure = stick_figure(x_location, y_location, 35+n*2, 35+n*2) {
             foreground foreground_color
+            drag_and_move true
+            
+            # on mouse click, change color
+            on_mouse_up do
+              a_stick_figure.foreground = rgb(rand*255, rand*255, rand*255)
+            end
           }
         }
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-swt
 version: !ruby/object:Gem::Version
-  version: 4.20.12.2
+  version: 4.20.13.1
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -438,6 +438,7 @@ files:
 - lib/glimmer/dsl/swt/layout_data_expression.rb
 - lib/glimmer/dsl/swt/layout_expression.rb
 - lib/glimmer/dsl/swt/list_selection_data_binding_expression.rb
+- lib/glimmer/dsl/swt/listener_expression.rb
 - lib/glimmer/dsl/swt/menu_bar_expression.rb
 - lib/glimmer/dsl/swt/menu_expression.rb
 - lib/glimmer/dsl/swt/message_box_expression.rb
@@ -462,7 +463,6 @@ files:
 - lib/glimmer/dsl/swt/tree_items_data_binding_expression.rb
 - lib/glimmer/dsl/swt/tree_properties_expression.rb
 - lib/glimmer/dsl/swt/widget_expression.rb
-- lib/glimmer/dsl/swt/widget_listener_expression.rb
 - lib/glimmer/launcher.rb
 - lib/glimmer/rake_task.rb
 - lib/glimmer/rake_task/list.rb