clevic 0.12.0 → 0.13.0.b1

data/lib/clevic/swing.rb

@@ -0,0 +1,38 @@
+=begin
+  Require this file to do Clevic in Swing with JRuby
+=end
+
+require 'pathname'
+
+# This seems to be required for jruby-1.5.x (at least for 1.5.2)
+require 'java'
+
+# require these first, so TableModel and TableView get the correct ancestors
+require 'clevic/swing/table_model.rb'
+require 'clevic/swing/table_view.rb'
+( Pathname.new( __FILE__ ).parent + 'swing' ).children.grep( /.rb$/ ).each do |child|
+  require child.to_s
+end
+
+# now require the generic parts
+require 'clevic/table_model'
+require 'clevic/table_view'
+require 'clevic.rb'
+
+module Clevic
+
+def self.tahoma
+  if @font.nil?
+    @font = 
+    begin
+      found = java.awt.GraphicsEnvironment.local_graphics_environment.all_fonts.select {|f| f.font_name == "Tahoma"}.first
+      found.deriveFont( 13.0 )
+      java.awt.Font.new( 'DialogInput', java.awt.Font::PLAIN, 13 )
+  rescue
+      java.awt.Font.new( 'DialogInput', java.awt.Font::PLAIN, 13 )
+    end
+  end
+  @font
+end
+
+end

data/lib/clevic/swing/action.rb

@@ -0,0 +1,125 @@
+require 'gather'
+
+module Clevic
+
+class Action
+  include Gather
+  property :shortcut, :method, :handler, :tool_tip, :visible, :name, :text, :checkable
+  
+  def initialize( parent, options = {}, &block )
+    @parent = parent
+    gather( options, &block )
+  end
+  attr_reader :parent, :menu_item
+  
+  def plain_text
+    text.gsub( /&/, '' )
+  end
+  
+  # find the java.awt.event.KeyEvent::VK constant
+  # for the letter after the &. Then set it on the item's
+  # mnemonic. Because JMenuItem.setMnemonic won't take a nil
+  def mnemonic
+    if @mnemonic.nil?
+      ix = text.index '&'
+      @mnemonic =
+      if ix
+        eval( "java.awt.event.KeyEvent::VK_#{text[ix+1..ix+1].upcase}" )
+      else
+        false
+      end
+    end
+    @mnemonic
+  end
+  
+  def menu_item
+    if @menu_item.nil?
+      @menu_item =
+      if checkable
+        javax.swing.JCheckBoxMenuItem.new
+      else
+        javax.swing.JMenuItem.new
+      end
+      
+      menu_item.text = plain_text
+      menu_item.mnemonic = mnemonic if mnemonic
+      menu_item.accelerator = parse_shortcut( shortcut ) unless shortcut.nil?
+      menu_item.tool_tip_text = tool_tip
+      menu_item.add_action_listener do |event|
+        handler.call( event )
+      end
+    end
+    @menu_item
+  end
+  
+  # parse a Qt-style Ctrl+D shortcut specification
+  # and return a javax.swing.KeyStroke
+  def parse_shortcut( sequence )
+    # munge keystroke to something getKeyStroke recognises
+    # file:///usr/share/doc/java-sdk-docs-1.6.0.10/html/api/javax/swing/KeyStroke.html#getKeyStroke%28java.lang.String%29
+    # Yes, the space MUST be last in the charset, otherwise Ctrl-" fails
+    modifiers = sequence.split( /[-+ ]/ )
+    last = modifiers.pop
+    
+    modifier_mask = modifiers.inject(0) do |mask,value|
+      mask |
+      if value =~ /ctrl/i
+        java.awt.Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()
+      else
+        eval( "java.awt.event.InputEvent::#{value.upcase}_DOWN_MASK" )
+      end
+    end
+    
+    keystroke =
+    if last.length == 1
+      case last
+        # these two seem to break the KeyStroke parsing algorithm
+        when "'"
+          javax.swing.KeyStroke.getKeyStroke( java.awt.event.KeyEvent::VK_QUOTE, modifier_mask )
+          
+        when '"'
+          javax.swing.KeyStroke.getKeyStroke( java.awt.event.KeyEvent::VK_QUOTE, modifier_mask | java.awt.event.InputEvent::SHIFT_DOWN_MASK )
+        
+        # the conversion in else doesn't work for these
+        when '['
+          javax.swing.KeyStroke.getKeyStroke( java.awt.event.KeyEvent::VK_OPEN_BRACKET, modifier_mask )
+          
+        when ']'
+          javax.swing.KeyStroke.getKeyStroke( java.awt.event.KeyEvent::VK_CLOSE_BRACKET, modifier_mask )
+          
+        when ';'
+          javax.swing.KeyStroke.getKeyStroke( java.awt.event.KeyEvent::VK_SEMICOLON, modifier_mask )
+          
+        else
+          keystring = javax.swing.KeyStroke.getKeyStroke( java.lang.Character.new( last.to_char ), modifier_mask ).toString
+          puts "keystring: #{keystring.inspect}"
+          # have to do this conversion for Mac OS X
+          javax.swing.KeyStroke.getKeyStroke( keystring.gsub( /typed/, 'pressed' ) )
+      end
+    else
+      # F keys
+      # insert, delete, tab etc
+      found = java.awt.event.KeyEvent.constants.grep( /#{last}/i )
+      raise "too many options for #{sequence}: #{found.inspect}" if found.size != 1
+      javax.swing.KeyStroke.getKeyStroke( eval( "java.awt.event.KeyEvent::#{found.first}" ), modifier_mask )
+    end
+    puts "keystroke: #{keystroke.inspect}"
+    keystroke || raise( "unknown keystroke #{sequence} => #{modifiers.inspect} #{last}" )
+  end
+end
+
+# dummy class for creating a menu separator
+class Separator < Action
+  def initialize
+    super(nil)
+  end
+  
+  def shortcut
+    nil
+  end
+  
+  def menu_item
+  end
+end
+
+end

data/lib/clevic/swing/action_builder.rb

@@ -0,0 +1,47 @@
+require 'clevic/action_builder.rb'
+require 'clevic/swing/action.rb'
+require 'clevic/swing/extensions.rb'
+
+require 'changes'
+
+module Clevic
+
+module ActionBuilder
+  # Create a new separator and add a new separator.
+  def separator
+    Separator.new.tap do |action|
+      add_action action
+      collect_actions << action
+    end
+  end
+  
+  def create_action( &block )
+    Action.new( self ).tap( &block )
+  end
+  
+  # set up the code to be executed when an action is triggered,
+  def action_method_or_block( action, options, &block )
+    # connect the action to some code
+    if options.has_key?( :method )
+      action.handler do |event|
+        puts "#{__FILE__}:#{__LINE__}:action.name: #{action.name.inspect}"
+        action_triggered do
+          # active is from Qt checkbox-menu-items
+          send_args = [ options[:method], options.has_key?( :checkable ) ? action.menu_item.selected? : nil ].compact
+          send( *send_args )
+        end
+      end
+    else
+      unless block.nil?
+        # TODO not sure why triggered is outside here, but not in the method section
+        action_triggered do
+          action.handler do |event|
+            yield( event )
+          end
+        end
+      end
+    end
+  end
+end
+
+end # Clevic

data/lib/clevic/swing/boolean_delegate.rb

@@ -0,0 +1,26 @@
+require 'clevic/swing/delegate'
+
+module Clevic
+
+  class BooleanDelegate < Delegate
+    def init_component( cell_editor )
+      editor.selected = attribute_value
+    end
+    
+    def editor
+      @editor ||= javax.swing.JCheckBox.new.tap do |e|
+        # TODO this is common to all delegates
+        e.horizontal_alignment = field.swing_alignment
+      end
+    end
+    
+    def value
+      editor.selected
+    end
+    
+    def native
+      java.lang.Boolean
+    end
+  end
+
+end

data/lib/clevic/swing/browser.rb

@@ -0,0 +1,282 @@
+#~ require 'clevic/search_dialog.rb'
+require 'clevic/view'
+require 'clevic/swing/action_builder'
+
+module Clevic
+
+=begin rdoc
+The main application class. Display one tabs for each descendant of Clevic::View
+in Clevic::View.order. DefaultView classes created by Clevic::Record are included.
+=end
+class Browser < javax.swing.JFrame
+  #~ slots *%w{dump() refresh_table() filter_by_current(bool) next_tab() previous_tab()}
+  
+  attr_reader :menu_edit, :menu_search, :menu_table
+  
+  def initialize
+    super
+    
+    # set OSX application title
+    java.lang.System.setProperty( "com.apple.mrj.application.apple.menu.about.name", title_string )
+
+    self.jmenu_bar = menu_bar
+    self.icon_image = icon
+    
+    # add the tables tab
+    add( tables_tab, java.awt.BorderLayout::CENTER )
+    
+    # add the status bar
+    add( status_bar, java.awt.BorderLayout::SOUTH )
+    
+    load_views
+    update_menus
+    self.title = title_string
+  end
+  
+  def title_string
+    [database_name, 'Clevic'].compact.join ' '
+  end
+  
+  def menu_bar
+    javax.swing.JMenuBar.new.tap do |menu_bar|
+      menu_bar << javax.swing.JMenu.new( 'File' ).tap do |menu|
+        menu.mnemonic = java.awt.event.KeyEvent::VK_F
+        menu << "Open"
+        menu << "Close"
+      end
+      
+      @menu_edit = javax.swing.JMenu.new( 'Edit' ).tap {|m| m.mnemonic = java.awt.event.KeyEvent::VK_E}
+      menu_bar << menu_edit
+      
+      @menu_search = javax.swing.JMenu.new( 'Search' ).tap {|m| m.mnemonic = java.awt.event.KeyEvent::VK_S}
+      menu_bar << menu_search
+      
+      @menu_table = javax.swing.JMenu.new( 'Table' ).tap do |menu|
+        menu.mnemonic = java.awt.event.KeyEvent::VK_T
+        menu << Action.new( self ) do |action|
+          action.name = :next_tab
+          action.text = "&Next"
+          action.shortcut = "Ctrl+Tab"
+          action.handler do |event|
+            puts "next tab"
+            next_tab
+          end
+        end
+        
+        menu << Action.new( self ) do |action|
+          action.name = :previous_tab
+          action.text = "&Previous"
+          action.shortcut = "Shift+Ctrl+Tab"
+          action.handler do |event|
+            puts "previous tab"
+            previous_tab
+          end
+        end
+        
+        if $options[:debug]
+          menu << Action.new( self ) do |action|
+            action.name = :dump
+            action.text = "&Dump"
+            action.shortcut = "Ctrl+D"
+            action.handler do |event|
+              dump
+            end
+          end
+        end
+      end
+      menu_bar << @menu_table
+    end
+  end
+  
+  def icon
+    @icon ||=
+    begin
+      icon_path = Pathname.new( __FILE__ ).parent.parent + "icons/icon.png"
+      raise "icon.png not found" unless icon_path.file?
+      javax.swing.ImageIcon.new( icon_path.realpath.to_s ).image
+    end
+  end
+  
+  def tables_tab
+    @tables_tab ||= javax.swing.JTabbedPane.new.tap do |tables_tab|
+      # tell tab to not take focus
+      tables_tab.focusable = false
+    
+      # tab navigation
+      tables_tab.add_change_listener do |change_event|
+        puts "change_event: #{change_event.source.inspect}"
+        puts "change_event.source.selected_index: #{change_event.source.selected_index.inspect}"
+        current_changed
+        # TODO tell exiting tab to save currently editing row/cell
+      end
+    end
+  end
+  
+  def status_bar
+    @status_bar ||= javax.swing.JLabel.new.tap do |status_bar|
+      status_bar.horizontal_alignment = javax.swing.SwingConstants::RIGHT
+      # just so the bar actually displays
+      status_bar.text = "Welcome to Clevic"
+    end
+  end
+  
+  def status_bar_timer
+    @status_bar_timer ||= javax.swing.Timer.new( 15000, nil ).tap do |timer|
+      timer.repeats = false
+      # This is only for 1.6
+      #~ timer.action_command = 'hide_status_message'
+      timer.add_action_listener do |event|
+        status_bar.text = nil
+        timer.stop
+      end
+    end
+  end
+  
+  # Set the main window title to the name of the database, if we can find it.
+  def database_name
+    table_view.model.entity_class.db.url rescue ''
+  end
+  
+  # called by current_changed to update the Edit menu to the menus
+  # defined by the currently selected view
+  def update_menus
+    # update edit menu
+    menu_edit.remove_all
+    
+    # do the model-specific menu items first
+    table_view.model_actions.each do |action|
+      menu_edit << action
+    end
+    
+    # now do the generic edit items
+    table_view.edit_actions.each do |action|
+      menu_edit << action
+    end
+    
+    # update search menu
+    menu_search.remove_all
+    table_view.search_actions.each do |action|
+      menu_search << action
+    end
+  end
+  
+  # activated by Ctrl-Shift-D for debugging
+  def dump
+    puts "table_view.model: #{table_view.model.inspect}"
+    puts "table_view.model.entity_class: #{table_view.model.entity_class.inspect}"
+  end
+  
+  # return the Clevic::TableView object in the currently displayed tab
+  def table_view
+    tables_tab.selected_component
+  end
+  
+  # slot to handle Ctrl-Tab and move to next tab, or wrap around
+  def next_tab
+    tables_tab.selected_index = 
+    if tables_tab.selected_index >= tables_tab.count - 1
+      0
+    else
+      tables_tab.selected_index + 1
+    end
+  end
+
+  # slot to handle Ctrl-Backtab and move to previous tab, or wrap around
+  def previous_tab
+    tables_tab.selected_index = 
+    if tables_tab.selected_index <= 0
+      tables_tab.count - 1
+    else
+      tables_tab.selected_index - 1
+    end
+  end
+  
+  # slot to handle the currentChanged signal from tables_tab, and
+  # set focus on the grid
+  def current_changed
+    update_menus
+    table_view.request_focus
+  end
+  
+  # Create the tabs, each with a collection for a particular entity class.
+  # views come from Clevic::View.order
+  def load_views
+    views = Clevic::View.views
+    Kernel.raise "no views to display" if views.empty?
+    
+    # Add all existing model objects as tabs, one each
+    views.each do |view_class|
+      begin
+        view = view_class.new
+        unless view.entity_class.table_exists?
+          puts "Browser::load_views: No table for #{view.entity_class.inspect}"
+          next
+        end
+          
+        # create the the table_view and the table_model for the entity_class
+        tab = Clevic::TableView.new( view )
+        
+        # add a new tab
+        tables_tab.add( tab.title, tab )
+        
+        # add the table to the Table menu
+        menu_table << Action.new( self ) do |action|
+          action.text = tab.title
+          action.handler do
+            tables_tab.current = tab
+          end
+        end
+        
+        init_connections( tab )
+      rescue Exception => e
+        puts "UI from #{view} will not be available: #{e.message}"
+        puts e.backtrace
+      end
+    end
+  end
+  
+  def init_connections( tab )
+    tab.emit_status_text do |msg|
+      status_bar.text = msg
+      # hide the message after a while.
+      status_bar_timer.start
+    end
+    
+    # handle filter status changed, so we can provide a visual indication
+    tab.emit_filter_status do |status|
+      # update the tab, so there's a visual indication of filtering
+      filter_title = ( tab.filtered? ? '| ' : '' ) + tab.title
+      tables_tab.set_title_at( tables_tab.selected_index, filter_title )
+      
+      if tab.filtered?
+        tables_tab.set_tool_tip_text_at( tables_tab.selected_index, tab.filtered.status_message )
+      else
+        tables_tab.set_tool_tip_text_at( tables_tab.selected_index, nil )
+      end
+    end
+  end
+  
+  # make sure all outstanding records are saved
+  def save_all
+    tables_tab.each {|x| x.save_row( x.current_index ) }
+  end
+  
+  def self.run( args )
+    # make it more appley
+    java.lang.System.setProperty( "apple.laf.useScreenMenuBar", "true" )
+    javax.swing.UIManager.setLookAndFeel( javax.swing.UIManager.getSystemLookAndFeelClassName() )
+
+    # load models
+    args.each do |arg|
+      load_models( Pathname.new( arg ) )
+    end
+    
+    # make top-level UI
+    browser = Browser.new
+    browser.default_close_operation = javax.swing.JFrame::EXIT_ON_CLOSE
+    browser.pack
+    browser.visible = true 
+  end
+end
+
+end