clevic 0.12.0 → 0.13.0.b1

data/lib/clevic/swing/row_header.rb

@@ -0,0 +1,210 @@
+module Clevic
+
+  # TODO Weirdness with deleting a row. Takes a long time to get back to user
+  # TODO TextArea not working.
+  # TODO make sure a click in the main table when a row selection is active selects the main table cell
+  # TODO allow for clevic/table_view to access the row selection for deletes
+  class RowHeaderModel < javax.swing.table.AbstractTableModel
+    # Need a Clevic::TableModel here because the underlying
+    # connection isn't always the same instance. Because of
+    # CacheTable#renew
+    def initialize( table_model )
+      super()
+      @table_model = table_model
+      
+      # re-fire events
+      table_model.add_table_model_listener do |event|
+        fireTableChanged( event )
+      end
+    end
+    
+    # override TableModel method
+    def getRowCount
+      @table_model.getRowCount
+    end
+    
+    # override TableModel method
+    def getColumnCount
+      1
+    end
+
+    # override TableModel method
+    def getColumnName( column_index )
+      "row"
+    end
+    
+    def getColumnClass( column_index )
+      java.lang.Object
+    end
+
+    def isCellEditable( row_index, column_index )
+      false
+    end
+    
+    def getValueAt( row_index, column_index )
+      row_index+1
+    end
+    
+    def id_value( row_index, column_index )
+      if @table_model.collection.cached_at?( row_index )
+        "#{row_index+1} [id=#{@table_model.collection[row_index].id}]"
+      else
+        row_index+1
+      end
+    end
+    
+    def setValueAt( value, row_index, column_index )
+      raise "Can't set values in the row header"
+    end
+  end
+
+  # The JTable used to display a row header, and allow row selection.
+  # Also handles highlighting rows for different states, eg validation errors
+  # or unsaved.
+  # TODO need to add exceptions thrown by a Model.save to the error list in the model
+  class RowHeader < javax.swing.JTable
+    # for reloading and ease of testing
+    # should probably fix this in Kernel or Module or Class
+    unless ancestors.include?( javax.swing.table.TableCellRenderer )
+      include javax.swing.table.TableCellRenderer
+    end
+    
+    # The Clevic::TableView instance
+    attr_reader :table_view
+    
+    # this will add a row header to the passed table_view
+    def initialize( table_view )
+      @table_view = table_view
+      super( RowHeaderModel.new( table_view.model ) )
+      self.font = table_view.font
+      self.grid_color = java.awt.Color::white
+      
+      # user header renderer for all cells
+      set_default_renderer( java.lang.Object, table_header.default_renderer )
+      
+      # set the width
+      column_width = table_view.column_width( 0, "  #{row_count}" )
+      column_model.column( 0 ).preferred_width = column_width
+      
+      # This is a workaround either for OSX, or java-1.5.0_19-b02-306
+      self.minimum_size = java.awt.Dimension.new( column_width, minimum_size.height )
+
+      # put a count above the row number header
+      @count_label = javax.swing.JLabel.new( row_count.to_s ).tap do |count_label|
+        count_label.font = self.font
+        count_label.horizontal_alignment = javax.swing.JComponent::CENTER_ALIGNMENT
+        table_view.set_corner( javax.swing.ScrollPaneConstants::UPPER_LEFT_CORNER, count_label )
+        
+        # make sure count label is updated when the model changes
+        model.add_table_model_listener do |event|
+          count_label.text = row_count.to_s
+        end
+      end
+      
+      # insert into the row header side of the scrollpane
+      table_view.row_header = javax.swing.JViewport.new.tap do |vp|
+        vp.view = self
+        # make sure size is passed along to viewport
+        vp.preferred_size = preferred_size
+      end
+      
+      row_selection_handlers
+    end
+    
+    # Transfer row header selection to full row selections in the main
+    # table. Also clear the row header selection if a main table
+    # selection happens.
+    def row_selection_handlers
+      # add a selection listener to select data table rows
+      selection_model.addListSelectionListener do |list_event|
+        process_list_selection( list_event )
+      end
+      
+      # selections in the main table must clear any selections
+      # in the row header, ie self
+      table_view.jtable.selection_model.addListSelectionListener do |event|
+        selection_model.clear_selection unless row_header_selecting
+      end
+    end
+    
+    # guard to make sure changes to main table selection don't feed back.
+    def row_header_selecting( &block )
+      if block_given?
+        begin
+          @row_header_selecting = true
+          yield
+        ensure
+          @row_header_selecting = false
+        end
+      else
+        @row_header_selecting
+      end
+    end
+    
+    def process_list_selection( event )
+      # tell the main table handler we're busy
+      row_header_selecting do
+        # clear main table selection and start again
+        table_view.jtable.selection_model.clear_selection
+        
+        # select the whole row in main table. Subsequent row selections will also
+        # select the whole row. What a broken API.
+        table_view.jtable.setColumnSelectionInterval( table_view.model.fields.size-1, 0 )
+        
+        selected_rows.each do |row|
+          table_view.jtable.selection_model.addSelectionInterval( row, row )
+        end
+        
+        # make sure the keyboard focus is on the latest selected row
+        table_view.jtable.selection_model.addSelectionInterval( selection_model.lead_selection_index, selection_model.lead_selection_index )
+        
+        # make sure main table gets focus again
+        table_view.request_focus
+      end
+    end
+    
+    # return self so that getTableCellRendererComponent is called
+    def getCellRenderer( row, column )
+      self
+    end
+    
+    # Implementation of TableCellRenderer
+    # return renderer Component
+    def getTableCellRendererComponent(jtable, value,is_selected,has_focus,row,column)
+      item = table_view.model.collection[row]
+      renderer = get_default_renderer( java.lang.Object ).getTableCellRendererComponent(jtable,value,is_selected,has_focus,row,column)
+      
+      case
+      # no highlighting for an empty item
+      when item.nil?
+        renderer.background = java.awt.Color::yellow
+        renderer.opaque = true
+        renderer.tool_tip_text = "deleted elsewhere"
+        
+      # there's a validation error
+      when item.errors && !item.errors.empty?
+        renderer.background = java.awt.Color::orange
+        renderer.opaque = true
+        renderer.tool_tip_text = "validation errors"
+      
+      # record isn't saved yet
+      when item.changed?
+        renderer.background = java.awt.Color::yellow
+        renderer.opaque = true
+        renderer.tool_tip_text = "row not saved"
+      
+      when is_selected
+        renderer.background = javax.swing.UIManager.get 'Table.selectionBackground'
+        renderer.tool_tip_text = "id=#{item.id}"
+      
+      else
+        renderer.tool_tip_text = "id=#{item.id}"
+        
+      end
+      
+      renderer
+    end
+
+  end
+
+end

data/lib/clevic/swing/search_dialog.rb

@@ -0,0 +1,230 @@
+require 'clevic/extensions.rb'
+require 'clevic/swing/extensions.rb'
+
+module Clevic
+  class SearchDialog < javax.swing.JDialog
+    def initialize( parent = nil, modal = true )
+      if parent
+        # JDK 5 barfs on this
+        super(parent)
+      else
+        super()
+      end
+      
+      init_controls
+      init_layout
+      
+      self.default_close_operation = javax.swing.WindowConstants::HIDE_ON_CLOSE
+      self.name = "SearchDialog"
+      self.modal = modal
+      self.title = "Search"
+      
+      # Enter triggers Ok button
+      root_pane.default_button = ok_button
+      
+      # TODO finish this for Esc key to close dialog
+      #~ esc = javax.swing.KeyStroke.getKeyStroke( KeyEvent.VK_ESCAPE, 0 )
+      #~ root_pane.registerKeyboardAction( actionListener, stroke, javax.swing.JComponent.WHEN_IN_FOCUSED_WINDOW )
+    end
+    
+    # after the dialog, this will be either accepted or rejected
+    attr_reader :status
+    
+    def from_start?
+      from_start.selected
+    end
+    
+    def from_start=( value )
+      from_start.selected = value
+    end
+    
+    def regex?
+      regex.selected
+    end
+    
+    def whole_words?
+      whole_words.selected
+    end
+    
+    def forwards?
+      forwards.selected
+    end
+    
+    def backwards?
+      backwards.selected
+    end
+    
+    # return either :backwards or :forwards
+    def direction
+      return :forwards if forwards?
+      return :backwards if backwards?
+      raise "direction not known"
+    end
+    
+    # show the dialog, wait for close,
+    # return an object that understands rejected? and accepted?
+    def exec( text = '' )
+      self.search_text = text
+      search_combo.request_focus
+      search_combo.editor.select_all
+      
+      # modal dialog, so this will wait
+      show
+      
+      # remember previous searches
+      unless search_combo.include?( search_text )
+        search_combo << search_text
+      end
+      
+      self
+    end
+    
+    def search_text=( value )
+      search_combo.editor.item = value.to_s
+    end
+    
+    def search_text
+      search_combo.editor.item
+    end
+    
+    def accepted?
+      status == :accept
+    end
+    
+    def accept!
+      @status = :accept
+    end
+    
+    def rejected?
+      status == :reject
+    end
+    
+    def reject!
+      @status = :reject
+    end
+    
+    attr_reader :search_label, :search_combo
+    attr_reader :from_start, :whole_words, :regex
+    attr_reader :forwards, :backwards
+    attr_reader :ok_button, :cancel_button
+    
+    def init_controls
+      @search_label = javax.swing.JLabel.new( "Search" ).tap do |search_label|
+        search_label.text = "Search"
+        search_label.name = "search_label"
+      end
+      
+      @search_combo = javax.swing.JComboBox.new.tap do |search_combo|
+        search_combo.editable = true
+        search_combo.name = "search_combo"
+      end
+      
+      @from_start = javax.swing.JCheckBox.new.tap do |from_start|
+        from_start.mnemonic = 'S'
+        from_start.text = "From Start"
+        from_start.name = "from_start"
+      end
+      
+      @regex = javax.swing.JCheckBox.new.tap do |regex|
+        regex.mnemonic = 'R'
+        regex.text = "Regular Expression"
+        regex.name = "regex"
+      end
+      
+      @whole_words = javax.swing.JCheckBox.new.tap do |whole_words|
+        whole_words.mnemonic = 'W'
+        whole_words.text = "Whole words"
+        whole_words.name = "whole_words"
+      end
+      
+      @forwards = javax.swing.JRadioButton.new.tap do |forwards|
+        forwards.mnemonic = 'F'
+        forwards.text = "Forwards"
+        forwards.name = "forwards"
+        forwards.selected = true
+      end
+      
+      @backwards = javax.swing.JRadioButton.new.tap do |backwards|
+        backwards.mnemonic = 'B'
+        backwards.text = "Backwards"
+        backwards.name = "backwards"
+      end
+
+      @ok_button = javax.swing.JButton.new.tap do |ok_button|
+        ok_button.mnemonic = 'O'
+        ok_button.text = "Ok"
+        ok_button.name = "ok_button"
+        ok_button.add_action_listener do |event|
+          hide
+          accept!
+        end
+      end
+
+      @cancel_button = javax.swing.JButton.new.tap do |cancel_button|
+        cancel_button.mnemonic = 'C'
+        cancel_button.text = "Cancel"
+        cancel_button.name = "cancel_button"
+        cancel_button.add_action_listener do |event|
+          hide
+          reject!
+        end
+      end
+    end
+    
+    # this was originally Java from NetBeans, so it's really ugly.
+    # Note that for 1.5 compatibility, we have to use org.jdesktop.layout.GroupLayout
+    # and include swing-layout-1.0.3.jar
+    def init_layout
+      content_pane.layout = org.jdesktop.layout.GroupLayout.new( content_pane ).tap do |layout|
+        getContentPane().setLayout(layout);
+        layout.setHorizontalGroup( \
+            layout.createParallelGroup(org.jdesktop.layout.GroupLayout::LEADING) \
+            .add(layout.createSequentialGroup() \
+                .addContainerGap() \
+                .add(layout.createParallelGroup(org.jdesktop.layout.GroupLayout::LEADING) \
+                    .add(layout.createSequentialGroup() \
+                        .add(21, 21, 21) \
+                        .add(search_label) \
+                        .addPreferredGap(org.jdesktop.layout.LayoutStyle::RELATED) \
+                        .add(layout.createParallelGroup(org.jdesktop.layout.GroupLayout::LEADING, false) \
+                            .add(search_combo, 0, 192, java.lang.Short::MAX_VALUE) \
+                            .add(from_start, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, java.lang.Short::MAX_VALUE) \
+                            .add(regex, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, java.lang.Short::MAX_VALUE) \
+                            .add(whole_words, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, java.lang.Short::MAX_VALUE) \
+                            .add(forwards, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, java.lang.Short::MAX_VALUE) \
+                            .add(backwards))) \
+                    .add(layout.createSequentialGroup() \
+                        .add(ok_button) \
+                        .addPreferredGap(org.jdesktop.layout.LayoutStyle::RELATED, 160, java.lang.Short::MAX_VALUE) \
+                        .add(cancel_button))) \
+                .add(16, 16, 16)) \
+        );
+        layout.setVerticalGroup(
+            layout.createParallelGroup(org.jdesktop.layout.GroupLayout::LEADING) \
+            .add(org.jdesktop.layout.GroupLayout::TRAILING, layout.createSequentialGroup() \
+                .addContainerGap(23, java.lang.Short::MAX_VALUE) \
+                .add(layout.createParallelGroup(org.jdesktop.layout.GroupLayout::BASELINE) \
+                    .add(search_combo, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE) \
+                    .add(search_label)) \
+                .add(18, 18, 18) \
+                .add(from_start) \
+                .addPreferredGap(org.jdesktop.layout.LayoutStyle::RELATED) \
+                .add(regex) \
+                .addPreferredGap(org.jdesktop.layout.LayoutStyle::RELATED) \
+                .add(whole_words) \
+                .add(18, 18, 18) \
+                .add(forwards) \
+                .addPreferredGap(org.jdesktop.layout.LayoutStyle::RELATED) \
+                .add(backwards) \
+                .add(18, 18, 18) \
+                .add(layout.createParallelGroup(org.jdesktop.layout.GroupLayout::BASELINE) \
+                    .add(ok_button) \
+                    .add(cancel_button)) \
+                .add(20, 20, 20)) \
+        );
+      end
+      pack
+    end
+  end
+
+end

data/lib/clevic/swing/selection_model.rb

@@ -0,0 +1,90 @@
+module Clevic
+
+=begin
+QItemSelectionRange contains information about a range of selected items in a 
+model. A range of items is a contiguous array of model items, extending to 
+cover a number of adjacent rows and columns with a common parent item; this 
+can be visualized as a two-dimensional block of cells in a table
+
+file:///usr/share/doc/qt-4.6.2/html/qitemselectionrange.html#details
+=end
+class SelectionRange
+  # row_range and column_range are Range objects
+  def initialize( row_range, column_range )
+    @row_range = row_range
+    @column_range = column_range
+  end
+  
+  def height
+    @row_range.distance
+  end
+  
+  def width
+    @column_range.distance
+  end
+  
+  def top_left
+    SwingTableIndex.new( nil, @row_range.first, @column_range.first )
+  end
+  
+  def bottom_right
+    SwingTableIndex.new( nil, @row_range.last, @column_range.last )
+  end
+end
+
+class SelectionModel
+  def initialize( table_view )
+    @table_view = table_view 
+  end
+  
+  attr_reader :table_view
+  
+  def jtable
+    @table_view.jtable
+  end
+  
+  # return a collection of selection ranges
+  def ranges
+    rv = []
+    jtable.selected_rows.to_a.group.each do |row_group|
+      jtable.selected_columns.to_a.group.each do |column_group|
+        rv << SelectionRange.new( row_group.range, column_group.range )
+      end
+    end
+    rv
+  end
+  
+  def single_cell?
+    jtable.selected_row_count == 1 && jtable.selected_column_count == 1
+  end
+  
+  def selected?( row, column )
+    selected_indexes.first.with do |index|
+      index.row == row &&
+      index.column == column
+    end
+  end
+  
+  # return an array of integer indexes for currently selected rows
+  def row_indexes
+    jtable.selected_rows.to_a
+  end
+  
+  def clear
+    jtable.clear_selection
+  end
+  
+  # return the full set of selected indexes, ordered
+  # by row then column
+  def selected_indexes
+    indexes = []
+    jtable.selected_rows.each do |row_index|
+      jtable.selected_columns.each do |column_index|
+        indexes << table_view.model.create_index( row_index, column_index )
+      end
+    end
+    indexes
+  end
+end
+
+end