"

 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.

"

ListModelView subclass:#SelectionInListModelView

	instanceVariableNames:'selection multipleSelectOk actionBlock doubleClickActionBlock

		clickLine highlightMode useIndex hilightFgColor hilightBgColor

		hilightLevel hilightFrameColor hilightStyle dragAccessPoint

		dropTarget dropSource'

	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 )

        actionBlock             <Block>    action evaluated on single click

        doubleClickActionBlock  <Block>    action evaluated on double click

        clickPosition           <Point>    internal use

        highlightMode           <Symbol>   how to draw the selection

        useIndex                <Boolean>  representation of the model selection

        hilightFgColor          <Color>           

        hilightBgColor          <Color>    how highlighted items are drawn

        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

    [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 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:'initialization'!

initialize

    "setup the signals

    "

    super initialize.

    DefaultHilightLevel isNil ifTrue:[

        self updateStyleCache

    ].

! !

!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'!

list:aList

    "get the status of <showRoot> from the list

    "

    selection notNil ifTrue:[

        selection := nil.

        self selectionChanged.

    ].

  ^ super list:aList

! !

!SelectionInListModelView methodsFor:'accessing behavior'!

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

    "

    (aMode ~~ highlightMode and:[(aMode == #label or:[aMode == #line])]) ifTrue:[

        highlightMode := aMode.

        shown ifTrue:[

            self selectionDo:[:i|self redrawSelectionAt:i]

        ]

    ]

!

multipleSelectOk

    "allow/disallow multiple selections; the default is false

    "

    ^ multipleSelectOk

!

multipleSelectOk:aState

    "allow/disallow multiple selections; the default is false

    "

    aState == multipleSelectOk ifFalse:[

        multipleSelectOk := aState.

        selection notNil ifTrue:[

            multipleSelectOk ifTrue:[

                selection := Array with:selection

            ] ifFalse:[

                selection size ~~ 1 ifTrue:[

                    selection := nil.

                    self invalidate.

                    self selectionChanged

                ] ifFalse:[

                    selection := selection at:1

                ]

            ]

        ]

    ]

!

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:'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

! !

!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)

    "

    useIndex ifFalse:[

        ^ self selectionValue

    ].

    selection isNil ifTrue:[

        ^ multipleSelectOk ifTrue:[#()] ifFalse:[0]

    ].

  ^ multipleSelectOk ifTrue:[selection copy] ifFalse:[selection]

!

getSelectionFromModel

    "get selection from model; returns a selection or nil

    "

    |value newSel|

    (    model isNil

     or:[(value := model value) isNil

     or:[value == 0]]

    ) ifTrue:[

        ^ nil

    ].

    multipleSelectOk ifFalse:[

        useIndex ifFalse:[

            (value := self identityIndexOf:value) == 0 ifTrue:[

                ^ nil

            ]

        ].

        ^ value

    ].

    "/ MULTI SELECT

    value isEmpty ifTrue:[^ nil].

    useIndex      ifTrue:[^ value].

    newSel := OrderedCollection new.

    value do:[:el||index|

        (index := self identityIndexOf:el) ~~ 0 ifTrue:[

            newSel add:index

        ]

    ].

    ^ newSel notEmpty ifTrue:[newSel] ifFalse:[nil]

!

listSizeChanged:aLnNr nLines:aDeltaLines

    "update selection

    "

    |newSel noChg size changed|

    super listSizeChanged:aLnNr nLines:aDeltaLines.

    selection isNil ifTrue:[^ self].

    list size == 0 ifTrue:[

      ^ self deselectWithoutRedraw

    ].

    multipleSelectOk ifFalse:[

        selection >= aLnNr ifTrue:[

            selection := selection + aDeltaLines.

            (aDeltaLines < 0 and:[selection < aLnNr]) ifTrue:[

                self deselectWithoutRedraw

            ] ifFalse:[

                (model notNil and:[useIndex]) ifTrue:[

                    model setValue:selection

                ]

            ]

        ].

        ^ self

    ].

    size    := selection size.

    changed := false.

    aDeltaLines < 0  ifFalse:[

        1 to:size do:[:anIndex|

            newSel := selection at:anIndex.

            newSel >= aLnNr ifTrue:[

                changed := true.

                selection at:anIndex put:(newSel + aDeltaLines)

            ]

        ].

        (changed and:[useIndex and:[model notNil]]) ifTrue:[

            model setValue:(selection copy)

        ].

        ^ self

    ].

    noChg := 0.

    1 to:size do:[:anIndex|

        newSel := selection at:anIndex.

        newSel >= aLnNr ifTrue:[

            newSel  := newSel + aDeltaLines.

            changed := true.

            newSel < aLnNr ifTrue:[

                noChg  := noChg + 1.

                newSel := 0.

            ].

            selection at:anIndex put:newSel

        ]

    ].

    noChg ~~ 0 ifTrue:[

        noChg == size ifTrue:[

            self deselectWithoutRedraw

        ] ifFalse:[

            selection := selection select:[:i| i ~~ 0].

            self selectionChanged

        ]

    ] ifFalse:[

        (changed and:[useIndex and:[model notNil]]) ifTrue:[

            model setValue:(selection copy)

        ]

    ]

!

selectionChanged

    "selection has changed. Call actionblock and/or send changeMessage if defined

    "

    |value arg|

    (model isNil and:[actionBlock isNil]) ifTrue:[

        ^ self

    ].

    arg := self argForChangeMessage.

    model notNil ifTrue:[

        model removeDependent:self.

        self sendChangeMessage:#value: with:arg.

        model addDependent:self.

    ].

    actionBlock notNil ifTrue:[

        (actionBlock numArgs) == 1 ifTrue:[

            actionBlock value:arg

        ] ifFalse:[

            actionBlock value

        ]

    ].

!

update:something with:aParameter from:changedObject

    "one of my models changed

    "

    |newSelection|

    changedObject == model ifTrue:[

        newSelection := self getSelectionFromModel.

        newSelection ~= selection ifTrue:[

            self pushEvent:#setSelection: with:newSelection

        ]

    ] ifFalse:[

        super update:something with:aParameter from:changedObject

    ].

! !

!SelectionInListModelView methodsFor:'drag & drop'!

canDrag

    "returns true if dragging is enabled

    "

    ^ dropSource notNil

!

dropSource

    "returns the dropSource or nil

    "

    ^ dropSource

!

dropSource:aDropSourceOrNil

    "set the dropSource or nil

    "

    dropSource := aDropSourceOrNil.

!

dropTarget

    "returns the dropTarget or nil

    "

    ^ dropTarget

!

dropTarget:aDropTragetOrNil

    "set the dropTarget or nil

    "

    dropTarget := aDropTragetOrNil.

!

startDragAt:aPoint

    "start drag at a point

    "

    dropSource notNil ifTrue:[

        dropSource startDragSelector notNil ifTrue:[

            dropSource startDragIn:self at:aPoint

        ] ifFalse:[

            DragAndDropManager new startDragFrom:self

                                      dropSource:dropSource

                                          offset:#center

        ]

    ]

! !

!SelectionInListModelView methodsFor:'drawing'!

drawFrom:start to:stop x:xL y:yT toX:xR

    "draw the lines between start to stop without clearing the background

    "

    |selY selH

     w        "{ Class:SmallInteger }"

     y0       "{ Class:SmallInteger }"

     y1       "{ Class:SmallInteger }"

     hg       "{ Class:SmallInteger }"

    |

    w := xR - xL.

    (highlightMode == #line and:[selection notNil]) ifTrue:[

        "/ redraw the background for all selected lines in the invalid range

        self selectionDo:[:lnNr|

            (lnNr between:start and:stop) ifTrue:[

                selY isNil ifTrue:[