glimmer-dsl-swt 4.24.4.1 → 4.24.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0501a99ee5c020f5af90de5bef4b2de5649b71ecc72ef18c07cf7624e202cd2
-  data.tar.gz: 17f1582e1692df7535ff337c9994f4db60ebf85c1ebc2a1e34057f29218e6dfd
+  metadata.gz: 3a089b978fce806c9396adb1f971c4ba8f5344f0b927e8781c6a6985d9c234d2
+  data.tar.gz: 82e0a576ebf56dd83bafda03378aec4cee32cfa0de1d2bf61bc247c2c33562a1
 SHA512:
-  metadata.gz: c6653469f0356e6f8b26176cf1ed780b77a04288855c532c7f33cc0a6363e2674b79fb836cf9482cb7668d06002d8cfc097f73df7b9c1777b835ec231db37d76
-  data.tar.gz: 87f7266996c85bb845495032c41f84132a86c935a516f6a38a96a3b57904855096c00e522c6065124b881f6fbaff865066f7978fe64e392a168d91e4a4aa7abc
+  metadata.gz: 620cc756c24723f0e7443055b9f156e71a7312e07093142dc606f16692af7cd7f37eb97294586bbf79239ccd9fc3c34c9fb107efd28eb5713a287dd882ad1b48
+  data.tar.gz: 6c954efcf5550479ab13ef3f21b1f68f3f1ab32823fe638ef13618c5e3c12292f1d1fbb8ed42d2158a480a344ac64c12f2f87d8b96deeadda7373302e01167fb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 4.24.4.2
+
+- `refined_table` filtering support
+- Ensure correct `refined_table` enablement of pagination buttons based on whether on first/last page or not
+- Display vertical scroll bar when setting `refined_table` `per_page` to a height value that results in table exceeding screen height
+- Support `refined_table` nested elements `first_button {}`, `previous_button {}`, `page_text {}`, `next_button {}`, `last_button {}` to customize every widget within.
+- Support `refined_table` attributes for accessing nested elements: `table_proxy`, `first_button_proxy`, `previous_button_proxy`, `page_text_proxy`, `next_button_proxy`, `last_button_proxy` to customize every widget within.
+
 ## 4.24.4.1
 
 - Optimize `table` data-binding performance (improving paging performance in `refined_table`) by making observer registrations run asynchronously in a separate thread
@@ -8,6 +16,8 @@
 
 ## 4.24.4.0
 
+- `refined_table` custom widget with pagination support (and future filtering support)
+- Hello, Refined Table! sample demonstrating `refined_table`
 - Save `WidgetBinding` instances on `WidgetProxy` objects via `widget_bindings` attribute
 - Support specifying `@children_owner` in any custom widget for which adding children will not add them under the `body_root` (e.g. a composite wrapping a table will designate the table as the `@children_owner` for adding `table_column`s)
 - Add explicit `shell_proxy` method to `Glimmer::UI::CustomWidget` that delegates to `body_root` to avoid annoying false negative error every time that method is called

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.24.4.1
+# [<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.24.4.2
 ## 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)
@@ -21,7 +21,7 @@ Featured in JRuby Cookbook](http://shop.oreilly.com/product/9780596519650.do) an
 
 ![Eclipse SWT RCP NASA Mars Rover](/images/glimmer-eclipse-swt-rcp-nasa-mars-rover.png)
 
-[Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) 4.24.4.1 includes [SWT 4.24](https://download.eclipse.org/eclipse/downloads/drops4/R-4.24-202206070700/), which was released on June 7, 2022. 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.
+[Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) 4.24.4.2 includes [SWT 4.24](https://download.eclipse.org/eclipse/downloads/drops4/R-4.24-202206070700/), which was released on June 7, 2022. 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.
 
 **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. That was [originally conceived back in 2007](https://andymaleh.blogspot.com/2007/12/data-shining-in-glimmer.html).
 
@@ -338,7 +338,7 @@ jgem install glimmer-dsl-swt
 
 Or this command if you want a specific version:
 ```
-jgem install glimmer-dsl-swt -v 4.24.4.1
+jgem install glimmer-dsl-swt -v 4.24.4.2
 ```
 
 `jgem` is JRuby's version of `gem` command.
@@ -366,7 +366,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.24.4.1'
+gem 'glimmer-dsl-swt', '~> 4.24.4.2'
 ```
 
 And, then run:
@@ -389,7 +389,7 @@ glimmer
 ```
 
 ```
-Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.24.4.1
+Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.24.4.2
       
 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.24.4.1
+4.24.4.2

data/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md

@@ -4311,13 +4311,14 @@ Here is an explanation of the example above:
 
 **(ALPHA FEATURE)**
 
-`refined_table` is a custom widget that can handle very large amounts of data by applying pagination.
+`refined_table` is a custom widget that can handle very large amounts of data by applying pagination and filtering.
 
 Just use like a standard `table`, but data-bind models to the `model_array` property instead of `items`. `refined_table` will take care of the rest.
 
 Options:
 - `per_page` (default: `10`): specifies how many rows to display per page
 - `page` (default: `1` if table is filled and `0` otherwise): specifies initial page
+- `query` (default: `''`): specifies filter query term (empty shows all results)
 
 Note that currently `refined_table` only supports displaying a **read-only** table (meaning it can read updates from the model, but it cannot write back to the model through `TableEditor` cells).
 

data/lib/glimmer/data_binding/table_items_binding.rb

@@ -117,6 +117,8 @@ module Glimmer
               end
               
               @model_collection = new_model_collection
+            else
+              @model_collection = []
             end
             
             populate_table(@model_collection, @table, @column_properties, internal_sort: internal_sort)

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

@@ -31,12 +31,16 @@ module Glimmer
         option :per_page, default: 10
         option :page, default: 0
         option :model_array
+        option :query, default: ''
         
+        attr_accessor :filtered_model_array
         attr_accessor :refined_model_array
-        attr_reader :table_proxy, :page_text_proxy
+        attr_reader :table_proxy, :page_text_proxy, :first_button_proxy, :previous_button_proxy, :next_button_proxy, :last_button_proxy
         
         before_body do
+          self.query ||= ''
           self.model_array ||= []
+          self.filtered_model_array = []
           self.refined_model_array = []
         end
         
@@ -47,12 +51,12 @@ module Glimmer
                 @data_bound = true
                 model_binding = new_widget_binding.model_binding
                 observe(self, :model_array) do
-                  paginate
+                  filter_and_paginate
                 end
                 @table_proxy.content {
                   items(dsl: true) <=> [self, :refined_model_array, model_binding.binding_options.merge(read_only: true)]
                 }
-                paginate
+                filter_and_paginate
               end
             end
           end.observe(body_root.widget_bindings)
@@ -60,76 +64,112 @@ module Glimmer
         
         body {
           composite {
-            composite {
+            text(:search, :border) {
               layout_data(:fill, :center, true, false)
               
-              fill_layout(:horizontal)
+              text <=> [self, :query, after_write: -> { filter_and_paginate }]
+            }
+            
+            pagination
+            
+            @children_owner = @table_proxy = table(swt_style) {
+              layout_data(:fill, :fill, true, true)
+            }
+          }
+        }
+        
+        def pagination
+          composite {
+            layout_data(:fill, :center, true, false)
+            
+            fill_layout(:horizontal)
+            
+            @first_button_proxy = button {
+              text '<<'
+              enabled <= [self, :page, on_read: ->(value) {value > first_page}]
               
-              button {
-                text '<<'
-                
-                on_widget_selected do
-                  self.page = first_page
-                  paginate
-                end
-              }
+              on_widget_selected do
+                self.page = first_page
+                filter_and_paginate
+              end
+            }
+            
+            @previous_button_proxy = button {
+              text '<'
+              enabled <= [self, :page, on_read: ->(value) {value > first_page}]
               
-              button {
-                text '<'
-                
-                on_widget_selected do
-                  self.page -= 1
-                  paginate
-                end
-              }
+              on_widget_selected do
+                self.page -= 1
+                filter_and_paginate
+              end
+            }
+            
+            @page_text_proxy = text(:border, :center) {
+              text <= [self, :page, on_read: ->(value) { "#{value} of #{page_count}" }]
               
-              @page_text_proxy = text(:border, :center) {
-                text <= [self, :page, on_read: ->(value) { "#{value} of #{page_count}" }]
-                
-                on_focus_gained do
-                  @page_text_proxy.select_all
-                end
-                
-                on_focus_lost do
-                  self.page = @page_text_proxy.text.to_i
-                  paginate
-                end
-                
-                on_key_pressed do |key_event|
-                  if key_event.keyCode == swt(:cr)
-                    self.page = @page_text_proxy.text.to_i
-                    paginate
-                  end
-                end
-              }
+              on_focus_gained do
+                @page_text_proxy.select_all
+              end
               
-              button {
-                text '>'
-                
-                on_widget_selected do
-                  self.page += 1
-                  paginate
-                end
-              }
+              on_focus_lost do
+                self.page = @page_text_proxy.text.to_i
+                filter_and_paginate
+              end
               
-              button {
-                text '>>'
-                
-                on_widget_selected do
-                  self.page = last_page
-                  paginate
+              on_key_pressed do |key_event|
+                if key_event.keyCode == swt(:cr)
+                  self.page = @page_text_proxy.text.to_i
+                  filter_and_paginate
                 end
-              }
+              end
             }
             
-            @children_owner = @table_proxy = table(swt_style)
+            @next_button_proxy = button {
+              text '>'
+              enabled <= [self, :page, on_read: ->(value) {value < last_page}]
+              
+              on_widget_selected do
+                self.page += 1
+                filter_and_paginate
+              end
+            }
+            
+            @last_button_proxy = button {
+              text '>>'
+              enabled <= [self, :page, on_read: ->(value) {value < last_page}]
+              
+              on_widget_selected do
+                self.page = last_page
+                filter_and_paginate
+              end
+            }
           }
-        }
+        end
         
         def table_block=(block)
           @table_proxy.content(&block)
         end
         
+        def page_text_block=(block)
+          @page_text_proxy.content(&block)
+        end
+        
+        def first_button_block=(block)
+          @first_button_proxy.content(&block)
+        end
+        
+        def previous_button_block=(block)
+          @previous_button_proxy.content(&block)
+        end
+        
+        def next_button_block=(block)
+          @next_button_proxy.content(&block)
+        end
+        
+        def last_button_block=(block)
+          @last_button_proxy.content(&block)
+        end
+        
         def method_missing(method_name, *args, &block)
           dsl_mode = @dsl_mode || args.last.is_a?(Hash) && args.last[:dsl]
           if dsl_mode
@@ -153,28 +193,41 @@ module Glimmer
         end
         
         def page_count
-          (model_array && (model_array.count / per_page.to_f).ceil) || 0
+          (filtered_model_array && (filtered_model_array.count / per_page.to_f).ceil) || 0
         end
         
         def corrected_page(initial_page_value = nil)
           correct_page = initial_page_value || page
           correct_page = [correct_page, page_count].min
           correct_page = [correct_page, 1].max
-          correct_page = (model_array&.count.to_i > 0) ? (correct_page > 0 ? correct_page : 1) : 0
+          correct_page = (filtered_model_array&.count.to_i > 0) ? (correct_page > 0 ? correct_page : 1) : 0
           correct_page
         end
         
         def first_page
-          (model_array&.count.to_i > 0) ? 1 : 0
+          (filtered_model_array&.count.to_i > 0) ? 1 : 0
         end
         
         def last_page
           page_count
         end
         
+        def filter_and_paginate
+          filter
+          paginate
+        end
+        
+        def filter
+          self.filtered_model_array = model_array.select do |model|
+            @table_proxy.cells_for(model).any? do |cell_text|
+              cell_text.to_s.downcase.include?(query.to_s.downcase)
+            end
+          end
+        end
+        
         def paginate
           self.page = corrected_page(page)
-          self.refined_model_array = model_array[(page - 1) * per_page, per_page]
+          self.refined_model_array = filtered_model_array[(page - 1) * per_page, per_page]
         end
       end
     end

data/samples/elaborate/meta_sample/tutorials.yml

@@ -30,3 +30,4 @@ Hello, Custom Widget!: aJHLo5yLDZc
 Hello, Custom Shell!: c8Eb8GWM_XQ
 Hello, Custom Shape!: H3J8ecp30Ak
 Battleship: b00OWeLZOt8
+Klondike Solitaire: qOzgiz9X3sI

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-swt
 version: !ruby/object:Gem::Version
-  version: 4.24.4.1
+  version: 4.24.4.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement