glimmer-dsl-swt 4.17.9.0 → 4.17.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3915e615b5248813ee6a9ca415c1be065f9d0ff9192e87a4a410146e0aae6f52
-  data.tar.gz: 98c2fa055457d36b53c840de96bad374dfeaec9fd21e36782090378d4439fffe
+  metadata.gz: e98b64d0a38325d6474b61a1a411d910418fcf47448fe9d6a2c88742bc2109ed
+  data.tar.gz: dff1f5b21cc4b594be8f5b6eac5337e4ee4d072b1fb2bf87c3eb0e6728e1eb41
 SHA512:
-  metadata.gz: 31978beac188701c12a27dd742452cb62c52b913dd7fd485dc1c4bd19ab52d9dea9a30a84b867691b81ac7ff23adc2cf7874bcb8718ca058526c143158d9f16f
-  data.tar.gz: 2c1e46b47851006dbbf0187e9ba215db83c3e603d058e9fd3e8a1c2476f944c66deae8391b714e918632e7bcf0c59556edccfcc28c726698850d57e331cd0423
+  metadata.gz: 62c570e832502b5dcde331cc9ef6774d1a15353d7f33066641ce7b07fa3f5a278cb4b1031a1266996fc9d09e37aa1884523ffb57100e47605cc4c54225b1b0b0
+  data.tar.gz: acf8dd65d70769f0f7c27873715f1360f6847ad0ffe3f1eed4c5af0c58768ec2c8ca6d4d1e337c88bca2ecb771025ded162130ed48aa0eec57c04c32590eda91

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+### 4.17.10.0
+
+- Support table editing via `date_time` for date/time values
+- Support table default sort configuration via sort_property
+- Support table default sort configuration via sort block
+- Support table default sort configuration via sort_by block
+- Hello, Table! Sample editor :date_time, property: :date_time in
+- Hello, Table! Sample label for  (Baseball Game Schedule)
+- Hello, Table! Sample combo for selecting nlds, nlcs, alds, alcs, world series
+- Hello, Table! Sample promotion field that indicates things like Free Bobblehead, Free Towel, Free Umbrella, etc...
+- ShellProxy#include_focus_control?
+- Fix issue with table selection data-binding when in single selection mode vs multi
+- Hello, Spinner! Sample
+
 ### 4.17.9.0
 
 - Add table style :editable to hook editing listener on mouse click automatically (instead of manually via on_widget_selected)

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.17.9.0
+# [<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.17.10.0
 
 ## JRuby Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-swt.svg)](http://badge.fury.io/rb/glimmer-dsl-swt)
@@ -360,6 +360,8 @@ Glimmer App:
       - [Hello, Directory Dialog!](#hello-directory-dialog)
       - [Hello, File Dialog!](#hello-file-dialog)
       - [Hello, Date Time!](#hello-date-time)
+      - [Hello, Spinner!](#hello-spinner)
+      - [Hello, Table!](#hello-table)
     - [Elaborate Samples](#elaborate-samples)
       - [User Profile](#user-profile)
       - [Login](#login)
@@ -453,7 +455,7 @@ jgem install glimmer-dsl-swt
 
 Or this command if you want a specific version:
 ```
-jgem install glimmer-dsl-swt -v 4.17.9.0
+jgem install glimmer-dsl-swt -v 4.17.10.0
 
 ```
 
@@ -530,7 +532,7 @@ bin/glimmer samples
 Below are the full usage instructions that come up when running `glimmer` without args.
 
 ```
-Glimmer (Ruby Desktop Development GUI Library) - JRuby Gem: glimmer-dsl-swt v4.17.9.0
+Glimmer (Ruby Desktop Development GUI Library) - JRuby Gem: glimmer-dsl-swt v4.17.10.0
 
       
 Usage: glimmer [--bundler] [--pd] [--quiet] [--debug] [--log-level=VALUE] [[ENV_VAR=VALUE]...] [[-jruby-option]...] (application.rb or task[task_args]) [[application2.rb]...]
@@ -1008,7 +1010,7 @@ Output:
                                                                          
   Css    glimmer-dsl-css    1.1.0     AndyMaleh    Glimmer DSL for CSS
   Opal   glimmer-dsl-opal   0.4.0     AndyMaleh    Glimmer DSL for Opal
-  Swt    glimmer-dsl-swt    4.17.9.0
+  Swt    glimmer-dsl-swt    4.17.10.0
   AndyMaleh    Glimmer DSL for SWT
   Tk     glimmer-dsl-tk     0.0.6     AndyMaleh    Glimmer DSL for Tk
   Xml    glimmer-dsl-xml    1.1.0     AndyMaleh    Glimmer DSL for XML
@@ -2269,6 +2271,117 @@ This automatically leverages the SWT TableEditor custom class behind the scenes,
 passed table item text into something else.
 It automatically persists the change to `items` data-bound model on ENTER/FOCUS-OUT or cancels on ESC/NO-CHANGE.
 
+##### Table Selection
+
+Table Selection data-binding is simply done via the `selection` property.
+
+```ruby
+selection bind(group, :selected_person)
+```
+
+If it's a multi-selection table (`table(:multi)`), then the data-bound model property oughta be a collection.
+
+```ruby
+selection bind(group, :selected_people)
+```
+
+##### Table Editing
+
+Glimmer provides a custom SWT style for table editing called `:editable` to obviate the need for an `on_mouse_up` listener.
+
+For example, the code above could be simplified as:
+
+```ruby
+shell {
+  @table = table(:editable) {
+    table_column {
+      text "Name"
+      width 120
+    }
+    table_column {
+      text "Age"
+      width 120
+    }
+    table_column {
+      text "Adult"
+      width 120
+    }
+    items bind(group, :people), column_properties(:name, :age, :adult)
+    selection bind(group, :selected_person)
+  }
+}
+```
+
+Additionally, Glimmer supports the idea of custom editors or no editor per column.
+
+Example:
+
+```ruby
+shell {
+  @table = table(:editable) {
+    table_column {
+      text "Name"
+      width 120
+    }
+    table_column {
+      text "Age"
+      width 120
+      editor :spinner
+    }
+    table_column {
+      text "Adult"
+      width 120
+      editor :checkbox
+    }
+    items bind(group, :people), column_properties(:name, :age, :adult)
+    selection bind(group, :selected_person)
+  }
+}
+```
+
+The example above uses a `spinner` widget editor for the age column since it's an `Integer` and
+a `checkbox` widget (`button(:check)`) editor for the adult column since it's a `Boolean`
+
+Here are all the supported types of table editors:
+- `text`: expects a `String` property
+- `combo`: expects a `String` property accompanied by a matching `property_options` property by convention to provide items to present in the `combo`
+- `checkbox`: expects a `Boolean` property
+- `radio`: expects a `Boolean` property
+- `spinner`: expects an `Integer` property
+- `date`: expects a `DateTime` property
+- `date_drop_down`: expects a `DateTime` property
+- `time`: expects a `DateTime` property
+
+An editor may also take additional arguments (SWT styles such as :long for the date field) that are passed to the editor widget, as well as hash options to
+customize the property being used for editing (e.g. property: :raw_name for a :formatted_name field) in case it differs from the property used to display
+the data in the table.
+
+Example:
+
+```ruby
+shell {
+  @table = table(:editable) {
+    table_column {
+      text "Date of Birth"
+      width 120
+      editor :date_drop_down, property: :date_time
+    }
+    table_column {
+      text "Industry"
+      width 120
+      # assume there is a `Person#industry_options` property method on the model to provide items to the `combo`
+      editor :combo, :read_only # passes :ready_only SWT style to `combo` widget
+    }
+    items bind(group, :people), column_properties(:formatted_date, :industry)
+    selection bind(group, :selected_person)
+  }
+}
+```
+
+Check out [Hello, Table!](#hello-table) for an actual example including table editors.
+
+[Are We There Yet?](#are-we-there-yet) is an actual production Glimmer application that takes full advantage of table capabilities.
+
 ##### Table Sorting
 
 Glimmer automatically adds sorting support to the SWT `Table` widget.
@@ -2285,6 +2398,8 @@ Should you have a special data type that could not be compared automatically, Gl
 - `sort_by(&block)`: this works just like Ruby `Enumerable` `sort_by`. The block receives the table column data as argument.
 - `sort(&comparator)`: this works just like Ruby `Enumerable` `sort`. The comparator block receives two objects from the table column data.
 
+These alternatives could be used inside `table_column` for column-clicked sorting or in the `table` body directly to set the initial default sort.
+
 You may also set `additional_sort_properties` on the parent `table` widget to have secondary sorting applied. For example, if you set `additional_sort_properties :name, :project_name`, then whenever you sort by `:name`, it additionally sorts by `:project_name` afterwards, and vice versa. This only works for columns that either have no custom sort set or have a `sort_property` with one property only (but no sort or sort_by block)
 
 Example:
@@ -2392,6 +2507,8 @@ You can data-bind any of these properties:
 
 Learn more at the [Hello, Date Time!](#hello-date-time) sample.
 
+If you need a better widget with the ability to customize the date format pattern, check out the [Nebula CDateTime Glimmer Custom Widget](https://github.com/AndyObtiva/glimmer-cw-cdatetime-nebula)
+
 ### Observer
 
 Glimmer comes with `Observer` module, which is used internally for data-binding, but can also be used externally for custom use of the Observer Pattern. It is hidden when observing widgets, and used explicitly when observing models.
@@ -3853,6 +3970,66 @@ Hello, Date Time!
 
 ![Hello Date Time](images/glimmer-hello-date-time.png)
 
+#### Hello, Spinner!
+
+This sample demonstrates the use of `spinner` widget in Glimmer
+
+Code:
+
+[samples/hello/hello_spinner.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_spinner.rb)
+
+Hello, Spinner!
+
+![Hello Spinner](images/glimmer-hello-spinner.png)
+
+#### Hello, Table!
+
+This sample demonstrates the use of [table](#table) widget in Glimmer, including data-binding, multi-type editing, sorting, and filtering.
+
+Code:
+
+[samples/hello/hello_table.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_table.rb)
+
+Hello, Table!
+
+![Hello Table](images/glimmer-hello-table.png)
+
+Hello, Table! Editing Game Date
+
+![Hello Table](images/glimmer-hello-table-editing-game-date.png)
+
+Hello, Table! Editing Game Time
+
+![Hello Table](images/glimmer-hello-table-editing-game-time.png)
+
+Hello, Table! Editing Home Team
+
+![Hello Table](images/glimmer-hello-table-editing-home-team.png)
+
+Hello, Table! Sorted Game Date Ascending
+
+![Hello Table](images/glimmer-hello-table-sorted-game-date-ascending.png)
+
+Hello, Table! Sorted Game Date Descending
+
+![Hello Table](images/glimmer-hello-table-sorted-game-date-descending.png)
+
+Hello, Table! Playoff Type Combo
+
+![Hello Table](images/glimmer-hello-table-playoff-type-combo.png)
+
+Hello, Table! Playoff Type Changed
+
+![Hello Table](images/glimmer-hello-table-playoff-type-changed.png)
+
+Hello, Table! Game Booked
+
+![Hello Table](images/glimmer-hello-table-game-booked.png)
+
+Hello, Table! Context Menu
+
+![Hello Table](images/glimmer-hello-table-context-menu.png)
+
 ### Elaborate Samples
 
 For more elaborate samples, check the following:

data/VERSION

@@ -1 +1 @@
-4.17.9.0
+4.17.10.0

data/glimmer-dsl-swt.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-dsl-swt 4.17.9.0 ruby lib
+# stub: glimmer-dsl-swt 4.17.10.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-swt".freeze
-  s.version = "4.17.9.0"
+  s.version = "4.17.10.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["AndyMaleh".freeze]
-  s.date = "2020-11-07"
+  s.date = "2020-11-10"
   s.description = "Glimmer DSL for SWT (JRuby Desktop Development GUI Library)".freeze
   s.email = "andy.am@gmail.com".freeze
   s.executables = ["glimmer".freeze, "girb".freeze]
@@ -152,6 +152,7 @@ Gem::Specification.new do |s|
     "samples/hello/hello_radio.rb",
     "samples/hello/hello_radio_group.rb",
     "samples/hello/hello_sash_form.rb",
+    "samples/hello/hello_spinner.rb",
     "samples/hello/hello_styled_text.rb",
     "samples/hello/hello_tab.rb",
     "samples/hello/hello_table.rb",

data/lib/glimmer/data_binding/table_items_binding.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2007-2020 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
@@ -7,10 +7,10 @@
 # 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
@@ -61,7 +61,7 @@ module Glimmer
           add_dependent(@table_observer_registration => @table_items_observer_registration)
           @model_collection = new_model_collection
         end
-        populate_table(@model_collection, @table, @column_properties)        
+        populate_table(@model_collection, @table, @column_properties)
       end
       
       def populate_table(model_collection, parent, column_properties)
@@ -79,7 +79,7 @@ module Glimmer
         selected_table_items = parent.search {|item| selected_table_item_models.include?(item.getData) }
         selected_table_items = [parent.swt_widget.getItems.first].to_java(TableItem) if selected_table_items.empty? && !parent.swt_widget.getItems.empty?
         parent.swt_widget.setSelection(selected_table_items) unless selected_table_items.empty?
-        parent.sort
+        parent.sort!
         parent.swt_widget.redraw if parent&.swt_widget&.respond_to?(:redraw)
       end
     end

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

@@ -1,5 +1,5 @@
 # Copyright (c) 2007-2020 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
@@ -7,10 +7,10 @@
 # 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

data/lib/glimmer/swt/shell_proxy.rb

@@ -88,18 +88,26 @@ module Glimmer
 
       # Opens shell and starts SWT's UI thread event loop
       def open
+        open_only
+        start_event_loop unless nested?
+      end
+      alias show open
+      
+      # Opens without starting the event loop.
+      def open_only
         if @opened_before
           @swt_widget.setVisible(true)
-          # notify_observers('visible')
         else
           @opened_before = true
           @swt_widget.pack
           center
           @swt_widget.open
-          start_event_loop
         end
       end
-      alias show open
+      
+      def nested?
+        !parent.nil?
+      end
 
       def hide
         @swt_widget.setVisible(false)
@@ -113,6 +121,10 @@ module Glimmer
       def visible=(visibility)
         visibility ? show : hide
       end
+      
+      def include_focus_control?
+        DisplayProxy.instance.focus_control&.shell == swt_widget
+      end
 
       def pack
         @swt_widget.pack
@@ -169,6 +181,9 @@ module Glimmer
           super
         end
       end
+      
     end
+    
   end
+  
 end

data/lib/glimmer/swt/tab_item_proxy.rb

@@ -39,6 +39,7 @@ module Glimmer
     #
     # Follows the Proxy Design Pattern
     class TabItemProxy < WidgetProxy
+      ATTRIBUTES = %w[text image]
       include_package 'org.eclipse.swt.widgets'
 
       attr_reader :widget_proxy, :swt_tab_item
@@ -51,7 +52,7 @@ module Glimmer
       end
 
       def has_attribute?(attribute_name, *args)
-        if attribute_name.to_s == "text"
+        if ATTRIBUTES.include?(attribute_name.to_s)
           true
         else
           super(attribute_name, *args)
@@ -63,6 +64,8 @@ module Glimmer
         if attribute_name.to_s == "text"
           text_value = args[0]
           @swt_tab_item.setText text_value
+        elsif attribute_name.to_s == "image"
+          widget_proxy.set_attribute('image', *args)
         else
           super(attribute_name, *args)
         end
@@ -71,6 +74,8 @@ module Glimmer
       def get_attribute(attribute_name)
         if attribute_name.to_s == "text"
           @swt_tab_item.getText
+        elsif attribute_name.to_s == "image"
+          widget_proxy.get_attribute('image')
         else
           super(attribute_name)
         end

data/lib/glimmer/swt/table_column_proxy.rb

@@ -20,6 +20,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'glimmer/swt/widget_proxy'
+require 'glimmer/swt/swt_proxy'
 
 module Glimmer
   module SWT
@@ -34,7 +35,7 @@ module Glimmer
         @no_sort = args.delete(:no_sort)
         super
         on_widget_selected do |event|
-          parent.sort_by_column(self)
+          parent.sort_by_column!(self)
         end unless no_sort?
       end
       
@@ -42,10 +43,15 @@ module Glimmer
         @sort_property = args unless args.empty?
       end
       
+      # Sets editor (e.g. combo)
       def editor=(args)
         @editor = args
       end
       
+      def editable?
+        !@editor&.include?(:none)
+      end
+      
     end
   end
 end