class Canis::Tree

a representation of heirarchical data in outline form Currently supports only single selection, and does not allow editing. @events Events: SELECT, DESELECT, TREE_WILL_EXPAND_EVENT, TREE_COLLAPSED_EVENT

Constants

TREE_EVENTS

Attributes

current_index[RW]
one_key_selection[RW]

dsl_accessor :valign # popup related

will pressing a single key move to first matching row. setting it to false lets us use vim keys
selected_index[R]

index of row selected, relates to internal representation, not tree. @see selected_row

toprow[R]

dsl_accessor :title dsl_property :title_attrib # bold, reverse, normal dsl_accessor :border_attrib, :border_color # FIXME not used currently

treemodel[R]

Public Class Methods

new(form, config={}) click to toggle source
Calls superclass method
# File lib/canis/core/widgets/deprecated/rtree.rb, line 62
def initialize form, config={}, &block
  @focusable = true
  @editable = false
  @row = 0
  @col = 0
  # array representation of tree
  @list = nil
  # any special attribs such as status to be printed in col1, or color (selection)
  @list_attribs = {}
  # hash containing nodes that are expanded or once expanded
  # if value is true, then currently expanded, else once expanded
  # TODO : will need purging under some situations
  @expanded_state = {}
  @suppress_borders = false
  @row_offset = @col_offset = 1
  @current_index = 0
  @one_key_selection = false # use vim keys
  super
  #@selection_mode ||= :single # default is multiple, anything else given becomes single
  @win = @graphic    # 2010-01-04 12:36 BUFFERED  replace form.window with graphic
  @sanitization_required = true
  @longest_line = 0
  
 
  #@win_left = 0
  #@win_top = 0
  @_events.push(*[:ENTER_ROW, :LEAVE_ROW, :TREE_COLLAPSED_EVENT, :TREE_EXPANDED_EVENT, :TREE_SELECTION_EVENT, :TREE_WILL_COLLAPSE_EVENT, :TREE_WILL_EXPAND_EVENT])

  
  bind(:PROPERTY_CHANGE){|e| @cell_renderer = nil } # will be recreated if anything changes 2011-09-28 V1.3.1
  # FIXME the above is dangerous if user set his own renderer with some values XXX
  init_vars
  bordertitle_init

  #if !@list.selected_index.nil?
    #set_focus_on @list.selected_index # the new version
  #end
  @keys_mapped = false
end

Public Instance Methods

<<( array) click to toggle source
add a row to the table

The name add will be removed soon, pls use << instead.

# File lib/canis/core/widgets/tree.rb, line 387
def <<( array)
  unless @list
    # columns were not added, this most likely is the title
    @list ||= []
    _init_model array
  end
  @list << array
  @native_text = @list # 2014-05-27 - 16:34
  fire_dimension_changed
  self
end
OLDprint_borders() click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 255
    def OLDprint_borders
      width = @width
      height = @height-1 # 2010-01-04 15:30 BUFFERED HEIGHT
      window = @graphic  # 2010-01-04 12:37 BUFFERED
      startcol = @col 
      startrow = @row 
      @color_pair = get_color($datacolor)
#      bordercolor = @border_color || $datacolor # changed 2011 dts
      bordercolor = @border_color || @color_pair # 2011-09-28 V1.3.1
      borderatt = @border_attrib || Ncurses::A_NORMAL
                           
      window.print_border startrow, startcol, height, width, bordercolor, borderatt
      print_title
    end
OLDprint_title() click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 269
def OLDprint_title
  return unless @title
  _title = @title
  if @title.length > @width - 2
    _title = @title[0..@width-2]
  end
  @color_pair ||= get_color($datacolor)
  @graphic.printstring( @row, @col+(@width-_title.length)/2, _title, @color_pair, @title_attrib) unless @title.nil?
end
XXXpadrefresh() click to toggle source

refresh pad onto window overrides super due to header_adjustment and the header too

# File lib/canis/core/widgets/tree.rb, line 418
def XXXpadrefresh
  top = @window.top
  left = @window.left
  sr = @startrow + top
  sc = @startcol + left
  # first do header always in first row
  retval = FFI::NCurses.prefresh(@pad,0,@pcol, sr , sc , 2 , @cols+ sc );
  # now print rest of data
  # h is header_adjustment
  h = 1 
  retval = FFI::NCurses.prefresh(@pad,@prow + h,@pcol, sr + h , sc , @rows + sr  , @cols+ sc );
  $log.warn "XXX:  PADREFRESH #{retval}, #{@prow}, #{@pcol}, #{sr}, #{sc}, #{@rows+sr}, #{@cols+sc}." if retval == -1
  # padrefresh can fail if width is greater than NCurses.COLS
end
_list() click to toggle source

private, for use by repaint

# File lib/canis/core/widgets/deprecated/rtree.rb, line 205
def _list
  if @_structure_changed 
    @list = nil
    @_structure_changed = false
  end
  unless @list
    $log.debug " XXX recreating _list"
    convert_to_list @treemodel
    $log.debug " XXXX list: #{@list.size} : #{@list} "
  end
  return @list
end
ask_search_backward() click to toggle source

gets string to search and calls data models find prev

# File lib/canis/core/widgets/deprecated/rtree.rb, line 365
def ask_search_backward
  regex =  get_string("Enter regex to search (backward)")
  @last_regex = regex
  ix = @list.find_prev regex, @current_index
  if ix.nil?
    alert("No matching data for: #{regex}")
  else
    set_focus_on(ix)
  end
end
ask_search_forward() click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 355
def ask_search_forward
    regex =  get_string("Enter regex to search")
    ix = @list.find_match regex
    if ix.nil?
      alert("No matching data for: #{regex}")
    else
      set_focus_on(ix)
    end
end
ask_selection_for_char() click to toggle source

get a keystroke from user and go to first item starting with that key

# File lib/canis/core/widgets/deprecated/rtree.rb, line 348
def ask_selection_for_char
  ch = @graphic.getch
  if ch < 0 || ch > 255
    return :UNHANDLED
  end
  ret = set_selection_for_char ch.chr
end
cell_renderer(*val) click to toggle source

getter and setter for cell_renderer

# File lib/canis/core/widgets/deprecated/rtree.rb, line 409
def cell_renderer(*val)
  if val.empty?
    @cell_renderer ||= create_default_cell_renderer
  else
    @cell_renderer = val[0] 
  end
end
collapse_children(node=:current_index) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 646
def collapse_children node=:current_index
  $multiplier = 999 if !$multiplier || $multiplier == 0
  $log.debug " CCCC IINSIDE COLLLAPSE"
  node = row_to_node if node == :current_index
  return if node.children.empty? # or node.is_leaf?
  #node.children.each do |e|
    #expand_node e # this will keep expanding parents
    #expand_children e
  #end
  node.breadth_each($multiplier) do |e|
    $log.debug "CCC collapsing #{e.user_object}  "
    collapse_node e
  end
  $multiplier = 0
  _structure_changed true
end
collapse_node(node) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 599
def collapse_node(node)
  $log.debug " collapse called on #{node.user_object} "
  state = false
  fire_handler :TREE_WILL_COLLAPSE_EVENT, node
  set_expanded_state(node, state)
  fire_handler :TREE_COLLAPSED_EVENT, node
end
collapse_parent(node=:current_index) click to toggle source

collapse parent can use multiplier. # we need to move up also

# File lib/canis/core/widgets/deprecated/rtree.rb, line 665
def collapse_parent node=:current_index
  node = row_to_node if node == :current_index
  parent = node.parent
  return if parent.nil?
  goto_parent node
  collapse_node parent
end
command(*args, &block) click to toggle source

default block @since 1.5.0 2011-11-22

# File lib/canis/core/widgets/deprecated/rtree.rb, line 751
def command *args, &block
  bind :TREE_WILL_EXPAND_EVENT, *args, &block
end
convert_to_list(tree) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 217
def convert_to_list tree
  @list = get_expanded_descendants(tree.root)
  #$log.debug "XXX convert #{tree.root.children.size} "
  #$log.debug " converted tree to list. #{@list.size} "
end
create_default_cell_renderer() click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 416
def create_default_cell_renderer
  return Canis::TreeCellRenderer.new "", {"color"=>@color, "bgcolor"=>@bgcolor, "parent" => self, "display_length"=> @width-@internal_width-@left_margin}
end
create_default_renderer() click to toggle source
# File lib/canis/core/widgets/tree.rb, line 192
def create_default_renderer
  renderer DefaultTreeRenderer.new(self)
end
current_row() click to toggle source

return object under cursor Note: this should not be confused with selected row/s. User may not have selected this. This is only useful since in some demos we like to change a status bar as a user scrolls down @since 1.2.0 2010-09-06 14:33 making life easier for others.

# File lib/canis/core/widgets/deprecated/rtree.rb, line 235
def current_row
  @list[@current_index]
end
Also aliased as: text, current_value
current_value()
commendte off on 2014-05-27 - 14:27

alias :text :current_row # thanks to shoes, not sure how this will impact since widget has text.

Alias for: current_row
data(alist=nil) click to toggle source

pass data to create this tree model used to be list

# File lib/canis/core/widgets/deprecated/rtree.rb, line 171
def data alist=nil

  # if nothing passed, print an empty root, rather than crashing
  alist = [] if alist.nil?
  @data = alist # data given by user
  case alist
  when Array
    @treemodel = Canis::DefaultTreeModel.new("/")
    @treemodel.root.add alist
  when Hash
    @treemodel = Canis::DefaultTreeModel.new("/")
    @treemodel.root.add alist
  when TreeNode
    # this is a root node
    @treemodel = Canis::DefaultTreeModel.new(alist)
  when DefaultTreeModel
    @treemodel = alist
  else
    if alist.is_a? DefaultTreeModel
      @treemodel = alist
    else
      raise ArgumentError, "Tree does not know how to handle #{alist.class} "
    end
  end
  # we now have a tree
  raise "I still don't have a tree" unless @treemodel
  set_expanded_state(@treemodel.root, true)
  convert_to_list @treemodel
  
  # added on 2009-01-13 23:19 since updates are not automatic now
  #@list.bind(:LIST_DATA_EVENT) { |e| list_data_changed() }
  #create_default_list_selection_model TODO
end
delete_at(ix) click to toggle source

delete a data row at index

NOTE : This does not adjust for header_adjustment. So zero will refer to the header if there is one.

This is to keep consistent with textpad which does not know of header_adjustment and uses the actual
index. Usually, programmers will be dealing with +@current_index+
# File lib/canis/core/widgets/tree.rb, line 405
def delete_at ix
  return unless @list
  raise ArgumentError, "Argument must be within 0 and #{@list.length}" if ix < 0 or ix >=  @list.length 
  fire_dimension_changed
  #@list.delete_at(ix + @_header_adjustment)
  _ret = @list.delete_at(ix)
  @native_text = @list # 2014-05-27 - 16:34
  return _ret
end
expand_children(node=:current_index) click to toggle source

this expands all the children of a node, recursively we can't use multiplier concept here since we are doing a preorder enumeration we need to do a breadth first enumeration to use a multiplier

# File lib/canis/core/widgets/deprecated/rtree.rb, line 632
def expand_children node=:current_index
  $multiplier = 999 if !$multiplier || $multiplier == 0
  node = row_to_node if node == :current_index
  return if node.children.empty? # or node.is_leaf?
  #node.children.each do |e|
    #expand_node e # this will keep expanding parents
    #expand_children e
  #end
  node.breadth_each($multiplier) do |e|
    expand_node e
  end
  $multiplier = 0
  _structure_changed true
end
expand_node(node) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 592
def expand_node(node)
  #$log.debug " expand called on #{node.user_object} "
  state = true
  fire_handler :TREE_WILL_EXPAND_EVENT, node
  set_expanded_state(node, state)
  fire_handler :TREE_EXPANDED_EVENT, node
end
expand_parents(node) click to toggle source

goes up to root of this node, and expands down to this node this is often required to make a specific node visible such as in a dir listing when current dir is deep in heirarchy.

# File lib/canis/core/widgets/deprecated/rtree.rb, line 620
def expand_parents node
  _path = node.tree_path
  _path.each do |e| 
    # if already expanded parent then break we should break
    #set_expanded_state(e, true)
    expand_node(e)
  end
end
get_content() click to toggle source

START FOR scrollable ###

# File lib/canis/core/widgets/deprecated/rtree.rb, line 279
def get_content
  #@list 2008-12-01 23:13
  @list_variable && @list_variable.value || @list 
  # called by next_match in listscrollable
  @list
end
get_expanded_descendants(node) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 697
def get_expanded_descendants(node)
  nodes = []
  nodes << node
  traverse_expanded node, nodes
  $log.debug " def get_expanded_descendants(node) #{nodes.size} "
  return nodes
end
get_node_for_path(user_path) click to toggle source

To retrieve the node corresponding to a path specified as an array or string Do not mention the root. e.g. “ruby/1.9.2/io/console” or %w[ ruby 1.9.3 io console ] @since 1.4.0 2011-10-2

# File lib/canis/core/widgets/deprecated/rtree.rb, line 723
def get_node_for_path(user_path)
  case user_path
  when String
    user_path = user_path.split "/"
  when Array
  else
    raise ArgumentError, "Should be Array or String delimited with /"
  end
  $log.debug "TREE #{user_path} " if $log.debug? 
  root = @treemodel.root
  found = nil
  user_path.each { |e| 
    success = false
    root.children.each { |c| 
      if c.user_object == e
        found = c
        success = true
        root = c
        break
      end
    }
    return false unless success

  }
  return found
end
get_window() click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 285
def get_window
  @graphic 
end
getvalue() click to toggle source
END FOR scrollable ###

override widgets text

# File lib/canis/core/widgets/deprecated/rtree.rb, line 290
def getvalue
  selected_row()
end
goto_parent(node=:current_index) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 672
def goto_parent node=:current_index
  node = row_to_node if node == :current_index
  parent = node.parent
  return if parent.nil?
  crow = @current_index
  @list.each_with_index { |e,i| 
    if e == parent
      crow = i
      break
    end
  }
  @repaint_required = true
  #set_form_row  # will not work if off form
  set_focus_on crow
end
handle_key(ch) click to toggle source

Listbox

# File lib/canis/core/widgets/deprecated/rtree.rb, line 294
def handle_key(ch)
  return if @list.nil? || @list.empty?
  @current_index ||= 0
  @toprow ||= 0
  h = scrollatrow()
  rc = row_count
  $log.debug " tree got ch #{ch}"
  case ch
  when 27, ?\C-c.getbyte(0)
    #editing_canceled @current_index if @cell_editing_allowed
    #cancel_block # block
    $multiplier = 0
    return 0
  #when ?\C-u.getbyte(0)
    # multiplier. Series is 4 16 64
    # TESTING @multiplier = (@multiplier == 0 ? 4 : @multiplier *= 4)
  #  return 0
  when ?\C-c.getbyte(0)
    @multiplier = 0
    return 0
  else
    ret = :UNHANDLED 
    if ret == :UNHANDLED
      # beware one-key eats up numbers. we'll be wondering why
      if @one_key_selection
        case ch
        #when ?A.getbyte(0)..?Z.getbyte(0), ?a.getbyte(0)..?z.getbyte(0), ?0.getbyte(0)..?9.getbyte(0)
        when ?A.getbyte(0)..?Z.getbyte(0), ?a.getbyte(0)..?z.getbyte(0)
          # simple motion, key press defines motion
          ret = set_selection_for_char ch.chr
        else
          ret = process_key ch, self
          @multiplier = 0
          return :UNHANDLED if ret == :UNHANDLED
        end
      else
        # no motion on single key, we can freak out like in vim, pref f <char> for set_selection
        case ch
        when ?0.getbyte(0)..?9.getbyte(0)
          $multiplier *= 10 ; $multiplier += (ch-48)
          #$log.debug " setting mult to #{$multiplier} in list "
          return 0
        end
        $log.debug " TREE before process key #{ch} "
        ret = process_key ch, self
        $log.debug " TREE after process key #{ch} #{ret} "
        #$multiplier = 0 # 2010-09-02 22:35 this prevents parent from using mult
        return :UNHANDLED if ret == :UNHANDLED
      end
    end
  end
  $multiplier = 0
end
has_been_expanded(node) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 688
def has_been_expanded node
  @expanded_state.has_key? node
end
init_vars() click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 101
def init_vars
  @repaint_required = true
  @toprow = @pcol = 0
  if @show_selector
    @row_selected_symbol ||= '>'
    @row_unselected_symbol ||= ' '
    @left_margin ||= @row_selected_symbol.length
  end
  @left_margin ||= 0
  #@one_key_selection = true if @one_key_selection.nil?
  @row_offset = @col_offset = 0 if @suppress_borders
  @internal_width = 2 # taking into account borders accounting for 2 cols
  @internal_width = 0 if @suppress_borders # should it be 0 ???
  map_keys unless @keys_mapped

end
is_row_selected?(row=@current_index) click to toggle source
# File lib/canis/core/widgets/tree.rb, line 443
def is_row_selected? row=@current_index
  row == @selected_index
end
list_data_changed() click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 503
def list_data_changed
  if row_count == 0 # added on 2009-02-02 17:13 so cursor not hanging on last row which could be empty
    init_vars
    @current_index = 0
    set_form_row
  end
  @repaint_required = true
end
map_keys() click to toggle source

maps keys to methods checks @key_map can be :emacs or :vim.

# File lib/canis/core/widgets/deprecated/rtree.rb, line 119
def map_keys
  @keys_mapped = true
  bind_key($row_selector, 'toggle row selection'){ toggle_row_selection() }
  bind_key(KEY_ENTER, 'toggle expanded state') { toggle_expanded_state() }
  bind_key(?o, 'toggle expanded state') { toggle_expanded_state() }
  bind_key(?f, 'first row starting with char'){ ask_selection_for_char() }
  bind_key(?\M-v, 'one key selection toggle'){ @one_key_selection = !@one_key_selection }
  bind_key(?O, 'expand children'){ expand_children() }
  bind_key(?X, 'collapse children'){ collapse_children() }
  bind_key(?>, :scroll_right)
  bind_key(?<, :scroll_left)
  # TODO
  bind_key(?x, 'collapse parent'){ collapse_parent() }
  bind_key(?p, 'goto parent'){ goto_parent() }
  require 'canis/core/include/deprecated/listbindings'
  #ListBindings.bindings
  bindings
end
mark_parents_expanded(node) click to toggle source

this is required to make a node visible, if you wish to start from a node that is not root e.g. you are loading app in a dir somewhere but want to show path from root down. NOTE this sucks since you have to click 2 times to expand it.

# File lib/canis/core/widgets/deprecated/rtree.rb, line 609
def mark_parents_expanded node
  # i am setting parents as expanded, but NOT firing handlers - XXX separate this into expand_parents
  _path = node.tree_path
  _path.each do |e| 
    # if already expanded parent then break we should break
    set_expanded_state(e, true) 
  end
end
node_collapsed?(node) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 694
def node_collapsed? node
  !node_expanded?(node)
end
node_expanded?(node) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 691
def node_expanded? node
  @expanded_state[node] == true
end
node_to_row(node) click to toggle source

convert a given node to row

# File lib/canis/core/widgets/deprecated/rtree.rb, line 563
def node_to_row node
  crow = nil
  @list.each_with_index { |e,i| 
    if e == node
      crow = i
      break
    end
  }
  crow
end
on_enter() click to toggle source

please check for error before proceeding @return [Boolean] false if no data

Calls superclass method
# File lib/canis/core/widgets/deprecated/rtree.rb, line 377
def on_enter
  if @list.size < 1
    Ncurses.beep
    return false
  end
  on_enter_row @current_index
  set_form_row # added 2009-01-11 23:41
  #$log.debug " ONE ENTER LIST #{@current_index}, #{@form.row}"
  @repaint_required = true
  super
  #fire_handler :ENTER, self
  true
end
on_enter_row(arow) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 390
def on_enter_row arow
  #$log.debug " Listbox #{self} ENTER_ROW with curr #{@current_index}. row: #{arow} H: #{@handler.keys}"
  #fire_handler :ENTER_ROW, arow
  fire_handler :ENTER_ROW, self
  #@list.on_enter_row self TODO
  #edit_row_at arow
  @repaint_required = true
end
on_leave_row(arow) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 399
def on_leave_row arow
  #$log.debug " Listbox #{self} leave with (cr: #{@current_index}) #{arow}: list[row]:#{@list[arow]}"
  #$log.debug " Listbox #{self} leave with (cr: #{@current_index}) #{arow}: "
  #fire_handler :LEAVE_ROW, arow
  fire_handler :LEAVE_ROW, self
  #editing_completed arow
end
print_foot() click to toggle source

print footer containing line and total, overriding textpad which prints column offset also This is called internally by +repaint()+ but can be overridden for more complex printing.

renderer(*val) click to toggle source

supply a custom renderer that implements +render()+ @see render

# File lib/canis/core/widgets/tree.rb, line 374
def renderer *val
  if val.empty?
    return @renderer
  end
  @renderer = val[0]
end
repaint() click to toggle source

this method chops the data to length before giving it to the renderer, this can cause problems if the renderer does some processing. also, it pans the data horizontally giving the renderer a section of it. FIXME: tree may not be clearing till end see appdirtree after divider movement

# File lib/canis/core/widgets/deprecated/rtree.rb, line 425
def repaint
  return unless @repaint_required
  @height ||= 10
  @width  ||= 30

  my_win = @form ? @form.window : @target_window
  @graphic = my_win unless @graphic
   
  raise " #{@name} neither form, nor target window given TV paint " unless my_win
  raise " #{@name} NO GRAPHIC set as yet                 TV paint " unless @graphic
  #@win_left = my_win.left
  #@win_top = my_win.top

  $log.debug "rtree repaint  #{@name} graphic #{@graphic}"
  print_borders unless @suppress_borders # do this once only, unless everything changes
  maxlen = @maxlen || @width-@internal_width
  maxlen -= @left_margin # 2011-10-6
  tm = _list()
  select_default_values
  rc = row_count
  tr = @toprow
  acolor = get_color $datacolor
  h = scrollatrow()
  r,c = rowcol
  @longest_line = @width #maxlen
  0.upto(h) do |hh|
    crow = tr+hh
    if crow < rc
        _focussed = @current_index == crow ? true : false  # row focussed ?
        focus_type = _focussed 
        # added 2010-09-02 14:39 so inactive fields don't show a bright focussed line
        #focussed = false if focussed && !@focussed
        focus_type = :SOFT_FOCUS if _focussed && !@focussed
        selected = row_selected? crow 
        content = tm[crow]   # 2009-01-17 18:37 chomp giving error in some cases says frozen
        if content.is_a? TreeNode
          node = content
          object = content
          leaf = node.is_leaf?
          # content passed is rejected by treecellrenderer 2011-10-6
          content = node.user_object.to_s # may need to trim or truncate
          expanded = row_expanded? crow  
        elsif content.is_a? String
          $log.warn "Removed this entire block since i don't think it was used XXX  "
          # this block does not set object XXX
        else
          raise "repaint what is the class #{content.class} "
          content = content.to_s
        end
        # this is redundant since data is taken by renderer directly
        #sanitize content if @sanitization_required
        #truncate value
        ## set the selector symbol if requested
        selection_symbol = ''
        if @show_selector
          if selected
            selection_symbol = @row_selected_symbol
          else
            selection_symbol =  @row_unselected_symbol
          end
          @graphic.printstring r+hh, c, selection_symbol, acolor,@attr
        end

        renderer = cell_renderer()
        renderer.display_length(@width-@internal_width-@left_margin) # just in case resizing of listbox
        renderer.pcol = @pcol
        #renderer.repaint @graphic, r+hh, c+@left_margin, crow, content, _focussed, selected
        renderer.repaint @graphic, r+hh, c+@left_margin, crow, object, content, leaf,  focus_type, selected, expanded
        @longest_line = renderer.actual_length if renderer.actual_length > @longest_line 
    else
      # clear rows
      @graphic.printstring r+hh, c, " " * (@width-@internal_width), acolor,@attr
    end
  end
  @table_changed = false
  @repaint_required = false
end
root(node=nil, asks_allow_children=false, &block) click to toggle source

Sets the given node as root and returns treemodel. Returns root if no argument given. Now we return root if already set Made node nillable so we can return root.

@raise ArgumentError if setting a root after its set

or passing nil if its not been set.
# File lib/canis/core/widgets/deprecated/rtree.rb, line 159
def root node=nil, asks_allow_children=false, &block
  if @treemodel
    return @treemodel.root unless node
    raise ArgumentError, "Root already set"
  end

  raise ArgumentError, "root: node cannot be nil" unless node
  @treemodel = Canis::DefaultTreeModel.new(node, asks_allow_children, &block)
end
row_collapsed?(row) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 584
def row_collapsed? row
  !row_expanded? row
end
row_count() click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 139
def row_count
  return 0 if @list.nil?
  @list.length
end
row_expanded?(row) click to toggle source

@return [TreeNode, nil] returns selected node or nil

# File lib/canis/core/widgets/deprecated/rtree.rb, line 580
def row_expanded? row
  node = @list[row]
  node_expanded? node
end
row_selected?(row) click to toggle source

private related to index in representation, not tree

# File lib/canis/core/widgets/deprecated/rtree.rb, line 575
def row_selected? row
  @selected_index == row
end
row_to_node(row=@current_index) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 559
def row_to_node row=@current_index
  @list[row]
end
scrollatrow() click to toggle source

at what row should scrolling begin

# File lib/canis/core/widgets/deprecated/rtree.rb, line 144
def scrollatrow
  if @suppress_borders
    return @height - 1
  else
    return @height - 3
  end
end
select_default_values() click to toggle source

show default value as selected and fire handler for it This is called in repaint, so can raise an error if called on creation or before repaint. Just set @default_value, and let us handle the rest. Suggestions are welcome.

# File lib/canis/core/widgets/deprecated/rtree.rb, line 244
def select_default_values
  return if @default_value.nil?
  # NOTE list not yet created
  raise "list has not yet been created" unless @list
  index = node_to_row @default_value
  raise "could not find node #{@default_value}, #{@list}  " unless index
  return unless index
  @current_index = index
  toggle_row_selection
  @default_value = nil
end
selected_row() click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 517
def selected_row
  @list[@selected_index].node
end
set_default_selection_model() click to toggle source

set the default selection model as the operational one

# File lib/canis/core/widgets/tree.rb, line 187
def set_default_selection_model
  @list_selection_model = nil
  @list_selection_model = Canis::DefaultListSelectionModel.new self
end
set_expanded_state(node, state) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 587
def set_expanded_state(node, state)
  @expanded_state[node] = state
  @repaint_required = true
  _structure_changed true
end
set_form_col(col1=0) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 511
def set_form_col col1=0
  @cols_panned ||= 0 # RFED16 2010-02-17 23:40
  win_col = 0 
  col2 = win_col + @col + @col_offset + col1 + @cols_panned + @left_margin
  setrowcol nil, col2 # 2010-02-17 23:19 RFED16
end
text()
Alias for: current_row
toggle_expanded_state(row=@current_index) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 544
def toggle_expanded_state row=@current_index
  state = row_expanded? row
  node  = row_to_node
  if node.nil?
    Ncurses.beep
    $log.debug " No such node on row #{row} "
    return
  end
  $log.debug " toggle XXX state #{state} #{node} "
  if state
    collapse_node node
  else
    expand_node node
  end
end
toggle_row_selection() click to toggle source

An event is thrown when a row is selected or deselected. Please note that when a row is selected, another one is automatically deselected. An event is not thrown for that since your may not want to collapse that. Only clicking on a selected row, will send a DESELECT on it since you may want to collapse it. However, the previous selection is also present in the event object, so you can act upon it. This is not used for expanding or collapsing, only for application to show some data in another window or pane based on selection. Maybe there should not be a deselect for current row ?

# File lib/canis/core/widgets/deprecated/rtree.rb, line 528
def toggle_row_selection
  node = @list[@current_index]
  previous_node = nil
  previous_node = @list[@selected_index] if @selected_index
  if @selected_index == @current_index
    @selected_index = nil
  else
    @selected_index = @current_index
  end
  state = @selected_index.nil? ? :DESELECTED : :SELECTED
  #TreeSelectionEvent = Struct.new(:node, :tree, :state, :previous_node, :row_first)
  @tree_selection_event = TreeSelectionEvent.new(node, self, state, previous_node, @current_index) #if @item_event.nil?
  fire_handler :TREE_SELECTION_EVENT, @tree_selection_event # should the event itself be ITEM_EVENT
  $log.debug " XXX tree selected #{@selected_index}/ #{@current_index} , #{state} "
  @repaint_required = true
end
traverse(node, level=0) { |node, level| ... } click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 222
def traverse node, level=0, &block
  raise "disuse"
  #icon = node.is_leaf? ? "-" : "+"
  #puts "%*s %s" % [ level+1, icon,  node.user_object ]
  yield node, level if block_given?
  node.children.each do |e| 
    traverse e, level+1, &block
  end
end
traverse_expanded(node, nodes) click to toggle source
# File lib/canis/core/widgets/deprecated/rtree.rb, line 704
def traverse_expanded node, nodes
  return if !node_expanded? node
  #nodes << node
  node.children.each do |e| 
    nodes << e
    if node_expanded? e
      traverse_expanded e, nodes
    else
      next
    end
  end
end

Private Instance Methods

_structure_changed(tf=true) click to toggle source

please do not rely on this yet, name could change

# File lib/canis/core/widgets/deprecated/rtree.rb, line 756
def _structure_changed tf=true
  @_structure_changed = tf
  @repaint_required = true
  #@list = nil
end