glimmer-dsl-swt 4.18.4.1 → 4.18.4.6

data/docs/reference/GLIMMER_CONFIGURATION.md

@@ -0,0 +1,183 @@
+## Glimmer Configuration
+
+Glimmer configuration may be done via the `Glimmer::Config` module.
+
+### logger
+
+The Glimmer DSL engine supports logging via a standard `STDOUT` Ruby `Logger` configured in the `Glimmer::Config.logger` config option.
+It is set to level Logger::ERROR by default.
+Log level may be adjusted via `Glimmer::Config.logger.level` just like any other Ruby Logger.
+
+Example:
+
+```ruby
+Glimmer::Config.logger.level = :debug
+```
+This results in more verbose debug loggging to `STDOUT`, which is very helpful in troubleshooting Glimmer DSL syntax when needed.
+
+Example log:
+```
+D, [2017-07-21T19:23:12.587870 #35707] DEBUG -- : method: shell and args: []
+D, [2017-07-21T19:23:12.594405 #35707] DEBUG -- : ShellCommandHandler will handle command: shell with arguments []
+D, [2017-07-21T19:23:12.844775 #35707] DEBUG -- : method: composite and args: []
+D, [2017-07-21T19:23:12.845388 #35707] DEBUG -- : parent is a widget: true
+D, [2017-07-21T19:23:12.845833 #35707] DEBUG -- : on listener?: false
+D, [2017-07-21T19:23:12.864395 #35707] DEBUG -- : WidgetCommandHandler will handle command: composite with arguments []
+D, [2017-07-21T19:23:12.864893 #35707] DEBUG -- : widget styles are: []
+D, [2017-07-21T19:23:12.874296 #35707] DEBUG -- : method: list and args: [:multi]
+D, [2017-07-21T19:23:12.874969 #35707] DEBUG -- : parent is a widget: true
+D, [2017-07-21T19:23:12.875452 #35707] DEBUG -- : on listener?: false
+D, [2017-07-21T19:23:12.878434 #35707] DEBUG -- : WidgetCommandHandler will handle command: list with arguments [:multi]
+D, [2017-07-21T19:23:12.878798 #35707] DEBUG -- : widget styles are: [:multi]
+```
+
+The `logger` instance may be replaced with a custom logger via `Glimmer::Config.logger = custom_logger`
+
+To reset `logger` to the default instance, you may call `Glimmer::Config.reset_logger!`
+
+All logging is done lazily via blocks (e.g. `logger.debug {message}`) to avoid affecting app performance with logging when below the configured logging level threshold.
+
+[Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt) enhances Glimmer default logging support via the Ruby [`logging`](https://github.com/TwP/logging) gem, enabling buffered asynchronous logging in a separate thread, thus completely unhindering normal desktop app performance.
+
+Other config options related to the [`logging`](https://github.com/TwP/logging) gem are mentioned below.
+
+#### logging_devices
+
+This is an array of these possible values: `:stdout` (default), `:stderr`, `:file`, `:syslog` (default), `:stringio`
+
+It defaults to `[:stdout, :syslog]`
+
+When `:file` is included, Glimmer creates a 'log' directory directly below the Glimmer app local directory.
+It may also be customized further via the `logging_device_file_options` option.
+This is useful on Windows as an alternative to `syslog`, which is not available on Windows by default.
+
+#### logging_device_file_options
+
+This is a hash of [`logging`](https://github.com/TwP/logging) gem options for the `:file` logging device.
+
+Default: `{size: 1_000_000, age: 'daily', roll_by: 'number'}`
+
+That ensures splitting log files at the 1MB size and daily, rolling them by unique number.
+
+#### logging_appender_options
+
+Appender options is a hash passed as options to every appender (logging device) used in the [`logging`](https://github.com/TwP/logging) gem.
+
+Default: `{async: true, auto_flushing: 500, write_size: 500, flush_period: 60, immediate_at: [:error, :fatal], layout: logging_layout}`
+
+That ensures asynchronous buffered logging that is flushed every 500 messages and 60 seconds, or immediately at error and fatal log levels
+
+#### logging_layout
+
+This is a [`logging`](https://github.com/TwP/logging) gem layout that formats the logging output.
+
+Default:
+
+```
+Logging.layouts.pattern(
+  pattern: '[%d] %-5l %c: %m\n',
+  date_pattern: '%Y-%m-%d %H:%M:%S'
+)
+```
+
+### import_swt_packages
+
+Glimmer automatically imports all SWT Java packages upon adding `include Glimmer`, `include Glimmer::UI::CustomWidget`, or `include Glimmer::UI::CustomShell` to a class or module. It relies on JRuby's `include_package` for lazy-importing upon first reference of a Java class.
+
+As a result, you may call SWT Java classes from Glimmer Ruby code without mentioning Java package references explicitly.
+
+For example, `org.eclipse.swt.graphics.Color` can be referenced as just `Color`
+
+The Java packages imported come from the [`Glimmer::Config.import_swt_packages`](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/lib/ext/glimmer/config.rb) config option, which defaults to `Glimmer::Config::DEFAULT_IMPORT_SWT_PACKAGES`, importing the following Java packages:
+```
+org.eclipse.swt.*
+org.eclipse.swt.widgets.*
+org.eclipse.swt.layout.*
+org.eclipse.swt.graphics.*
+org.eclipse.swt.browser.*
+org.eclipse.swt.custom.*
+org.eclipse.swt.dnd.*
+```
+
+If you need to import additional Java packages as extra Glimmer widgets, you may add more packages to [`Glimmer::Config.import_swt_packages`](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/lib/ext/glimmer/config.rb) by using the `+=` operator (or alternatively limit to certain packages via `=` operator).
+
+Example:
+
+```ruby
+Glimmer::Config.import_swt_packages += [
+  'org.eclipse.nebula.widgets.ganttchart'
+]
+```
+
+Another alternative is to simply add a `java_import` call to your code (e.g. `java_import 'org.eclipse.nebula.widgets.ganttchart.GanttChart'`). Glimmer will automatically take advantage of it (e.g. when invoking `gantt_chart` keyword)
+
+Nonetheless, you can disable automatic Java package import if needed via this Glimmer configuration option:
+
+```ruby
+Glimmer::Config.import_swt_packages = false
+```
+
+Once disabled, to import SWT Java packages manually, you may simply:
+
+1. `include Glimmer::SWT::Packages`: lazily imports all SWT Java packages to your class, lazy-loading SWT Java class constants on first reference.
+
+2. `java_import swt_package_class_string`: immediately imports a specific Java class where `swt_package_class_string` is the Java full package reference of a Java class (e.g. `java_import 'org.eclipse.swt.SWT'`)
+
+Note: Glimmer relies on [`nested_imported_jruby_include_package`](https://github.com/AndyObtiva/nested_inherited_jruby_include_package), which automatically brings packages to nested-modules/nested-classes and sub-modules/sub-classes.
+
+You can learn more about importing Java packages into Ruby code at this JRuby WIKI page:
+
+https://github.com/jruby/jruby/wiki/CallingJavaFromJRuby
+
+### loop_max_count
+
+Glimmer has infinite loop detection support.
+It can detect when an infinite loop is about to occur in method_missing and stops it.
+It detects potential infinite loops when the same keyword and args repeat more than 100 times, which is unusual in a GUI app.
+
+The max limit can be changed via the `Glimmer::Config::loop_max_count=(count)` config option.
+
+Infinite loop detection may be disabled altogether if needed by setting `Glimmer::Config::loop_max_count` to `-1`
+
+### excluded_keyword_checkers
+
+Glimmer permits consumers to exclude keywords from DSL processing by its engine via the `excluded_keyword_checkers` config option.
+
+To do so, add a proc to it that returns a boolean indicating if a keyword is excluded or not.
+
+Note that this proc runs within the context of the Glimmer object (as in the object mixing in the Glimmer module), so checker can can pretend to run there with its `self` object assumption.
+
+Example of keywords excluded by [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt):
+
+```ruby
+Glimmer::Config.excluded_keyword_checkers << lambda do |method_symbol, *args|
+  method = method_symbol.to_s
+  result = false
+  result ||= method.start_with?('on_swt_') && is_a?(Glimmer::UI::CustomWidget) && respond_to?(method)
+  result ||= method == 'dispose' && is_a?(Glimmer::UI::CustomWidget) && respond_to?(method)
+  result ||= ['drag_source_proxy', 'drop_target_proxy'].include?(method) && is_a?(Glimmer::UI::CustomWidget)
+  result ||= method == 'post_initialize_child'
+  result ||= method.end_with?('=')
+  result ||= ['finish_edit!', 'search', 'all_tree_items', 'depth_first_search'].include?(method) && is_a?(Glimmer::UI::CustomWidget) && body_root.respond_to?(method)
+end
+```
+
+### log_excluded_keywords
+
+(default = false)
+
+This just tells Glimmer whether to log excluded keywords or not (at the debug level). It is off by default.
+
+### auto_sync_exec
+
+(default = false)
+
+This automatically uses sync_exec on GUI calls from threads other than the main GUI thread instead of requiring users to manually use sync_exec. Default value to false.
+
+Keep in mind the caveat that it would force redraws on every minor changein the models instead of applying large scope changes all together, thus causing too much drawing/stutter in the GUI. As such, this is a good fit for simpler GUIs, not ones used with highly sophisticated 2D graphics. It may be mitigated in the future by introducing the idea of large-scale observation events that wrap around smaller events. Until then, keep the caveat in mind or just use sync_exec manually as usually done with Java SWT apps.
+
+## License
+
+[MIT](LICENSE.txt)
+
+Copyright (c) 2007-2021 - Andy Maleh.

data/docs/reference/GLIMMER_GIRB.md

@@ -0,0 +1,30 @@
+## Girb (Glimmer irb) Command
+
+With `glimmer-dsl-swt` installed, you may want to run `girb` instead of standard `irb` to have SWT preloaded and the Glimmer library required and included for quick Glimmer coding/testing.
+
+```
+girb
+```
+
+![GIRB](/images/glimmer-girb.png)
+
+If you cloned [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) project locally, you may run `bin/girb` instead.
+
+```
+bin/girb
+```
+
+Watch out for hands-on examples in this README indicated by "you may copy/paste in [`girb`](#girb-glimmer-irb-command)"
+
+Keep in mind that all samples live under [https://github.com/AndyObtiva/glimmer-dsl-swt/samples](https://github.com/AndyObtiva/glimmer-dsl-swt/samples)
+
+If you need a more GUI interactive option to experiement with Glimmer GUI DSL Syntax, you may try:
+- [Glimmer Meta-Sample (The Sample of Samples)](#samples): allows launching Glimmer samples and viewing/editing code to learn/experiment too.
+- ["Ugliest Editor Ever"](https://github.com/AndyObtiva/glimmer-cs-gladiator)
+- Just build your own GUI editor using the [Glimmer DSL for SWT Ruby Gem](https://rubygems.org/gems/glimmer-dsl-swt).
+
+## License
+
+[MIT](LICENSE.txt)
+
+Copyright (c) 2007-2021 - Andy Maleh.

data/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md

@@ -0,0 +1,3251 @@
+## Glimmer GUI DSL Syntax
+
+This guide should help you get started with Glimmer DSL for SWT. For more advanced SWT details, please refer to the [SWT Reference](/README.md#swt-reference).
+
+Glimmer's core is a GUI DSL with a lightweight visual syntax that makes it easy to visualize the nesting of widgets in the GUI hierarchy tree.
+
+It is available through mixing in the `Glimmer` module, which makes [Glimmer GUI DSL Keywords](#glimmer-gui-dsl-keywords) available to both the instance scope and class scope:
+
+```ruby
+include Glimmer
+```
+
+For example, here is the basic "Hello, World!" sample code (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+include Glimmer
+
+shell {
+  text "Glimmer"
+  label {
+    text "Hello, World!"
+  }
+}.open
+```
+
+The `include Glimmer` declaration on top mixed the `Glimmer` module into the Ruby global main object making the Glimmer GUI DSL available at the top-level global scope.
+
+While this works well enough for mini-samples, it is better to isolate Glimmer in a class or module during production application development to create a clean separation between view code (GUI) and model code (business domain). Here is the "Hello, World!" sample re-written in a class to illustrate how mixing in the `Glimmer` module (via `include Glimmer`) makes the Glimmer GUI DSL available in both the instance scope and class scope. That is clearly demonstrated by pre-initializing a color constant in the class scope and building the GUI in the `#open` instance method (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+class HelloWorld
+  include Glimmer # makes the GUI DSL available in both the class scope and instance scope
+  
+  COLOR_FOREGROUND_DEFAULT = rgb(255, 0, 0) # rgb is a GUI DSL keyword used in the class scope
+  
+  def open
+    # the following are GUI DSL keywords (shell, text, and label) used in the instance scope
+    shell {
+      text "Glimmer"
+      label {
+        text "Hello, World!"
+        foreground COLOR_FOREGROUND_DEFAULT
+      }
+    }.open
+  end
+end
+
+HelloWorld.new.open
+```
+
+This renders "Hello, World!" with a red foreground color:
+
+![Hello World Red Foreground Color](/images/glimmer-hello-world-red-foreground-color.png)
+
+The GUI DSL intentionally avoids overly verbose syntax, requiring as little declarative code as possible to describe what GUI to render, how to style it, and what properties to data-bind to the Models.
+
+As such, it breaks off from Ruby's convention of using `do end` for multi-line blocks, opting instead for the lightweight and visual `{ }` curly brace blocks everywhere inside the GUI DSL. More details about Glimmer's syntax conventions may be found in the [Glimmer Style Guide](GLIMMER_STYLE_GUIDE.md)
+
+Glimmer DSL syntax consists mainly of:
+- keywords (e.g. `table` for a table widget)
+- style/args (e.g. :multi as in `table(:multi)` for a multi-line selection table widget)
+- content (e.g. `{ table_column { text 'Name'} }` as in `table(:multi) { table_column { text 'name'} }` for a multi-line selection table widget with a table column having header text property `'Name'` as content)
+
+### DSL Auto-Expansion
+
+Glimmer supports a new and radical Ruby DSL concept called DSL Auto-Expansion. To explain, let's first mention the two types of Glimmer GUI DSL keywords: static and dynamic.
+
+Static keywords are pre-identified keywords in the Glimmer DSL, such as `shell`, `display`, `message_box`, `async_exec`, `sync_exec`, and `bind`.
+
+Dynamic keywords are dynamically figured out from currently imported (aka required/loaded) SWT widgets and custom widgets. Examples are: `label`, `combo`, and `list` for SWT widgets and `c_date_time`, `video`, and `gantt_chart` for custom widgets.
+
+The only reason to distinguish between the two is to realize that importing new Glimmer [custom widgets](#custom-widgets) and Java SWT custom widget libraries automatically expands Glimmer's DSL vocabulary with new dynamic keywords.
+
+For example, if a project adds this custom Java SWT library from the [Nebula Project](https://www.eclipse.org/nebula/):
+
+https://www.eclipse.org/nebula/widgets/gallery/gallery.php
+
+Glimmer will automatically support using the keyword `gallery`
+
+This is what DSL Auto-Expansion is.
+
+You will learn more about widgets next.
+
+### Widgets
+
+Glimmer GUIs (user interfaces) are modeled with widgets, which are wrappers around the SWT library widgets found here:
+
+https://www.eclipse.org/swt/widgets/
+
+This screenshot taken from the link above should give a glimpse of how SWT widgets look and feel:
+
+[![SWT Widgets](/images/glimmer-swt-widgets.png)](https://www.eclipse.org/swt/widgets/)
+
+In Glimmer DSL, widgets are declared with lowercase underscored names mirroring their SWT names minus the package name. For example, here are some Glimmer widgets and their SWT counterparts:
+
+- `shell` instantiates `org.eclipse.swt.widgets.Shell`
+- `text` instantiates `org.eclipse.swt.widgets.Text`
+- `button` instantiates `org.eclipse.swt.widgets.Button`
+- `label` instantiates `org.eclipse.swt.widgets.Label`
+- `composite` instantiates `org.eclipse.swt.widgets.Composite`
+- `tab_folder` instantiates `org.eclipse.swt.widgets.TabFolder`
+- `tab_item` instantiates `org.eclipse.swt.widgets.TabItem`
+- `table` instantiates `org.eclipse.swt.widgets.Table`
+- `table_column` instantiates `org.eclipse.swt.widgets.TableColumn`
+- `tree` instantiates `org.eclipse.swt.widgets.Tree`
+- `combo` instantiates `org.eclipse.swt.widgets.Combo`
+- `list` instantiates `org.eclipse.swt.widgets.List`
+
+Every **widget** is sufficiently declared by name, but may optionally be accompanied with:
+- SWT **style**/***arguments*** wrapped by parenthesis according to [Glimmer Style Guide](GLIMMER_STYLE_GUIDE.md) (see [next section](#widget-styles) for details).
+- Ruby block containing **content**, which may be **properties** (e.g. `enabled false`) or nested **widgets** (e.g. `table_column` nested inside `table`)
+
+For example, if we were to revisit `samples/hello/hello_world.rb` above (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+shell {
+  text "Glimmer"
+  label {
+    text "Hello, World!"
+  }
+}.open
+```
+
+Note that `shell` instantiates the outer shell **widget**, in other words, the window that houses all of the desktop graphical user interface.
+
+`shell` is then followed by a ***block*** that contains
+
+```ruby
+# ...
+  text "Glimmer" # text property of shell
+  label { # label widget declaration as content of shell
+    text "Hello, World!" # text property of label
+  }
+# ...
+```
+
+The first line declares a **property** called `text`, which sets the title of the shell (window) to `"Glimmer"`. **Properties** always have ***arguments*** (not wrapped by parenthesis according to [Glimmer Style Guide](GLIMMER_STYLE_GUIDE.md)), such as the text `"Glimmer"` in this case, and do **NOT** have a ***block*** (this distinguishes them from **widget** declarations).
+
+The second line declares the `label` **widget**, which is followed by a Ruby **content** ***block*** that contains its `text` **property** with value `"Hello, World!"`
+
+The **widget** ***block*** may optionally receive an argument representing the widget proxy object that the block content is for. This is useful in rare cases when the content code needs to refer to parent widget during declaration. You may leave that argument out most of the time and only add when absolutely needed.
+
+Example:
+
+```ruby
+shell {|shell_proxy|
+  #...
+}
+```
+
+Remember that The `shell` widget is always the outermost widget containing all others in a Glimmer desktop windowed application.
+
+After it is declared, a `shell` must be opened with the `#open` method, which can be called on the block directly as in the example above, or by capturing `shell` in a `@shell` variable (shown in example below), and calling `#open` on it independently (recommended in actual apps)
+
+```ruby
+@shell = shell {
+  # properties and content
+  # ...
+}
+@shell.open
+```
+
+It is centered upon initial display and has a minimum width of 130 (can be re-centered when needed with `@shell.center` method after capturing `shell` in a `@shell` variable as per samples)
+
+Check out the [samples](samples) directory for more examples.
+
+Example from [hello_tab.rb](samples/hello/hello_tab.rb) sample (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+![Hello Tab English](/images/glimmer-hello-tab-english.png)
+
+![Hello Tab French](/images/glimmer-hello-tab-french.png)
+
+```ruby
+shell {
+  text "Hello, Tab!"
+  tab_folder {
+    tab_item {
+      text "English"
+      label {
+        text "Hello, World!"
+      }
+    }
+    tab_item {
+      text "French"
+      label {
+        text "Bonjour Univers!"
+      }
+    }
+  }
+}.open
+```
+
+If you are new to Glimmer, you have learned enough to start running some [samples](#samples) directly or by reading through [Glimmer GUI DSL Keywords](#glimmer-gui-dsl-keywords) (which list each keyword's samples). Go ahead and run all Glimmer [samples](#samples), and come back to read the rest in any order you like since this material is more organized like a reference.
+
+If you are advanced and need more widgets, check out the [Nebula Project](https://www.eclipse.org/nebula/) for an extensive list of high quality custom widgets:
+
+https://www.eclipse.org/nebula/
+
+#### Glimmer GUI DSL Keywords
+
+This is not an exaustive list, but should give you a good start in learning Glimmer GUI DSL keywords, keeping in mind that the full list can be derived from the [SWT documentation](https://www.eclipse.org/swt/widgets/). More will be explained in the following sections.
+
+**Widgets:**
+- `button`: featured in [Hello, Checkbox!](#hello-checkbox) / [Hello, Button!](#hello-button) / [Hello, Table!](#hello-table) / [Hello, Radio Group!](#hello-radio-group) / [Hello, Radio!](#hello-radio) / [Hello, Message Box!](#hello-message-box) / [Hello, List Single Selection!](#hello-list-single-selection) / [Hello, List Multi Selection!](#hello-list-multi-selection) / [Hello, Group!](#hello-group) / [Hello, Combo!](#hello-combo) / [Hello, Checkbox Group!](#hello-checkbox-group) / [Contact Manager](#contact-manager) / [Tic Tac Toe](#tic-tac-toe) / [Login](#login)
+- `browser`: featured in [Hello, Browser!](#hello-browser)
+- `calendar`: featured in [Hello, Date Time!](#hello-date-time)
+- `checkbox`: featured in [Hello, Checkbox Group!](#hello-checkbox-group) / [Hello, Checkbox!](#hello-checkbox)
+- `checkbox_group`: featured in [Hello, Checkbox Group!](#hello-checkbox-group)
+- `combo`: featured in [Hello, Table!](#hello-table) / [Hello, Combo!](#hello-combo)
+- `composite`: featured in [Hello, Radio!](#hello-radio) / [Hello, Computed!](#hello-computed) / [Hello, Checkbox!](#hello-checkbox) / [Tic Tac Toe](#tic-tac-toe) / [Login](#login) / [Contact Manager](#contact-manager)
+- `date`: featured in [Hello, Table!](#hello-table) / [Hello, Date Time!](#hello-date-time) / [Hello, Custom Shell!](#hello-custom-shell) / [Tic Tac Toe](#tic-tac-toe)
+- `date_drop_down`: featured in [Hello, Table!](#hello-table) / [Hello, Date Time!](#hello-date-time)
+- `group`: featured in [Hello, Group!](#hello-group) / [Contact Manager](#contact-manager)
+- `label`: featured in [Hello, Computed!](#hello-computed) / [Hello, Checkbox Group!](#hello-checkbox-group) / [Hello, Checkbox!](#hello-checkbox) / [Hello, World!](#hello-world) / [Hello, Table!](#hello-table) / [Hello, Tab!](#hello-tab) / [Hello, Radio Group!](#hello-radio-group) / [Hello, Radio!](#hello-radio) / [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu) / [Hello, Menu Bar!](#hello-menu-bar) / [Hello, Date Time!](#hello-date-time) / [Hello, Custom Widget!](#hello-custom-widget) / [Hello, Custom Shell!](#hello-custom-shell) / [Contact Manager](#contact-manager) / [Login](#login)
+- `list` (w/ optional `:multi` SWT style): featured in [Hello, List Single Selection!](#hello-list-single-selection) / [Hello, List Multi Selection!](#hello-list-multi-selection) / [Contact Manager](#contact-manager)
+- `menu`: featured in [Hello, Menu Bar!](#hello-menu-bar) / [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu) / [Hello, Table!](#hello-table)
+- `menu_bar`: featured in [Hello, Menu Bar!](#hello-menu-bar)
+- `menu_item`: featured in [Hello, Table!](#hello-table) / [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu) / [Hello, Menu Bar!](#hello-menu-bar)
+- `message_box`: featured in [Hello, Table!](#hello-table) / [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu) / [Hello, Message Box!](#hello-message-box) / [Hello, Menu Bar!](#hello-menu-bar)
+- `radio`: featured in [Hello, Radio!](#hello-radio) / [Hello, Group!](#hello-group)
+- `radio_group`: featured in [Hello, Radio Group!](#hello-radio-group)
+- `scrolled_composite`
+- `shell`: featured in [Hello, Checkbox!](#hello-checkbox) / [Hello, Button!](#hello-button) / [Hello, Table!](#hello-table) / [Hello, Tab!](#hello-tab) / [Hello, Radio Group!](#hello-radio-group) / [Hello, Radio!](#hello-radio) / [Hello, List Single Selection!](#hello-list-single-selection) / [Hello, List Multi Selection!](#hello-list-multi-selection) / [Hello, Group!](#hello-group) / [Hello, Date Time!](#hello-date-time) / [Hello, Custom Shell!](#hello-custom-shell) / [Hello, Computed!](#hello-computed) / [Hello, Combo!](#hello-combo) / [Hello, Checkbox Group!](#hello-checkbox-group) / [Contact Manager](#contact-manager) / [Tic Tac Toe](#tic-tac-toe) / [Login](#login)
+- `tab_folder`: featured in [Hello, Tab!](#hello-tab)
+- `tab_item`: featured in [Hello, Tab!](#hello-tab)
+- `table`: featured in [Hello, Custom Shell!](#hello-custom-shell) / [Hello, Table!](#hello-table) / [Contact Manager](#contact-manager)
+- `table_column`: featured in [Hello, Table!](#hello-table) / [Hello, Custom Shell!](#hello-custom-shell) / [Contact Manager](#contact-manager)
+- `text`: featured in [Hello, Computed!](#hello-computed) / [Login](#login) / [Contact Manager](#contact-manager)
+- `time`: featured in [Hello, Table!](#hello-table) / [Hello, Date Time!](#hello-date-time)
+- Glimmer::UI::CustomWidget: ability to define any keyword as a custom widget - featured in [Hello, Custom Widget!](#hello-custom-widget)
+- Glimmer::UI::CustomShell: ability to define any keyword as a custom shell (aka custom window) that opens in a new browser window (tab) automatically unless there is no shell open in the current browser window (tab) - featured in [Hello, Custom Shell!](#hello-custom-shell)
+
+**Layouts:**
+- `grid_layout`: featured in [Hello, Custom Shell!](#hello-custom-shell) / [Hello, Computed!](#hello-computed) / [Hello, Table!](#hello-table) / [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu) / [Hello, Menu Bar!](#hello-menu-bar) / [Hello, List Single Selection!](#hello-list-single-selection) / [Hello, List Multi Selection!](#hello-list-multi-selection) / [Contact Manager](#contact-manager) / [Login](#login) / [Tic Tac Toe](#tic-tac-toe)
+- `row_layout`: featured in [Hello, Radio Group!](#hello-radio-group) / [Hello, Radio!](#hello-radio) / [Hello, Group!](#hello-group) / [Hello, Date Time!](#hello-date-time) / [Hello, Combo!](#hello-combo) / [Hello, Checkbox Group!](#hello-checkbox-group) / [Hello, Checkbox!](#hello-checkbox) / [Contact Manager](#contact-manager)
+- `fill_layout`: featured in [Hello, Custom Widget!](#hello-custom-widget)
+- `layout_data`: featured in [Hello, Table!](#hello-table) / [Hello, Custom Shell!](#hello-custom-shell) / [Hello, Computed!](#hello-computed) / [Tic Tac Toe](#tic-tac-toe) / [Contact Manager](#contact-manager)
+
+**Graphics/Style:**
+- `color`: featured in [Hello, Custom Widget!](#hello-custom-widget) / [Hello, Menu Bar!](#hello-menu-bar)
+- `font`: featured in [Hello, Checkbox Group!](#hello-checkbox-group) / [Hello, Checkbox!](#hello-checkbox) / [Hello, Table!](#hello-table) / [Hello, Radio Group!](#hello-radio-group) / [Hello, Radio!](#hello-radio) / [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu) / [Hello, Menu Bar!](#hello-menu-bar) / [Hello, Group!](#hello-group) / [Hello, Date Time!](#hello-date-time) / [Hello, Custom Widget!](#hello-custom-widget) / [Hello, Custom Shell!](#hello-custom-shell) / [Contact Manager](#contact-manager) / [Tic Tac Toe](#tic-tac-toe)
+- `Point` class used in setting location on widgets
+- `swt` and `SWT` class to set SWT styles on widgets - featured in [Hello, Custom Shell!](#hello-custom-shell) / [Login](#login) / [Contact Manager](#contact-manager)
+
+**Data-Binding/Observers:**
+- `bind`: featured in [Hello, Computed!](#hello-computed) / [Hello, Combo!](#hello-combo) / [Hello, Checkbox Group!](#hello-checkbox-group) / [Hello, Checkbox!](#hello-checkbox) / [Hello, Button!](#hello-button) / [Hello, Table!](#hello-table) / [Hello, Radio Group!](#hello-radio-group) / [Hello, Radio!](#hello-radio) / [Hello, List Single Selection!](#hello-list-single-selection) / [Hello, List Multi Selection!](#hello-list-multi-selection) / [Hello, Group!](#hello-group) / [Hello, Date Time!](#hello-date-time) / [Hello, Custom Widget!](#hello-custom-widget) / [Hello, Custom Shell!](#hello-custom-shell) / [Login](#login) / [Contact Manager](#contact-manager) / [Tic Tac Toe](#tic-tac-toe)
+- `observe`: featured in [Hello, Table!](#hello-table) / [Tic Tac Toe](#tic-tac-toe)
+- `on_widget_selected`: featured in [Hello, Combo!](#hello-combo) / [Hello, Checkbox Group!](#hello-checkbox-group) / [Hello, Checkbox!](#hello-checkbox) / [Hello, Button!](#hello-button) / [Hello, Table!](#hello-table) / [Hello, Radio Group!](#hello-radio-group) / [Hello, Radio!](#hello-radio) / [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu) / [Hello, Message Box!](#hello-message-box) / [Hello, Menu Bar!](#hello-menu-bar) / [Hello, List Single Selection!](#hello-list-single-selection) / [Hello, List Multi Selection!](#hello-list-multi-selection) / [Hello, Group!](#hello-group) / [Contact Manager](#contact-manager) / [Login](#login) / [Tic Tac Toe](#tic-tac-toe)
+- `on_modify_text`
+- `on_key_pressed` (and SWT alias `on_swt_keydown`) - featured in [Login](#login) / [Contact Manager](#contact-manager)
+- `on_key_released` (and SWT alias `on_swt_keyup`)
+- `on_mouse_down` (and SWT alias `on_swt_mousedown`)
+- `on_mouse_up` (and SWT alias `on_swt_mouseup`) - featured in [Hello, Custom Shell!](#hello-custom-shell) / [Contact Manager](#contact-manager)
+
+**Event loop:**
+- `display`: featured in [Tic Tac Toe](#tic-tac-toe)
+- `async_exec`: featured in [Hello, Custom Widget!](#hello-custom-widget) / [Hello, Custom Shell!](#hello-custom-shell)
+- `sync_exec`: executes a block on the event loop synchronously (usually from another thread)
+- `timer_exec`: executes a block after a delay of time has passed
+
+#### SWT Proxies
+
+Glimmer follows Proxy Design Pattern by having Ruby proxy wrappers for all SWT objects:
+- `Glimmer::SWT:WidgetProxy` wraps all descendants of `org.eclipse.swt.widgets.Widget` except the ones that have their own wrappers.
+- `Glimmer::SWT::ShellProxy` wraps `org.eclipse.swt.widgets.Shell`
+- `Glimmer::SWT:TabItemProxy` wraps `org.eclipse.swt.widget.TabItem` (also adds a composite to enable adding content under tab items directly in Glimmer)
+- `Glimmer::SWT:LayoutProxy` wraps all descendants of `org.eclipse.swt.widget.Layout`
+- `Glimmer::SWT:LayoutDataProxy` wraps all layout data objects
+- `Glimmer::SWT:DisplayProxy` wraps `org.eclipse.swt.widget.Display` (manages displaying GUI)
+- `Glimmer::SWT:ColorProxy` wraps `org.eclipse.swt.graphics.Color`
+- `Glimmer::SWT:FontProxy` wraps `org.eclipse.swt.graphics.Font`
+- `Glimmer::SWT::WidgetListenerProxy` wraps all widget listeners
+
+These proxy objects have an API and provide some convenience methods, some of which are mentioned below.
+
+##### swt_widget
+
+Glimmer SWT proxies come with the instance method `#swt_widget`, which returns the actual SWT `Widget` object wrapped by the Glimmer widget proxy. It is useful in cases you'd like to do some custom SWT programming outside of Glimmer.
+
+##### Shell widget proxy methods
+
+Shell widget proxy has extra methods specific to SWT Shell:
+- `#open`: Opens the shell, making it visible and active, and starting the SWT Event Loop (you may learn more about it here: https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Display.html). If shell was already open, but hidden, it makes the shell visible.
+- `#show`: Alias for `#open`
+- `#hide`: Hides a shell setting "visible" property to false
+- `#close`: Closes the shell
+- `#center`: Centers the shell within monitor it is in
+- `#start_event_loop`: (happens as part of `#open`) Starts SWT Event Loop (you may learn more about it here: https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Display.html). This method is not needed except in rare circumstances where there is a need to start the SWT Event Loop before opening the shell.
+- `#visible?`: Returns whether a shell is visible
+- `#opened_before?`: Returns whether a shell has been opened at least once before (additionally implying the SWT Event Loop has been started already)
+- `#visible=`: Setting to true opens/shows shell. Setting to false hides the shell.
+- `#pack`: Packs contained widgets using SWT's `Shell#pack` method
+- `#pack_same_size`: Packs contained widgets without changing shell's size when widget sizes change
+
+##### Widget Content Block
+
+Glimmer allows re-opening any widget and adding properties or extra content after it has been constructed already by using the `#content` method.
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+@shell = shell {
+  text "Application"
+  row_layout
+  @label1 = label {
+    text "Hello,"
+  }
+}
+@shell.content {
+  minimum_size 130, 130
+  label {
+    text "World!"
+  }
+}
+@label1.content {
+  foreground :red
+}
+@shell.open
+```
+
+##### Shell Icon
+
+To set the shell icon, simply set the `image` property under the `shell` widget. This shows up in the operating system toolbar and app-switcher (e.g. CMD+TAB) (and application window top-left corner in Windows)
+
+Example:
+
+```ruby
+shell {
+  # ...
+  image 'path/to/image.png'
+  # ...
+}
+```
+
+###### Shell Icon Tip for Packaging on Windows
+
+When setting shell icon for a [packaged](#packaging--distribution) app, which has a JAR file at its core, you can reference the `ico` file that ships with the app by going one level up (e.g. `'../AppName.ico'`)
+
+#### Dialog
+
+Dialog is a variation on Shell. It is basically a shell that is modal (blocks what's behind it) and belongs to another shell. It only has a close button.
+
+Glimmer facilitates building dialogs by using the `dialog` keyword, which automatically adds the SWT.DIALOG_TRIM and SWT.APPLICATION_MODAL [widget styles](#widget-styles) needed for a dialog.
+
+Check out [Hello, Dialog!](#hello-dialog) sample to learn more.
+
+##### message_box
+
+The Glimmer DSL `message_box` keyword is similar to `shell` and `dialog`, but renders a modal dialog with a title `text` property, main body `message` property, and dismissal button(s) only (OK button by default or [more options](https://www.eclipse.org/swt/javadoc.php)). It may also be opened via the `#open` method.
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+include Glimmer
+
+@shell = shell {
+  text 'Hello, Message Box!'
+  button {
+    text 'Please Click To Win a Surprise'
+    on_widget_selected {
+      message_box(@shell) {
+        text 'Surprise'
+        message "Congratulations!\n\nYou have won $1,000,000!"
+      }.open
+    }
+  }
+}
+@shell.open
+```
+
+![Hello Message Box Dialog](/images/glimmer-hello-message-box-dialog.png)
+
+It is also possible to use `message_box` even before instantiating the first `shell` ([Glimmer](https://rubygems.org/gems/glimmer) builds a throwaway `shell` parent automatically for it):
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+include Glimmer
+
+message_box {
+  text 'Greeting'
+  message "Hello, World!"
+}.open
+```
+
+#### Display
+
+The SWT `Display` class is a singleton in Glimmer. It is used in SWT to represent your display device, allowing you to manage GUI globally
+and access available monitors. Additionally, it is responsible for the SWT event loop, which runs on the first thread the Glimmer application starts on. In multi-threaded programming, `Display` provides the methods `async_exec` and `sync_exec` to enable enqueuing GUI changes asynchronously or synchronously from threads other than the main (first) thread since direct GUI changes are forbidden from other threads by design.
+
+`Display` is automatically instantiated upon first instantiation of a `shell` widget.
+
+Alternatively, for advanced use cases, a `Display` can be created explicitly with the Glimmer `display` keyword. When a `shell` is later declared, it
+automatically uses the `display` created earlier without having to explicitly hook it.
+
+```ruby
+@display = display {
+  cursor_location 300, 300
+  on_swt_keydown {
+    # ...
+  }
+  # ...
+}
+@shell = shell { # uses display created above
+}
+```
+The benefit of instantiating an SWT Display explicitly is to set [Properties](#widget-properties) or [Observers](#observer).
+Although SWT Display is not technically a widget, it has similar APIs and DSL support.
+
+#### Multi-Threading
+
+[JRuby](https://www.jruby.org/) supports [truly parallel multi-threading](https://github.com/jruby/jruby/wiki/Concurrency-in-jruby) since it relies on the JVM (Java Virtual Machine). As such, it enables development of highly-interactive desktop applications that can do background work while the user is interacting with the GUI. However, any code that interacts with the GUI from a thread other than the main (first) GUI thread must do so only through sync_exec (if it is standard synchronous code) or async_exec.
+
+##### async_exec
+
+`async_exec {}` is a Glimmer DSL keyword in addition to being a method on `display`. It accepts a block and when invoked, adds the block to the end of a queue of GUI events scheduled to run on the SWT event loop, executing asynchronously.
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```
+@shell = shell {
+  text 'Glimmer'
+  @label = label {
+    text 'Hello, World!'
+  }
+}
+
+Thread.new {
+  [:red, :dark_green, :blue].cycle { |color|
+    async_exec {
+      @label.content {
+        foreground color if @shell.visible?
+      }
+    }
+    sleep(1)
+  }
+}
+
+@shell.open
+```
+
+##### sync_exec
+
+`sync_exec {}` works just like `async_exec` except it executes the block synchronously at the earliest opportunity possible, waiting for the block to be finished.
+
+##### timer_exec
+
+`timer_exec(delay_in_milliseconds) {}` works just like `async_exec` except it executes the block after a delay has elapsed.
+
+#### Menus
+
+Glimmer DSL provides support for SWT Menu and MenuItem widgets.
+
+There are 2 main types of menus in SWT:
+- Menu Bar (shows up on top)
+- Pop Up Context Menu (shows up when right-clicking a widget)
+
+Underneath both types, there can be a 3rd menu type called Drop Down.
+
+Glimmer provides special support for Drop Down menus as it automatically instantiates associated Cascade menu items and wires together with proper parenting, swt styles, and calling setMenu.
+
+The ampersand symbol indicates the keyboard shortcut key for the menu item (e.g. '&Help' can be triggered on Windows by hitting ALT+H)
+
+Example of a Menu Bar (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+include Glimmer
+
+COLORS = [:white, :red, :yellow, :green, :blue, :magenta, :gray, :black]
+
+shell {
+  grid_layout {
+    margin_width 0
+    margin_height 0
+  }
+  
+  text 'Hello, Menu Bar!'
+  
+  @label = label(:center) {
+    font height: 50
+    text 'Check Out The Menu Bar Above!'
+  }
+  
+  menu_bar {
+    menu {
+      text '&File'
+      menu_item {
+        text '&New'
+        accelerator :command, :N
+        
+        on_widget_selected {
+          message_box {
+            text 'New'
+            message 'New file created.'
+          }.open
+        }
+      }
+      menu_item {
+        text '&Open...'
+        accelerator :command, :O
+        
+        on_widget_selected {
+          message_box {
+            text 'Open'
+            message 'Opening File...'
+          }.open
+        }
+      }
+      menu {
+        text 'Open &Recent'
+        menu_item {
+          text 'File 1'
+          on_widget_selected {
+            message_box {
+              text 'File 1'
+              message 'File 1 Contents'
+            }.open
+          }
+        }
+        menu_item {
+          text 'File 2'
+          on_widget_selected {
+            message_box {
+              text 'File 2'
+              message 'File 2 Contents'
+            }.open
+          }
+        }
+      }
+      menu_item(:separator)
+      menu_item {
+        text 'E&xit'
+        
+        on_widget_selected {
+          exit(0)
+        }
+      }
+    }
+    menu {
+      text '&Edit'
+      menu_item {
+        text 'Cut'
+        accelerator :command, :X
+      }
+      menu_item {
+        text 'Copy'
+        accelerator :command, :C
+      }
+      menu_item {
+        text 'Paste'
+        accelerator :command, :V
+      }
+    }
+    menu {
+      text '&Options'
+      
+      menu_item(:radio) {
+        text '&Enabled'
+        
+        on_widget_selected {
+          @select_one_menu.enabled = true
+          @select_multiple_menu.enabled = true
+        }
+      }
+      @select_one_menu = menu {
+        text '&Select One'
+        enabled false
+        
+        menu_item(:radio) {
+          text 'Option 1'
+        }
+        menu_item(:radio) {
+          text 'Option 2'
+        }
+        menu_item(:radio) {
+          text 'Option 3'
+        }
+      }
+      @select_multiple_menu = menu {
+        text '&Select Multiple'
+        enabled false
+        
+        menu_item(:check) {
+          text 'Option 4'
+        }
+        menu_item(:check) {
+          text 'Option 5'
+        }
+        menu_item(:check) {
+          text 'Option 6'
+        }
+      }
+    }
+    menu {
+      text '&Format'
+      menu {
+        text '&Background Color'
+        COLORS.each { |color_style|
+          menu_item(:radio) {
+            text color_style.to_s.split('_').map(&:capitalize).join(' ')
+            
+            on_widget_selected {
+              @label.background = color_style
+            }
+          }
+        }
+      }
+      menu {
+        text 'Foreground &Color'
+        COLORS.each { |color_style|
+          menu_item(:radio) {
+            text color_style.to_s.split('_').map(&:capitalize).join(' ')
+            
+            on_widget_selected {
+              @label.foreground = color_style
+            }
+          }
+        }
+      }
+    }
+    menu {
+      text '&View'
+      menu_item(:radio) {
+        text 'Small'
+        
+        on_widget_selected {
+          @label.font = {height: 25}
+          @label.parent.pack
+        }
+      }
+      menu_item(:radio) {
+        text 'Medium'
+        selection true
+        
+        on_widget_selected {
+          @label.font = {height: 50}
+          @label.parent.pack
+        }
+      }
+      menu_item(:radio) {
+        text 'Large'
+        
+        on_widget_selected {
+          @label.font = {height: 75}
+          @label.parent.pack
+        }
+      }
+    }
+    menu {
+      text '&Help'
+      menu_item {
+        text '&Manual'
+        accelerator :command, :shift, :M
+        
+        on_widget_selected {
+          message_box {
+            text 'Manual'
+            message 'Manual Contents'
+          }.open
+        }
+      }
+      menu_item {
+        text '&Tutorial'
+        accelerator :command, :shift, :T
+        
+        on_widget_selected {
+          message_box {
+            text 'Tutorial'
+            message 'Tutorial Contents'
+          }.open
+        }
+      }
+      menu_item(:separator)
+      menu_item {
+        text '&Report an Issue...'
+        
+        on_widget_selected {
+          message_box {
+            text 'Report an Issue'
+            message 'Reporting an issue...'
+          }.open
+        }
+      }
+    }
+  }
+}.open
+```
+
+Example of a Pop Up Context Menu (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+include Glimmer
+
+shell {
+  grid_layout {
+    margin_width 0
+    margin_height 0
+  }
+  
+  text 'Hello, Pop Up Context Menu!'
+  
+  label {
+    text "Right-Click on the Text to\nPop Up a Context Menu"
+    font height: 50
+    
+    menu {
+      menu {
+        text '&History'
+        menu {
+          text '&Recent'
+          menu_item {
+            text 'File 1'
+            on_widget_selected {
+              message_box {
+                text 'File 1'
+                message 'File 1 Contents'
+              }.open
+            }
+          }
+          menu_item {
+            text 'File 2'
+            on_widget_selected {
+              message_box {
+                text 'File 2'
+                message 'File 2 Contents'
+              }.open
+            }
+          }
+        }
+        menu {
+          text '&Archived'
+          menu_item {
+            text 'File 3'
+            on_widget_selected {
+              message_box {
+                text 'File 3'
+                message 'File 3 Contents'
+              }.open
+            }
+          }
+          menu_item {
+            text 'File 4'
+            on_widget_selected {
+              message_box {
+                text 'File 4'
+                message 'File 4 Contents'
+              }.open
+            }
+          }
+        }
+      }
+    }
+  }
+}.open
+```
+
+#### ScrolledComposite
+
+Glimmer provides smart defaults for the `scrolled_composite` widget by:
+- Automatically setting the nested widget as its content (meaning use can just like a plain old `composite` to add scrolling)
+- Automatically setting the :h_scroll and :v_scroll SWT styles (can be set manually if only one of either :h_scroll or :v_scroll is desired )
+- Automatically setting the expand horizontal and expand vertical SWT properties to `true`
+
+#### Sash Form Widget
+
+`sash_form` is an SWT built-in custom widget that provides a resizable sash that splits a window area into two or more panes.
+
+It can be customized with the `weights` attribute by setting initial weights to size the panes at first display.
+
+One noteworthy thing about the Glimmer implementation is that, unlike behavior in SWT, it allows declaring `weights` before the content of the `sash_form`, thus providing more natural and convenient syntax (Glimmer automatically takes care of sending that declaration to SWT at the end of declaring `sash_form` content as per the SWT requirements)
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+shell {
+  text 'Sash Form Example'
+  sash_form {
+    label {
+      text '(resize >>)'
+      background :dark_green
+      foreground :white
+      font height: 20
+    }
+    label {
+      text '(<< resize)'
+      background :red
+      foreground :white
+      font height: 20
+    }
+    weights 1, 2
+  }
+}.open
+```
+
+You may check out a more full-fledged example in [Hello, Sash Form!](#hello-sash-form)
+
+![Hello Sash Form](/images/glimmer-hello-sash-form.png)
+
+#### Browser Widget
+
+![Hello Browser](/images/glimmer-hello-browser.png)
+
+Glimmer supports the SWT Browser widget, which can load URLs or render HTML. It can even be instrumented with JavaScript when needed (though highly discouraged since it defeats the purpose of using Ruby except in very rare cases like leveraging a pre-existing web codebase in a desktop app).
+
+Example loading a URL (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+shell {
+  minimum_size 1024, 860
+  browser {
+    url 'http://brightonresort.com/about'
+  }
+}.open
+```
+
+Example rendering HTML with JavaScript on document ready (you may copy/paste in [`girb`](GLIMMER_GIRB.md) provided you install and require [glimmer-dsl-xml gem](https://github.com/AndyObtiva/glimmer-dsl-xml)):
+
+```ruby
+shell {
+  minimum_size 130, 130
+  @browser = browser {
+    text html {
+      head {
+        meta(name: "viewport", content: "width=device-width, initial-scale=2.0")
+      }
+      body {
+        h1 { "Hello, World!" }
+      }
+    }
+    on_completed { # on load of the page execute this JavaScript
+      @browser.swt_widget.execute("alert('Hello, World!');")
+    }
+  }
+}.open
+```
+
+### Widget Styles
+
+SWT widgets receive `SWT` styles in their constructor as per this guide:
+
+https://wiki.eclipse.org/SWT_Widget_Style_Bits
+
+Glimmer DSL facilitates that by passing symbols representing `SWT` constants as widget method arguments (i.e. inside widget `()` parentheses according to [Glimmer Style Guide](GLIMMER_STYLE_GUIDE.md). See example below) in lower case version (e.g. `SWT::MULTI` becomes `:multi`).
+
+These styles customize widget look, feel, and behavior.
+
+Example:
+
+```ruby
+# ...
+list(:multi) { # SWT styles go inside ()
+  # ...
+}
+# ...
+```
+Passing `:multi` to `list` widget enables list element multi-selection.
+
+```ruby
+# ...
+composite(:border) { # SWT styles go inside ()
+  # ...
+}
+# ...
+```
+Passing `:border` to `composite` widget ensures it has a border.
+
+When you need to pass in **multiple SWT styles**, simply separate by commas.
+
+Example:
+
+```ruby
+# ...
+text(:center, :border) { # Multiple SWT styles separated by comma
+  # ...
+}
+# ...
+```
+
+Glimmer ships with SWT style **smart defaults** so you wouldn't have to set them yourself most of the time (albeit you can always override them):
+
+- `text(:border)`
+- `table(:border, :virtual, :full_selection)`
+- `tree(:border, :virtual, :v_scroll, :h_scroll)`
+- `spinner(:border)`
+- `list(:border, :v_scroll)`
+- `button(:push)`
+
+You may check out all available `SWT` styles here:
+
+https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
+
+#### Explicit SWT Style Bit
+
+When building a widget-related SWT object manually (e.g. `GridData.new(...)`), you are expected to use `SWT::CONSTANT` directly or BIT-OR a few SWT constants together like `SWT::BORDER | SWT::V_SCROLL`.
+
+Glimmer facilitates that with `swt` keyword by allowing you to pass multiple styles as an argument array of symbols instead of dealing with BIT-OR.
+Example:
+
+```ruby
+style = swt(:border, :v_scroll)
+```
+
+#### Negative SWT Style Bits
+
+In rare occasions, you might need to apply & with a negative (not) style bit to negate it from another style bit that includes it.
+Glimmer facilitates that by declaring the negative style bit via postfixing a symbol with `!`.
+
+Example:
+
+```ruby
+style = swt(:shell_trim, :max!) # creates a shell trim style without the maximize button (negated)
+```
+
+#### Extra SWT Styles
+
+##### Non-resizable Window
+
+SWT Shell widget by default is resizable. To make it non-resizable, one must pass a complicated style bit concoction like `swt(:shell_trim, :resize!, :max!)`.
+
+Glimmer makes this easier by alternatively ing a `:no_resize` extra SWT style, added for convenience.
+This makes declaring a non-resizable window as easy as:
+
+```ruby
+shell(:no_resize) {
+  # ...
+}
+```
+
+### Widget Properties
+
+Widget properties such as text value, enablement, visibility, and layout details are set within the widget block using methods matching SWT widget property names in lower snakecase. You may refer to SWT widget guide for details on available widget properties:
+
+https://help.eclipse.org/2019-12/topic/org.eclipse.platform.doc.isv/guide/swt_widgets_controls.htm?cp=2_0_7_0_0
+
+
+Code examples:
+
+```ruby
+# ...
+label {
+  text "Hello, World!" # SWT properties go inside {} block
+}
+# ...
+```
+
+In the above example, the `label` widget `text` property was set to "Hello, World!".
+
+```ruby
+# ...
+button {
+  enabled bind(@tic_tac_toe_board.box(row, column), :empty)
+}
+# ...
+```
+
+In the above example, the `text` widget `enabled` property was data-bound to `#empty` method on `@tic_tac_toe_board.box(row, column)` (learn more about data-binding below)
+
+#### Color
+
+Colors make up a subset of widget properties. SWT accepts color objects created with RGB (Red Green Blue) or RGBA (Red Green Blue Alpha). Glimmer supports constructing color objects using the `rgb` and `rgba` DSL keywords.
+
+Example:
+
+```ruby
+# ...
+label {
+  background rgb(144, 240, 244)
+  foreground rgba(38, 92, 232, 255)
+}
+# ...
+```
+
+SWT also supports standard colors available as constants under the `SWT` namespace with the `COLOR_` prefix (e.g. `SWT::COLOR_BLUE`)
+
+Glimmer supports constructing colors for these constants as lowercase Ruby symbols (with or without `color_` prefix) passed to `color` DSL keyword
+
+Example:
+
+```ruby
+# ...
+label {
+  background color(:black)
+  foreground color(:yellow)
+}
+label {
+  background color(:color_white)
+  foreground color(:color_red)
+}
+# ...
+```
+
+You may check out all available standard colors in `SWT` over here (having `COLOR_` prefix):
+
+https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
+
+
+##### `#swt_color`
+
+Glimmer color objects come with an instance method `#swt_color` that returns the actual SWT `Color` object wrapped by the Glimmer color object. It is useful in cases you'd like to do some custom SWT programming outside of Glimmer.
+
+Example:
+
+```ruby
+color(:black).swt_color # returns SWT Color object
+```
+
+#### Font
+
+Fonts are represented in Glimmer as a hash of name, height, and style keys.
+
+The style can be one (or more) of 3 values: `:normal`, `:bold`, and `:italic`
+
+Example:
+
+```ruby
+# ...
+label {
+  font name: 'Arial', height: 36, style: :normal
+}
+# ...
+```
+
+Keys are optional, so some of them may be left off.
+When passing multiple styles, they are included in an array.
+
+Example:
+
+```ruby
+# ...
+label {
+  font style: [:bold, :italic]
+}
+# ...
+```
+
+You may simply use the standalone `font` keyword without nesting in a parent if there is a need to build a Font object to use in manual SWT programming outside of widget font property setting.
+
+Example:
+
+```ruby
+@font = font(name: 'Arial', height: 36, style: :normal)
+```
+
+### Image
+
+The `image` keyword creates an instance of [org.eclipse.swt.graphics.Image](https://help.eclipse.org/2020-09/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Image.html).
+
+It is a graphics `Image` object (not a widget), but is used used in setting the `image` property on `label` and `background_image` on `composite` (and subclasses)
+
+Glimmer recently included **EXPERIMENTAL** gif animation support for the `background_image` property on `composite' since SWT does not support animation by default. On Windows, it only works inside composites nested under standard shells, not ones that have the SWT styles :on_top or :no_trim
+
+Learn more about images in general at this SWT Image guide: https://www.eclipse.org/articles/Article-SWT-images/graphics-resources.html
+
+#### Image Options
+
+Options may be passed in a hash at the end of `image` arguments:
+
+- `width`: width of image
+- `height`: height of image
+
+If only the width or height alone are specified, the other is calculated while maintaining the image aspect ratio.
+
+Example:
+
+```
+label {
+  image 'someimage.png', width: 400, height: 300
+}
+```
+
+### Cursor
+
+SWT widget `cursor` property represents the mouse cursor you see on the screen when you hover over that widget.
+
+The `Display` class provides a way to obtain standard system cursors matching of the SWT style constants starting with prefix `CURSOR_` (e.g. `SWT::CURSOR_HELP` shows a question mark mouse cursor)
+
+Glimmer provides an easier way to obtain and set `cursor` property on a widget by simply mentioning the SWT style constant as an abbreviated symbol excluding the "CURSOR_" suffix.
+
+Example:
+
+```ruby
+shell {
+  minimum_size 128, 128
+  cursor :appstarting
+}
+```
+
+This sets the shell `cursor` to that of `SWT::CURSOR_APPSTARTING`
+
+### Layouts
+
+Glimmer lays widgets out visually using SWT layouts, which can only be set on composite widget and subclasses.
+
+The most common SWT layouts are:
+- `FillLayout`: lays widgets out in equal proportion horizontally or vertically with spacing/margin options. This is the ***default*** layout for ***shell*** (with `:horizontal` option) in Glimmer.
+- `RowLayout`: lays widgets out horizontally or vertically in varying proportions with advanced spacing/margin/justify options
+- `GridLayout`: lays widgets out in a grid with advanced spacing/margin/alignment/indentation options. This is the **default** layout for **composite** in Glimmer. It is important to master.
+
+In Glimmer DSL, just like widgets, layouts can be specified with lowercase underscored names followed by a block containing properties, also lowercase underscored names (e.g. `RowLayout` is `row_layout`).
+
+Example:
+
+```ruby
+# ...
+composite {
+  row_layout {
+    wrap true
+    pack false
+    justify true
+    type :vertical
+    margin_left 1
+    margin_top 2
+    margin_right 3
+    margin_bottom 4
+    spacing 5
+  }
+  # ... widgets follow
+}
+# ...
+```
+
+If you data-bind any layout properties, when they change, the shell containing their widget re-packs its children (calls `#pack` method automatically) to ensure proper relayout of all widgets.
+
+Alternatively, a layout may be constructed by following the SWT API for the layout object. For example, a `RowLayout` can be constructed by passing it an SWT style constant (Glimmer automatically accepts symbols (e.g. `:horizontal`) for SWT style arguments like `SWT::HORIZONTAL`.)
+
+```ruby
+# ...
+composite {
+  row_layout :horizontal
+  # ... widgets follow
+}
+# ...
+```
+
+Here is a more sophisticated example taken from [hello_computed.rb](samples/hello/hello_computed.rb) sample:
+
+![Hello Computed](/images/glimmer-hello-computed.png)
+
+```ruby
+shell {
+  text 'Hello, Computed!'
+  composite {
+    grid_layout {
+      num_columns 2
+      make_columns_equal_width true
+      horizontal_spacing 20
+      vertical_spacing 10
+    }
+    label {text 'First &Name: '}
+    text {
+      text bind(@contact, :first_name)
+      layout_data {
+        horizontal_alignment :fill
+        grab_excess_horizontal_space true
+      }
+    }
+    label {text '&Last Name: '}
+    text {
+      text bind(@contact, :last_name)
+      layout_data {
+        horizontal_alignment :fill
+        grab_excess_horizontal_space true
+      }
+    }
+    label {text '&Year of Birth: '}
+    text {
+      text bind(@contact, :year_of_birth)
+      layout_data {
+        horizontal_alignment :fill
+        grab_excess_horizontal_space true
+      }
+    }
+    label {text 'Name: '}
+    label {
+      text bind(@contact, :name, computed_by: [:first_name, :last_name])
+      layout_data {
+        horizontal_alignment :fill
+        grab_excess_horizontal_space true
+      }
+    }
+    label {text 'Age: '}
+    label {
+      text bind(@contact, :age, on_write: :to_i, computed_by: [:year_of_birth])
+      layout_data {
+        horizontal_alignment :fill
+        grab_excess_horizontal_space true
+      }
+    }
+  }
+}.open
+```
+
+Check out the samples directory for more advanced examples of layouts in Glimmer.
+
+**Defaults**:
+
+Glimmer composites always come with `grid_layout` by default, but you can still specify explicitly if you'd like to set specific properties on it.
+
+Glimmer shell always comes with `fill_layout` having `:horizontal` type.
+
+This is a great guide for learning more about SWT layouts:
+
+https://www.eclipse.org/articles/Article-Understanding-Layouts/Understanding-Layouts.htm
+
+Also, for a reference, check the SWT API:
+
+https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/index.html
+
+### Layout Data
+
+Layouts organize widgets following common rules for all widgets directly under a composite. But, what if a specific widget needs its own rules. That's where layout data comes into play.
+
+By convention, SWT layouts expect widgets to set layout data with a class matching their class name with the word "Data" replacing "Layout":
+- `GridLayout` on a composite demands `GridData` on contained widgets
+- `RowLayout` on a composite demands `RowData` on contained widgets
+
+Not all layouts support layout data to further customize widget layouts. For example, `FillLayout` supports no layout data.
+
+Unlike widgets and layouts in Glimmer DSL, layout data is simply specified with `layout_data` keyword nested inside a widget block body, and followed by arguments and/or a block of its own properties (lowercase underscored names).
+
+Glimmer automatically deduces layout data class name by convention as per rule above, with the assumption that the layout data class lives under the same exact Java package as the layout (one can set custom layout data that breaks convention if needed in rare cases. See code below for an example)
+
+Glimmer also automatically accepts symbols (e.g. `:fill`) for SWT style arguments like `SWT::FILL`.
+
+Examples:
+
+```ruby
+# ...
+composite {
+  row_layout :horizontal
+  label {
+    layout_data { # followed by properties
+      width 50
+      height 30
+    }
+  }
+  # ... more widgets follow
+}
+# ...
+```
+
+```ruby
+# ...
+composite {
+  grid_layout 3, false # grid layout with 3 columns not of equal width
+  label {
+    # layout data followed by arguments passed to SWT GridData constructor
+    layout_data :fill, :end, true, false
+  }
+}
+# ...
+```
+
+```ruby
+# ...
+composite {
+  grid_layout 3, false # grid layout with 3 columns not of equal width
+  label {
+    # layout data set explicitly via an object (helps in rare cases that break convention)
+    layout_data GridData.new(swt(:fill), swt(:end), true, false)
+  }
+}
+# ...
+```
+
+If you data-bind any layout data properties, when they change, the shell containing their widget re-packs its children (calls `#pack` method automatically) to ensure proper relayout of all widgets.
+
+**NOTE**: Layout data must never be reused between widgets. Always specify or clone again for every widget.
+
+This is a great guide for learning more about SWT layouts:
+
+https://www.eclipse.org/articles/Article-Understanding-Layouts/Understanding-Layouts.htm
+
+Also, for a reference, check the SWT API:
+
+https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/index.html
+
+
+### Canvas Shape DSL
+
+**(ALPHA FEATURE)**
+
+Glimmer supports drawing graphics directly on a `canvas` widget via SWT (or any widget for that matter though `canvas` is recommended for drawing).
+
+This is accomplished via the Shape DSL a sub-DSL of the Glimmer GUI DSL, which makes it possible to draw graphics declaratively with very understandable and maintainable syntax.
+
+Shape keywords and their args (including defaults) are listed below (they basically match method names and arguments on [org.eclipse.swt.graphics.GC](https://help.eclipse.org/2020-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/GC.html) minus the `draw` or `fill` prefix in downcase):
+- `arc(x, y, width, height, startAngle, arcAngle, fill: false)` arc is part of a circle within an oval area, denoted by start angle (degrees) and end angle (degrees)
+- `focus(x, y, width, height)` this is just like rectangle but its foreground color is always that of the OS widget focus color (useful when capturing user interaction via a shape)
+- `image(image, x, y)` [image](#image)
+- `line(x1, y1, x2, y2)` line
+- `oval(x, y, width, height, fill: false)` oval if width does not match heigh and circle if width matches height. Can be optionally filled.
+- `point(x, y)` point
+- `polygon(pointArray, fill: false)` polygon consisting of points, which close automatically to form a shape that can be optionally filled (when points only form a line, it does not show up as filled)
+- `polyline(pointArray)` polyline is just like a polygon, but it does not close up to form a shape, remaining open (unless the points close themselves by having the last point or an intermediate point match the first)
+- `rectangle(x, y, width, height, fill: false)` standard rectangle, which can be optionally filled
+- `rectangle(x, y, width, height, arcWidth = 60, arcHeight = 60, fill: false, round: true)` round rectangle, which can be optionally filled, and takes optional extra round angle arguments
+- `rectangle(x, y, width, height, vertical = true, fill: true, gradient: true)` gradient rectangle, which is always filled, and takes an optional extra argument to specify true for vertical gradient (default) and false for horizontal gradient
+- `text(string, x, y, flags = nil)` text with optional flags (flag format is `swt(comma_separated_flags)` where flags can be :draw_delimiter (i.e. new lines), :draw_tab, :draw_mnemonic, and :draw_transparent as explained in [GC API](https://help.eclipse.org/2020-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/GC.html))
+
+Shape keywords that can be filled with color can take an keyword argument `fill: true`. Defaults to false when not specified unless background is set with no foreground (or foreground is set with no background), in which case a smart default is applied.
+Smart defaults can be applied to automatically infer `gradient: true` (rectangle with both foreground and background) and `round: true` (rectangle with more than 4 args, the extra args are numeric) as well.
+
+Optionally, a shape keyword takes a block that can set any attributes from [org.eclipse.swt.graphics.GC](https://help.eclipse.org/2020-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/GC.html) (methods starting with `set`), which enable setting the `background` for filling and `foreground` for drawing.
+
+Here is a list of supported attributes nestable within a block under shapes:
+- `advanced` enables advanced graphics subsystem (boolean value). Typically gets enabled automatically when setting alpha, antialias, patterns, interpolation, clipping. Rendering sometimes differs between advanced and non-advanced mode for basic graphics too, so you could enable manually if you prefer its look even for basic graphics.
+- `alpha` sets transparency (integer between `0` and `255`)
+- `antialias` enables antialiasing (SWT style value of `:default`, `:off`, `:on` whereby `:default` applies OS default, which varies per OS)
+- `background` sets fill color for fillable shapes (standard color symbol (e.g. `:red`), `rgb(red_integer, green_integer, blue_integer)` color, or Color/ColorProxy object directly)
+- `background_pattern` sets fill gradient/image pattern for fillable shape background (takes the same arguments as the SWT [Pattern](https://help.eclipse.org/2020-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Pattern.html) class [e.g. `background_pattern 2.3, 4.2, 5.4, 7.2, :red, :blue`] / note: this feature isn't extensively tested yet)
+- `clipping` clips area of painting (numeric values for `(x, y, width, height)`)
+- `fill_rule` sets filling rule (SWT style value of `:fill_even_odd` or `:fill_winding`)
+- `font` sets font (Hash of `:name`, `:height`, and `:style` just like standard widget font property, or Font/FontProxy object directly)
+- `foreground` sets draw color for drawable shapes (standard color symbol (e.g. `:red`), `rgb(red_integer, green_integer, blue_integer)` color, or Color/ColorProxy object directly)
+- `foreground_pattern` sets foreground gradient/image pattern for drawable shape lines (takes the same arguments as the SWT [Pattern](https://help.eclipse.org/2020-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Pattern.html) class [e.g. `foreground_pattern 2.3, 4.2, 5.4, 7.2, :red, :blue`] / note: this feature isn't extensively tested yet)
+- `interpolation` sets the interpolation value (SWT style value of `:default`, `:none`, `:low`, `:high`)
+- `line_cap` sets line cap (SWT style value of `:cap_flat`, `:cap_round`, or `:cap_square`)
+- `line_dash` line dash float values (automatically sets `line_style` to SWT style value of `:line_custom`)
+- `line_join` line join style (SWT style value of `:join_miter`, `:join_round`, or `:join_bevel`)
+- `line_style` line join style (SWT style value of `:line_solid`, `:line_dash`, `:line_dot`, `:line_dashdot`, or `:line_dashdotdot`)
+- `line_width` line width in integer (used in draw operations)
+- `text_anti_alias` enables text antialiasing (SWT style value of `:default`, `:off`, `:on` whereby `:default` applies OS default, which varies per OS)
+- `transform` sets transform object using [Canvas Transform DSL](#canvas-transform-dsl) syntax
+
+Keep in mind that ordering of shapes matters as it is followed in painting. For example, it is recommended you paint filled shapes first and then drawn ones.
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+include Glimmer
+
+# image object has to be declared outside the canvas and shell to avoid confusing with canvas image property
+image_object = image(File.expand_path('./icons/scaffold_app.png'), width: 100)
+
+shell {
+  text 'Canvas Example'
+  minimum_size 320, 400
+
+  canvas {
+    background :dark_yellow
+    rectangle(0, 0, 220, 400) {
+      background :dark_red
+    }
+    rectangle(50, 20, 300, 150, 30, 50, round: true) {
+      background :yellow
+    }
+    rectangle(150, 200, 100, 70, true, gradient: true) {
+      background :dark_red
+      foreground :yellow
+    }
+    text('Glimmer', 208, 83) {
+      font height: 25, style: :bold
+    }
+    rectangle(200, 80, 108, 36) {
+      foreground :black
+      line_width 3
+    }
+    image(image_object, 70, 50)
+  }
+}.open
+```
+
+Screenshot:
+
+![Canvas Animation Example](/images/glimmer-example-canvas.png)
+
+Learn more at the [Hello, Canvas! Sample](#hello-canvas).
+
+If you get extremely stuck, remember that you could always default to direct [SWT GC usage]([org.eclipse.swt.graphics.GC](https://help.eclipse.org/2020-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/GC.html) and learn more at the [SWT Graphics Guide](https://www.eclipse.org/articles/Article-SWT-graphics/SWT_graphics.html) and [SWT Image Guide](https://www.eclipse.org/articles/Article-SWT-images/graphics-resources.html#Saving%20Images).
+
+Example of manually doing the same things as in the above example without relying on the declarative Glimmer Shape DSL:
+
+```ruby
+image_object = image(File.expand_path('./icons/scaffold_app.png'), width: 100)
+
+include Glimmer
+
+shell {
+  text 'Canvas Manual Example'
+  minimum_size 320, 400
+
+  canvas {
+    background :yellow
+    
+    on_paint_control { |event|
+      event.gc.set_background(color(:red).swt_color)
+      event.gc.fill_rectangle(0, 0, 220, 400)
+      
+      event.gc.set_background(color(:magenta).swt_color)
+      event.gc.fill_roundRectangle(50, 20, 300, 150, 30, 50)
+      
+      event.gc.set_background(color(:dark_magenta).swt_color)
+      event.gc.fill_gradientRectangle(150, 200, 100, 70, true)
+      
+      event.gc.set_foreground(color(:dark_blue).swt_color)
+      event.gc.draw_rectangle(200, 80, 108, 36)
+      
+      event.gc.set_foreground(color(:black).swt_color)
+      event.gc.set_lineWidth(3)
+      event.gc.draw_rectangle(200, 80, 108, 36)
+      
+      event.gc.draw_image(image_object.swt_image, 70, 50)
+    }
+  }
+}.open
+```
+
+In any case, if there is anything missing you would like added to the Glimmer Shape DSL that you saw available in the SWT APIs, you may [report an issue](https://github.com/AndyObtiva/glimmer-dsl-swt/issues) or implement yourself and [contribute](#contributing) via a [Pull Request](https://github.com/AndyObtiva/glimmer-dsl-swt/pulls).
+
+#### Shapes inside a Widget
+
+Keep in mind that the Shape DSL can be used inside any widget, not just `canvas`. Unlike shapes on a `canvas`, which are standalone graphics, when included in a widget, which already has its own look and feel, shapes are used as a decorative add-on that complements its look by getting painted on top of it. For example, shapes were used to decorate `composite` blocks in the [Tetris](#tetris) sample to have a more bevel look. In summary, Shapes can be used in a hybrid approach (shapes inside a widget), not just standalone in a `canvas`.
+
+#### Shapes inside an Image
+
+You can build an image using the Canvas Shape DSL (including setting the icon of the application).
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```
+include Glimmer
+
+shell {
+  text 'Image Shape DSL Example'
+  label {
+    bevel_constant = 20
+    icon_block_size = 64
+    icon_bevel_size = icon_block_size.to_f / 25.to_f
+    icon_bevel_pixel_size = 0.16*icon_block_size.to_f
+    icon_size = 8
+    icon_pixel_size = icon_block_size * icon_size
+    image(icon_pixel_size, icon_pixel_size) {
+      icon_size.times { |row|
+        icon_size.times { |column|
+          colored = row >= 1 && column.between?(1, 6)
+          color = colored ? color([:white, :red, :blue, :green, :yellow, :magenta, :cyan, :dark_blue].sample) : color(:white)
+          x = column * icon_block_size
+          y = row * icon_block_size
+          rectangle(x, y, icon_block_size, icon_block_size) {
+            background color
+          }
+          polygon(x, y, x + icon_block_size, y, x + icon_block_size - icon_bevel_pixel_size, y + icon_bevel_pixel_size, x + icon_bevel_pixel_size, y + icon_bevel_pixel_size) {
+            background rgb(color.red + 4*bevel_constant, color.green + 4*bevel_constant, color.blue + 4*bevel_constant)
+          }
+          polygon(x + icon_block_size, y, x + icon_block_size - icon_bevel_pixel_size, y + icon_bevel_pixel_size, x + icon_block_size - icon_bevel_pixel_size, y + icon_block_size - icon_bevel_pixel_size, x + icon_block_size, y + icon_block_size) {
+            background rgb(color.red - bevel_constant, color.green - bevel_constant, color.blue - bevel_constant)
+          }
+          polygon(x + icon_block_size, y + icon_block_size, x, y + icon_block_size, x + icon_bevel_pixel_size, y + icon_block_size - icon_bevel_pixel_size, x + icon_block_size - icon_bevel_pixel_size, y + icon_block_size - icon_bevel_pixel_size) {
+            background rgb(color.red - 2*bevel_constant, color.green - 2*bevel_constant, color.blue - 2*bevel_constant)
+          }
+          polygon(x, y, x, y + icon_block_size, x + icon_bevel_pixel_size, y + icon_block_size - icon_bevel_pixel_size, x + icon_bevel_pixel_size, y + icon_bevel_pixel_size) {
+            background rgb(color.red - bevel_constant, color.green - bevel_constant, color.blue - bevel_constant)
+          }
+        }
+      }
+    }
+  }
+}.open
+```
+
+![Image Shape DSL](/images/glimmer-example-image-shape-dsl.png)
+
+Example setting the icon of the application (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```
+include Glimmer
+
+shell {
+  text 'Image Shape DSL Example'
+  label {
+    text 'Image Shape DSL Example'
+    font height: 30
+  }
+  bevel_constant = 20
+  icon_block_size = 64
+  icon_bevel_size = icon_block_size.to_f / 25.to_f
+  icon_bevel_pixel_size = 0.16*icon_block_size.to_f
+  icon_size = 8
+  icon_pixel_size = icon_block_size * icon_size
+  image(icon_pixel_size, icon_pixel_size) {
+    icon_size.times { |row|
+      icon_size.times { |column|
+        colored = row >= 1 && column.between?(1, 6)
+        color = colored ? color([:white, :red, :blue, :green, :yellow, :magenta, :cyan, :dark_blue].sample) : color(:white)
+        x = column * icon_block_size
+        y = row * icon_block_size
+        rectangle(x, y, icon_block_size, icon_block_size) {
+          background color
+        }
+        polygon(x, y, x + icon_block_size, y, x + icon_block_size - icon_bevel_pixel_size, y + icon_bevel_pixel_size, x + icon_bevel_pixel_size, y + icon_bevel_pixel_size) {
+          background rgb(color.red + 4*bevel_constant, color.green + 4*bevel_constant, color.blue + 4*bevel_constant)
+        }
+        polygon(x + icon_block_size, y, x + icon_block_size - icon_bevel_pixel_size, y + icon_bevel_pixel_size, x + icon_block_size - icon_bevel_pixel_size, y + icon_block_size - icon_bevel_pixel_size, x + icon_block_size, y + icon_block_size) {
+          background rgb(color.red - bevel_constant, color.green - bevel_constant, color.blue - bevel_constant)
+        }
+        polygon(x + icon_block_size, y + icon_block_size, x, y + icon_block_size, x + icon_bevel_pixel_size, y + icon_block_size - icon_bevel_pixel_size, x + icon_block_size - icon_bevel_pixel_size, y + icon_block_size - icon_bevel_pixel_size) {
+          background rgb(color.red - 2*bevel_constant, color.green - 2*bevel_constant, color.blue - 2*bevel_constant)
+        }
+        polygon(x, y, x, y + icon_block_size, x + icon_bevel_pixel_size, y + icon_block_size - icon_bevel_pixel_size, x + icon_bevel_pixel_size, y + icon_bevel_pixel_size) {
+          background rgb(color.red - bevel_constant, color.green - bevel_constant, color.blue - bevel_constant)
+        }
+      }
+    }
+  }
+}.open
+```
+
+![Image Shape DSL](/images/glimmer-example-image-shape-dsl-app-switcher-icon.png)
+
+
+### Canvas Transform DSL
+
+**(ALPHA FEATURE)**
+
+The transform DSL builds [org.eclipse.swt.graphics.Transform](https://help.eclipse.org/2020-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Transform.html) objects with a nice declarative syntax.
+
+`transform` keyword builds a `Transform` object. It optionally takes the transformation matrix elements: (m11, m12, m21, m22, dx, dy)
+
+The first 2 values represent the 1st row, the second 2 values represent the 2nd row, and the last 2 values represent translation on the x and y axes
+
+Additionally, Transform operation keywords may be nested within the `transform` keyword to set its properties:
+- `identity` resets transform to identity (no transformation)
+- `invert` inverts a transform
+- `multiply(&block)` multiplies by another transform (takes a block representing properties of another transform, no need for using the word transform again)
+- `rotate(angle)` rotates by angle degrees
+- `scale(x, y)` scales a shape (stretch)
+- `shear(x, y)` shear effect
+- `translate(x, y)` translate x and y coordinates (move)
+- `elements(m11, m12, m21, m22, dx, dy)` resets all values of the transform matrix (first 2 values represent the 1st row, second 2 values represent the 2nd row, the last 2 values represent translation on x and y axes)
+ 
+Also, setting `transform` to `nil` after a previous `transform` has been set is like calling `identity`. It resets the transform.
+ 
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+include Glimmer
+
+shell {
+  text 'Canvas Transform Example'
+  minimum_size 330, 352
+  
+  canvas { |canvas_proxy|
+    background :white
+
+    text('glimmer', 0, 0) {
+      foreground :red
+      transform {
+        translate 220, 100
+        scale 2.5, 2.5
+        rotate 90
+      }
+    }
+    text('glimmer', 0, 0) {
+      foreground :dark_green
+      transform {
+        translate 0, 0
+        shear 2, 3
+        scale 2, 2
+      }
+    }
+    text('glimmer', 0, 0) {
+      foreground :blue
+      transform {
+        translate 0, 220
+        scale 3, 3
+      }
+    }
+  }
+}.open
+```
+
+![Canvas Transform Example](/images/glimmer-example-canvas-transform.png)
+
+#### Top-Level Transform Fluent Interface
+
+When using a transform at the top-level (outside of shell), you get a fluent interface to faciliate manual constructioni and use.
+
+Example:
+
+```ruby
+include Glimmer # make sure it is included in your class/module before using the fluent interface
+
+transform(1, 1, 4, 2, 2, 4).
+  multiply(1, 2, 3, 4,3,4).
+  scale(1, 2, 3, 4, 5, 6).
+  rotate(45).
+  scale(2, 4).
+  invert.
+  shear(2, 4).
+  translate(3, 7)
+```
+
+Learn more at the [Hello, Canvas Transform! Sample](#hello-canvas-transform).
+
+### Canvas Animation DSL
+
+**(EARLY ALPHA FEATURE)**
+
+(note: this is a very new feature of Glimmer. It may change a bit while getting battle tested. As always, you could default to basic SWT usage if needed.)
+
+Glimmer additionally provides built-in support for animations via a declarative Animation DSL, another sub-DSL of the Glimmer GUI DSL.
+
+Animations take advantage of multi-threading, automatically running each animation in its own independent thread of execution while updating the GUI asynchronously.
+
+Multiple simultaneous animations are supported by declaring an animation per `canvas` (or widget) parent.
+
+This example says it all (it moves a tiny red square across a blue background) (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+include Glimmer
+
+shell {
+  text 'Canvas Animation Example'
+  minimum_size 400, 400
+
+  canvas {
+    animation {
+      every 0.1
+      
+      frame { |index|
+        background rgb(index%100, index%100 + 100, index%55 + 200)
+        rectangle(index, index, 20, 20) {
+          background :red
+        }
+      }
+    }
+  }
+}.open
+```
+
+Screenshot:
+
+![Canvas Animation Example](/images/glimmer-example-canvas-animation.png)
+
+Keywords:
+- `animation` declares an animation under a canvas, which renders frames using a frame block indefinitely or finitely depending on (cycle_count/frame_count) properties
+- `every` specifies delay in seconds between every two frame renders
+- `frame` a block that can contain Shape DSL syntax that is rendered dynamically with variables calculated on the fly
+- `cycle` a property that takes an array to cycle into a second variable for the `frame` block
+- `cycle_count` an optional cycle count limit after which the animation stops
+- `frame_count` an optional frame count limit after which the animation stops
+- `started` a boolean indicating if the animation is started right away or stopped waiting for manual startup via `#start` method
+
+API of Animation Object (returned from `animation` keyword):
+- `#start` starts an animation that is indefinite or has never been started before (i.e. having `started: false` option). Otherwise, resumes a stopped animation that has not been completed.
+- `#stop` stops animation. Maintains progress when `frame_count`, `cycle_count`, or `duration_limit` are set and haven't finished. That way, if `#start` is called, animation resumes from where it stopped exactly to completion.
+- `#restart` restarts animation, restarting progress of `frame_count`, `cycle_count`, and `duration_limit` if set.
+- `#started?` returns whether animation started
+- `#stopped?` returns whether animation stopped
+- `#indefinite?` (alias `infinite?`) returns true if animation does not have `frame_count`, `cycle_count`, or `duration_limit`
+- `#finite?` returns true if animation has `frame_count`, `cycle_count` (with `cycle`), or `duration_limit`
+- `#frame_count_limited?` returns true if `frame_count` is specified
+- `#cycle_enabled?` returns true if `cycle` is specified
+- `#cycle_limited?` returns true if `cycle_count` is specified
+- `#duration_limited?` returns true if `duration_limit` is specified
+
+Learn more at the [Hello, Canvas Animation! Sample](#hello-canvas-animation).
+
+If there is anything missing you would like added to the Glimmer Animation DSL that you saw available in the SWT APIs, you may [report an issue](https://github.com/AndyObtiva/glimmer-dsl-swt/issues) or implement yourself and [contribute](#contributing) via a Pull Request.
+
+#### Animation via Data-Binding
+
+Animation could be alternatively implemented without the `animation` keyword through a loop that invokes model methods inside `sync_exec {}` (or `async_exec {}`), which indirectly cause updates to the GUI via data-binding.
+
+The [Glimmer Tetris](#glimmer-tetris) sample provides a good example of that.
+
+### Data-Binding
+
+Data-binding is done with `bind` command following widget property to bind and taking model and bindable attribute as arguments.
+
+#### General Examples
+
+`text bind(contact, :first_name)`
+
+This example binds the text property of a widget like `label` to the first name of a contact model.
+
+`text bind(contact, 'address.street')`
+
+This example binds the text property of a widget like `label` to the nested street of
+the address of a contact. This is called nested property data binding.
+
+`text bind(contact, 'address.street', on_read: :upcase, on_write: :downcase)`
+
+This example adds on the one above it by specifying converters on read and write of the model property, like in the case of a `text` widget. The text widget will then displays the street upper case and the model will store it lower case. When specifying converters, read and write operations must be symmetric (to avoid an infinite update loop between the widget and the model since the widget checks first if value changed before updating)
+
+`text bind(contact, 'address.street', on_read: lambda { |s| s[0..10] })`
+
+This example also specifies a converter on read of the model property, but via a lambda, which truncates the street to 10 characters only. Note that the read and write operations are assymetric. This is fine in the case of formatting data for a read-only widget like `label`
+
+`text bind(contact, 'address.street') { |s| s[0..10] }`
+
+This is a block shortcut version of the syntax above it. It facilitates formatting model data for read-only widgets since it's a very common view concern. It also saves the developer from having to create a separate formatter/presenter for the model when the view can be an active view that handles common simple formatting operations directly.
+
+`text bind(contact, 'address.street', read_only: true)
+
+This is read-ohly data-binding. It doesn't update contact.address.street when widget text property is changed.
+
+`text bind(contact, 'addresses[1].street')`
+
+This example binds the text property of a widget like `label` to the nested indexed address street of a contact. This is called nested indexed property data binding.
+
+`text bind(contact, :age, computed_by: :date_of_birth)`
+
+This example demonstrates computed value data binding whereby the value of `age` depends on changes to `date_of_birth`.
+
+`text bind(contact, :name, computed_by: [:first_name, :last_name])`
+
+This example demonstrates computed value data binding whereby the value of `name` depends on changes to both `first_name` and `last_name`.
+
+`text bind(contact, 'profiles[0].name', computed_by: ['profiles[0].first_name', 'profiles[0].last_name'])`
+
+This example demonstrates nested indexed computed value data binding whereby the value of `profiles[0].name` depends on changes to both nested `profiles[0].first_name` and `profiles[0].last_name`.
+
+Example from [samples/hello/hello_combo.rb](samples/hello_combo.rb) sample (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+#### Combo
+
+The `combo` widget provides a dropdown of options. By default, it also allows typing in a new option. To disable that behavior, you may use with the `:read_only` SWT style.
+
+When data-binding a `combo` widget, Glimmer can automatically deduce available options from data-bound model by convention: `{attribute_name}_options` method.
+
+![Hello Combo](/images/glimmer-hello-combo.png)
+
+![Hello Combo](/images/glimmer-hello-combo-expanded.png)
+
+```ruby
+class Person
+  attr_accessor :country, :country_options
+
+  def initialize
+    self.country_options=["", "Canada", "US", "Mexico"]
+    self.country = "Canada"
+  end
+
+  def reset_country
+    self.country = "Canada"
+  end
+end
+
+class HelloCombo
+  include Glimmer
+  def launch
+    person = Person.new
+    shell {
+      composite {
+        combo(:read_only) {
+          selection bind(person, :country)
+        }
+        button {
+          text "Reset"
+          on_widget_selected do
+            person.reset_country
+          end
+        }
+      }
+    }.open
+  end
+end
+
+HelloCombo.new.launch
+```
+
+`combo` widget is data-bound to the country of a person. Note that it expects the `person` object to have the `:country` attribute and `:country_options` attribute containing all available countries (aka options). Glimmer reads these attributes by convention.
+
+#### List
+
+Example from [samples/hello/hello_list_single_selection.rb](samples/hello_list_single_selection.rb) sample:
+
+![Hello List Single Selection](/images/glimmer-hello-list-single-selection.png)
+
+```ruby
+shell {
+  composite {
+    list {
+      selection bind(person, :country)
+    }
+    button {
+      text "Reset"
+      on_widget_selected do
+        person.reset_country
+      end
+    }
+  }
+}.open
+```
+
+`list` widget is also data-bound to the country of a person similarly to the combo widget. Not much difference here (the rest of the code not shown is the same).
+
+Nonetheless, in the next example, a multi-selection list is declared instead allowing data-binding of multiple selection values to the bindable attribute on the model.
+
+Example from [samples/hello/hello_list_multi_selection.rb](samples/hello_list_multi_selection.rb) sample (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+![Hello List Multi Selection](/images/glimmer-hello-list-multi-selection.png)
+
+```ruby
+class Person
+  attr_accessor :provinces, :provinces_options
+
+  def initialize
+    self.provinces_options=[
+      "",
+      "Quebec",
+      "Ontario",
+      "Manitoba",
+      "Saskatchewan",
+      "Alberta",
+      "British Columbia",
+      "Nova Skotia",
+      "Newfoundland"
+    ]
+    self.provinces = ["Quebec", "Manitoba", "Alberta"]
+  end
+
+  def reset_provinces
+    self.provinces = ["Quebec", "Manitoba", "Alberta"]
+  end
+end
+
+class HelloListMultiSelection
+  include Glimmer
+  def launch
+    person = Person.new
+    shell {
+      composite {
+        list(:multi) {
+          selection bind(person, :provinces)
+        }
+        button {
+          text "Reset"
+          on_widget_selected do
+            person.reset_provinces
+          end
+        }
+      }
+    }.open
+  end
+end
+
+HelloListMultiSelection.new.launch
+```
+
+The Glimmer code is not much different from above except for passing the `:multi` style to the `list` widget. However, the model code behind the scenes is quite different as it is a `provinces` array bindable to the selection of multiple values on a `list` widget. `provinces_options` contains all available province values just as expected by a single selection `list` and `combo`.
+
+Note that in all the data-binding examples above, there was also an observer attached to the `button` widget to trigger an action on the model, which in turn triggers a data-binding update on the `list` or `combo`. Observers will be discussed in more details in the [next section](#observer).
+
+You may learn more about Glimmer's data-binding syntax by reading the code under the [samples](samples) directory.
+
+#### Table
+
+The SWT Tree widget renders a multi-column data table, such as a contact listing or a sales report.
+
+To data-bind a Table, you need the main model, the collection property, and the text display attribute for each table column.
+
+This involves using the `bind` keyword mentioned above in addition to a special `column_properties` keyword that takes the table column text attribute methods.
+
+It assumes you have defined the table columns via `table_column` widget.
+
+Example:
+
+```ruby
+shell {
+  @table = table {
+    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)
+    on_mouse_up { |event|
+      @table.edit_table_item(event.table_item, event.column_index)
+    }
+  }
+}
+```
+
+The code above includes two data-bindings:
+- Table `items`, which first bind to the model collection property (group.people), and then maps each column property (name, age, adult) for displaying each table item column.
+- Table `selection`, which binds the single table item selected by the user to the attribute denoted by the `bind` keyword (or binds multiple table items selected for a table with `:multi` SWT style)
+- The `on_mouse_up` event handler invokes `@table.edit_table_item(event.table_item, event.column_index)` to start edit mode on the clicked table item cell, and then saves or cancel depending on whether the user hits ENTER or ESC once done editing (or focus-out after either making a change or not making any changes.)
+
+Additionally, Table `items` data-binding automatically stores each node model unto the SWT TableItem object via `setData` method. This enables things like searchability.
+
+The table widget in Glimmer is represented by a subclass of `WidgetProxy` called `TableProxy`.
+TableProxy includes a `search` method that takes a block to look for a table item.
+
+Example:
+
+```ruby
+found_array = @table.search { |table_item| table_item.getData == company.owner }
+```
+
+This finds a person. The array is a Java array. This enables easy passing of it to SWT `Table#setSelection` method, which expects a Java array of `TableItem` objects.
+
+To edit a table, you must invoke `TableProxy#edit_selected_table_item(column_index, before_write: nil, after_write: nil, after_cancel: nil)` or `TableProxy#edit_table_item(table_item, column_index, before_write: nil, after_write: nil, after_cancel: nil)`.
+This automatically leverages the SWT TableEditor custom class behind the scenes, displaying a text widget to the user to change the selected or
+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, storing model data in a database via ActiveRecord. As such, it's an excellent demonstration of how to use Glimmer DSL for SWT with a database.
+
+##### Table Sorting
+
+Glimmer automatically adds sorting support to the SWT `Table` widget.
+
+Check out the [Contact Manager](#contact-manager) sample for an example.
+You may click on any column and it will sort by ascending order first and descending if you click again.
+
+Glimmer automatic table sorting supports `String`, `Integer`, and `Float` columns out of the box as well as any column data that is comparable.
+
+In cases where data is nil, depending on the data-type, it is automatically converted to `Float` with `to_f`, `Integer` with `to_i`, or `String` with `to_s`.
+
+Should you have a special data type that could not be compared automatically, Glimmer s the following 3 alternatives for custom sorting:
+- `sort_property`: this may be set to an alternative property to the one data-bound to the table column. For example, a table column called 'adult', which returns `true` or `false` may be sorted with `sort_property :dob` instead. This also support multi-property (aka multi-column) sorting (e.g. `sort_property :dob, :name`).
+- `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:
+
+```ruby
+# ...
+  table {
+    table_column {
+      text 'Task'
+      width 120
+    }
+    table_column {
+      text 'Project'
+      width 120
+    }
+    table_column {
+      text 'Duration (hours)'
+      width 120
+      sort_property :duration_in_hours
+    }
+    table_column {
+      text 'Priority'
+      width 120
+      sort_by { |value| ['High', 'Medium', 'Low'].index(value) }
+    }
+    table_column {
+      text 'Start Date'
+      width 120
+      sort { |d1, d2| d1.to_date <=> d2.to_date }
+    }
+    additional_sort_properties :project_name, :duration_in_hours, :name
+    items bind(Task, :list), column_properties(:name, :project_name, :duration, :priority, :start_date)
+    # ...
+  }
+# ...
+```
+
+Here is an explanation of the example above:
+- Task and Project table columns are data-bound to the `:name` and `:project_name` properties and sorted through them automatically
+- Task Duration table column is data-bound to the `:duration` property, but sorted via the `:duration_in_hours` property instead
+- Task Priority table column has a custom sort_by block
+- Task Start Date table column has a custom sort comparator block
+- Additional (secondary) sort properties are applied when sorting by Task, Project, or Duration in the order specified
+
+`bind(model, :property, read_only_sort: true)` could be used with items to make sorting not propagate sorting changes to model.
+
+#### Tree
+
+The SWT Tree widget visualizes a tree data-structure, such as an employment or composition hierarchy.
+
+To data-bind a Tree, you need the root model, the children querying method, and the text display attribute on each child.
+
+This involves using the `bind` keyword mentioned above in addition to a special `tree_properties` keyword that takes the children and text attribute methods.
+
+Example:
+
+```ruby
+shell {
+  @tree = tree {
+    items bind(company, :owner), tree_properties(children: :coworkers, text: :name)
+    selection bind(company, :selected_coworker)
+  }
+}
+```
+
+The code above includes two data-bindings:
+- Tree `items`, which first bind to the root node (company.owner), and then dig down via `coworkers` `children` method, using the `name` `text` attribute for displaying each tree item.
+- Tree `selection`, which binds the single tree item selected by the user to the attribute denoted by the `bind` keyword
+
+Additionally, Tree `items` data-binding automatically stores each node model unto the SWT TreeItem object via `setData` method. This enables things like searchability.
+
+The tree widget in Glimmer is represented by a subclass of `WidgetProxy` called `TreeProxy`.
+TreeProxy includes a `depth_first_search` method that takes a block to look for a tree item.
+
+Example:
+
+```ruby
+found_array = @tree.depth_first_search { |tree_item| tree_item.getData == company.owner }
+```
+
+This finds the root node. The array is a Java array. This enables easy passing of it to SWT `Tree#setSelection` method, which expects a Java array of `TreeItem` objects.
+
+To edit a tree, you must invoke `TreeProxy#edit_selected_tree_item` or `TreeProxy#edit_tree_item`. This automatically leverages the SWT TreeEditor custom class behind the scenes, displaying
+a text widget to the user to change the selected or passed tree 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.
+
+#### DateTime
+
+`date_time` represents the SWT DateTime widget.
+
+Glimmer s the following alias keywords for it for convenience:
+- `date`: `date_time(:date)`
+- `date_drop_down`: `date_time(:date, :drop_down)`
+- `time`: `date_time(:time)`
+- `calendar`: `date_time(:calendar)`
+
+You can data-bind any of these properties:
+- `date_time bind(model, :property)`: produces a Ruby DateTime object
+- `date bind(model, :property)`: produces a Ruby Date object
+- `time bind(model, :property)`: produces a Ruby Time object
+- `year bind(model, :property)`: produces an integer
+- `month bind(model, :property)`: produces an integer
+- `day bind(model, :property)`: produces an integer
+- `hours bind(model, :property)`: produces an integer
+- `minutes bind(model, :property)`: produces an integer
+- `seconds bind(model, :property)`: produces an integer
+
+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 the `Observer` mixin 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. In bidirectional data-binding, `Observer` is automatically unregistered from models once a widget is disposed to avoid memory leaks and worrying about managing them yourself.
+
+#### Observing Widgets
+
+Glimmer supports observing widgets with two main types of events:
+1. `on_{swt-listener-method-name}`: where {swt-listener-method-name} is replaced with the lowercase underscored event method name on an SWT listener class (e.g. `on_verify_text` for `org.eclipse.swt.events.VerifyListener#verifyText`).
+2. `on_swt_{swt-event-constant}`: where {swt-event-constant} is replaced with an [`org.eclipse.swt.SWT`](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html) event constant (e.g. `on_swt_show` for `SWT.Show` to observe when widget becomes visible)
+
+Additionally, there are two more types of events:
+- SWT `display` supports global listeners called filters that run on any widget. They are hooked via `on_swt_{swt-event-constant}`
+- SWT `display` supports Mac application menu item observers (`on_about` and `on_preferences`), which you can read about under [Miscellaneous](#miscellaneous).
+
+Number 1 is more commonly used in SWT applications, so make it your starting point. Number 2 covers events not found in number 1, so look into it if you don't find an SWT listener you need in number 1.
+
+**Regarding number 1**, to figure out what the available events for an SWT widget are, check out all of its `add***Listener` API methods, and then open the listener class argument to check its "event methods".
+
+For example, if you look at the `Button` SWT API:
+https://help.eclipse.org/2019-12/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fapi%2Forg%2Feclipse%2Fswt%2Fbrowser%2FBrowser.html
+
+It has `addSelectionListener`. Additionally, under its `Control` super class, it has `addControlListener`, `addDragDetectListener`, `addFocusListener`, `addGestureListener`, `addHelpListener`, `addKeyListener`, `addMenuDetectListener`, `addMouseListener`, `addMouseMoveListener`, `addMouseTrackListener`, `addMouseWheelListener`, `addPaintListener`, `addTouchListener`, and `addTraverseListener`
+
+Suppose, we select `addSelectionListener`, which is responsible for what happens when a user selects a button (clicks it). Then, open its argument `SelectionListener` SWT API, and you find the event (instance) methods: `widgetDefaultSelected` and `widgetSelected`. Let's select the second one, which is what gets invoked when a button is clicked.
+
+Now, Glimmer simplifies the process of hooking into that listener (observer) by neither requiring you to call the `addSelectionListener` method nor requiring you to implement/extend the `SelectionListener` API.
+
+Instead, simply add a `on_widget_selected` followed by a Ruby block containing the logic to perform. Glimmer figures out the rest.
+
+Let's revisit the Tic Tac Toe example shown near the beginning of the page:
+
+```ruby
+shell {
+  text "Tic-Tac-Toe"
+  minimum_size 150, 178
+  composite {
+    grid_layout 3, true
+    (1..3).each { |row|
+      (1..3).each { |column|
+        button {
+          layout_data :fill, :fill, true, true
+          text        bind(@tic_tac_toe_board[row, column], :sign)
+          enabled     bind(@tic_tac_toe_board[row, column], :empty)
+          on_widget_selected {
+            @tic_tac_toe_board.mark(row, column)
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+Note that every Tic Tac Toe grid cell has its `text` and `enabled` properties data-bound to the `sign` and `empty` attributes on the `TicTacToe::Board` model respectively.
+
+Next however, each of these Tic Tac Toe grid cells, which are clickable buttons, have an `on_widget_selected` observer, which once triggered, marks the cell on the `TicTacToe::Board` to make a move.
+
+**Regarding number 2**, you can figure out all available events by looking at the [`org.eclipse.swt.SWT`](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html) API:
+
+https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+`SWT.Show` - hooks a listener for showing a widget (using `on_swt_show` in Glimmer)
+`SWT.Hide` - hooks a listener for hiding a widget (using `on_swt_hide` in Glimmer)
+
+```ruby
+shell {
+  @button1 = button {
+    text "Show 2nd Button"
+    visible true
+    on_swt_show {
+      @button2.swt_widget.setVisible(false)
+    }
+    on_widget_selected {
+      @button2.swt_widget.setVisible(true)
+    }
+  }
+  @button2 = button {
+    text "Show 1st Button"
+    visible false
+    on_swt_show {
+      @button1.swt_widget.setVisible(false)
+    }
+    on_widget_selected {
+      @button1.swt_widget.setVisible(true)
+    }
+  }
+}.open
+```
+
+**Gotcha:** SWT.Resize event needs to be hooked using **`on_swt_Resize`** because [`org.eclipse.swt.SWT`](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html) has 2 constants for resize: `RESIZE` and `Resize`, so it cannot infer the right one automatically from the underscored version `on_swt_resize`
+
+##### Alternative Syntax
+
+Instead of declaring a widget observer using `on_***` syntax inside a widget content block, you may also do so after the widget declaration by invoking directly on the widget object.
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```
+@shell = shell {
+  label {
+    text "Hello, World!"
+  }
+}
+@shell.on_shell_iconified {
+  @shell.close
+}
+@shell.open
+```
+
+The shell declared above has been modified so that the minimize button works just like the close button. Once you minimize the shell (iconify it), it closes.
+
+The alternative syntax can be helpful if you prefer to separate Glimmer observer declarations from Glimmer GUI declarations, or would like to add observers dynamically based on some logic later on.
+
+#### Observing Models
+
+Glimmer DSL includes an `observe` keyword used to register an observer by passing in the observable and the property(ies) to observe, and then specifying in a block what happens on notification.
+
+```ruby
+class TicTacToe
+  include Glimmer
+
+  def initialize
+    # ...
+    observe(@tic_tac_toe_board, :game_status) { |game_status|
+      display_win_message if game_status == Board::WIN
+      display_draw_message if game_status == Board::DRAW
+    }
+  end
+  # ...
+end
+```
+
+Observers can be a good mechanism for displaying dialog messages in Glimmer (using SWT's [`MessageBox`](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/MessageBox.html) class).
+
+Look at [`samples/elaborate/tictactoe/tic_tac_toe.rb`](samples/tictactoe/tic_tac_toe.rb) for more details starting with the code included below.
+
+```ruby
+class TicTacToe
+  include Glimmer
+  include Observer
+
+  def initialize
+    # ...
+    observe(@tic_tac_toe_board, :game_status) { |game_status|
+      display_win_message if game_status == Board::WIN
+      display_draw_message if game_status == Board::DRAW
+    }
+  end
+
+  def display_win_message
+    display_game_over_message("Player #{@tic_tac_toe_board.winning_sign} has won!")
+  end
+
+  def display_draw_message
+    display_game_over_message("Draw!")
+  end
+
+  def display_game_over_message(message)
+    message_box(@shell) {
+      text 'Game Over'
+      message message_text
+    }.open
+    @tic_tac_toe_board.reset
+  end
+  # ...
+end
+```
+
+### Custom Widgets
+
+Custom widgets are brand new Glimmer DSL keywords that represent aggregates of existing widgets (e.g. `address_form`), customized existing widgets (e.g. `greeting_label`), or brand new widgets (e.g. `oscilloscope`)
+
+You can find out about [published Glimmer Custom Widgets](https://github.com/AndyObtiva/glimmer-dsl-swt#gem-listing) by running the `glimmer list:gems:customwidget` command
+
+Glimmer supports three ways of creating custom widgets with minimal code:
+1. Method-based Custom Widgets (for single-view-internal reuse): Extract a method containing Glimmer DSL widget syntax. Useful for quickly eliminating redundant code within a single view.
+2. Class-based Custom Widgets (for multiple-view-external reuse): Create a class that includes the `Glimmer::UI::CustomWidget` module and Glimmer DSL widget syntax in a `body {}` block. This will automatically extend Glimmer's DSL syntax with an underscored lowercase keyword matching the class name by convention. Useful in making a custom widget available in many views.
+
+Approach #1 is a casual Ruby-based approach. Approach #2 is the official Glimmer approach. Typically, when referring to Custom Widgets, we are talking about Class-based Custom Widgets.
+
+A developer might start with approach #1 to eliminate duplication in a view and later upgrade it to approach #2 when needing to export a custom widget to make it available in many views.
+
+Class-based Custom Widgets  a number of benefits over method-based custom widgets, such as built-in support for passing SWT style, nested block of extra widgets and properties, and `before_body`/`after_body` hooks.
+
+#### Simple Example
+
+##### Method-Based Custom Widget Example
+
+(you may copy/paste in [`girb`](GLIMMER_GIRB.md))
+
+Definition and usage in the same file:
+```ruby
+def red_label(label_text)
+  label {
+    text label_text
+    background :red
+  }
+end
+
+shell {
+  red_label('Red Label')
+}.open
+```
+
+##### Class-Based Custom Widget Example
+
+Simply create a new class that includes `Glimmer::UI::CustomWidget` and put Glimmer DSL code in its `#body` block (its return value is stored in `#body_root` attribute). Glimmer will then automatically recognize this class by convention when it encounters a keyword matching the class name converted to underscored lowercase (and namespace double-colons `::` replaced with double-underscores `__`)
+
+(you may copy/paste in [`girb`](GLIMMER_GIRB.md))
+
+Definition:
+```ruby
+class RedLabel
+  include Glimmer::UI::CustomWidget
+
+  body {
+    label(swt_style) {
+      background :red
+    }
+  }
+end
+```
+
+Usage:
+```ruby
+shell {
+  red_label(:center) {
+    text 'Red Label'
+    foreground :green
+  }
+}.open
+```
+
+As you can see, `RedLabel` became the Glimmer DSL keyword `red_label` and worked just like a standard label by taking in SWT style and nested properties. As such, it is a first-class citizen of the Glimmer GUI DSL.
+
+#### Custom Widget Lifecycle Hooks
+
+You may execute code before or after evaluating the body with these lifecycle hooks:
+- `before_body`: takes a block that executes in the custom widget instance scope before calling `body`. Useful for initializing variables to later use in `body`
+- `after_body`: takes a block that executes in the custom widget instance scope after calling `body`. Useful for setting up observers on widgets built in `body` (set in instance variables) and linking to other shells.
+
+#### Lifecycle Hooks Example
+
+(you may copy/paste in [`girb`](GLIMMER_GIRB.md))
+
+Definition:
+```ruby
+module Red
+  class Composite
+    include Glimmer::UI::CustomWidget
+
+    before_body {
+      @color = :red
+    }
+
+    body {
+      composite(swt_style) {
+        background @color
+      }
+    }
+  end
+end
+```
+
+Usage:
+```ruby
+shell {
+  red__composite {
+    label {
+      foreground :white
+      text 'This is showing inside a Red Composite'
+    }
+  }
+}.open
+```
+
+Notice how `Red::Composite` became `red__composite` with double-underscore, which is how Glimmer Custom Widgets signify namespaces by convention. Additionally, the `before_body` lifecycle hook was utilized to set a `@color` variable and use inside the `body`.
+
+Keep in mind that namespaces are not needed to be specified if the Custom Widget class has a unique name, not clashing with a basic SWT widget or another custom widget name.
+
+#### Custom Widget API
+
+Custom Widgets have the following attributes available to call from inside the `#body` method:
+- `#parent`: Glimmer object parenting custom widget
+- `#swt_style`: SWT style integer. Can be useful if you want to allow consumers to customize a widget inside the custom widget body
+- `#options`: a hash of options passed in parentheses when declaring a custom widget (useful for passing in model data) (e.g. `calendar(events: events)`). Custom widget class can declare option names (array) with `::options` class method as shown below, which generates attribute accessors for every option (not to be confused with `#options` instance method for retrieving options hash containing names & values)
+- `#content`: nested block underneath custom widget. It will be automatically called at the end of processing the custom widget body. Alternatively, the custom widget body may call `content.call` at the place where the content is needed to show up as shown in the following example.
+- `#body_root`: top-most (root) widget returned from `#body` method.
+- `#swt_widget`: actual SWT widget for `body_root`
+
+Additionally, custom widgets can call the following class methods:
+- `::options(*option_names)`: declares a list of options by taking an option name array (symbols/strings). This generates option attribute accessors (e.g. `options :orientation, :bg_color` generates `#orientation`, `#orientation=(v)`, `#bg_color`, and `#bg_color=(v)` attribute accessors)
+- `::option(option_name, default: nil)`: declares a single option taking option name and default value as arguments (also generates attribute accessors just like `::options`)
+
+#### Content/Options Example
+
+(you may copy/paste in [`girb`](GLIMMER_GIRB.md))
+
+Definition:
+```ruby
+class Sandwich
+  include Glimmer::UI::CustomWidget
+
+  options :orientation, :bg_color
+  option :fg_color, default: :black
+
+  body {
+    composite(swt_style) { # gets custom widget style
+      fill_layout orientation # using orientation option
+      background bg_color # using container_background option
+      label {
+        text 'SANDWICH TOP'
+      }
+      content.call # this is where content block is called
+      label {
+        text 'SANDWICH BOTTOM'
+      }
+    }
+  }
+end
+```
+
+Usage:
+```ruby
+shell {
+  sandwich(:no_focus, orientation: :vertical, bg_color: :red) {
+    label {
+      background :green
+      text 'SANDWICH CONTENT'
+    }
+  }
+}.open
+```
+
+Notice how `:no_focus` was the `swt_style` value, followed by the `options` hash `{orientation: :horizontal, bg_color: :white}`, and finally the `content` block containing the label with `'SANDWICH CONTENT'`
+
+#### Custom Widget Gotchas
+
+Beware of defining a custom attribute that is a common SWT widget property name.
+For example, if you define `text=` and `text` methods to accept a custom text and then later you write this body:
+
+```ruby
+# ...
+def text
+  # ...
+end
+
+def text=(value)
+  # ...
+end
+
+body {
+  composite {
+    label {
+      text "Hello"
+    }
+    label {
+      text "World"
+    }
+  }
+}
+# ...
+```
+
+The `text` method invoked in the custom widget body will call the one you defined above it. To avoid this gotcha, simply name the text property above something else, like `custom_text`.
+
+#### Built-In Custom Widgets
+
+##### Checkbox Group Custom Widget
+
+`checkbox_group` (or alias `check_group`) is a Glimmer built-in custom widget that displays a list of `checkbox` buttons (`button(:check)`) based on its `items` property.
+
+`checkbox_group` consists of a root `composite` (with `grid_layout 1, false` by default) that holds nested `checkbox` (`button(:check)`) widgets.
+
+The `selection` property determines which `checkbox` buttons are checked. It expects an `Array` of `String` objects
+The `selection_indices` property determines which `checkbox` button indices are checked. It expects an `Array` of index `Integer` objects that are zero-based.
+The `checkboxes` property returns the list of nested `checkbox` widgets.
+
+When data-binding `selection`, the model property should have a matching property with `_options` suffix (e.g. `activities_options` for `activities`) to provide an `Array` of `String` objects for `checkbox` buttons.
+
+You may see an example at the [Hello, Checkbox Group!](#hello-checkbox-group) sample.
+
+![Hello Checkbox Group](/images/glimmer-hello-checkbox-group.png)
+
+##### Radio Group Custom Widget
+
+`radio_group` is a Glimmer built-in custom widget that displays a list of `radio` buttons (`button(:radio)`) based on its `items` property, which expects an `Array` of `String` objects.
+
+`radio_group` consists of a root `composite` (with `grid_layout 1, false` by default) that holds nested `radio` widgets.
+
+The `selection` property determines which `radio` button is selected. It expects a `String`
+The `selection_index` property determines which `radio` button index is selected. It expects an index integer that is zero-based.
+The `radios` property returns the list of nested `radio` widgets.
+
+When data-binding `selection`, the model property should have a matching property with `_options` suffix (e.g. `country_options` for `country`) to provide text for `radio` buttons.
+
+This custom widget is used in the [Glimmer Meta-Sample (The Sample of Samples)](#samples):
+
+![Glimmer Meta-Sample](/images/glimmer-meta-sample.png)
+
+Glimmer Meta-Sample Code Example:
+
+```ruby
+# ...
+radio_group { |radio_group_proxy|
+  row_layout(:vertical) {
+    fill true
+  }
+  selection bind(sample_directory, :selected_sample_name)
+  font height: 24
+}
+
+# ...
+```
+
+You may see another example at the [Hello, Radio Group!](#hello-radio-group) sample.
+
+##### Code Text Custom Widget
+
+**(BETA FEATURE)**
+
+`code_text` is a Glimmer built-in custom widget that displays syntax highlighted Ruby code in a customized SWT [StyledText](https://help.eclipse.org/2020-09/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/custom/StyledText.html) widget.
+
+It is used in the [Glimmer Meta-Sample (The Sample of Samples)](#samples):
+
+![Glimmer Meta-Sample](/images/glimmer-meta-sample.png)
+
+Glimmer Meta-Sample Code Example:
+
+```ruby
+# ...
+@code_text = code_text {
+  text bind(SampleDirectory, 'selected_sample.code', read_only: true)
+  editable bind(SampleDirectory, 'selected_sample.editable')
+}
+# ...
+```
+
+To use, simply use `code_text` in place of the `text` or `styled_text` widget. If you set its `text` value to Ruby code, it automatically styles it with syntax highlighting.
+
+###### Options
+
+**lines**
+(default: `false`)
+
+Shows line numbers when set to true.
+
+If set to a hash like `{width: 4}`, it sets the initial width of the line numbers lane in character count (default: 4)
+
+Keep in mind that if the text grows and required a wider line numbers area, it grows automatically regardless of initial width.
+
+**theme**
+(default: `'glimmer'`)
+
+Changes syntax color highlighting theme. Can be one of the following:
+- glimmer
+- github
+- pastie
+
+**language**
+(default: `'ruby'`)
+
+Sets the code language, which can be one of the following [rouge gem](#https://rubygems.org/gems/rouge) supported languages:
+- abap
+- actionscript
+- ada
+- apache
+- apex
+- apiblueprint
+- apple_script
+- armasm
+- augeas
+- awk
+- batchfile
+- bbcbasic
+- bibtex
+- biml
+- bpf
+- brainfuck
+- brightscript
+- bsl
+- c
+- ceylon
+- cfscript
+- clean
+- clojure
+- cmake
+- cmhg
+- coffeescript
+- common_lisp
+- conf
+- console
+- coq
+- cpp
+- crystal
+- csharp
+- css
+- csvs
+- cuda
+- cypher
+- cython
+- d
+- dart
+- datastudio
+- diff
+- digdag
+- docker
+- dot
+- ecl
+- eex
+- eiffel
+- elixir
+- elm
+- email
+- epp
+- erb
+- erlang
+- escape
+- factor
+- fortran
+- freefem
+- fsharp
+- gdscript
+- ghc_cmm
+- ghc_core
+- gherkin
+- glsl
+- go
+- gradle
+- graphql
+- groovy
+- hack
+- haml
+- handlebars
+- haskell
+- haxe
+- hcl
+- hlsl
+- hocon
+- hql
+- html
+- http
+- hylang
+- idlang
+- igorpro
+- ini
+- io
+- irb
+- isbl
+- j
+- janet
+- java
+- javascript
+- jinja
+- jsl
+- json
+- json_doc
+- jsonnet
+- jsp
+- jsx
+- julia
+- kotlin
+- lasso
+- liquid
+- literate_coffeescript
+- literate_haskell
+- livescript
+- llvm
+- lua
+- lustre
+- lutin
+- m68k
+- magik
+- make
+- markdown
+- mason
+- mathematica
+- matlab
+- minizinc
+- moonscript
+- mosel
+- msgtrans
+- mxml
+- nasm
+- nesasm
+- nginx
+- nim
+- nix
+- objective_c
+- objective_cpp
+- ocaml
+- ocl
+- openedge
+- opentype_feature_file
+- pascal
+- perl
+- php
+- plain_text
+- plist
+- pony
+- postscript
+- powershell
+- praat
+- prolog
+- prometheus
+- properties
+- protobuf
+- puppet
+- python
+- q
+- qml
+- r
+- racket
+- reasonml
+- rego
+- rescript
+- robot_framework
+- ruby
+- rust
+- sas
+- sass
+- scala
+- scheme
+- scss
+- sed
+- shell
+- sieve
+- slice
+- slim
+- smalltalk
+- smarty
+- sml
+- solidity
+- sparql
+- sqf
+- sql
+- ssh
+- supercollider
+- swift
+- systemd
+- tap
+- tcl
+- terraform
+- tex
+- toml
+- tsx
+- ttcn3
+- tulip
+- turtle
+- twig
+- typescript
+- vala
+- varnish
+- vb
+- velocity
+- verilog
+- vhdl
+- viml
+- vue
+- wollok
+- xml
+- xojo
+- xpath
+- xquery
+- yaml
+- yang
+- zig
+
+**default_behavior**
+(default: true)
+
+This adds some default keyboard shortcuts:
+- CMD+A (CTRL+A on Windows/Linux) to select all
+- CTRL+A on Mac to jump to beginning of line
+- CTRL+E on Mac to jump to end of line
+
+If you prefer it to be vanilla with no default key event listeners, then pass the `default_behavior: false` option.
+
+Learn more at [Hello, Code Text!](#hello-code-text)
+
+##### Video Custom Custom Widget
+
+[![Video Widget](/images/glimmer-video-widget.png)](https://github.com/AndyObtiva/glimmer-cw-video)
+
+Glimmer supports a [video custom widget](https://github.com/AndyObtiva/glimmer-cw-video) not in SWT, which was originally a Glimmer built-in custom widget, but has been later extracted into its own [Ruby gem](https://rubygems.org/gems/glimmer-cw-video).
+
+Simply install the [glimmer-cw-video](https://rubygems.org/gems/glimmer-cw-video) gem.
+
+#### Custom Widget Final Notes
+
+This [Eclipse guide](https://www.eclipse.org/articles/Article-Writing%20Your%20Own%20Widget/Writing%20Your%20Own%20Widget.htm) for how to write custom SWT widgets is also applicable to Glimmer Custom Widgets written in Ruby. I recommend reading it:
+[https://www.eclipse.org/articles/Article-Writing%20Your%20Own%20Widget/Writing%20Your%20Own%20Widget.htm](https://www.eclipse.org/articles/Article-Writing%20Your%20Own%20Widget/Writing%20Your%20Own%20Widget.htm)
+
+Also, you may check out [Hello, Custom Widget!](#hello-custom-widget) for another example.
+
+### Custom Shells
+
+Custom shells are a kind of custom widgets that have shells only as the body root. They can be self-contained applications that may be opened and hidden/closed independently of the main app.
+
+They may also be chained in a wizard fashion.
+
+You can find out about [published Glimmer Custom Shells](https://github.com/AndyObtiva/glimmer-dsl-swt#gem-listing) by running the `glimmer list:gems:customshell` command
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+class WizardStep
+  include Glimmer::UI::CustomShell
+
+  options :number, :step_count
+
+  before_body {
+    @title = "Step #{number}"
+  }
+
+  body {
+    shell {
+      text "Wizard - #{@title}"
+      minimum_size 200, 100
+      fill_layout :vertical
+      label(:center) {
+        text @title
+        font height: 30
+      }
+      if number < step_count
+        button {
+          text "Go To Next Step"
+          on_widget_selected {
+            body_root.hide
+          }
+        }
+      end
+    }
+  }
+end
+
+shell { |app_shell|
+  text "Wizard"
+  minimum_size 200, 100
+  @current_step_number = 1
+  @wizard_steps = 5.times.map { |n|
+    wizard_step(number: n+1, step_count: 5) {
+      on_swt_hide {
+        if @current_step_number < 5
+          @current_step_number += 1
+          app_shell.hide
+          @wizard_steps[@current_step_number - 1].open
+        end
+      }
+    }
+  }
+  button {
+    text "Start"
+    font height: 40
+    on_widget_selected {
+      app_shell.hide
+      @wizard_steps[@current_step_number - 1].open
+    }
+  }
+}.open
+```
+
+If you use a Custom Shell as the top-level app shell, you may invoke the class method `::launch` instead to avoid building an app class yourself or including Glimmer into the top-level namespace (e.g. `Tetris.launch` instead of `include Glimmer; tetris.open`)
+
+You may check out [Hello, Custom Shell!](#hello-custom-shell) for another example.
+
+### Drag and Drop
+
+Glimmer s Drag and Drop support, thanks to [SWT](https://www.eclipse.org/swt/) and Glimmer's lightweight [DSL syntax](#glimmer-dsl-syntax).
+
+You may learn more about SWT Drag and Drop support over here: [https://www.eclipse.org/articles/Article-SWT-DND/DND-in-SWT.html](https://www.eclipse.org/articles/Article-SWT-DND/DND-in-SWT.html)
+
+To get started, simply follow these steps:
+1. On the drag source widget, add `on_drag_set_data` [DragSourceListener](https://help.eclipse.org/2020-03/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/dnd/DragSourceListener.html) event handler block at minimum (you may also add `on_drag_start` and `on_drag_finished` if needed)
+1. Set `event.data` to transfer via drag and drop inside the `on_drag_set_data` event handler block (defaults to `transfer` type of `:text`, as in a Ruby String)
+1. On the drop target widget, add `on_drop` [DropTargetListener](https://help.eclipse.org/2020-03/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/dnd/DropTargetListener.html) event handler block at minimum (you may also add `on_drag_enter` [must set [`event.detail`](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/dnd/DropTargetEvent.html#detail) if added], `on_drag_over`, `on_drag_leave`, `on_drag_operation_changed` and `on_drop_accept` if needed)
+1. Read `event.data` and consume it (e.g. change widget text) inside the `on_drop` event handler block.
+
+Example (taken from [samples/hello/hello_drag_and_drop.rb](#hello-drag-and-drop) / you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+class Location
+  attr_accessor :country
+  
+  def country_options
+    %w[USA Canada Mexico Columbia UK Australia Germany Italy Spain]
+  end
+end
+
+@location = Location.new
+
+include Glimmer
+
+shell {
+  text 'Hello, Drag and Drop!'
+  list {
+    selection bind(@location, :country)
+    on_drag_set_data { |event|
+      list = event.widget.getControl
+      event.data = list.getSelection.first
+    }
+  }
+  label(:center) {
+    text 'Drag a country here!'
+    font height: 20
+    on_drop { |event|
+      event.widget.getControl.setText(event.data)
+    }
+  }
+}.open
+```
+
+![Hello Drag and Drop](/images/glimmer-hello-drag-and-drop.gif)
+
+Optional steps:
+- Set a `transfer` property (defaults to `:text`). Values may be: :text (default), :html :image, :rtf, :url, and :file, or an array of multiple values. The `transfer` property will automatically convert your option into a [Transfer](https://help.eclipse.org/2020-03/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/dnd/Transfer.html) object as per the SWT API.
+- Specify `drag_source_style` operation (may be: :drop_copy (default), :drop_link, :drop_move, :drop_none, or an array of multiple operations)
+- Specify `drag_source_effect` (Check [DragSourceEffect](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/dnd/DragSourceEffect.html) SWT API for details)
+- Specify `drop_target_style` operation (may be: :drop_copy (default), :drop_link, :drop_move, :drop_none, or an array of multiple operations)
+- Specify `drop_target_effect` (Check [DropTargetEffect](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/dnd/DropTargetEffect.html) SWT API for details)
+- Set drag operation in `event.detail` (e.g. DND::DROP_COPY) inside `on_drag_enter`
+
+### Miscellaneous
+
+#### Multi-DSL Support
+
+Glimmer is a DSL engine that supports multiple DSLs (Domain Specific Languages):
+- [SWT](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (Desktop GUI)
+- [Opal](https://github.com/AndyObtiva/glimmer-dsl-opal): Glimmer DSL for Opal (Web GUI Adapter for Desktop Apps)
+- [XML](https://github.com/AndyObtiva/glimmer-dsl-xml): Glimmer DSL for XML (& HTML) - Useful with [SWT Browser Widget](#browser-widget)
+- [CSS](https://github.com/AndyObtiva/glimmer-dsl-css): Glimmer DSL for CSS (Cascading Style Sheets) - Useful with [SWT Browser Widget](#browser-widget)
+
+Glimmer automatically recognizes top-level keywords in each DSL and activates DSL accordingly. Glimmer allows mixing DSLs, which comes in handy when doing things like using the SWT Browser widget with XML and CSS. Once done processing a nested DSL top-level keyword, Glimmer switches back to the prior DSL automatically.
+
+##### SWT
+
+The SWT DSL was already covered in detail. However, for the sake of mixing DSLs, you need to know that the SWT DSL has the following top-level keywords:
+- `shell`
+- `display`
+- `color`
+- `observe`
+- `async_exec`
+- `sync_exec`
+
+##### Opal
+
+Full instructions are found in the [Opal](https://github.com/AndyObtiva/glimmer-dsl-opal) DSL page.
+
+The [Opal](https://github.com/AndyObtiva/glimmer-dsl-opal) DSL is simply a web GUI adapter for desktop apps written in Glimmer. As such, it supports all the DSL keywords of the SWT DSL and shares the same top-level keywords.
+
+##### XML
+
+Simply start with `html` keyword and add HTML inside its block using Glimmer DSL syntax.
+Once done, you may call `to_s`, `to_xml`, or `to_html` to get the formatted HTML output.
+
+Here are all the Glimmer XML DSL top-level keywords:
+- `html`
+- `tag`: enables custom tag creation for exceptional cases by passing tag name as '_name' attribute
+- `name_space`: enables namespacing html tags
+
+Element properties are typically passed as a key/value hash (e.g. `section(id: 'main', class: 'accordion')`) . However, for properties like "selected" or "checked", you must leave value `nil` or otherwise pass in front of the hash (e.g. `input(:checked, type: 'checkbox')` )
+
+Example (basic HTML / you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+@xml = html {
+  head {
+    meta(name: "viewport", content: "width=device-width, initial-scale=2.0")
+  }
+  body {
+    h1 { "Hello, World!" }
+  }
+}
+puts @xml
+```
+
+Output:
+
+```
+<html><head><meta name="viewport" content="width=device-width, initial-scale=2.0" /></head><body><h1>Hello, World!</h1></body></html>
+```
+
+Example (explicit XML tag / you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+puts tag(:_name => "DOCUMENT")
+```
+
+Output:
+
+```
+<DOCUMENT/>
+```
+
+Example (XML namespaces using `name_space` keyword / you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+@xml = name_space(:w3c) {
+  html(:id => "thesis", :class => "document") {
+    body(:id => "main") {
+    }
+  }
+}
+puts @xml
+```
+
+Output:
+
+```
+<w3c:html id="thesis" class="document"><w3c:body id="main"></w3c:body></w3c:html>
+```
+
+Example (XML namespaces using dot operator / you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+@xml = tag(:_name => "DOCUMENT") {
+  document.body(document.id => "main") {
+  }
+}
+puts @xml
+```
+
+Output:
+
+```
+<DOCUMENT><document:body document:id="main"></document:body></DOCUMENT>
+```
+
+##### CSS
+
+Simply start with `css` keyword and add stylesheet rule sets inside its block using Glimmer DSL syntax.
+Once done, you may call `to_s` or `to_css` to get the formatted CSS output.
+
+`css` is the only top-level keyword in the Glimmer CSS DSL
+
+Selectors may be specified by `s` keyword or HTML element keyword directly (e.g. `body`)
+Rule property values may be specified by `pv` keyword or underscored property name directly (e.g. `font_size`)
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+@css = css {
+  body {
+    font_size '1.1em'
+    pv 'background', 'white'
+  }
+  
+  s('body > h1') {
+    background_color :red
+    pv 'font-size', '2em'
+  }
+}
+puts @css
+```
+
+##### Listing / Enabling / Disabling DSLs
+
+Glimmer provides a number of methods on Glimmer::DSL::Engine to configure DSL support or inquire about it:
+- `Glimmer::DSL::Engine.dsls`: Lists available Glimmer DSLs
+- `Glimmer::DSL::Engine.disable_dsl(dsl_name)`: Disables a specific DSL. Useful when there is no need for certain DSLs in a certain application.
+- `Glimmer::DSL::Engine.disabled_dsls': Lists disabled DSLs
+- `Glimmer::DSL::Engine.enable_dsl(dsl_name)`: Re-enables disabled DSL
+- `Glimmer::DSL::Engine.enabled_dsls=(dsl_names)`: Disables all DSLs except the ones specified.
+
+#### Application Menu Items (About/Preferences)
+
+Mac applications always have About and Preferences menu items. Glimmer provides widget observer hooks for them on the `display`:
+- `on_about`: executes code when user selects App Name -> About
+- `on_preferences`: executes code when user selects App Name -> Preferences or hits 'CMD+,' on the Mac
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+class Example
+  def initialize
+    display {
+      on_about {
+        message_box(@shell_proxy) {
+          text 'About'
+          message 'About Application'
+        }.open
+      }
+      on_preferences {
+        preferences_dialog = dialog {
+          text 'Preferences'
+          row_layout {
+            type :vertical
+            margin_left 15
+            margin_top 15
+            margin_right 15
+            margin_bottom 15
+          }
+          label {
+            text 'Check one of these options:'
+          }
+          button(:radio) {
+            text 'Option 1'
+          }
+          button(:radio) {
+            text 'Option 2'
+          }
+        }
+        preferences_dialog.open
+      }
+    }
+    @shell_proxy = shell {
+      text 'Application Menu Items'
+      fill_layout {
+        margin_width 15
+        margin_height 15
+      }
+      label {
+        text 'Application Menu Items'
+        font height: 30
+      }
+    }
+    @shell_proxy.open
+  end
+end
+
+Example.new
+```
+
+#### App Name and Version
+
+Application name (shows up on the Mac in top menu bar) and version may be specified upon [packaging](#packaging--distribution) by specifying "-Bmac.CFBundleName" and "-Bmac.CFBundleVersion" options.
+
+Still, if you would like proper application name to show up on the Mac top menu bar during development, you may do so by invoking the SWT `Display.app_name=` method before any Display object has been instantiated (i.e. before any Glimmer widget like shell has been declared).
+
+Example (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+Display.app_name = 'Glimmer Demo'
+
+shell(:no_resize) {
+  text "Glimmer"
+  label {
+    text "Hello, World!"
+  }
+}.open
+```
+
+Also, you may invoke `Display.app_version = '1.0.0'` if needed for OS app version identification reasons during development, replacing `'1.0.0'` with your application version.
+
+#### Performance Profiling
+
+JRuby comes with built-in support for performance profiling via the `--profile` option (with some code shown below), which can be accepted by the `glimmer` command too:
+
+`glimmer --profile path_to_glimmer_app.rb`
+
+Additionally, add this code to monitor Glimmer app performance around its launch method:
+
+```ruby
+require 'jruby/profiler'
+profile_data = JRuby::Profiler.profile do
+  SomeGlimmerApp.launch
+end
+
+profile_printer = JRuby::Profiler::HtmlProfilePrinter.new(profile_data)
+ps = java.io.PrintStream.new(STDOUT.to_outputstream)
+```
+
+When monitoring app startup time performance, make sure to add a hook to the top-level `shell` `on_swt_show` event that exits the app as soon as the shell shows up to end performance profiling and get the results.
+
+Example:
+
+```ruby
+shell {
+  # some code
+  on_swt_show {
+    exit(0)
+  }
+}
+```
+
+You may run `glimmer` with the `--profile.graph` instead for a more detailed output.
+
+Learn more at the [JRuby Performance Profile WIKI page](https://github.com/jruby/jruby/wiki/Profiling-JRuby).
+
+##### SWT Browser Style Options
+
+The `browser` widget can use a particular desktop browser by setting the SWT Style to:
+- `:webkit`: use the Webkit browser engine
+- `:chromium`: use the Chromium browser engine
+
+Example using the Chromium browser (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
+
+```ruby
+shell {
+  minimum_size 1024, 860
+  browser(:chromium) {
+    url 'http://brightonresort.com/about'
+  }
+}.open
+```
+
+This relies on Glimmer's [Multi-DSL Support](#multi-dsl-support) for building the HTML text using [Glimmer XML DSL](https://github.com/AndyObtiva/glimmer-dsl-xml).
+
+## License
+
+[MIT](LICENSE.txt)
+
+Copyright (c) 2007-2021 - Andy Maleh.