swing_paradise 0.1.46

data/lib/swing_paradise/requires/require_the_project.rb

@@ -0,0 +1,15 @@
+# =========================================================================== #
+# require 'swing_paradise/requires/require_the_project.rb'
+# =========================================================================== #
+require 'swing_paradise/toplevel_methods/misc.rb'
+require 'swing_paradise/java_classes/jbutton/jbutton.rb'
+require 'swing_paradise/java_classes/jframe/jframe.rb'
+require 'swing_paradise/java_classes/jlabel/jlabel.rb'
+require 'swing_paradise/java_classes/jpanel/jpanel.rb'
+require 'swing_paradise/java_classes/jspinner/jspinner.rb'
+require 'swing_paradise/java_classes/jtextfield/jtextfield.rb'
+require 'swing_paradise/java_classes/jtextarea/jtextarea.rb'
+require 'swing_paradise/java_classes/jcombobox/jcombobox.rb'
+require 'swing_paradise/java_classes/jscrollpane/jscrollpane.rb'
+require 'swing_paradise/misc/misc.rb'
+require 'swing_paradise/base_module/base_module.rb'

data/lib/swing_paradise/toplevel_methods/misc.rb

@@ -0,0 +1,293 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'swing_paradise/toplevel_methods/misc.rb'
+# include SwingParadise
+# =========================================================================== #
+module SwingParadise
+
+  # ========================================================================= #
+  # === SwingParadise.set_global_font
+  # ========================================================================= #
+  def self.set_global_font(
+      font1 = Font.new('Hack', Font::PLAIN, 50)
+    )
+    UIManager.put('Button.font', font1)
+    UIManager.put('ToggleButton.font', font1)
+    UIManager.put('RadioButton.font', font1)
+    UIManager.put('CheckBox.font', font1)
+    UIManager.put('ColorChooser.font', font1)
+    UIManager.put('ComboBox.font', font1)
+    UIManager.put('Label.font', font1)
+    UIManager.put('List.font', font1)
+    UIManager.put('MenuBar.font', font1)
+    UIManager.put('MenuItem.font', font1)
+    UIManager.put('RadioButtonMenuItem.font', font1)
+    UIManager.put('CheckBoxMenuItem.font', font1)
+    UIManager.put('Menu.font', font1)
+    UIManager.put('PopupMenu.font', font1)
+    UIManager.put('OptionPane.font', font1)
+    UIManager.put('Panel.font', font1)
+    UIManager.put('ProgressBar.font', font1)
+    UIManager.put('ScrollPane.font', font1)
+    UIManager.put('Viewport.font', font1)
+    UIManager.put('TabbedPane.font', font1)
+    UIManager.put('Table.font', font1)
+    UIManager.put('TableHeader.font', font1)
+    UIManager.put('TextField.font', font1)
+    UIManager.put('PasswordField.font', font1)
+    UIManager.put('TextArea.font', font1)
+    UIManager.put('TextPane.font', font1)
+    UIManager.put('EditorPane.font', font1)
+    UIManager.put('TitledBorder.font', font1)
+    UIManager.put('ToolBar.font', font1)
+    UIManager.put('ToolTip.font', font1)
+    UIManager.put('Tree.font', font1)
+  end
+
+  # ========================================================================= #
+  # === SwingParadise.create_text_view
+  # ========================================================================= #
+  def self.create_text_view
+    return JTextArea.new
+  end
+
+  # ========================================================================= #
+  # === SwingParadise.is_left_mouse_button?
+  # ========================================================================= #
+  def self.is_left_mouse_button?(event)
+    javax.swing.SwingUtilities.isLeftMouseButton(event)
+  end
+
+  # ========================================================================= #
+  # === SwingParadise.create_image
+  #
+  # We can not use ImageIcon directly because this can then not be
+  # .add()-ed to a box, so we need to use a label, and then use
+  # .setIcon() on it instead.
+  # ========================================================================= #
+  def self.create_image(i)
+    label = JLabel.new
+    image_icon = ImageIcon.new(i)
+    label.setIcon(image_icon)
+    return label
+  end
+
+  # ========================================================================= #
+  # === SwingParadise.jruby_font
+  #
+  # This method should be equivalent to:
+  #
+  #   Font.new('Sans serif', Font::PLAIN, 28)
+  #
+  # It must also be able to deal with Symbols, such as :hack_25.
+  #
+  # Usage example:
+  #
+  #   LARGE_FONT = SwingParadise.jruby_font('Sans serif 28')
+  #
+  # ========================================================================= #
+  def self.jruby_font(
+      i            = 'Sans serif 28',
+      type_variant = Font::PLAIN, # This is the default font type to be used.
+      font_size    = 20
+    )
+    name_of_the_font = 'Sans serif'
+    if i.is_a? Symbol # Handle Symbols first.
+      splitted = i.to_s.split('_') # :hack_20 would now be ['hack','20'].
+      font_size = splitted.last.to_i # ['hack','20']
+      name_of_the_font = splitted.first.capitalize
+      i = nil # Short-circuit it here.
+    end
+    if i and i.respond_to?(:include?) and i.include?(' ')
+      splitted = i.split(' ') # i = 'Monospace 25'; splitted = i.split(' ')
+      font_size = splitted.last.to_i
+      name_of_the_font = splitted[0 .. -2].join(' ')
+    else
+      name_of_the_font = i
+    end
+    if i.is_a? Java::JavaAwt::Font
+      return i
+    end
+    return Font.new(name_of_the_font, type_variant, font_size)
+  end; self.instance_eval { alias font         jruby_font } # === SwingParadise.font
+       self.instance_eval { alias convert_font jruby_font } # === SwingParadise.convert_font
+
+  # ========================================================================= #
+  # === SwingParadise.button
+  # ========================================================================= #
+  def self.button(i = '')
+    require 'swing_paradise/java_classes/jbutton/jbutton.rb'
+    _ = javax.swing.JButton.new(i)
+    return _
+  end; self.instance_eval { alias create_button button } # === SwingParadise.create_button
+
+  # ========================================================================= #
+  # === quit_button
+  #
+  # This method can be used to quickly create a quit-button.
+  # ========================================================================= #
+  def quit_button
+    _ = SwingParadise.button('Quit')
+    _.on_event {|event|
+      System.exit(0)
+    }
+    return _
+  end
+
+  # ========================================================================= #
+  # === SwingParadise.jscroll_pane
+  #
+  # A JScrollPane provides a scrollable view of another widget. The
+  # JScrollPane manages a viewport, optional vertical and horizontal
+  # scroll bars, and optional row and column heading viewports.
+  # ========================================================================= #
+  def self.jscroll_pane(
+      child_widget,
+      vertical_scrollbar_policy   = :vertical_always,
+      horizontal_scrollbar_policy = :default
+    )
+    case vertical_scrollbar_policy
+    # ======================================================================= #
+    # === :vertical_always
+    # ======================================================================= #
+    when :vertical_always
+      vertical_scrollbar_policy = Java::JavaxSwing::ScrollPaneConstants::VERTICAL_SCROLLBAR_ALWAYS
+    end
+    case horizontal_scrollbar_policy
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      horizontal_scrollbar_policy = Java::JavaxSwing::ScrollPaneConstants::HORIZONTAL_SCROLLBAR_ALWAYS
+    # ======================================================================= #
+    # === :horizontal_never
+    # ======================================================================= #
+    when :horizontal_never
+      horizontal_scrollbar_policy = Java::JavaxSwing::ScrollPaneConstants::HORIZONTAL_SCROLLBAR_NEVER
+    end
+    JScrollPane.new(
+      child_widget,
+      vertical_scrollbar_policy,
+      horizontal_scrollbar_policy
+    )
+  end; self.instance_eval { alias scroll_pane             jscroll_pane } # === SwingParadise.scroll_pane
+       self.instance_eval { alias scrollpane              jscroll_pane } # === SwingParadise.scrollpane
+       self.instance_eval { alias scrolled_window         jscroll_pane } # === SwingParadise.scrolled_window
+       self.instance_eval { alias scrolling               jscroll_pane } # === SwingParadise.scrolling
+       self.instance_eval { alias created_scrolled_window jscroll_pane } # === SwingParadise.created_scrolled_window
+       self.instance_eval { alias create_scrolled_window  jscroll_pane } # === SwingParadise.create_scrolled_window
+
+  # ========================================================================= #
+  # === SwingParadise.entry
+  #
+  # Java Swing has two basic text components:
+  #
+  #   (1) JTextField, and
+  #   (2) JTextArea
+  #
+  # ========================================================================= #
+  def self.entry(
+      i                  = '',
+      optional_n_entries = nil
+    )
+    # require 'swing_paradise/java_classes/jtextarea/jtextarea.rb'
+    require 'swing_paradise/java_classes/jtextfield/jtextfield.rb'
+    if optional_n_entries
+      _ = javax.swing.JTextField.new(i, optional_n_entries) # JTextArea.new(i)
+    else
+      _ = javax.swing.JTextField.new(i) # JTextArea.new(i)
+    end
+    return _
+  end; self.instance_eval { alias create_entry entry } # === SwingParadise.create_entry
+
+  # ========================================================================= #
+  # === SwingParadise.vbox
+  #
+  # A vertical box.
+  # ========================================================================= #
+  def self.vbox
+    javax.swing.Box.createVerticalBox
+  end; self.instance_eval { alias create_vbox vbox } # === SwingParadise.create_vbox
+
+  # ========================================================================= #
+  # === SwingParadise.hbox
+  #
+  # A horizontal box.
+  # ========================================================================= #
+  def self.hbox(*optional_widgets)
+    optional_widgets.flatten!
+    _ = javax.swing.Box.createHorizontalBox
+    if optional_widgets and !optional_widgets.empty?
+      optional_widgets.each {|this_widget|
+        _.add(this_widget)
+      }
+    end
+    return _
+  end; self.instance_eval { alias create_hbox hbox } # === SwingParadise.create_hbox
+
+  # ========================================================================= #
+  # === SwingParadise.remove_html
+  #
+  # Usage example:
+  #
+  #   SwingParadise.remove_html('<one>two</three>')
+  #
+  # ========================================================================= #
+  def self.remove_html(i)
+    i.gsub(
+      %r{<[^>]+>},
+      ''
+    )
+  end
+
+  # ========================================================================= #
+  # === SwingParadise.text
+  #
+  # This method will return a JLabel instance.
+  # ========================================================================= #
+  def self.text(i = '')
+    _ = javax.swing.JLabel.new(i)
+    return _
+  end; self.instance_eval { alias label text } # === SwingParadise.label
+
+  # ========================================================================= #
+  # === swing_dimension
+  #
+  # This is a slight wrapper over java.awt.Dimension.
+  # ========================================================================= #
+  def swing_dimension(new_width, new_height)
+    java.awt.Dimension.new(new_width, new_height)
+  end
+
+  # ========================================================================= #
+  # === jcombobox
+  # ========================================================================= #
+  def jcombobox(i = nil)
+    combo_box = JComboBox.new
+    if i and i.respond_to?(:each)
+      i.each {|this_exam_topic|
+        combo_box.addItem(this_exam_topic)
+      }
+    end
+    return combo_box
+  end
+
+  # ========================================================================= #
+  # === text
+  # ========================================================================= #
+  def text(i = '')
+    return JLabel.new(i)
+  end; alias jtext text # === jtext
+
+  # ========================================================================= #
+  # === show_message_dialog
+  # ========================================================================= #
+  def show_message_dialog(
+      text = ''
+    )
+    javax.swing.JOptionPane.showMessageDialog(nil, text)
+  end
+
+end

data/lib/swing_paradise/version/version.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module SwingParadise
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.1.46'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UDPATE = '11.04.2024'
+
+end

data/lib/swing_paradise/widget_collection/README.md

@@ -0,0 +1,2 @@
+This directory may contain code that provides re-usable components,
+in jruby+SWING.

data/lib/swing_paradise/widget_collection/text_viewer.rb

@@ -0,0 +1,160 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === TextViewer
+#
+# Usage example:
+#
+#   TextViewer.new(ARGV)
+#
+# =========================================================================== #
+# require 'text_viewer.rb'
+# =========================================================================== #
+require 'swing_paradise/base_module/base_module.rb'
+
+module SwingParadise
+
+class TextViewer < JFrame # === SwingParadise::TextViewer
+
+  include ::SwingParadise::BaseModule
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 1400
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 1024
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    super()
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super() if respond_to?(:super)
+    # infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === create_the_menu                                            (menu tag)
+  # ========================================================================= #
+  def create_the_menu
+    @menu_bar = create_menu_bar
+    m1 = JMenu.new('Open a local file')
+    m1.use_this_font = :hack_28
+    m1.setMnemonic(KeyEvent::VK_A)
+
+    open_a_local_file_entrypoint = JMenuItem.new('Open a local file', KeyEvent::VK_T)
+    open_a_local_file_entrypoint.use_this_font = :hack_26
+    open_a_local_file_entrypoint.addActionListener {|event|
+      do_choose_a_local_file_then_read_it_in
+    }
+    m1 << open_a_local_file_entrypoint
+
+    @menu_bar << m1
+    m2 = JMenu.new('Help')
+    m2.use_this_font = :hack_28
+    @menu_bar.add(m2)
+    @menu_bar.use_this_font = :hack_30
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    create_the_menu
+    
+    frame = frame('Viewing the content of a file:')
+    panel = create_panel # This is an instance of Java::JavaxSwing::JPanel.
+    panel.use_this_font = :hack_40
+    frame << panel
+    panel.setLayout(BoxLayout.new(panel, BoxLayout::PAGE_AXIS)) # FlowLayout.new)
+    panel.hint = 'Table example'
+
+    # ======================================================================= #
+    # Put the editor pane in a scroll pane.
+    # ======================================================================= #
+    button1 = create_button
+    @text_view = create_text_view
+    @text_view.use_this_font = :hack_30
+    scroll_pane = scroll_pane(@text_view)
+    scroll_pane.vertical_scrollbar_always
+    scroll_pane.min_size(WIDTH, HEIGHT)
+    scroll_pane.pad10px
+    panel << scroll_pane
+    qbutton = quit_button # quit tag
+    qbutton.use_this_font = :hack_32
+    panel << qbutton
+
+    frame.menubar(@menu_bar)
+    frame.use_this_font = :hack_30
+    frame.exit_on_close
+    frame.set_size(WIDTH+100, 800)
+    frame.setLocationRelativeTo(nil)
+    check_commandline_arguments
+    frame.show_all
+  end
+
+  # ========================================================================= #
+  # === do_choose_a_local_file_then_read_it_in
+  # ========================================================================= #
+  def do_choose_a_local_file_then_read_it_in
+    file_chooser = JFileChooser.new # dialog tag.
+    file_chooser.use_this_font = :hack_38
+    # file_chooser.setFileSelectionMode(JFileChooser::DIRECTORIES_ONLY)
+    result = file_chooser.showOpenDialog(nil)
+    case result
+    when JFileChooser::APPROVE_OPTION
+      this_file = file_chooser.getSelectedFile.getAbsoluteFile.to_s
+      this_file = File.absolute_path(this_file)
+      read_in_this_file(this_file)
+    end
+  end
+
+  # ========================================================================= #
+  # === read_in_this_file
+  # ========================================================================= #
+  def read_in_this_file(i)
+    @text_view.set_text(File.read(i))
+  end
+
+  # ========================================================================= #
+  # === check_commandline_arguments
+  # ========================================================================= #
+  def check_commandline_arguments
+    commandline_arguments?.each {|entry|
+      if entry and File.file?(entry)
+        read_in_this_file(entry)
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === TextViewer[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  SwingParadise::TextViewer.new(ARGV)
+end # text_viewer.rb

data/lib/swing_paradise.rb

@@ -0,0 +1 @@
+require 'swing_paradise/requires/require_the_project.rb'

data/swing_paradise.gemspec

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'yaml'
+require 'swing_paradise/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'swing_paradise'
+  s.version = SwingParadise::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+This gem is meant to be for jruby only.
+
+It attempts to make the Swing bindings, available in Java,
+more convenient to use from within Ruby code. In other
+words: this gem is basically a helper-wrapper over Swing.
+Naturally you need to use jruby, if you wish to make use
+of this gem.
+
+EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  s.authors = ['Robert A. Heiler']
+  s.email   = Roebe.email?
+  s.files   = Dir['**/*']
+
+  s.license     = 'MIT'
+  s.homepage    = 'https://www.rubydoc.info/gems/rbt/'
+  s.require_paths = ['lib']
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+}

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: swing_paradise
+version: !ruby/object:Gem::Version
+  version: 0.1.46
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-11 00:00:00.000000000 Z
+dependencies: []
+description: |2+
+
+  This gem is meant to be for jruby only.
+
+  It attempts to make the Swing bindings, available in Java,
+  more convenient to use from within Ruby code. In other
+  words: this gem is basically a helper-wrapper over Swing.
+  Naturally you need to use jruby, if you wish to make use
+  of this gem.
+
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- doc/README.gen
+- lib/swing_paradise.rb
+- lib/swing_paradise/autoinclude.rb
+- lib/swing_paradise/awt/README.md
+- lib/swing_paradise/awt/color.rb
+- lib/swing_paradise/base_module/base_module.rb
+- lib/swing_paradise/classes
+- lib/swing_paradise/examples/001_quit_button_example.rb
+- lib/swing_paradise/examples/002_text_area_example.rb
+- lib/swing_paradise/examples/003_combo_box_example.rb
+- lib/swing_paradise/examples/004_jpanel_left_bound_example.rb
+- lib/swing_paradise/examples/005_box_layout_example.rb
+- lib/swing_paradise/examples/006_frame_example.rb
+- lib/swing_paradise/examples/007_textarea_responding_to_enter_key_example.rb
+- lib/swing_paradise/examples/008_scrolled_window_example.rb
+- lib/swing_paradise/examples/009_font_size_example.rb
+- lib/swing_paradise/examples/010_counter_example.rb
+- lib/swing_paradise/examples/011_button_with_image_example.rb
+- lib/swing_paradise/examples/012_quit_on_escape_key_being_pressed.rb
+- lib/swing_paradise/examples/013_simple_box_example.rb
+- lib/swing_paradise/examples/014_mouse_events_example.rb
+- lib/swing_paradise/examples/015_menu_example.rb
+- lib/swing_paradise/examples/016_file_chooser_example.rb
+- lib/swing_paradise/examples/017_buttons_example.rb
+- lib/swing_paradise/examples/018_colour_chooser_example.rb
+- lib/swing_paradise/examples/019_jeditorpane_example.rb
+- lib/swing_paradise/examples/020_table_example.rb
+- lib/swing_paradise/examples/021_jsplitpane_example.rb
+- lib/swing_paradise/examples/022_drawing_oval_example.rb
+- lib/swing_paradise/examples/023_show_message_dialog_example.rb
+- lib/swing_paradise/java_classes/border_factory/border_factory.rb
+- lib/swing_paradise/java_classes/box/box.rb
+- lib/swing_paradise/java_classes/button
+- lib/swing_paradise/java_classes/checkbox
+- lib/swing_paradise/java_classes/combobox
+- lib/swing_paradise/java_classes/default_table_model/default_table_model.rb
+- lib/swing_paradise/java_classes/frame
+- lib/swing_paradise/java_classes/jbutton/jbutton.rb
+- lib/swing_paradise/java_classes/jcheckbox/jcheckbox.rb
+- lib/swing_paradise/java_classes/jcombobox/jcombobox.rb
+- lib/swing_paradise/java_classes/jcomponent/jcomponent.rb
+- lib/swing_paradise/java_classes/jeditorpane/jeditorpane.rb
+- lib/swing_paradise/java_classes/jfilechooser/jfilechooser.rb
+- lib/swing_paradise/java_classes/jframe/jframe.rb
+- lib/swing_paradise/java_classes/jlabel/jlabel.rb
+- lib/swing_paradise/java_classes/jmenu/jmenu.rb
+- lib/swing_paradise/java_classes/jmenubar/jmenubar.rb
+- lib/swing_paradise/java_classes/jpanel/jpanel.rb
+- lib/swing_paradise/java_classes/jscrollpane/jscrollpane.rb
+- lib/swing_paradise/java_classes/jspinner/jspinner.rb
+- lib/swing_paradise/java_classes/jtextarea/jtextarea.rb
+- lib/swing_paradise/java_classes/jtextfield/jtextfield.rb
+- lib/swing_paradise/java_classes/label
+- lib/swing_paradise/java_classes/panel
+- lib/swing_paradise/java_classes/spinner
+- lib/swing_paradise/java_classes/textarea
+- lib/swing_paradise/misc/misc.rb
+- lib/swing_paradise/prototype/prototype.rb
+- lib/swing_paradise/requires/require_the_project.rb
+- lib/swing_paradise/toplevel_methods/misc.rb
+- lib/swing_paradise/version/version.rb
+- lib/swing_paradise/widget_collection/README.md
+- lib/swing_paradise/widget_collection/text_viewer.rb
+- swing_paradise.gemspec
+homepage: https://www.rubydoc.info/gems/rbt/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.5.7
+requirements: []
+rubygems_version: 3.5.7
+signing_key:
+specification_version: 4
+summary: 'This gem is meant to be for jruby only.  It attempts to make the Swing bindings,
+  available in Java, more convenient to use from within Ruby code. In other words:
+  this gem is basically a helper-wrapper over Swing. Naturally you need to use jruby,
+  if you wish to make use of this gem.'
+test_files: []
+...