"

 COPYRIGHT (c) 1999 by eXept Software AG

              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.

"

"{ Package: 'stx:libwidg2' }"

ListModelView subclass:#SelectionInListModelView

	instanceVariableNames:'selection multipleSelectOk selectOnButtomMenu actionBlock

		doubleClickActionBlock selectConditionBlock clickLine

		highlightMode useIndex ignoreReselect toggleSelect hilightFgColor

		hilightBgColor hilightLevel hilightFrameColor hilightStyle

		dragAccessPoint dropTarget dropSource editorView openEditorAction

		closeEditorAction highlightEnterItem enterItem cursorItem

		lineMask'

	classVariableNames:'DefaultHilightStyle DefaultHilightBackgroundColor

		DefaultHilightForegroundColor DefaultHilightLevel

		DefaultHilightFrameColor'

	poolDictionaries:''

	category:'Views-Lists'

!

!SelectionInListModelView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1999 by eXept Software AG

              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.

"

!

documentation

"

    SelectionInListModelView is mostly like SelectionInListView,

    but derives from the ListModelView and thus the list is kept

    by the model.

    [Instance variables:]

        selection               <misc>       the current selection. nil, a number or collection of numbers

        multipleSelectOk        <Boolean>    allow/disallow multiple selections( default:false )

        selectOnButtomMenu      <Boolean>    enable/disable selection will change on menu pressed

        actionBlock             <Block>      action evaluated on single click

        doubleClickActionBlock  <Block>      action evaluated on double click

        selectConditionBlock

        clickLine               <Number>     clicked line during button motion

        useIndex                <Boolean>    representation of the model selection

        ignoreReselect          <Boolean>    if set, a click on an already selected entry is ignored

        toggleSelect            <Boolean>    a click on an entry unselects it and vice versa

        highlightMode           <Symbol>     how to draw the selection

        hilightFgColor          <Color>      foregroundColor of highlighted items       

        hilightBgColor          <Color>      backgroundColor of highlighted items

        hilightLevel            <Integer>    level to draw selections (i.e. for 3D effect)

        hilightFrameColor       <Color>      rectangle around highlighted items

        hilightStyle            <Boolean>    actions on widget are enabled/disabled

        dragAccessPoint         <Point>      point where the drag operation starts from

        dropTarget              <DropTarget> keeps information about the drop operation

        dropSource              <DropSource> keeps information about the drag operation

        editorView              <View>       editor on current selected item

        openEditorAction        <Action>     action to get an editor on the current selection from user

        closeEditorAction       <Action>     action invoked before the editor is closed.

        enterItem               <Item/nil>   item over which the mouse pointer is located

                                             or nil

        highlightEnterItem      <Boolean>    enable or disable highlight of enterItem

    [author:]

        Claus Atzkern

    [see also:]

        ListModelView

        HierarchicalListView

"

!

examples

"

                                                                        [exBegin]

    |top list view|

    list := List new.

    1 to:100 do:[:i| list add:('element: ', i printString) ].

    top  := StandardSystemView new; extent:300@300.

    view := ScrollableView for:SelectionInListModelView miniScroller:true

                        origin:0.0@0.0 corner:1.0@1.0 in:top.

    view list:list.

    top  open.

                                                                        [exEnd]

                                                                        [exBegin]

    |top list view|

    list := List new.

    1 to:100 do:[:i| list add:('element: ', i printString) ].

    top  := StandardSystemView new; extent:300@300.

    view := ScrollableView for:SelectionInListModelView miniScroller:true

                        origin:0.0@0.0 corner:1.0@1.0 in:top.

    view list:list.

    view openEditorAction:[:ln :aGC| |field|

        field := EditField new.

        field level:0.

        field acceptOnLostFocus:true.

        field acceptAction:[:x| list at:ln put:(field contents) ].

        field font:(aGC font).

        field contents:(list at:ln).

        field

    ].

    top open.

                                                                        [exEnd]

                                                                        [exBegin]

    |top list view item|

    list := HierarchicalList new.

    item := HierarchicalItem::Example labeled:'Test'.

    item expand.

    list showRoot:false.

    list root:item.

    top  := StandardSystemView new; extent:300@300.

    view := ScrollableView for:SelectionInListModelView miniScroller:true

                        origin:0.0@0.0 corner:1.0@1.0 in:top.

    view list:list.

    view doubleClickAction:[:i| (list at:i) toggleExpand ].

    top  open.

                                                                        [exEnd]

"

! !

!SelectionInListModelView class methodsFor:'defaults'!

updateStyleCache

    "extract values from the styleSheet and cache them in class variables"

    <resource: #style   (

                        #'selection.hilightForegroundColor' #'selection.hilightBackgroundColor'

                        #'selection.hilightFrameColor'      #'selection.hilightLevel'

                        #'selection.foregroundColor'        #'selection.backgroundColor'

                        #'selection.shadowColor'            #'selection.lightColor'

                        #'selection.font'                   #'selection.hilightStyle'

                        #'text.foregroundColor'

                        )>

    DefaultHilightForegroundColor  := StyleSheet colorAt:'selection.hilightForegroundColor'.

    DefaultHilightBackgroundColor  := StyleSheet colorAt:'selection.hilightBackgroundColor'.

    DefaultHilightFrameColor       := StyleSheet colorAt:'selection.hilightFrameColor'.

    DefaultHilightLevel            := StyleSheet at:'selection.hilightLevel' default:0.

    DefaultHilightStyle            := StyleSheet at:'selection.hilightStyle' default:(StyleSheet name).

    DefaultForegroundColor         := StyleSheet colorAt:'selection.foregroundColor'.

    DefaultBackgroundColor         := StyleSheet colorAt:'selection.backgroundColor'.

    DefaultShadowColor             := StyleSheet colorAt:'selection.shadowColor'.

    DefaultLightColor              := StyleSheet colorAt:'selection.lightColor'.

    DefaultForegroundColor isNil ifTrue:[

        DefaultForegroundColor := StyleSheet colorAt:'text.foregroundColor' default:Black

    ].

    "

     self updateStyleCache

    "

! !

!SelectionInListModelView methodsFor:'accessing'!

cursorLine

    "returns the index of the cursor line or 0

    "

    |index|

    cursorItem isNil ifTrue:[^ 0 ].

    index := list identityIndexOf:cursorItem.

    index == 0 ifTrue:[ cursorItem := nil ].

    ^ index

!

list:aList

    "get the status of <showRoot> from the list

    "

    self deselectWithoutRedraw.

  ^ super list:aList

! !

!SelectionInListModelView methodsFor:'accessing editor'!

closeEditor

    "close the current editor

    "

    |editor|

    (editor := editorView) notNil ifTrue:[

        editorView := nil.

        closeEditorAction notNil ifTrue:[

            closeEditorAction value:editor.

        ].

        editor destroy.

    ].

!

closeEditorAction

    "get the block which is evaluated before the editor is closed; the argument

     to the action is the editor.

    "

    ^ closeEditorAction

!

closeEditorAction:anOneArgAction

    "get the block which is evaluated before the editor is closed; the argument

     to the action is the editor.

    "

    closeEditorAction := anOneArgAction.

!

openEditor

    "opens the editor on the current selection;

     returns the editorView or nil if no openEditorAction is defined

     or no single selection exists ...

    "

    |numArgs lnNr|

    self closeEditor.

    shown ifFalse:[^ nil].

    openEditorAction isNil ifTrue:[^ nil].

    lnNr := self selectedIndex.

    lnNr == 0 ifTrue:[^ nil].

    self makeSelectionVisible.

    numArgs := openEditorAction numArgs.

    numArgs == 0 ifTrue:[

        editorView := openEditorAction value

    ] ifFalse:[

        numArgs == 1 ifTrue:[editorView := openEditorAction value:lnNr]

                    ifFalse:[editorView := openEditorAction value:lnNr value:self]

    ].

    editorView isNil ifTrue:[^ nil].

    editorView superView isNil ifTrue:[

        self addSubView:editorView

    ].

    self computeEditorLayout.

    editorView realize.

    self windowGroup focusView:editorView.

  ^ editorView

!

openEditorAction

    "get the block which is evaluated to get the editor which is set for the

     line; the arguments to the block is the line number and the widget itself

    "

    ^ openEditorAction

!

openEditorAction:aTwoArgAction

    "set the block which is evaluated to get the editor which is set for the

     line; the arguments to the block is the line number and the widget itself

    "

    openEditorAction := aTwoArgAction.

! !

!SelectionInListModelView methodsFor:'accessing-actions'!

action

    "get the action block to be performed on select

    "

    ^ actionBlock

!

action:aOneArgAction

    "set the action block to be performed on select

    "

    actionBlock := aOneArgAction

!

doubleClickAction

    "get the action block to be performed on doubleclick

    "

    ^ doubleClickActionBlock

!

doubleClickAction:aOneArgAction

    "set the action block to be performed on doubleclick

    "

    doubleClickActionBlock := aOneArgAction

!

selectConditionBlock

    "set the conditionBlock; this block is evaluated before a selection

     change is performed; the change will not be done, if the evaluation

     returns false

    "

    ^ selectConditionBlock

!

selectConditionBlock:aOneArgBlock

    "set the conditionBlock; this block is evaluated before a selection

     change is performed; the change will not be done, if the evaluation

     returns false

    "

    selectConditionBlock := aOneArgBlock.

! !

!SelectionInListModelView methodsFor:'accessing-behavior'!

highlightEnterItem

    "enable or disable to highlight the item over which the mouse pointer is located

    "

    ^ highlightEnterItem

!

highlightEnterItem:aBool

    "enable or disable to highlight the item over which the mouse pointer is located

    "

    highlightEnterItem ~~ aBool ifTrue:[

        highlightEnterItem := aBool.

        self pointerEntersItem:nil.

    ].

!

highlightMode

    "get the mode how to draw a selected line:

        #line           draw whole line selected

        #label          draw label selected

    "

    ^ highlightMode

!

highlightMode:aMode

    "set the mode how to draw a selected line:

        #line           draw whole line selected

        #label          draw label selected

    "

    highlightMode := aMode.

!

ignoreReselect

    "get the ignoreReselect flag - see method #ignoreReselect: for more details

    "

    ^ ignoreReselect

!

ignoreReselect:aBoolean

    "set/clear the ignoreReselect flag - 

     if set, a click on an already selected entry is ignored.

     Otherwise the notification is done, even if no

     change in the selection occurs.

     (for example, in browser to update a method).

     Setting ignoreReselect to false makes sense if data is shown

     which may change by itself (i.e. without the user doing anything)

     For example, the inspector uses this, and redisplays the value,

     if the selection is the same.

     The default is true, meaning that a click on an already selected

     does not lead to a notification via the actionBlock/change mechanism.

    "

    ignoreReselect := aBoolean

!

multipleSelectOk

    "allow/disallow multiple selections; the default is false

    "

    ^ multipleSelectOk

!

multipleSelectOk:aState

    "allow/disallow multiple selections. If enabled, the

     user may select multiple entries in the list, and the program

     always gets a collection of selected items (indexes if useIndex is true,

     values otherwise). The default is false, for single selections.

    "

    |state|

    state := aState ? false.

    multipleSelectOk == state ifTrue:[ ^ self ].

    selection isNil ifTrue:[

        multipleSelectOk := state.

        ^ self.

    ].

    multipleSelectOk ifFalse:[

        selection := Array with:selection.

        multipleSelectOk := true.

        ^ self

    ].

    selection size == 1 ifTrue:[

        selection := selection first.

    ] ifFalse:[

        self selection:nil

    ].

    multipleSelectOk := false.

!

selectOnButtomMenu

    "define the button-menu-press behavior; if true the line under the mouse

     will be selected before the menu is opened. Otherwise the menu is opened

     on the current selection.

    "

    ^ selectOnButtomMenu

!

selectOnButtomMenu:aBoolean

    "define the button-menu-press behavior; if true the line under the mouse

     will be selected before the menu is opened. Otherwise the menu is opened

     on the current selection.

    "

    selectOnButtomMenu := aBoolean.

!

toggleSelect

    "get the toggleSelect flag - see method #toggleSelect: for more details

    "

    ^ toggleSelect

!

toggleSelect:aBoolean

    "turn on/off toggle select. If true, clicking on a selected entry

     unselects it and vice versa. The default is false, which means

     that clicking on an already selected entry does not change its

     select status (see also ignoreReselect:).

    "

    toggleSelect := aBoolean.

!

useIndex

    "set/clear the useIndex flag.

     the selection writen to the model are the indices into the list

     or the elements selected.

    "

    ^ useIndex

!

useIndex:aBoolean

    "set/clear the useIndex flag.

     the selection writen to the model are the indices into the list

     or the elements selected.

    "

    useIndex := aBoolean ? true

! !

!SelectionInListModelView methodsFor:'change & update'!

argForChangeMessage

    "return the argument for a selectionChange;

     depending on the setting of useIndex, this is either the numeric

     index of the selection or the value (i.e. the string)

    "

    selection isNil ifTrue:[

        multipleSelectOk ifTrue:[^ #()].

        ^ useIndex ifTrue:[0] ifFalse:[nil]