rbcurse-experimental 0.0.0

data/lib/rbcurse/experimental/widgets/rscrollform.rb

@@ -0,0 +1,418 @@
+=begin
+  * Name: ScrollForm - a form that can take more than the screen and focus only on what's visible
+  *  This class originated in TabbedPane for the top button form which only scrolls
+  *  horizontally and uses objects that have a ht of 1. Here we have to deal with
+  * large objects and vertical scrolling.
+  * Description: 
+  * Author: rkumar
+  
+  --------
+  * Date: 2010-03-16 11:32 
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+
+NOTE: 
+    There are going to be tricky cases we have to deal with such as objects that start in the viewable
+area but finish outside, or vice versa.
+
+    What if we wish some static text to be displayed at top or bottom of ScrollForm
+=end
+require 'logger'
+require 'rbcurse'
+
+#include Ncurses # FFI 2011-09-8 
+include RubyCurses
+module RubyCurses
+  extend self
+  class ScrollForm < RubyCurses::Form
+    # the pad prints from this col to window
+    attr_accessor :pmincol # advance / scroll columns
+    # the pad prints from this row to window, usually 0
+    attr_accessor :pminrow # advance / scroll rows (vertically)
+    #attr_accessor :display_w # width of screen display NOW METHODS
+    #attr_accessor :display_h # ht of screen display
+    attr_accessor :row_offset, :col_offset
+    attr_accessor :scroll_unit # by how much should be scroll
+    attr_reader :orig_top, :orig_left
+    attr_reader :window
+    attr_accessor :name
+    attr_reader :cols_panned, :rows_panned
+    def initialize win, &block
+      @target_window = win
+      super
+      @pminrow = @pmincol = 0
+      @row_offset = @col_offset = 0
+      @scroll_unit = 3
+      @cols_panned = @rows_panned = 0
+      @repaint_all = true
+
+      # take display dimensions from window. It is safe to override immediately after form creation
+      @display_h = win.height
+      @display_w = win.width
+      if @display_h == 0
+        @display_h = (Ncurses.LINES - win.top - 2)
+      else
+        @display_h = win.height - 2
+      end
+      if @display_w == 0
+        @display_w = (Ncurses.COLS - win.left - 2) 
+      else
+        # copywin fails unless u use rootwindow, so what gives in this case
+        @display_w = win.width - 2
+      end
+      
+      init_vars
+    end
+    def init_vars
+      # maybe we should use C-x combinations rather than these keys which might be used
+      #  by other widgets, apps
+      bind_key(?\M-h, :scroll_left)
+      bind_key(?\M-l, :scroll_right)
+      bind_key(?\M-n, :scroll_down)
+      bind_key(?\M-p, :scroll_up)
+    end
+    def should_print_border flag=true
+      @print_border_flag = flag
+      @row_offset = @col_offset = 1
+    end
+    # This is how we set size of pad and where it prints on screen
+    # This is all that's needed after constructor.
+    # @param [Fixnum] t top (row on screen to print pad on)
+    # @param [Fixnum] l left (col on screen to print)
+    # @param [Fixnum] h height (how many lines in Pad, usually more that screens actual height)
+    # @param [Fixnum] w width (how many cols in Pad, often more than screens width)
+    #
+    def set_pad_dimensions(t, l, h, w )
+      @pad_h = h
+      @pad_w = w
+      @top = @orig_top = t
+      @left = @orig_left = l
+      create_pad
+    end
+    # old program tabbed pane uses this. fix
+    # @deprecated use set_pad_dimensions
+    def set_layout h,w,t,l
+      set_pad_dimensions t,l,h,w
+    end
+    def display_h(*val)
+      if val.empty?
+        return @display_h
+      else
+        #raise ArgumentError "display_h should be ... " if val[0] ...
+        oldvalue = @display_h
+        @display_h = val[0]
+        $log.debug "XXX:given display_h to #{@display_h} "
+        @display_h = [@display_h, @target_window.height - 2].min unless @target_window.height == 0
+        $log.debug "XXX:set display_h to #{@display_h} "
+        #fire_property_handler(:display_h, oldvalue, @display_h)
+      end
+      self
+    end
+    #
+    # By default we are determining these 2 values based on window's dims.
+    # However, if you use a widget that is smaller than the window, then
+    # you will want to overwrite these values. 
+    def display_w(*val)
+      if val.empty?
+        return @display_w
+      else
+        #raise ArgumentError "display_h should be ... " if val[0] ...
+        oldvalue = @display_w
+        @display_w = val[0]
+        @display_w = [@display_w, @target_window.width - 2].min unless @target_window.width == 0
+        $log.debug "XXX:set display_w to #{@display_w} "
+        #fire_property_handler(:display_h, oldvalue, @display_h)
+      end
+      self
+    end
+    ## 
+    # create a pad to work on. 
+    # XXX We reuse window, which is already the main window
+    # So if we try creating pad later, then old external window is used.
+    # However, many methods in superclass operate on window so we needed to overwrite. What do i do ?
+    #private
+    def create_pad
+      #raise "Pad already created" if @pad
+      return @pad if @pad
+      r = @top
+      c = @left
+      layout = { :height => @pad_h, :width => @pad_w, :top => r, :left => c } 
+      @window = VER::Pad.create_with_layout(layout)
+  
+      @window.name = "Pad::ScrollPad" # 2010-02-02 20:01 
+      @name = "Form::ScrollForm"
+      @pad = @window
+      return @window
+    end
+    public
+    def scroll_right
+      s = @scroll_unit + $multiplier
+      $log.debug " scroll_right #{s} m: #{$multiplier} "
+      $multiplier = 0
+      return false if !validate_scroll_col(@pmincol + s)
+      @pmincol += s # some check is required or we'll crash
+      @cols_panned -= s
+      $log.debug " handled ch M-l in ScrollForm"
+      @window.modified = true
+      return 0
+    end
+    ## 
+    # validate fails once unit + mult > 1. Then it won't go further
+    # unit should be one by default.
+    def scroll_left
+      s = @scroll_unit + $multiplier
+      $log.debug " scroll_left #{s} m: #{$multiplier} "
+      $multiplier = 0
+      #return false if !validate_scroll_col(@pmincol - s)
+      if !validate_scroll_col(@pmincol - s)
+        @pmincol = 0
+        @cols_panned  = 0 
+      else
+        @pmincol -= s # some check is required or we'll crash
+        @cols_panned += s
+      end
+      @window.modified = true
+      return 0
+    end
+    def scroll_down
+      s = @scroll_unit + $multiplier; $multiplier = 0
+      return false if !validate_scroll_row(@pminrow + s)
+      @pminrow += s # some check is required or we'll crash
+      @rows_panned -= s
+      @window.modified = true
+      #@repaint_all = true
+      return 0
+    end
+    def scroll_up
+      s = @scroll_unit + $multiplier; $multiplier = 0
+      $log.debug " scroll_up #{s} "
+      #return false if !validate_scroll_row(@pminrow - s)
+      if !validate_scroll_row(@pminrow - s)
+        @pminrow = 0
+        @rows_panned = 0
+        $log.debug " !valid #{@pminrow} "
+      else
+        @pminrow -= s # some check is required or we'll crash
+        @rows_panned += s
+        $log.debug " valid #{@pminrow} "
+      end
+      @window.modified = true
+      #@repaint_all = true
+      return 0
+    end
+    # print a border on the main window, just for kicks
+    def print_border
+      $log.debug " SCROLL print_border ..."
+      #@window.print_border_only(@top-@rows_panned, @left+@cols_panned, @display_h, @display_w, $datacolor)
+      @target_window.print_border_only(@top, @left, @display_h, @display_w+1, $datacolor)
+    end
+    def print_footer
+      footer = "Lines %d-%d (%d)  Cols %d-%d (%d) " % [ @pminrow, @pminrow + @display_h, @orig_top + @pad_h, @pmincol, @pmincol + @display_w, @orig_left + @pad_w ] 
+      @target_window.printstring(@top +@display_h, @left + 3, footer, $datacolor)
+    end
+    # XXX what if we want a static area at bottom ?
+    # maybe we should rename targetwindow to window
+    #  and window to pad
+    #  super may need target window
+    def repaint
+      print_border if @repaint_all and @print_border_flag
+      print_footer if @print_border_flag
+      $log.debug " scrollForm repaint calling parent #{@row} #{@col}+ #{@cols_panned} #{@col_offset} "
+      super
+      prefresh
+      if @print_border_flag
+        _print_more_data_marker true
+        _print_more_columns_marker true
+      end
+      #$log.debug " @target_window.wmove #{@row+@rows_panned+@row_offset}, #{@col+@cols_panned+@col_offset}  "
+      @target_window.wmove @row+@rows_panned+@row_offset, @col+@cols_panned+@col_offset
+      @window.modified = false
+      @repaint_all = false
+    end
+    ## refresh pad onto window
+    # I am now copying onto main window, else prefresh has funny effects
+    def prefresh
+      ## reduce so we don't go off in top+h and top+w
+      $log.debug "  start ret = @buttonpad.prefresh( #{@pminrow} , #{@pmincol} , #{@top} , #{@left} , top + #{@display_h} left + #{@display_w} ) "
+      if @pminrow + @display_h > @orig_top + @pad_h
+        $log.debug " if #{@pminrow} + #{@display_h} > #{@orig_top} +#{@pad_h} "
+        $log.debug " ERROR 1 "
+        #return -1
+      end
+      if @pmincol + @display_w > @orig_left + @pad_w
+      $log.debug " if #{@pmincol} + #{@display_w} > #{@orig_left} +#{@pad_w} "
+        $log.debug " ERROR 2 "
+        return -1
+      end
+      # actually if there is a change in the screen, we may still need to allow update
+      # but ensure that size does not exceed
+      if @top + @display_h > @orig_top + @pad_h
+      $log.debug " if #{@top} + #{@display_h} > #{@orig_top} +#{@pad_h} "
+        $log.debug " ERROR 3 "
+        return -1
+      end
+      if @left + @display_w > @orig_left + @pad_w
+      $log.debug " if #{@left} + #{@display_w} > #{@orig_left} +#{@pad_w} "
+        $log.debug " ERROR 4 "
+        return -1
+      end
+      # maybe we should use copywin to copy onto @target_window
+      $log.debug "   ret = @window.prefresh( #{@pminrow} , #{@pmincol} , #{@top} , #{@left} , #{@top} + #{@display_h}, #{@left} + #{@display_w} ) "
+      omit = 0
+      # this works but if want to avoid copying border
+      #ret = @window.prefresh(@pminrow, @pmincol, @top+@row_offset, @left+@col_offset, @top + @display_h - @row_offset , @left + @display_w - @col_offset)
+      #
+      $log.debug "ret = @window.copywin( #{@pminrow} , #{@pmincol} , #{@top+@row_offset} , #{@left+@col_offset} , #{@top} + #{@display_h} - #{@row_offset} , #{@left} + #{@display_w} - #{@col_offset} ,  0)"
+      ## Haha , we are back to the old notorious copywin which has given mankind
+      # so much grief that it should be removed in the next round of creation.
+      ret = @window.copywin(@target_window.get_window, @pminrow, @pmincol, @top+@row_offset, @left+@col_offset, 
+            @top + @display_h - @row_offset , @left + @display_w - @col_offset,  0)
+
+      $log.debug " copywin ret = #{ret} "
+    end
+    private
+    def validate_scroll_row minrow
+       return false if minrow < 0
+      if minrow + @display_h > @orig_top + @pad_h
+        $log.debug " if #{minrow} + #{@display_h} > #{@orig_top} +#{@pad_h} "
+        $log.debug " ERROR 1 "
+        return false
+      end
+      return true
+    end
+    def validate_scroll_col mincol
+      return false if mincol < 0
+      if mincol + @display_w > @orig_left + @pad_w
+      $log.debug " if #{mincol} + #{@display_w} > #{@orig_left} +#{@pad_w} "
+        $log.debug " ERROR 2 "
+        return false
+      end
+      return true
+    end
+    # when tabbing through buttons, we need to account for all that panning/scrolling goin' on
+    # this is typically called by putchar or putc in editable components like field.
+    # XXX DELETE THIS IS SUPPOSE
+    def OLDsetrowcol r, c
+      $log.debug " SCROLL setrowcol #{r},  #{c} + #{@cols_panned}"
+      # aha ! here's where i can check whether the cursor is falling off the viewable area
+      cc = nil
+      rr = nil
+      if c
+        cc = c #+ @cols_panned
+        if c+@cols_panned < @orig_left
+          # this essentially means this widget (button) is not in view, its off to the left
+          $log.debug " setrowcol OVERRIDE #{c} #{@cols_panned} < #{@orig_left} "
+          $log.debug " aborting settrow col for now"
+          return
+        end
+        if c+@cols_panned > @orig_left + @display_w
+          # this essentially means this button is not in view, its off to the right
+          $log.debug " setrowcol OVERRIDE #{c} #{@cols_panned} > #{@orig_left} + #{@display_w} "
+          $log.debug " aborting settrow col for now"
+          return
+        end
+      end
+      if r
+        rr = r+@rows_panned
+      end
+      super rr, cc
+    end
+    public
+    def add_widget w
+      super
+      $log.debug " inside add_widget #{w.name}  pad w #{@pad_w} #{w.col}, #{@pad_h}  "
+      if w.col >= @pad_w
+        @pad_w += 10 # XXX currently just a guess value, we need length and maybe some extra
+        @window.wresize(@pad_h, @pad_w) if @pad
+      end
+      if w.row >= @pad_h
+        @pad_h += 10 # XXX currently just a guess value, we need length and maybe some extra
+        $log.debug " SCROLL add_widget ..."
+        @window.wresize(@pad_h, @pad_w) if @pad
+      end
+    end
+    ## Is a component visible, typically used to prevent traversal into the field
+    # @returns [true, false] false if components has scrolled off
+    def visible? component
+      r, c = component.rowcol
+      return false if c+@cols_panned < @orig_left
+      return false if c+@cols_panned > @orig_left + @display_w
+      # XXX TODO for rows UNTESTED for rows
+      return false if r + @rows_panned < @orig_top
+      return false if r + @rows_panned > @orig_top + @display_h - 2
+
+      return true
+    end
+    # returns index of first visible component. Currently using column index
+    # I am doing this for horizontal scrolling presently
+    # @return [index, -1] -1 if none visible, else index/offset
+    def first_visible_component_index
+      @widgets.each_with_index do |w, ix|
+        return ix if visible?(w) and focusable?(w)
+      end
+      return -1
+    end
+    def last_visible_component_index
+      ret = -1
+      @widgets.each_with_index do |w, ix|
+        ret = ix if visible?(w) and focusable?(w)
+      end
+      return ret
+    end
+    def req_first_field
+      index = first_visible_component_index
+      ret = select_field(index)
+      return ret
+    end
+    def req_last_field
+      select_field(last_visible_component_index)
+    end
+    def focusable?(w)
+      w.focusable and visible?(w)
+    end
+
+    # XXX needs to be called from repaint and print_border
+    # @param [boolean] should marker be printed or not
+    def _print_more_data_marker tf
+      tf = false
+      # the bottom marker meaning there's more data below
+      if @pminrow + @display_h < @pad_h
+        tf = true
+      end
+      marker = tf ?  Ncurses::ACS_CKBOARD : Ncurses::ACS_VLINE
+      h = @display_h; w = @display_w
+      r = @orig_top
+      c = @orig_left
+      $log.debug " more data #{r+h-1}, #{c+w-1} : row #{r} h #{h} w #{w} col #{c} "
+      @target_window.mvwaddch r+h-1, c+w-0, marker
+      # the top marker to show that there is data above
+      marker = @pminrow > 0 ?  Ncurses::ACS_CKBOARD : Ncurses::ACS_VLINE
+      @target_window.mvwaddch r+1, c+w-0, marker
+    end
+
+    # XXX needs to be called from repaint and print_border
+    # @param [boolean] should marker be printed or not
+    def _print_more_columns_marker tf
+      tf = false
+      if @pmincol + @display_w < @pad_w
+        tf = true
+      end
+      marker = tf ?  Ncurses::ACS_CKBOARD : Ncurses::ACS_HLINE
+      h = @display_h; w = @display_w
+      r = @orig_top
+      c = @orig_left
+      @target_window.mvwaddch r+h, c+w-2, marker
+      #
+      # show if columns to left or not
+      marker = @pmincol > 0 ?  Ncurses::ACS_CKBOARD : Ncurses::ACS_HLINE
+      @target_window.mvwaddch r+h, c+1, marker
+    end                                                                                                            
+  end # class ScrollF
+
+  # the return of the prodigals
+  # The Expanding Heart
+  # The coming together of all those who were
+
+
+end # module

data/lib/rbcurse/experimental/widgets/stackflow.rb

@@ -0,0 +1,478 @@
+=begin
+  * Name: stackflow.rb
+          A version of Container that uses stacks and flows and later grids
+          to place components
+          This is not a form. Thus it can be safely placed as a widget
+          without all the complicatinos of a form embedded inside another.
+NOTE: Still experimental
+  * Description   
+  * Author: rkumar (http://github.com/rkumar/rbcurse/)
+  * Date:  23.10.11 - 19:55
+  * License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+  * Last update:  30.10.11 - 12:55
+
+  == CHANGES
+     Have moved most things out to a module ModStack, so this is sort of just 
+     a skeletal container
+    x take care of margins
+    Resizing components
+    If window or container resized then redo the calc again.
+    Flow to have option of right to left orientation
+  == TODO 
+    - If user specifies width, height then to be accounted when calculating weight. Also,
+      in such cases we must try not to overwrite h/w when calculating.
+    - changing an objects config not easy since it is stored in item, user may not have
+      handle to item
+    - weightx weighty
+    - RESET height only if expandable
+    - exceeding 100 will result in exceeding container.
+    - C-a C-e misbehaving in examples
+
+=end
+
+require 'rbcurse'
+require 'rbcurse/core/include/bordertitle'
+require 'rbcurse/core/util/basestack'
+
+include RubyCurses
+module RubyCurses
+  extend self
+
+  # This is a more advanced version of container
+  # which allows user to stack or flow components, including
+  # embedding stacks within flows and viceversa.
+
+
+  class StackFlow < Widget
+
+    include BorderTitle
+    include ModStack
+    # should container stack objects ignoring users row col
+    # this is esp needed since App sets row and col which is too early
+    # This is now the default value, till i can redo things
+    #dsl_accessor :stack
+    attr_reader  :current_component
+    attr_reader  :components
+
+    def initialize form=nil, config={}, &block
+      @suppress_borders = false
+      @row_offset = @col_offset = 1
+      @_events ||= []
+      @focusable = true
+      @editable = false
+      @components = [] # all components
+      @focusables = [] # focusable components, makes checks easier
+      @active     = []
+      super
+
+      init_vars
+    end
+    def init_vars
+      @repaint_required = true
+      @row_offset = @col_offset = 0 if @suppress_borders 
+      @ctr = 0
+
+      @internal_width = 2
+      @internal_width = 1 if @suppress_borders
+      @name ||= "a_stackflow"
+      bind_key(?\M-1, :increase_current)
+      bind_key(?\M-2, :decrease_current)
+      #raise "NO components !" if @components.empty?
+      calc_weightages2(@components, self) # FIXME this needs to move to basestack
+
+    end
+
+
+    # NOTE this is called by basestack so it cannot be here FIXME
+
+    # NOTE: since we are handling the traversal, we delink the object from any
+    # form's widgets array  that might have been added. Whenever a form is available,
+    # we set it (without adding widget to it) so it can print using the form's window.
+    # 
+    # @param [Widget] to add
+    private
+    def __add *items
+      items.each do |c|  
+        raise ArgumentError, "Nil component passed to add" unless c
+        if c.is_a? Widget
+          if c.form && c.form != @form
+            $log.debug " removing widget VIMSPLIT #{c.class} wr:  #{c.row} row:#{@row} ht:#{@height} "
+            c.form.remove_widget c
+            c.form = nil
+            # or should i just stack them myself and screw what you've asked for
+          end
+          # take it out of form's control. We will control it.
+          if c.form
+            c.form.remove_widget c
+          end
+          # shoot, what if at this point the container does not have a form
+          attach_form c if @form
+        end
+        # most likely if you have created both container and widgets
+        # inside app, it would have given row after container
+
+        #@components << c
+        if c.focusable
+          @focusables << c 
+          @current_component ||= c # only the first else cursor falls on last on enter
+        end
+
+      end # items each
+      self
+    end
+
+    # When we get a form, we silently attach it to this object, without the form
+    #  knowing. We don't want form managing this object.
+    def attach_form c
+      c.form = @form
+      c.override_graphic @graphic
+      c.parent_component = self
+    end
+    public
+    def widgets; @components; end
+    # what of by_name
+
+
+
+    # repaint object
+    # called by Form, and sometimes parent component (if not form).
+    def repaint # stackflow
+      my_win = @form ? @form.window : @target_window
+      @graphic = my_win unless @graphic
+      raise " #{@name} NO GRAPHIC set as yet                 STACKFLOW paint " unless @graphic
+      # actually at this level we don't have margins set -- not yet.
+      @margin_left   ||= 0
+      @margin_right  ||= 0
+      @margin_top    ||= 0
+      @margin_bottom ||= 0
+      r  = @row + @row_offset + @margin_top
+      c  = @col + @col_offset + @margin_left
+      ht = @height-2-(@margin_top + @margin_bottom)
+      wd = @width -2-(@margin_left + @margin_right)
+      # should this not happen only if repaint_required ?
+      @components.each { |e| 
+        e.parent_component = self
+        e.row              = r
+        e.col              = c
+        # check that we are not trying to print outside bounds
+        # by default we are stacking top level comps regardless of stack or flow
+        #  otherwise too complicated
+        if e.is_a? BaseStack 
+          # using ||= allows us to use overrides given by user
+          # but disallows us from calculating if size changes
+            e.height           = (ht) * (e.weight * 0.01)
+            e.height           = e.height.round 
+            e.width            = wd 
+            if e.row + e.height >= @row + @height
+              #alert "is exceeding #{e.row} #{e.height} > #{@row} + #{@height} "
+              e.height = @height - e.row - 1
+            end
+            r += e.height
+            $log.debug "XXX: STACK r:#{e.row} e.h: #{e.height} w:#{e.weight} h: #{@height} "
+          #if e.type == :flow
+            #e.height           ||= (@height-2) * (e.weight * 0.01)
+            #e.height           = e.height.round
+            #e.width            ||= (@width-2) 
+            #r += e.height
+          #elsif e.type == :stack
+            #e.width            ||= (@width-2) * (e.weight * 0.01)
+            #e.width            = e.width.round
+            #e.height           ||= (@height-2)
+            #c += e.width
+          #end
+        end
+        check_coords e
+        attach_form e unless e.form
+      } # seeme one if printing out
+      last = @components.last
+      if last.row + last.height < @row + @height
+        last.height += 1 # @row + @height - last.row + last.height
+      end
+
+      # if some major change has happened then repaint everything
+      # if multiple components then last row and col needs to be stored or else overlap will happen FIXME
+      if @repaint_required
+        $log.debug " STACKFLOW repaint graphic #{@graphic}, size:#{@components.size} "
+        print_borders unless @suppress_borders # do this once only, unless everything changes
+        @components.each { |e| e.repaint_all(true); e.repaint }
+      else
+        @components.each { |e| e.repaint }
+      end # if repaint_required
+
+      @repaint_required = false
+    end
+
+    private
+    def check_coords e  # container
+      r = e.row
+      c = e.col
+      if r >= @row + @height
+        $log.warn "XXX: WARN #{e.class} is out of bounds row #{r} "
+        e.visible = false
+      end
+      if c >= @col + @width
+        $log.warn "XXX: WARN #{e.class} is out of bounds col #{c} "
+        e.visible = false
+      end
+      if e.row + e.height >= @height
+        $log.warn "XXX: WARN #{e.class} is out of bounds row #{e.row} + h #{e.height} >= #{@height} "
+        #e.visible = false
+      end
+      if e.col + e.width >= @width
+        $log.warn "XXX: WARN #{e.class} is out of bounds col #{e.col} + w #{e.width} >= #{@width} "
+        #e.visible = false
+      end
+    end
+
+    public
+    # called by parent or form, otherwise its private
+    def handle_key ch
+      $log.debug " STACKFLOW handle_key #{ch} "
+      return if @components.empty?
+      _multiplier = ($multiplier == 0 ? 1 : $multiplier )
+
+      # should this go here 2011-10-19 
+      unless @_entered
+        $log.warn "XXX WARN: calling ON_ENTER since in this situation it was not called"
+        on_enter
+      end
+      if ch == KEY_TAB
+        $log.debug "STACKFLOW GOTO NEXT TAB"
+        return goto_next_component
+      elsif ch == KEY_BTAB
+        return goto_prev_component
+      end
+      comp = @current_component
+      $log.debug " STACKFLOW handle_key #{ch}: #{comp}" 
+      if comp
+        ret = comp.handle_key(ch) 
+        $log.debug " STACKFLOW handle_key#{ch}: #{comp} returned #{ret} " 
+        if ret != :UNHANDLED
+          comp.repaint # NOTE: if we don;t do this, then it won't get repainted. I will have to repaint ALL
+          # in repaint of this.
+          return ret 
+        end
+        $log.debug "XXX STACKFLOW key unhandled by comp #{comp.name} "
+      else
+        $log.warn "XXX STACKFLOW key unhandled NULL comp"
+      end
+      case ch
+      when ?\C-c.getbyte(0)
+        $multiplier = 0
+        return 0
+      when ?0.getbyte(0)..?9.getbyte(0)
+        $log.debug " VIM coming here to set multiplier #{$multiplier} "
+        $multiplier *= 10 ; $multiplier += (ch-48)
+        return 0
+      end
+      ret = process_key ch, self
+      # allow user to map left and right if he wants
+      if ret == :UNHANDLED
+        case ch
+        when KEY_UP
+          # form will pick this up and do needful
+          return goto_prev_component #unless on_first_component?
+        when KEY_LEFT
+          # if i don't check for first component, key will go back to form,
+          # but not be processes. so focussed remain here, but be false.
+          # In case of returnign an unhandled TAB, on_leave will happen and cursor will move to 
+          # previous component outside of this.
+          return goto_prev_component unless on_first_component?
+        when KEY_RIGHT
+          return goto_next_component #unless on_last_component?
+        when KEY_DOWN
+          return goto_next_component #unless on_last_component?
+        else 
+          @_entered = false
+          return :UNHANDLED
+        end
+      end
+
+      $multiplier = 0
+      return 0
+    end
+    # Actually we should only go to current component if it accepted
+    # a key stroke. if user tabbed thru it, then no point going back to
+    # it. Go to first or last depending on TAB or BACKTAB otherwise.
+    # NOTE: if user comes in using DOWN or UP, last traversed component will get the focus
+    #
+    def on_enter
+      # if BTAB, the last comp XXX they must be focusable FIXME
+      if $current_key == KEY_BTAB || $current_key == KEY_UP
+        @current_component = @focusables.last
+      elsif $current_key == KEY_TAB || $current_key == KEY_DOWN
+        @current_component = @focusables.first
+      else
+        # let current component be, since an unhandled key may have resulted
+        #  in on_enter being called again
+      end
+      return unless @current_component
+      $log.debug " STACKFLOW came to ON_ENTER #{@current_component} "
+      set_form_row
+      @_entered = true
+    end
+    # we cannot be sure that this will be called especially if this is embedded 
+    # inside some other component
+    def on_leave
+      @_entered = false
+      super
+    end
+    def goto_next_component
+      if @current_component != nil 
+        leave_current_component
+        if on_last_component?
+          #@_entered = false
+          return :UNHANDLED
+        end
+        @current_index = @focusables.index(@current_component)
+        index = @current_index + 1
+        f = @focusables[index]
+        if f
+          @current_index = index
+          @current_component = f
+          return set_form_row
+        end
+      end
+      @_entered = false
+      return :UNHANDLED
+    end
+    def goto_prev_component
+      if @current_component != nil 
+        leave_current_component
+        if on_first_component?
+          @_entered = false
+          return :UNHANDLED
+        end
+        @current_index = @focusables.index(@current_component)
+        index = @current_index -= 1
+        f = @focusables[index]
+        if f
+          @current_index = index
+          @current_component = f
+          return set_form_row
+        end
+      end
+      return :UNHANDLED
+    end
+    # private
+    # XXX why are we calling 3 methods in a row, why not OE manages these 3
+    # There's double calling going on.
+    def set_form_row
+      return :UNHANDLED if @current_component.nil?
+      cc = @current_component
+      $log.debug "STACKFLOW #{@name} set_form_row calling sfr for #{cc.name}, r #{cc.row} c: #{cc.col} "
+      $log.debug " STACKFLOW on enter sfr #{@current_component.name}  #{@current_component} "
+
+      @current_component.on_enter
+      @current_component.set_form_row # why was this missing in vimsplit. is it
+      $log.debug "STACKFLOW #{@name} set_form_row calling sfr for #{cc.name}, r #{cc.row} c: #{cc.col} "
+      # that on_enter does a set_form_row
+      @current_component.set_form_col # XXX 
+      @current_component.repaint # OMG this could happen before we've set row and col
+      # XXX compo should do set_form_row and col if it has that
+    end
+    # 
+    def set_form_col
+      # override widget
+    end
+    # leave the component we are on.
+    # This should be followed by all containers, so that the on_leave action
+    # of earlier comp can be displayed, such as dimming components selections
+    def leave_current_component
+      begin
+        @current_component.on_leave
+      rescue FieldValidationException => fve
+        alert fve.to_s
+      end
+      # NOTE this is required, since repaint will just not happen otherwise
+      # Some components are erroneously repainting all, after setting this to true so it is 
+      # working there. 
+      @current_component.repaint_required true
+      $log.debug " after on_leave STACKFLOW XXX #{@current_component.focussed}   #{@current_component.name}"
+      @current_component.repaint
+    end
+
+    # is focus on first component FIXME check  for focusable
+    def on_first_component?
+      @current_component == @focusables.first
+    end
+    # is focus on last component FIXME check  for focusable
+    def on_last_component?
+      @current_component == @focusables.last
+    end
+    # set focus on given component
+    # Sometimes you have the handle to component, and you want to move focus to it
+    def goto_component comp
+      return if comp == @current_component
+      leave_current_component
+      @current_component = comp
+      set_form_row
+    end
+
+    def increase_current
+      c = @current_component
+      p = c.config[:parent]
+      $log.debug "XXX: INC increase current #{c} , #{p} "
+      p.increase c
+    end
+    def decrease_current
+      c = @current_component
+      p = c.config[:parent]
+      $log.debug "XXX: INC increase current #{c} , #{p} "
+      p.decrease c
+    end
+    # ADD HERE ABOVe
+  end # class
+
+end # module
+
+# NOTE  this is now giving an error ni basestack.rb 87 reg margin_top. 
+# @see teststackflow.rb in examples dir
+#
+if __FILE__ == $PROGRAM_NAME
+  require 'rbcurse/core/util/app'
+  App.new do
+
+    lb = Listbox.new nil, :list => ["ruby","perl","lisp","jaava", "c-blunt"] , :name => "mylist"
+    lb1 = Listbox.new nil, :list => ["roger","borg","haas","tsonga", "kolya","delpotro"] , :name => "mylist1"
+
+    lb2 = Listbox.new nil, :list => `gem list --local`.split("\n") , :name => "mylist2"
+
+    alist = %w[ ruby perl python java jruby macruby rubinius rails rack sinatra pylons django cakephp grails] 
+    str = "Hello people of this world.\nThis is a textbox.\nUse arrow keys, j/k/h/l/gg/G/C-a/C-e/C-n/C-p\n"
+    str << alist.join("\n")
+    require 'rbcurse/core/widgets/rtextview'
+    tv = TextView.new nil, :name => "text"
+    tv.set_content str
+=begin
+    f1 = field "name", :maxlen => 20, :display_length => 20, :bgcolor => :white, 
+      :color => :black, :text => "abc", :label => " Name: ", :label_color_pair => @datacolor
+    f2 = field "email", :display_length => 20, :bgcolor => :white, 
+      :color => :blue, :text => "me@google.com", :label => "Email: ", :label_color_pair => @datacolor
+    f3 = radio :group => :grp, :text => "red", :value => "RED", :color => :red
+    f4 = radio :group => :grp, :text => "blue", :value => "BLUE", :color => :blue
+    f5 = radio :group => :grp, :text => "green", :value => "GREEN", :color => :green
+=end
+
+    f1 = Field.new nil, :maxlen => 20, :display_length => 20, :bgcolor => :white, 
+      :color => :black, :text => "abc", :label => " Name: ", :label_color_pair => @datacolor
+    r = StackFlow.new @form, :row => 1, :col => 2, :width => 80, :height => 25, :title => "A container" do
+      stack :margin_left => 1 do
+        add tv, :weight => 30, :margin_left => 2
+        add lb, :weight => 30
+        flow :weight => 30 do 
+          add lb1, :weight => 40
+          add lb2, :weight => 60
+        end
+        add f1
+      end # stack
+    end # r
+
+    #r.add(f1)
+    #r.add(f2)
+    #r.add(f3,f4,f5)
+    #sl = status_line
+
+  end # app
+end # if