clevic 0.12.0 → 0.13.0.b1

data/lib/clevic/swing/table_view_focus.rb

@@ -0,0 +1,47 @@
+module Clevic
+
+  class TableViewFocus < java.awt.FocusTraversalPolicy
+    def initialize( table_view )
+      super()
+      @table_view = table_view
+      @table_view.focus_cycle_root = true
+    end
+    
+    # Returns the Component that should receive the focus after aComponent.
+    # def getComponentAfter(Container aContainer, Component aComponent)
+    def getComponentAfter(container, component)
+      @table_view.jtable
+    end
+
+    # Returns the Component that should receive the focus before aComponent.
+    # def getComponentBefore(Container aContainer, Component aComponent)
+    def getComponentBefore(container, component)
+      @table_view.jtable
+    end
+
+    # Returns the default Component to focus.
+    # def getDefaultComponent(Container aContainer)
+    def getDefaultComponent(container)
+      @table_view.jtable
+    end
+
+    # Returns the first Component in the traversal cycle.
+    # def getFirstComponent(Container aContainer)
+    def getFirstComponent(container)
+      @table_view.jtable
+    end
+    
+    # Returns the Component that should receive the focus when a Window is made visible for the first time.
+    # Component 	getInitialComponent(Window window)
+    def getInitialComponent(window)
+      @table_view.jtable
+    end
+    
+    # Returns the last Component in the traversal cycle.
+    # def getLastComponent(Container aContainer)
+    def getLastComponent(container)
+      @table_view.jtable
+    end
+  end
+  
+end

data/lib/clevic/swing/tag_delegate.rb

@@ -0,0 +1,127 @@
+require 'clevic/swing/delegate'
+require 'clevic/swing/tag_editor.rb'
+
+module Clevic
+
+=begin rdoc
+Delegate for doing simple multi-value fields. Tags, basically.
+=end
+class TagDelegate < Delegate
+  # Create a GUI widget and fill it with the possible values.
+  def init_component( cell_editor = nil )
+    line_editor edit_value
+    # This should be a collection of entities from the related table
+    @items = attribute_value
+  end
+  
+  # Return the GUI component / widget that is displayed when editing.
+  # Usually this will be a combo box widget, but it can be a text editor
+  # in some cases.
+  attr_reader :editor
+  
+  # the cell must be selected before the edit can be clicked
+  def needs_pre_selection?
+    true
+  end
+  
+  # Return a string to be shown to the user.
+  # model_value is an item stored in the combo box model.
+  def display_for( model_value )
+    field.transform_attribute( model_value )
+  end
+  
+  def line_editor( value = nil )
+    @line_editor ||= javax.swing.JTextField.new( value ).tap do |line|
+      line.font = Clevic.tahoma
+    end
+  end
+  
+  def editor
+    line_editor
+  end
+  
+  # Recreate the model and fill it with anything in population that
+  # matches the prefix first, followed by anything in the population that
+  # doesn't match the prefix.
+  # Then set the editor text value to either text, or to the previous
+  # value.
+  # Order is important: if the text is set first it's overridden when
+  # the model is populated.
+  def repopulate( prefix = nil, text = nil )
+    autocomplete do
+      # save text and popup
+      save_item = editor.editor.item
+      dropdown_visible = editor.popup_visible?
+      
+      # repopulate based on the prefix
+      prefix ||= editor.editor.item
+      editor.model = editor.model.class.new
+      # split set into things to display at the top, and things to display further down
+      matching, non_matching = population.partition{ |item| display_for( item ) =~ /^#{prefix}/i }
+      matching.each {|item| editor << item}
+      non_matching.each {|item| editor << item}
+      
+      # restore text and popup
+      editor.editor.item = text || save_item
+      editor.popup_visible = dropdown_visible
+    end
+  end
+    
+  # make sure we don't react to document change events
+  # while we're doing autocompletion. Reentrant
+  def autocomplete( &block )
+    @autocompleting = true
+    yield
+  ensure
+    @autocompleting = false
+  end
+  
+  # http://www.drdobbs.com/184404457 for autocompletion steps
+  def filter_prefix( prefix )
+    # search for matching item in the UI display_for for the items in the combo model
+    candidate = population.map{|item| display_for( item ) }.select {|x| x =~ /^#{prefix}/i }.first
+    unless candidate.nil?
+      first_not_of = candidate.match( /^#{prefix}/i ).offset(0).last
+      invoke_later do
+        autocomplete do
+          # set the shortlist, and the text editor value
+          repopulate prefix, candidate
+          
+          # set the suggestion selection
+          editor.editor.editor_component.with do |text_edit|
+            # highlight the suggested match, and leave caret
+            # at the beginning of the suggested text
+            text_edit.caret_position = candidate.length
+            text_edit.move_caret_position( first_not_of )
+          end
+        end
+      end
+    end
+  end
+  
+  # open the combo box, just like if F4 was pressed
+  # big trouble here with JComboBox firing an comboEdited action
+  # (probably) on focusGained
+  # which causes the popup to be hidden again
+  def full_edit
+    # Must request focus and then once focus is received, show popup.
+    # Otherwise focus received hides popup.
+    invoke_later do
+      #~ editor.add_focus_listener( LittleFocusPopper.new )
+      #~ editor.request_focus_in_window
+      editor.show_popup
+    end
+  end
+  
+  # open the text editor component
+  #~ def minimal_edit
+  #~ end
+  
+  # return an array of related entity objects, to be
+  # passed into the attribute setter
+  def value
+    "the value"
+  end
+end
+
+end

data/lib/clevic/swing/tag_editor.rb

@@ -0,0 +1,101 @@
+require 'clevic/swing/delegate'
+
+module Clevic
+
+# all this just to format a display item...
+# .... and work around various other Swing stupidities
+class TagEditor < javax.swing.JComponent
+  def initialize( field )
+    super()
+    @field = field
+    
+    create_fields
+    init_layout
+  end
+  
+  attr_reader :field
+  attr_reader :entity
+  
+  # Hopefully called by the editor framework
+  # might be init_component
+  def configureEditor( editor, entity )
+    @entity = entity
+    item_list.model.one = entity
+  end
+
+  attr_reader :text_field, :item_list, :ok_button, :cancel_button, :add_button, :remove_button
+
+  def create_fields
+    @item_list = TableView.new( field.many_view )
+
+    @text_field = javax.swing.JTextField.new
+    @ok_button = javax.swing.JButton.new
+    @cancel_button = javax.swing.JButton.new
+    @add_button = javax.swing.JButton.new
+    @remove_button = javax.swing.JButton.new
+  end
+  
+  def init_layout
+    # This is mostly cut-n-pasted from the Netbeans Java sources. So don't tweak it.
+    text_field.setName("text_field");
+
+    item_list.setName("item_list");
+
+    ok_button.setText("OK");
+    ok_button.setToolTipText("Accept edits");
+    ok_button.setName("ok_button");
+
+    cancel_button.setText("Cancel");
+    cancel_button.setToolTipText("Cancel edits");
+    cancel_button.setName("cancel_button");
+
+    add_button.setText("+");
+    add_button.setToolTipText("Add a new item");
+    add_button.setBorder(nil);
+    add_button.setName("add_button");
+
+    remove_button.setText("-");
+    remove_button.setToolTipText("Remove selected item");
+    remove_button.setBorder(nil);
+    remove_button.setName("remove_button");
+
+    layout = org.jdesktop.layout.GroupLayout.new( self );
+    setLayout(layout);
+    layout.setHorizontalGroup(
+        layout.createParallelGroup(org.jdesktop.layout.GroupLayout::LEADING) \
+        .add(layout.createSequentialGroup() \
+            .addContainerGap() \
+            .add(layout.createParallelGroup(org.jdesktop.layout.GroupLayout::LEADING) \
+                .add(item_list, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, 210, java.lang.Short::MAX_VALUE) \
+                .add(text_field, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, 210, java.lang.Short::MAX_VALUE) \
+                .add(layout.createSequentialGroup() \
+                    .add(ok_button) \
+                    .addPreferredGap(org.jdesktop.layout.LayoutStyle::RELATED, 82, java.lang.Short::MAX_VALUE) \
+                    .add(cancel_button)) \
+                .add(layout.createSequentialGroup() \
+                    .add(add_button, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE, 27, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE) \
+                    .addPreferredGap(org.jdesktop.layout.LayoutStyle::RELATED) \
+                    .add(remove_button, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE, 27, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE))) \
+            .addContainerGap()) \
+    );
+    layout.setVerticalGroup(
+        layout.createParallelGroup(org.jdesktop.layout.GroupLayout::LEADING) \
+        .add(layout.createSequentialGroup() \
+            .addContainerGap() \
+            .add(text_field, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE, org.jdesktop.layout.GroupLayout::DEFAULT_SIZE, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE) \
+            .add(18, 18, 18) \
+            .add(item_list, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE, 202, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE) \
+            .addPreferredGap(org.jdesktop.layout.LayoutStyle::RELATED) \
+            .add(layout.createParallelGroup(org.jdesktop.layout.GroupLayout::BASELINE) \
+                .add(add_button, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE, 20, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE) \
+                .add(remove_button, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE, 19, org.jdesktop.layout.GroupLayout::PREFERRED_SIZE)) \
+            .addPreferredGap(org.jdesktop.layout.LayoutStyle::RELATED, 30, java.lang.Short::MAX_VALUE) \
+            .add(layout.createParallelGroup(org.jdesktop.layout.GroupLayout::BASELINE) \
+                .add(ok_button) \
+                .add(cancel_button)) \
+            .addContainerGap()) \
+    );
+  end
+end
+
+end

data/lib/clevic/swing/text_area_delegate.rb

@@ -0,0 +1,46 @@
+require 'clevic/swing/delegate'
+
+module Clevic
+
+  class EditorScrollPane < javax.swing.JScrollPane
+    # work around stupid JTable non-api for setting
+    # cell editor component size
+    # rectangle is a java.awt.Rectangle
+    def setBounds( rectangle )
+      height = 100
+      newrect = java.awt.Rectangle.new( rectangle.x, rectangle.y, rectangle.width, height )
+      super( newrect )
+    end
+  end
+  
+  class TextAreaDelegate < Delegate
+    # TODO check that Ctrl-VK_ENTER stops editing
+    def init_component( cell_editor )
+      @cell_editor = cell_editor
+      text_component.text = edit_value
+      text_component.rows = ( edit_value.andand.count( "\n" ) || 0 ) + 2
+      text_component.select_all
+    end
+    
+    def editor
+      @editor ||= EditorScrollPane.new( text_component, javax.swing.ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS, javax.swing.ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS )
+    end
+    
+    def text_component
+      @text_component ||= javax.swing.JTextArea.new
+    end
+    
+    def value
+      text_component.text
+    end
+    
+    def minimal_edit
+      text_component.select_all
+    end
+    
+    def needs_pre_selection?
+      true
+    end
+  end
+
+end

data/lib/clevic/swing/text_delegate.rb

@@ -0,0 +1,31 @@
+require 'clevic/swing/delegate'
+
+module Clevic
+
+  class TextDelegate < Delegate
+    # TODO check that VK_ENTER stops editing
+    def init_component( cell_editor )
+      editor.text = edit_value
+      editor.select_all
+    end
+    
+    def editor
+      @editor ||= javax.swing.JTextField.new.tap do |e|
+        e.horizontal_alignment = field.swing_alignment
+      end
+    end
+    
+    def value
+      editor.text
+    end
+    
+    def minimal_edit
+      editor.select_all
+    end
+    
+    def needs_pre_selection?
+      true
+    end
+  end
+
+end

data/lib/clevic/swing/ui/build.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- You may freely edit this file. See commented blocks below for -->
+<!-- some examples of how to customize the build. -->
+<!-- (If you delete it and reopen the project it will be recreated.) -->
+<!-- By default, only the Clean and Build commands use this build script. -->
+<!-- Commands such as Run, Debug, and Test only use this build script if -->
+<!-- the Compile on Save feature is turned off for the project. -->
+<!-- You can turn off the Compile on Save (or Deploy on Save) setting -->
+<!-- in the project's Project Properties dialog box.-->
+<project name="ui" default="default" basedir=".">
+    <description>Builds, tests, and runs the project ui.</description>
+    <import file="nbproject/build-impl.xml"/>
+    <!--
+
+    There exist several targets which are by default empty and which can be 
+    used for execution of your tasks. These targets are usually executed 
+    before and after some main targets. They are: 
+
+      -pre-init:                 called before initialization of project properties
+      -post-init:                called after initialization of project properties
+      -pre-compile:              called before javac compilation
+      -post-compile:             called after javac compilation
+      -pre-compile-single:       called before javac compilation of single file
+      -post-compile-single:      called after javac compilation of single file
+      -pre-compile-test:         called before javac compilation of JUnit tests
+      -post-compile-test:        called after javac compilation of JUnit tests
+      -pre-compile-test-single:  called before javac compilation of single JUnit test
+      -post-compile-test-single: called after javac compilation of single JUunit test
+      -pre-jar:                  called before JAR building
+      -post-jar:                 called after JAR building
+      -post-clean:               called after cleaning build products
+
+    (Targets beginning with '-' are not intended to be called on their own.)
+
+    Example of inserting an obfuscator after compilation could look like this:
+
+        <target name="-post-compile">
+            <obfuscate>
+                <fileset dir="${build.classes.dir}"/>
+            </obfuscate>
+        </target>
+
+    For list of available properties check the imported 
+    nbproject/build-impl.xml file. 
+
+
+    Another way to customize the build is by overriding existing main targets.
+    The targets of interest are: 
+
+      -init-macrodef-javac:     defines macro for javac compilation
+      -init-macrodef-junit:     defines macro for junit execution
+      -init-macrodef-debug:     defines macro for class debugging
+      -init-macrodef-java:      defines macro for class execution
+      -do-jar-with-manifest:    JAR building (if you are using a manifest)
+      -do-jar-without-manifest: JAR building (if you are not using a manifest)
+      run:                      execution of project 
+      -javadoc-build:           Javadoc generation
+      test-report:              JUnit report generation
+
+    An example of overriding the target for project execution could look like this:
+
+        <target name="run" depends="ui-impl.jar">
+            <exec dir="bin" executable="launcher.exe">
+                <arg file="${dist.jar}"/>
+            </exec>
+        </target>
+
+    Notice that the overridden target depends on the jar target and not only on 
+    the compile target as the regular run target does. Again, for a list of available 
+    properties which you can use, check the target you are overriding in the
+    nbproject/build-impl.xml file. 
+
+    -->
+</project>

data/lib/clevic/swing/ui/dist/README.TXT

@@ -0,0 +1,33 @@
+========================
+BUILD OUTPUT DESCRIPTION
+========================
+
+When you build an Java application project that has a main class, the IDE
+automatically copies all of the JAR
+files on the projects classpath to your projects dist/lib folder. The IDE
+also adds each of the JAR files to the Class-Path element in the application
+JAR files manifest file (MANIFEST.MF).
+
+To run the project from the command line, go to the dist folder and
+type the following:
+
+java -jar "ui.jar" 
+
+To distribute this project, zip up the dist folder (including the lib folder)
+and distribute the ZIP file.
+
+Notes:
+
+* If two JAR files on the project classpath have the same name, only the first
+JAR file is copied to the lib folder.
+* Only JAR files are copied to the lib folder.
+If the classpath contains other types of files or folders, none of the
+classpath elements are copied to the lib folder. In such a case,
+you need to copy the classpath elements to the lib folder manually after the build.
+* If a library on the projects classpath also has a Class-Path element
+specified in the manifest,the content of the Class-Path element has to be on
+the projects runtime path.
+* To set a main class in a standard Java project, right-click the project node
+in the Projects window and choose Properties. Then click Run and enter the
+class name in the Main Class field. Alternatively, you can manually type the
+class name in the manifest Main-Class element.