bakkdoor-rswing 0.1.0 → 0.1.1

data/lib/rswing.rb

@@ -1,2 +1,5 @@
 require "java"
 $: << File.expand_path(File.dirname(__FILE__) + "/rswing/components")
+
+module RSwing  
+end

data/lib/rswing/components/button.rb

@@ -0,0 +1,44 @@
+module RSwing
+  module Components
+    require "java"
+    require "events/focus_events"
+    require "options"
+    require "listener"
+    include_package 'javax.swing'
+    ActionListener = java.awt.event.ActionListener
+    
+    # Button-Class. Wraps JButton-Class.
+    class Button < JButton
+      include Events::FocusEvents
+      
+      # - <tt>text</tt>: The Text to be displayed on the button.
+      # - <tt>options</tt>: Options-Hash with the following valid values:
+      # 1. <tt>:visible => true</tt>
+      # 2. <tt>:enabled => true</tt>
+      # 3. <tt>:belongs_to => nil</tt> # Container to which this button should be added (default: none)
+      # 4. <tt>:layout => nil</tt> # Layout-Options (e.g. GridBagContraints-Object) (default: none)
+      # 5. <tt>:icon => nil</tt> # Icon-Symbol to be displayed next to/instead of the text on the button (default: none)
+      # 6. <tt>:name => :okButton</tt> Name of the buttons for access via parent-container (default: none)
+      def initialize(text, options = {}, &block)
+        super(text)
+        
+        self.visible = Options.value_for(options => :visible)
+        self.enabled = Options.value_for(options => :enabled)
+        self.icon = Options.value_for(options => :icon)
+
+        # call block with current object, if given
+        if block_given?
+          yield self
+        end
+        
+        Container.add_if_requested(self, options)
+      end
+
+      # Eventhandler for clicked (actionPerformed) event.
+      # Takes a block, which will be executed if this event occurs.
+      def on_click(&block)
+        self.add_action_listener(Listener.create(ActionListener, :actionPerformed, &block))
+      end
+    end 
+  end
+end

data/lib/rswing/components/container.rb

@@ -0,0 +1,52 @@
+module RSwing
+  module Components
+    module Container
+      # Adds a component to the component_hash with a given name symbol.
+      # Raises an exception if name already taken.
+      def add_with_name(component, name_symbol)
+        if self.component_hash.has_key?(name_symbol)
+          raise "Name in Component bereits vergeben!"
+        else
+          self.component_hash[name_symbol] = component
+        end
+      end
+      
+      # Removes a component from this container. 
+      # Also removes it from the component_hash
+      def remove(component)
+        super.remove(component)
+        # delete all entries with component as value in component_hash
+        self.component_hash.delete_if { |key,value| value == component }
+      end
+      
+      # Returns the component with a given name inside of this container (if available).
+      # * <tt>name_symbol</tt> Name (as symbol) of the component to get.
+      def [](name_symbol)
+        if self.component_hash.has_key?(name_symbol)
+          self.component_hash[name_symbol] # erstes hash mit diesem namen als key zurückgeben
+        else
+          nil
+        end
+      end
+      
+      # Adds a component to a container, if specified via :belongs_to in options.
+      def self.add_if_requested(component, options)
+        if(container = Options.value_for(options => :belongs_to))
+          if(Options.value_for(options => :layout) || Options.value_for(options => :name))
+            container.add(component, options)
+          else
+            container.add(component)
+          end
+        end
+      end
+      
+      protected
+      # Name-Component-hash.
+      # For example:
+      # * <tt>{:okButton => okButtonObject, :cancelButton => cancelButtonObject}</tt>
+      def component_hash
+        @component_hash ||= {}
+      end
+    end
+  end
+end

data/lib/rswing/components/dialog.rb

@@ -0,0 +1,110 @@
+module RSwing
+  module Components
+    require "java"
+    require "container"
+    
+    JOptionPane = javax.swing.JOptionPane
+    JDialog = javax.swing.JDialog
+    
+    # Dialog-Class.
+    # Has static methods to create Message-Dialogs.
+    # (<tt>show()</tt> and <tt>showOptions</tt>).
+    # Can also be used to create custom dialogs by extending from this class.
+    class Dialog < JDialog
+      include Container
+      
+      def initialize(owner, title, options = {}, &block)
+        super(owner, title, Options.value_for(options => :modal))
+        
+        if(name = Options.value_for(options => :name) && owner.class.include?(Container))
+          owner.add_with_name(self, name)
+        end
+        
+        # call block with current object, if given
+        if block_given?
+          yield self
+        end
+        
+      end
+      
+      # Adds a component with a set of options to this dialog.
+      def add(component, options = {})
+        if(layout = Options.value_for(options => :layout))
+          self.content_pane.add(component, layout)
+        else
+          self.content_pane.add(component)
+        end
+        
+        
+        # wenn :name angegeben wurde, mit aufnehmen
+        if(name = Options.value_for(options => :name))
+          self.add_with_name(component, name)
+        end
+        
+        component #zurückgeben
+      end
+      
+      # Creates a MessageDialog.
+      # - <tt>parent</tt>: Parent-Container for this dialog.
+      # - <tt>message</tt>: Message, to be displayed in this dialog.
+      # - <tt>options</tt>: Options-Hash with the following valid values:
+      # 1. <tt>:dialog_type => (:error | :question | :plain | :warning | :info)</tt> (default: :info)
+      # 2. <tt>:title => "my title"</tt> (defailt: <tt>""</tt>)
+      # 3. <tt>:modal => false</tt> (default: true)
+      def self.show(parent, message, options = {})
+        message_type =
+          case Options.value_for(options => :dialog_type)
+          when :error
+            JOptionPane::ERROR_MESSAGE
+          when :question
+            JOptionPane::QUESTION_MESSAGE
+          when :plain
+            JOptionPane::PLAIN_MESSAGE
+          when :warning
+            JOptionPane::WARNING_MESSAGE
+          else
+            JOptionPane::INFORMATION_MESSAGE
+          end
+        
+        JOptionPane.showMessageDialog(parent, message, Options.value_for(options => :title), message_type)
+      end
+      
+      # Creates a OptionsDialog (Dialog with selection for different Options).
+      # - <tt>parent</tt>: Parent-Container for this dialog.
+      # - <tt>message</tt>: Message, to be displayed in the dialog.
+      # - <tt>options</tt>: Options-Hash with the following valid values:
+      # 1. <tt>:option_type => (:yes_no | :yes_no_cancel)</tt> (default: <tt>:yes_no</tt>)
+      # 2. <tt>:option_values => ["OK", "Cancel", "Quit"]</tt> (default: <tt>["Ja", "Nein"]</tt>)
+      # 3. <tt>:title => "mein titel"</tt> (default: <tt>""</tt>)
+      # 4. <tt>:modal => false</tt> (default: <tt>true</tt>)
+      # 5. <tt>:icon => nil</tt> (default: keins)
+      def self.showOption(parent, message, options = {})
+        title = options[:title].nil? ? "Bitte wählen Sie" : options[:title]
+        icon = Options.value_for(options => :icon) 
+        
+        option_type = option_type_for(Options.value_for(options => :option_type))
+        option_values = Options.value_for(options => :option_values)
+          
+        selected_option_index = JOptionPane.showOptionDialog(parent, message, title, option_type, JOptionPane::QUESTION_MESSAGE, icon, 
+				option_values.to_java(:Object), nil);
+                              
+        option_values[selected_option_index]
+      end
+      
+      # Returns a JOptionPane-specific option_type for a given rswing-option_type.
+      # For example: 
+      # 1. <tt>:yes_no</tt> => <tt>JOptionPane::YES_NO_OPTION</tt>
+      # 2. <tt>:yes_no_cancel</tt> => <tt>JOptionPane::YES_NO_CANCEL_OPTION</tt>
+      def self.option_type_for(option_type)
+        case option_type
+        when :yes_no
+          JOptionPane::YES_NO_OPTION
+        else
+          JOptionPane::YES_NO_CANCEL_OPTION
+        end
+      end
+
+    end    
+  end
+end
+

data/lib/rswing/components/events/focus_events.rb

@@ -0,0 +1,21 @@
+module RSwing
+  module Components
+    module Events
+      module FocusEvents
+        FocusListener = java.awt.event.FocusListener
+        
+        # Eventhandler für focus (focusGained) Event.
+        # Nimmt einen block, welcher dann bei diesem Event ausgeführt wird.
+        def on_focus(&block)
+          self.add_focus_listener(Listener.create(FocusListener, :focusGained ,&block))
+        end
+      
+        # Eventhandler für focus_lost (focusLost) Event.
+        # Nimmt einen block, welcher dann bei diesem Event ausgeführt wird.
+        def on_focus_lost(&block)
+          self.add_focus_listener(Listener.create(FocusListener, :focusLost ,&block))
+        end
+      end
+    end
+  end
+end

data/lib/rswing/components/events/key_events.rb

@@ -0,0 +1,21 @@
+module RSwing
+  module Components
+    module Events
+      module KeyEvents
+        KeyListener = java.awt.event.KeyListener
+        
+        def on_key_pressed(&block)
+          self.add_key_listener(Listener.create(KeyListener, :keyPressed, &block))
+        end
+      
+        def on_key_released(&block)
+          self.add_key_listener(Listener.create(KeyListener, :keyReleased, &block))
+        end
+      
+        def on_key_typed(&block)
+          self.add_key_listener(Listener.create(KeyListener, :keyTyped, &block))
+        end
+      end
+    end
+  end
+end

data/lib/rswing/components/events/mouse_events.rb

@@ -0,0 +1,29 @@
+module RSwing
+  module Components
+    module Events
+      module MouseEvents
+        MouseListener = java.awt.event.MouseListener
+        
+        def on_mouse_clicked(&block)
+          self.add_key_listener(Listener.create(MouseListener, :mouseClicked, &block))
+        end
+      
+        def on_mouse_entered(&block)
+          self.add_key_listener(Listener.create(MouseListener, :mouseEntered, &block))
+        end
+      
+        def on_mouse_exited(&block)
+          self.add_key_listener(Listener.create(MouseListener, :mouseExited, &block))
+        end
+      
+        def on_mouse_pressed(&block)
+          self.add_key_listener(Listener.create(MouseListener, :mousePressed, &block))
+        end
+      
+        def on_mouse_released(&block)
+          self.add_key_listener(Listener.create(MouseListener, :mouseReleased, &block))
+        end
+      end
+    end
+  end
+end

data/lib/rswing/components/frame.rb

@@ -0,0 +1,55 @@
+module RSwing
+  module Components
+    require "java"
+    require "container"
+    JFrame = javax.swing.JFrame
+    
+    class Frame < JFrame
+      include Container
+      
+      def initialize(title, &block)
+        super(title)
+        
+        # falls block übergeben wurde, mit aktuellem objekt aufrufen
+        if block_given?
+          yield self
+        end
+      end
+      
+      def add(component, options = {})
+        if(layout = Options.value_for(options => :layout))
+          self.content_pane.add(component, layout)
+        else
+          self.content_pane.add(component)
+        end
+        
+        
+        # wenn :name angegeben wurde, mit aufnehmen
+        if(name = Options.value_for(options => :name))
+          self.add_with_name(component, name)
+        end
+        
+        component #zurückgeben
+      end
+      
+      # Sets the default close operation for this frame.
+      # Valid operations are:
+      # 1. <tt>:do_nothing_on_close</tt>
+      # 2. <tt>:hide_on_close</tt> (default)
+      # 3. <tt>:dispose_on_close</tt>
+      # 4. <tt>:exit_on_close</tt>
+      def default_close_operation=(op = :hide_on_close)
+        case op
+        when :do_nothing_on_close
+          self.setDefaultCloseOperation(WindowConstants::DO_NOTHING_ON_CLOSE)
+        when :hide_on_close
+          self.setDefaultCloseOperation(WindowConstants::HIDE_ON_CLOSE)
+        when :dispose_on_close
+          self.setDefaultCloseOperation(WindowConstants::DISPOSE_ON_CLOSE)
+        when :exit_on_close
+          self.setDefaultCloseOperation(JFrame::EXIT_ON_CLOSE)
+        end
+      end
+    end
+  end
+end

data/lib/rswing/components/listener.rb

@@ -0,0 +1,24 @@
+module RSwing
+  module Components
+    class Listener
+      # Erstellt eine Listener-Klasse des angegebenen listener_interfaces 
+      # (Java Listener Interface), die alle Interface-Methoden leer haelt
+      # ausser derjenigen, die mit <tt>methodname</tt> angegeben wurde
+      # (und deren Inhalt mit dem angegebenen <tt>block</tt> gefüllt wird).
+      # Gibt anschließend eine neue Instanz dieser Listener-Klasse zurück
+      def self.create(listener_interface, methodname, &block)
+        listener_class = Class.new() do
+          include listener_interface
+          implement listener_interface
+          def initialize(methodname, &block)
+            self.class.instance_eval do
+              define_method(methodname, &block)
+            end
+          end
+        end
+        # neue instanz zurückgeben
+        listener_class.new(methodname, &block)
+      end
+    end
+  end
+end

data/lib/rswing/components/options.rb

@@ -0,0 +1,42 @@
+module RSwing
+  module Components
+    class Options
+      # Hash of all valid default-values for rswing options.
+      def self.gui_options
+        {
+          :enabled => true,
+          :visible => true,
+          :editable => true,
+          :resizable => true,
+          :modal => true,
+          :double_buffer => true,
+          :dialog_type => :info,
+          :option_type => :yes_no,
+          :option_values => ["Ja", "Nein"],
+          :icon => nil,
+          :belongs_to => nil,
+          :layout => nil,
+          :title => nil,
+          :name => nil,
+          :font => nil,
+          :doc => nil,
+          :columns => 10,
+          :text => ""
+        }
+      end
+
+      # Returns the value of a key (which is given as the value of the hash).
+      # If the value to the key isn't given in the hash, return the 
+      # default-value from <tt>gui_options</tt>-hash.
+      # * Example:
+      #     <tt>Options.value_for(options => :name)</tt>
+      def self.value_for(hash)
+        hash.each_pair do |options_hash, option_key|
+          # es sollte nur ein paar angegeben werden, sodass wir einfach nur das erste nehmen
+          # und den entsprechenden wert zurückgeben
+          return options_hash[option_key].nil? ? gui_options[option_key] : options_hash[option_key]
+        end
+      end
+    end
+  end
+end

data/lib/rswing/components/panel.rb

@@ -0,0 +1,42 @@
+module RSwing
+  module Components
+    require "java"
+    require "container"
+    require "events/key_events"
+    require "events/mouse_events"
+    require "events/focus_events"
+    include_package 'javax.swing'
+    
+    class Panel < JPanel
+      include Container
+      include Events::KeyEvents
+      include Events::MouseEvents
+      include Events::FocusEvents
+      
+      def initialize(layout_manager, options = {}, &block)
+        super(layout_manager, Options.value_for(options => :double_buffer))
+        
+        if (border_title = Options.value_for(options => :title))
+          border = BorderFactory.createTitledBorder(border_title)
+          border.title_font = Font.new("Arial", Font::BOLD, 14)
+          self.border = border
+        end      
+        
+        # block aufrufen mit aktuellem objekt, falls vorhanden
+        if block_given?
+          yield self
+        end
+        
+        Container.add_if_requested(self, options)
+      end
+      
+      def add(component, options = {})
+        super.add(component)
+        
+        if(name = Options.value_for(options => :name))
+          self.add_with_name(component, name)
+        end
+      end
+    end 
+  end
+end

data/lib/rswing/components/text_field.rb

@@ -0,0 +1,29 @@
+module RSwing
+  module Components
+    require "options"
+    
+    class TextField < javax.swing.JTextField
+      # Valid options are:
+      # 1. <tt>:text => "text"</tt> (default: "")
+      # 2. <tt>:columns => 5</tt> (default: 10)
+      # 3. <tt>:doc => nil</tt> (default: nil)
+      # 4. <tt>:font => nil</tt> (default nil)
+      # 5. <tt>:visible => false</tt> (default: true)
+      # 6. <tt>:editable => false</tt> (default: true)
+      def initialize(options = {})
+        if(options.empty?)
+          super()
+        else
+          if(doc = Options.value_for(options => :doc))
+            super(doc, Options.value_for(options => :text), Options.value_for(options => :columns))
+          else
+            super(Options.value_for(options => :text), Options.value_for(options => :columns))
+          end
+        end
+        
+        Container.add_if_requested(self, options)
+      end
+    end
+  
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bakkdoor-rswing
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Christopher Bertels
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-05 00:00:00 -07:00
+date: 2008-10-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -26,8 +26,17 @@ files:
 - LICENSE
 - Rakefile
 - lib/rswing.rb
-- lib/rswing/components/*.rb
-- lib/rswing/components/events/*.rb
+- lib/rswing/components/button.rb
+- lib/rswing/components/container.rb
+- lib/rswing/components/dialog.rb
+- lib/rswing/components/frame.rb
+- lib/rswing/components/listener.rb
+- lib/rswing/components/options.rb
+- lib/rswing/components/panel.rb
+- lib/rswing/components/text_field.rb
+- lib/rswing/components/events/focus_events.rb
+- lib/rswing/components/events/key_events.rb
+- lib/rswing/components/events/mouse_events.rb
 has_rdoc: true
 homepage: http://github.com/bakkdoor/rswing
 post_install_message: