Class: SelectionInTreeView

• Inheritance
• Description
• Class protocol
  • constants
  • defaults
  • resources
• Instance protocol
  • accessing
  • accessing-behavior
  • accessing-channels
  • accessing-images
  • accessing-look
  • change & update
  • drawing
  • drawing basics
  • enumerating
  • event handling
  • initialization & release
  • model
  • private
  • private-drag and drop
  • private-queries
  • private-redefinitions
  • queries
  • queries-contents
  • scrolling
  • selection
  • selection actions
• Examples

Inheritance:

   Object
   |
   +--GraphicsMedium
      |
      +--DisplaySurface
         |
         +--SimpleView
            |
            +--View
               |
               +--ListView
                  |
                  +--SelectionInListView
                     |
                     +--SelectionInTreeView
                        |
                        +--FileSelectionTree

Package:

stx:libwidg2

Category:

Views-Trees

Version:

rev: 1.146 date: 2023/12/19 20:48:58

user: cg

file: SelectionInTreeView.st directory: libwidg2

module: stx stc-classLibrary: libwidg2

Description:

OBSOLETE, please use HierarchicalListView.

somewhat like a SelectionInListView; but specialized for hierarchical (i.e. tree-like)
lists and adds the functions to show/hide subtrees. 
Requires SelectionInTree as model and TreeItem (or compatible) list entries.

Notice: 
    This class obsoletes SelectionInHierarchyView, which is no longer
    maintained but kept for backward compatibility.

Notice2: 
    Even for this class, an improved replacement now exists:
    HierarchicalListView.
    Please consider using that one.
    (however, this class is kept for backward compatibility).

copyright
COPYRIGHT (c) 1997 by eXept Software AG / Claus Gittinger
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 minImageInset

returns minimum inset from directory indication to image

 defaultModelClass

returns the default model

 updateStyleCache

extract values from the styleSheet and cache them in class variables

Usage example(s):

self updateStyleCache

 closeIndicator

returns a little [+] bitmap

 imageClosed

returns a closed file-directory bitmap

 imageItem

returns a regular file bitmap

 imageOpened

returns an opened file-directory bitmap

 openIndicator

returns a little [-] bitmap

Instance protocol:

 highlightMode

get the mode how to draw a selected line:
#line draw whole line selected
#label draw label selected

 highlightMode: aMode

set the mode how to draw a selected line:
#line draw whole line selected
#label draw label selected

 itemClass

returns current itemClass used

 itemClass: anItemClass

set itemClass to be used

 lineColor

returns user configured line color or nil

 lineColor: aColor

returns user configured line color or nil

 nodeAtIndex: anIndex

returns node at an index or nil

 root

gets the root of the model; the first item into list.

 root: aRoot

sets the root of the model; the first item into list.

 textInset

get the left inset of the text label

 textInset: anInset

set the left inset of the text label

 drawVLinesFromLevel

returns the level vertical lines are drawn from;
starting at 1 up to n

 drawVLinesFromLevel: aLevel

set the level vertical lines are drawn from;
starting at 1 up to n

 supportsExpandAll

 supportsExpandAll: aBool

 validateDoubleClickBlock

return the conditionBlock; this block is evaluated before a doubleClick action
on a node will be performed. In case of returning false, the doubleClick will
not be handled.

 validateDoubleClickBlock: aOneArgBlock

set the conditionBlock; this block is evaluated before a doubleClick action
on a node will be performed. In case of returning false, the doubleClick will
not be handled.

 validateExpandabilityBlock

return the expand conditionBlock; this block is evaluated before an expand due to
a doubleClick on a node will be performed. In case of returning false,
the node will not be expanded.

 validateExpandabilityBlock: aOneArgBlock

set the expand conditionBlock; this block is evaluated before an expand due to
a doubleClick on a node will be performed. In case of returning false,
the node will not be expanded.

 rootHolder

get the holder which keeps the hierarchical list entry or nil

 rootHolder: aValueHolder

set the holder which keeps the hierarchical list entry or nil

 selectionHolder

get the holder which keeps a list of selected items or nil

 selectionHolder: aHolder

set the holder which keeps a list of selected items or nil

 closeIndicator

return the bitmap image shown for expandable tree items (a little right arrow)
(initialized to a right arrow)

 closeIndicator: aBitmapIcon

set the bitmap image shown for expandable tree items
(defaults to a right arrow)

 imageClosed

return the value of the instance variable 'imageClosed'.
That's the (default) bitmap image shown for closed folders
(initialized to a file-directory bitmap)

 imageClosed: anIconImage

set the instance variable 'imageClosed'.
That's the (default) bitmap image shown for closed folders
(if nil, a class-specific open file-directory bitmap will be used).
Must be set early (before opening the view)

 imageItem

return the value of the instance variable 'imageItem'.
That's the (default) bitmap image shown for regular items
(initialized to a plain-file bitmap)

 imageItem: anIconImage

set the instance variable 'imageItem'.
That's the (default) bitmap image shown for non-folders
(if nil, a class-specific file bitmap will be used).
Must be set early (before opening the view)

 imageOnMyDevice: anImage

associate image to device and returns the new image.

 imageOpened

return the value of the instance variable 'imageOpened'.
That's the (default) bitmap image shown for opened folders
(initialized to an open file-directory bitmap)

 imageOpened: anIconImage

set the instance variable 'imageOpened'.
That's the (default) bitmap image shown for opened folders
(if nil, a class-specific open file-directory bitmap will be used).
Must be set early (before opening the view)

 openIndicator

return the bitmap image shown for expanded tree items (a little down arrow)
(initialized to a down arrow)

 openIndicator: aBitmapIcon

set the bitmap image shown for expanded tree items
(defaults to a down arrow)

 showDirectoryIndicator

returns true if items with children have an open/closed indicator

 showDirectoryIndicator: aBoolean

show or hide open/closed indicators for items with children

 showDirectoryIndicatorForRoot

returns true if the root item has an open/closed indicator
(showing requires that the general showDirectoryIndicator is also enabled)

 showDirectoryIndicatorForRoot: aBoolean

show/hide the root item's open/closed indicator
(showing requires that the the common showDirectoryIndicator is also enabled)

 showLines

returns true if lines are shown

 showLines: aBoolean

show or hide lines

 showLinesForRoot

returns true if root-lines are shown

 showLinesForRoot: aBoolean

show or hide lines for root(s)

 showRoot

return true if the root is shown

 showRoot: aBoolean

show or hide the root item

 modelChanged: what with: aPara

hierarchical list changed

 update: anAspect with: aParameter from: changedObject

one of my models changed its value

 drawLine: line atX: atX inVisible: visLineNr with: fg and: bg

(comment from inherited method)
draw a given string at visible lines position with
given x position in fg/bg. Clears the whole line before drawing the string.
This is a low level entry; not meant for public use.

 drawLine: line fromX: x inVisible: visLineNr with: fg and: bg

(comment from inherited method)
draw a given string at visible lines position with
given x position in fg/bg. Clears partial line before drawing the string.
Low level entry; not meant for public use.

 drawLine: line inVisible: visLineNr with: fg and: bg

(comment from inherited method)
draw a given string at visible lines position in fg/bg

 drawVisibleLine: visLineNr col: col with: fg and: bg

(comment from inherited method)
draw single character at col index of visible line in fg/bg

 drawVisibleLine: visLineNr from: startCol to: endCol with: fg and: bg

(comment from inherited method)
draw part of a visible line in fg/bg

 drawVisibleLine: visLineNr from: startCol with: fg and: bg

(comment from inherited method)
draw right part of a visible line from startCol to end of line in fg/bg

 redrawFromVisibleLine: startVisLineNr to: endVisLineNr

(comment from inherited method)
redraw a range of lines.
Must check, if any is in the selection and handle this case.
Otherwise draw it en-bloque using supers method.

 redrawIconAndIndicatorAt: aLnNr

 redrawIndicatorLine: aLineNr

redraw the directory indicator for a line

 redrawVisibleLine: visLineNr

(comment from inherited method)
redraw a single line.
Must check, if any is in the selection and handle this case.
Otherwise draw using supers method.

 redrawVisibleLine: visLineNr from: startCol to: endCol

(comment from inherited method)
redraw from a startCol to endCol.
Must check, if it's in the selection and handle this case.

 drawFromVisibleLine: startVisLineNr to: endVisLineNr with: fg and: bg

redraw a visible line range with clearing the background

 drawVHLinesX: x0 y: y0 toX: x1 start: start stop: stop

redraw from line to line without clearing the background

 drawVisibleLineSelected: visLineNr with: fg and: bg

redraw a single line as selected.

 paintOnIsSelected: isSelected

 redrawElement: anIndex

(comment from inherited method)
redraw an individual element

 redrawLabelAt: x y: yTop index: anIndex

 redrawLinesX: x0 y: y0 toX: x1 start: start stop: stop

redraw from line to line without clearing the background

 redrawSelFrameAtX: x0 y: y0 toX: x1

redraw selection frame for a line

 redrawX: x y: y width: w height: h

a region must be redrawn

 detectNode: aOneArgBlock

evaluate the argument, aBlock for each node in the list until
the block returns true; in this case return the node which caused
the true evaluation. If none node is detected, nil is returned.

 selectedNodesDo: aOneArgBlock

evaluate the block on each node selected

 activateMenu

menu receiver:appl. -- now done in findGuiResources ...

 buttonMotion: buttonMask x: x y: y

mouse-move while button was pressed - handle selection changes

 buttonMultiPress: button x: x y: y

discard doubleClick on indicator

 buttonPress: button x: x y: y

handle button press event

 buttonRelease: button x: x y: y

stop any autoscroll

 doubleClicked

handle a double click; collapse or expand selected entry
in case of having children

 handleSelectButtonAtX: x y: y

handle a select button click

 indicatiorLineForButton: aButton atX: x y: y

returns linenumber assigned to indicator at x/y or 0

 isCtrlMetaAltOrShiftPressed

returns true if CTRL, META, ALT or SHIFT is pressed

 key: key select: index x: x y: y

select an entry by a keyboard action. This is treated like a doubleClick
on that entry.
Add on: In case that the entry is not selectable, scroll to the entry

Usage example(s):

^ super key:key select:index x:x y:y

 keyPress: key x: x y: y

handle keyboard input

  |top sel|

  top := StandardSystemView new; extent:300@300.
  sel := SelectionInTreeView new.
  sel root:(TreeItem newAsTreeFromSmalltalkClass:Object).
  sel action:[:nr | Transcript show:'selected:'; showCR:nr].
  top add:(ScrollableView forView:sel) in:((0.0 @ 0.0 ) corner:( 1.0 @ 1.0)).
  top open.

  |top sel|

  top := StandardSystemView new; extent:300@300.
  sel := SelectionInTreeView new.
  sel root:(TreeItem newAsTreeFromSmalltalkClass:nil).
  sel action:[:nr | Transcript show:'selected:'; showCR:nr].
  sel lineColor:(Color red).
  top add:(ScrollableView forView:sel) in:((0.0 @ 0.0 ) corner:( 1.0 @ 1.0)).
  top open.

  |top sel|

  top := StandardSystemView new; extent:300@300.
  sel := SelectionInTreeView new.
  sel showLines:false.
  sel showDirectoryIndicator:true.
  sel root:(TreeItem newAsTreeFromSmalltalkClass:Object).
  sel action:[:nr | Transcript show:'selected:'; showCR:nr].
  top add:(ScrollableView forView:sel) in:((0.0 @ 0.0 ) corner:( 1.0 @ 1.0)).
  top open.