glimmer-dsl-swt 4.17.9.0 → 4.17.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3915e615b5248813ee6a9ca415c1be065f9d0ff9192e87a4a410146e0aae6f52
-  data.tar.gz: 98c2fa055457d36b53c840de96bad374dfeaec9fd21e36782090378d4439fffe
+  metadata.gz: 1fb2ca2da3bc7253db8416bc1395423988fee5296324c89fa06d380cb568f28e
+  data.tar.gz: 3924772c16691aafe3a8cdcdc05ef0e9aa566a6843642a987e7ac0e7348c63ec
 SHA512:
-  metadata.gz: 31978beac188701c12a27dd742452cb62c52b913dd7fd485dc1c4bd19ab52d9dea9a30a84b867691b81ac7ff23adc2cf7874bcb8718ca058526c143158d9f16f
-  data.tar.gz: 2c1e46b47851006dbbf0187e9ba215db83c3e603d058e9fd3e8a1c2476f944c66deae8391b714e918632e7bcf0c59556edccfcc28c726698850d57e331cd0423
+  metadata.gz: 38e692d156d993f29e9b362e8beb34c03eeb933b0d89a1d29c957e033da6f2356408032c03a2e3cfb69d66c0feb1f5c1b863705c40e2ddf55f2282efdf2d18d0
+  data.tar.gz: f9c23c58000fc174b8e6c83b430f117b4ed08ab305510a1f3ee7e1262af6ddb5105e60208be95a92d2bf5adb38501822fe9a8d1bde8fb25f3ee4b70047643858

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Change Log
 
+### 4.17.10.4
+
+- Do not select first row in a table by default (keep unselected)
+- Prevented extra call to model data in table items data-binding
+- Upgraded to glimmer v1.0.5
+
+### 4.17.10.3
+
+- Fixed issue in StyledText data-binding relating to capturing selection changes on mouse click
+
+### 4.17.10.2
+
+- Upgraded glimmer gem to version 1.0.4
+- Fixed issues relating to data-binding `styled_text` widget
+
+### 4.17.10.1
+
+- Upgraded glimmer gem to version 1.0.3
+- Upgraded rouge gem to version 3.25.0
+
+### 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,6 +1,6 @@
-# [<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.4
 
-## JRuby Desktop Development GUI Library
+## 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)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/glimmer-dsl-swt/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/glimmer-dsl-swt?branch=master)
@@ -238,7 +238,7 @@ Glimmer App:
 
 ## Table of contents
 
-- [Glimmer (Ruby Desktop Development GUI Library)](#-glimmer-ruby-desktop-development-gui-library)
+- [Glimmer (JRuby Desktop Development GUI Framework)](#jruby-desktop-development-gui-framework)
   - [Examples](#examples)
     - [Hello, World!](#hello-world)
     - [Tic Tac Toe](#tic-tac-toe)
@@ -353,13 +353,14 @@ Glimmer App:
       - [Hello, Expand Bar!](#hello-expand-bar)
       - [Hello, Radio!](#hello-radio)
       - [Hello, Radio Group!](#hello-radio-group)
-      - [Hello, Checkbox!](#hello-checkbox)
       - [Hello, Group!](#hello-group)
       - [Hello, Checkbox!](#hello-checkbox)
       - [Hello, Checkbox Group!](#hello-checkbox-group)
       - [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 +454,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.4
 
 ```
 
@@ -530,7 +531,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 (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.17.10.4
 
       
 Usage: glimmer [--bundler] [--pd] [--quiet] [--debug] [--log-level=VALUE] [[ENV_VAR=VALUE]...] [[-jruby-option]...] (application.rb or task[task_args]) [[application2.rb]...]
@@ -708,7 +709,7 @@ glimmer bin/greeter
 
 #### Desktopify
 
-This scaffolding mode enables you to desktopify a web app. Glimmer Scaffolding basically wraps the website with a [Browser Widget](#browser-widget).
+This scaffolding mode enables you to desktopify a web app. Glimmer Scaffolding basically turns a website into a desktop application by wrapping the website with a [Browser Widget](#browser-widget).
 
 The desktopify app is similar to the standard scaffolded app. It can be extended and the [browser may even be instrumented](https://help.eclipse.org/2020-09/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/browser/Browser.html).
 
@@ -1008,7 +1009,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.4
   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 +2270,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 +2397,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 +2506,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.
@@ -3757,14 +3873,6 @@ Hello, Radio Group!
 
 ![Hello Radio Group](images/glimmer-hello-radio-group.png)
 
-#### Hello, Checkbox!
-
-This sample demonstrates the use of a `checkbox` (aka `check` or `button(:check)`) in Glimmer.
-
-Code:
-
-[samples/hello/hello_checkbox.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_checkbox.rb)
-
 #### Hello, Group!
 
 This sample demonstrates the use of a `group` in Glimmer (not to be confused with the logical radio group custom widget, this is just an alternative to `composite` that provides a border around content).
@@ -3853,6 +3961,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:
@@ -4246,4 +4414,4 @@ Copyright (c) 2007-2020 - Andy Maleh.
 
 --
 
-[<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=40 />](https://github.com/AndyObtiva/glimmer) Built for [Glimmer](https://github.com/AndyObtiva/glimmer) (Ruby Desktop Development GUI Library).
+[<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=40 />](https://github.com/AndyObtiva/glimmer) Built for [Glimmer](https://github.com/AndyObtiva/glimmer) (DSL Framework).

data/VERSION

@@ -1 +1 @@
-4.17.9.0
+4.17.10.4

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.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-swt".freeze
-  s.version = "4.17.9.0"
+  s.version = "4.17.10.4"
 
   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-12-02"
   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",
@@ -171,7 +172,7 @@ Gem::Specification.new do |s|
   end
 
   if s.respond_to? :add_runtime_dependency then
-    s.add_runtime_dependency(%q<glimmer>.freeze, ["~> 1.0.2"])
+    s.add_runtime_dependency(%q<glimmer>.freeze, ["~> 1.0.5"])
     s.add_runtime_dependency(%q<super_module>.freeze, ["~> 1.4.1"])
     s.add_runtime_dependency(%q<nested_inherited_jruby_include_package>.freeze, ["~> 0.3.0"])
     s.add_runtime_dependency(%q<puts_debuggerer>.freeze, ["~> 0.10.2"])
@@ -181,7 +182,7 @@ Gem::Specification.new do |s|
     s.add_runtime_dependency(%q<os>.freeze, [">= 1.0.0", "< 2.0.0"])
     s.add_runtime_dependency(%q<rake>.freeze, [">= 10.1.0", "< 14.0.0"])
     s.add_runtime_dependency(%q<text-table>.freeze, [">= 1.2.4", "< 2.0.0"])
-    s.add_runtime_dependency(%q<rouge>.freeze, [">= 3.23.0", "< 4.0.0"])
+    s.add_runtime_dependency(%q<rouge>.freeze, [">= 3.25.0", "< 4.0.0"])
     s.add_development_dependency(%q<juwelier>.freeze, [">= 2.4.9", "< 3.0.0"])
     s.add_development_dependency(%q<warbler>.freeze, [">= 2.0.5", "< 3.0.0"])
     s.add_development_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
@@ -190,7 +191,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
     s.add_development_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
   else
-    s.add_dependency(%q<glimmer>.freeze, ["~> 1.0.2"])
+    s.add_dependency(%q<glimmer>.freeze, ["~> 1.0.5"])
     s.add_dependency(%q<super_module>.freeze, ["~> 1.4.1"])
     s.add_dependency(%q<nested_inherited_jruby_include_package>.freeze, ["~> 0.3.0"])
     s.add_dependency(%q<puts_debuggerer>.freeze, ["~> 0.10.2"])
@@ -200,7 +201,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<os>.freeze, [">= 1.0.0", "< 2.0.0"])
     s.add_dependency(%q<rake>.freeze, [">= 10.1.0", "< 14.0.0"])
     s.add_dependency(%q<text-table>.freeze, [">= 1.2.4", "< 2.0.0"])
-    s.add_dependency(%q<rouge>.freeze, [">= 3.23.0", "< 4.0.0"])
+    s.add_dependency(%q<rouge>.freeze, [">= 3.25.0", "< 4.0.0"])
     s.add_dependency(%q<juwelier>.freeze, [">= 2.4.9", "< 3.0.0"])
     s.add_dependency(%q<warbler>.freeze, [">= 2.0.5", "< 3.0.0"])
     s.add_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])

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
@@ -38,16 +38,16 @@ module Glimmer
         @model_binding = model_binding
         @table.swt_widget.data = @model_binding
         @column_properties = column_properties
+        @table.on_widget_disposed do |dispose_event|
+          unregister_all_observables
+        end
         if @table.respond_to?(:column_properties=)
           @table.column_properties = @column_properties
         else # assume custom widget
           @table.body_root.column_properties = @column_properties
         end
-        call(@model_binding.evaluate_property)
         @table_observer_registration = observe(model_binding)
-        @table.on_widget_disposed do |dispose_event|
-          unregister_all_observables
-        end
+        call
       end
 
       def call(new_model_collection=nil)
@@ -61,11 +61,11 @@ 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)
-        selected_table_item_models = parent.swt_widget.getSelection.map(&:getData)
+        selected_table_item_models = parent.swt_widget.getSelection.map(&:get_data)
         parent.finish_edit!
         parent.swt_widget.items.each(&:dispose)
         parent.swt_widget.removeAll
@@ -74,12 +74,11 @@ module Glimmer
           for index in 0..(column_properties.size-1)
             table_item.setText(index, model.send(column_properties[index]).to_s)
           end
-          table_item.setData(model)
+          table_item.set_data(model)
         end
-        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
+        selected_table_items = parent.search {|item| selected_table_item_models.include?(item.get_data) }
+        parent.swt_widget.setSelection(selected_table_items)
+        parent.sort!
         parent.swt_widget.redraw if parent&.swt_widget&.respond_to?(:redraw)
       end
     end