glimmer-dsl-swt 4.18.4.0 → 4.18.4.5

data/lib/glimmer/ui/custom_shell.rb

@@ -1,82 +1,82 @@
-# Copyright (c) 2007-2021 Andy Maleh
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require 'glimmer/error'
-
-module Glimmer
-  module UI
-    module CustomShell
-      include SuperModule
-      include Glimmer::UI::CustomWidget
-      
-      class << self
-        attr_reader :launched_custom_shell
-        
-        def launch(*args, &content)
-          @launched_custom_shell = send(keyword, *args, &content) if @launched_custom_shell.nil? || @launched_custom_shell.disposed?
-          @launched_custom_shell.swt_widget.set_data('launched', true)
-          @launched_custom_shell.open
-        end
-      end
-      
-      def initialize(parent, *swt_constants, options, &content)
-        super
-        @swt_widget.set_data('custom_shell', self)
-        raise Error, 'Invalid custom shell body root! Must be a shell or another custom shell.' unless body_root.swt_widget.is_a?(org.eclipse.swt.widgets.Shell)
-      end
-      
-      # Classes may override
-      def open
-        body_root.open
-      end
-
-      # DO NOT OVERRIDE. JUST AN ALIAS FOR `#open`. OVERRIDE `#open` INSTEAD.
-      def show
-        open
-      end
-
-      # TODO consider using Forwardable instead
-      def close
-        body_root.close
-      end
-
-      def hide
-        body_root.hide
-      end
-
-      def visible?
-        body_root.visible?
-      end
-
-      def disposed?
-        swt_widget.is_disposed
-      end
-
-      def center_within_display
-        body_root.center_within_display
-      end
-
-      def start_event_loop
-        body_root.start_event_loop
-      end
-    end
-  end
-end
+# Copyright (c) 2007-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer/error'
+
+module Glimmer
+  module UI
+    module CustomShell
+      include SuperModule
+      include Glimmer::UI::CustomWidget
+      
+      class << self
+        attr_reader :launched_custom_shell
+        
+        def launch(*args, &content)
+          @launched_custom_shell = send(keyword, *args, &content) if @launched_custom_shell.nil? || @launched_custom_shell.disposed?
+          @launched_custom_shell.swt_widget.set_data('launched', true)
+          @launched_custom_shell.open
+        end
+      end
+      
+      def initialize(parent, *swt_constants, options, &content)
+        super
+        @swt_widget.set_data('custom_shell', self)
+        raise Error, 'Invalid custom shell body root! Must be a shell or another custom shell.' unless body_root.swt_widget.is_a?(org.eclipse.swt.widgets.Shell)
+      end
+      
+      # Classes may override
+      def open
+        body_root.open
+      end
+
+      # DO NOT OVERRIDE. JUST AN ALIAS FOR `#open`. OVERRIDE `#open` INSTEAD.
+      def show
+        open
+      end
+
+      # TODO consider using Forwardable instead
+      def close
+        body_root.close
+      end
+
+      def hide
+        body_root.hide
+      end
+
+      def visible?
+        body_root.visible?
+      end
+
+      def disposed?
+        swt_widget.is_disposed
+      end
+
+      def center_within_display
+        body_root.center_within_display
+      end
+
+      def start_event_loop
+        body_root.start_event_loop
+      end
+    end
+  end
+end

data/lib/glimmer/ui/custom_widget.rb

@@ -158,11 +158,17 @@ module Glimmer
         def after_body(&block)
           @after_body_block = block
         end
+
+        # Current custom widgets being rendered. Useful to yoke all observers evaluated during rendering of their custom widgets for automatical disposal on_widget_disposed
+        def current_custom_widgets
+          @current_custom_widgets ||= []
+        end
       end
 
       attr_reader :body_root, :swt_widget, :parent, :parent_proxy, :swt_style, :options
 
       def initialize(parent, *swt_constants, options, &content)
+        Glimmer::UI::CustomWidget.current_custom_widgets << self
         @parent_proxy = @parent = parent
         @parent_proxy = @parent&.get_data('proxy') if @parent.respond_to?(:get_data) && @parent.get_data('proxy')
         @swt_style = SWT::SWTProxy[*swt_constants]
@@ -177,6 +183,9 @@ module Glimmer
         @swt_widget = @body_root.swt_widget
         @swt_widget.set_data('custom_widget', self)
         execute_hook('after_body')
+        @dispose_listener_registration = @body_root.on_widget_disposed do
+          observer_registrations.each(&:deregister)
+        end
       end
       
       # Subclasses may override to perform post initialization work on an added child
@@ -184,6 +193,10 @@ module Glimmer
         # No Op by default
       end
 
+      def observer_registrations
+        @observer_registrations ||= []
+      end
+
       def can_handle_observation_request?(observation_request)
         observation_request = observation_request.to_s
         result = false
@@ -273,6 +286,10 @@ module Glimmer
         SWT::DisplayProxy.instance.sync_exec(&block)
       end
 
+      def timer_exec(delay_in_millis, &block)
+        SWT::DisplayProxy.instance.timer_exec(delay_in_millis, &block)
+      end
+
       # 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
       def content(&block)

data/lib/glimmer/util/proc_tracker.rb

@@ -1,39 +1,39 @@
-# Copyright (c) 2007-2021 Andy Maleh
-# 
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-# 
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require 'delegate'
-
-module Glimmer
-  module Util
-    class ProcTracker < DelegateClass(Proc)
-      def initialize(proc)
-        super(proc)
-      end
-      def call(*args)
-        __getobj__.call(*args)
-        @called = true
-      end
-      def called?
-        !!@called
-      end
-    end
-  end
-end
+# Copyright (c) 2007-2021 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'delegate'
+
+module Glimmer
+  module Util
+    class ProcTracker < DelegateClass(Proc)
+      def initialize(proc)
+        super(proc)
+      end
+      def call(*args)
+        __getobj__.call(*args)
+        @called = true
+      end
+      def called?
+        !!@called
+      end
+    end
+  end
+end

data/samples/elaborate/contact_manager.rb

@@ -1,142 +1,142 @@
-# Copyright (c) 2007-2021 Andy Maleh
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require_relative "contact_manager/contact_manager_presenter"
-
-class ContactManager
-  include Glimmer
-
-  def initialize
-    @contact_manager_presenter = ContactManagerPresenter.new
-    @contact_manager_presenter.list
-  end
-
-  def launch
-    shell {
-      text "Contact Manager"
-      composite {
-        group {
-          grid_layout(2, false) {
-            margin_width 0
-            margin_height 0
-          }
-          layout_data :fill, :center, true, false
-          text 'Lookup Contacts'
-          font height: 24
-          
-          label {
-            layout_data :right, :center, false, false
-            text "First &Name: "
-            font height: 16
-          }
-          text {
-            layout_data :fill, :center, true, false
-            text bind(@contact_manager_presenter, :first_name)
-            on_key_pressed {|key_event|
-              @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
-            }
-          }
-          
-          label {
-            layout_data :right, :center, false, false
-            text "&Last Name: "
-            font height: 16
-          }
-          text {
-            layout_data :fill, :center, true, false
-            text bind(@contact_manager_presenter, :last_name)
-            on_key_pressed {|key_event|
-              @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
-            }
-          }
-          
-          label {
-            layout_data :right, :center, false, false
-            text "&Email: "
-            font height: 16
-          }
-          text {
-            layout_data :fill, :center, true, false
-            text bind(@contact_manager_presenter, :email)
-            on_key_pressed {|key_event|
-              @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
-            }
-          }
-          
-          composite {
-            row_layout {
-              margin_width 0
-              margin_height 0
-            }
-            layout_data(:right, :center, false, false) {
-              horizontal_span 2
-            }
-            
-            button {
-              text "&Find"
-              on_widget_selected { @contact_manager_presenter.find }
-              on_key_pressed {|key_event|
-                @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
-              }
-            }
-            
-            button {
-              text "&List All"
-              on_widget_selected { @contact_manager_presenter.list }
-              on_key_pressed {|key_event|
-                @contact_manager_presenter.list if key_event.keyCode == swt(:cr)
-              }
-            }
-          }
-        }
-
-        table(:multi) { |table_proxy|
-          layout_data {
-            horizontal_alignment :fill
-            vertical_alignment :fill
-            grab_excess_horizontal_space true
-            grab_excess_vertical_space true
-            height_hint 200
-          }
-          table_column {
-            text "First Name"
-            width 80
-          }
-          table_column {
-            text "Last Name"
-            width 80
-          }
-          table_column {
-            text "Email"
-            width 200
-          }
-          items bind(@contact_manager_presenter, :results),
-          column_properties(:first_name, :last_name, :email)
-          on_mouse_up { |event|
-            table_proxy.edit_table_item(event.table_item, event.column_index)
-          }
-        }
-      }
-    }.open
-  end
-end
-
-ContactManager.new.launch
+# Copyright (c) 2007-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require_relative "contact_manager/contact_manager_presenter"
+
+class ContactManager
+  include Glimmer
+
+  def initialize
+    @contact_manager_presenter = ContactManagerPresenter.new
+    @contact_manager_presenter.list
+  end
+
+  def launch
+    shell {
+      text "Contact Manager"
+      composite {
+        group {
+          grid_layout(2, false) {
+            margin_width 0
+            margin_height 0
+          }
+          layout_data :fill, :center, true, false
+          text 'Lookup Contacts'
+          font height: 24
+          
+          label {
+            layout_data :right, :center, false, false
+            text "First &Name: "
+            font height: 16
+          }
+          text {
+            layout_data :fill, :center, true, false
+            text bind(@contact_manager_presenter, :first_name)
+            on_key_pressed {|key_event|
+              @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
+            }
+          }
+          
+          label {
+            layout_data :right, :center, false, false
+            text "&Last Name: "
+            font height: 16
+          }
+          text {
+            layout_data :fill, :center, true, false
+            text bind(@contact_manager_presenter, :last_name)
+            on_key_pressed {|key_event|
+              @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
+            }
+          }
+          
+          label {
+            layout_data :right, :center, false, false
+            text "&Email: "
+            font height: 16
+          }
+          text {
+            layout_data :fill, :center, true, false
+            text bind(@contact_manager_presenter, :email)
+            on_key_pressed {|key_event|
+              @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
+            }
+          }
+          
+          composite {
+            row_layout {
+              margin_width 0
+              margin_height 0
+            }
+            layout_data(:right, :center, false, false) {
+              horizontal_span 2
+            }
+            
+            button {
+              text "&Find"
+              on_widget_selected { @contact_manager_presenter.find }
+              on_key_pressed {|key_event|
+                @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
+              }
+            }
+            
+            button {
+              text "&List All"
+              on_widget_selected { @contact_manager_presenter.list }
+              on_key_pressed {|key_event|
+                @contact_manager_presenter.list if key_event.keyCode == swt(:cr)
+              }
+            }
+          }
+        }
+
+        table(:multi) { |table_proxy|
+          layout_data {
+            horizontal_alignment :fill
+            vertical_alignment :fill
+            grab_excess_horizontal_space true
+            grab_excess_vertical_space true
+            height_hint 200
+          }
+          table_column {
+            text "First Name"
+            width 80
+          }
+          table_column {
+            text "Last Name"
+            width 80
+          }
+          table_column {
+            text "Email"
+            width 200
+          }
+          items bind(@contact_manager_presenter, :results),
+          column_properties(:first_name, :last_name, :email)
+          on_mouse_up { |event|
+            table_proxy.edit_table_item(event.table_item, event.column_index)
+          }
+        }
+      }
+    }.open
+  end
+end
+
+ContactManager.new.launch