"

 COPYRIGHT (c) 1997 by Claus Gittinger / 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' }"

View subclass:#DSVColumnView

	instanceVariableNames:'labelView listHolder editValue editView multipleSelectOk useIndex

		selectedColIndex selectedRowIndex selectRowOnDefault rowHeight

		columnDescriptors viewOrigin colorMap rowFontAscent lockRowIndex

		rowIfAbsentBlock columnHolder registererImages list fgColor

		separatorSize catchChangeEvents beDependentOfRows bgColor

		actionBlock builder tabIntern doubleClickActionBlock

		verticalSpacing horizontalSpacing rowSelectorForm

		buttonLightColor buttonShadowColor buttonHalfLightColor

		buttonHalfShadowColor checkToggleExtent checkToggleForm

		checkToggleActiveImage checkTogglePassiveImage checkToggleLevel

		comboButtonExtent comboButtonForm comboButtonLevel clickPosition

		dragAccessPoint dragIsActive dropTarget dropSource columnAdaptor

		tabAtEndAction tabAtStartAction modifiedChannel autoScroll

		autoScrollBlock needFitColumns scrollWhenUpdating

		selectionForegroundColor selectionBackgroundColor'

	classVariableNames:'DefaultForegroundColor DefaultBackgroundColor

		DefaultHilightForegroundColor DefaultHilightBackgroundColor

		ButtonLightColor ButtonShadowColor CheckToggleActiveImage

		CheckTogglePassiveImage ButtonHalfLightColor

		ButtonHalfShadowColor ButtonEdgeStyle CheckToggleForm

		CheckToggleLevel CheckToggleExtent ComboButtonForm

		ComboButtonLevel ComboButtonExtent'

	poolDictionaries:''

	category:'Views-DataSet'

!

!DSVColumnView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1997 by Claus Gittinger / 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

"

    implements a scrollable selection view based on rows and columns

    [Instance variables:]

        editValue               <Model>                 current editing model

        editView                <View>                  current editing component

        multipleSelectOk        <Boolean>               multiple selection enabled/disabled

        selectedColIndex        <Integer>               selected column index or 0

        selectedRowIndex        <Integer>               selected row    index or 0

        rowHeight               <Integer>               maximum height of any row

        columnDescriptors       <SequancableCollection> list of column descriptors

        viewOrigin              <Point>                 current view origin

        colorMap                <Dictionary>            store and register used colors on device

        rowFontAscent           <SmallInteger>          inset of a printable text in a row

                                                        including separator and font ascent.

        lockRowIndex            <SmallInteger>          internal used to indicate a row which has

                                                        changed its contents but no redraw should be

                                                        done( at:put: ).

        columnHolder            <ValueHolder>           holder which keeps the list of column descriptors.

        registererImages        <IdentityDictionary>    list of images registered on the device

        list                    <SequancableCollection> list of rows

        catchChangeEvents       <Boolean>               internal used to discard change notifications

        beDependentOfRows       <Boolean>               keep rows dependent; on default is disabled.

                                                        in case of enabled a row can raise a change

                                                        notification whithout a parameter which

                                                        will force a redraw of the row or the

                                                        readSelector of the column which will

                                                        redraw the cell in the row only.

        fgColor                 <Color>                 foreground color

        bgColor                 <Color>                 background color

        hgLgFgColor             <Color>                 highlight foreground color (selected)

        hgLgBgColor             <Color>                 highlight background color (selected)

        buttonLightColor        <Color>                 LightColor      ( drawing the edge of a button )

        buttonShadowColor       <Color>                 ShadowColor     ( drawing the edge of a button )

        buttonHalfLightColor    <Color>                 HalfLightColor  ( drawing the edge of a button )

        buttonHalfShadowColor   <Color>                 HalfShadowColor ( drawing the edge of a button )

        actionBlock             <a OneArgBlock>         action block performed on select

        doubleClickActionBlock  <a OneArgBlock>         action block performed on double click

        rowIfAbsentBlock        <a OneArgBlock>         this block is performed on an emty list entry

                                                        to retrive the item from the application. The

                                                        argument to the block is the index into the list.

                                                        The block should return the row instance which

                                                        is put to the list under the index.

        builder                 <UIBuilder>             builder set by application

        verticalSpacing         <SmallInteger>          vertical   row spacing( top  & bottom )

        horizontalSpacing       <SmallInteger>          horizontal row spacing( left & right )

        separatorSize           <SmallInteger>          line width of a vertical or horizontal separator

        rowSelectorForm         <Form>                  form used by a row selector

        checkToggleForm         <Form>                  form used by a checkToggle

        checkToggleExtent       <Point>                 extent of a checkToggle

        checkToggleLevel        <SmallInteger>          level used to draw a check toggle

        comboButtonForm         <Form>                  form used by a comboList or -Box

        comboButtonExtent       <Point>                 extent of a comboList or -Box

        comboButtonLevel        <SmallInteger>          level used to draw a comboList or -Box

        clickPosition           <Point>                 click position of the mouse

        dragAccessPoint         <Point>                 point where the drag operation starts

        dragIsActive            <Boolean>               true if a drag operation is active

        dropTarget              <DropTarget>            drag & drop target

        dropSource              <DropSource>            drag & drop source

    [author:]

        Claus Atzkern

    [see also:]

        DataSetColumnSpec

        DataSetColumn

        DataSetView

"

! !

!DSVColumnView class methodsFor:'accessing forms'!

rowSelector

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self rowSelector inspect

     ImageEditor openOnClass:self andSelector:#rowSelector

    "

    <resource: #image>

    ^Icon

        constantNamed:#'DSVColumnView rowSelector'

        ifAbsentPut:[(Depth2Image new) width: 11; height: 11; photometric:(#palette); bitsPerSample:(#(2 )); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'@@@@@A@@@AP@@A4@EW=@G?? O?:@@C(@@B @@B@@@@@@') ; colorMapFromArray:#[0 0 0 255 255 255 127 127 127 170 170 170]; mask:((Depth1Image new) width: 11; height: 11; photometric:(#blackIs0); bitsPerSample:(#(1 )); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'C@@N@@<@?8C?0O? ?<C? @<@C @L@@@a') ; yourself); yourself]

! !

!DSVColumnView class methodsFor:'defaults'!

defaultFont

    ^ SelectionInListView defaultFont

!

horizontalSpacing

    "returns the default horizontal space between rows

    "

    ^ 4

!

updateStyleCache

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

    "

    <resource: #style (#textForegroundColor 

                       #'scrollableView.backgroundColor'

                       #'selection.hilightForegroundColor'

                       #'selection.hilightBackgroundColor'   )>

    DefaultForegroundColor        := StyleSheet colorAt:#'textForegroundColor' default:(Color black).

    DefaultBackgroundColor        := StyleSheet colorAt:#'scrollableView.backgroundColor' default:DefaultViewBackgroundColor.

    DefaultHilightForegroundColor := StyleSheet colorAt:#'selection.hilightForegroundColor' default:DefaultBackgroundColor.

    DefaultHilightBackgroundColor := StyleSheet colorAt:#'selection.hilightBackgroundColor' default:DefaultForegroundColor.

    DefaultHilightForegroundColor = DefaultHilightBackgroundColor ifTrue:[

        DefaultHilightBackgroundColor := Color black

    ].

    ButtonLightColor       := StyleSheet colorAt:#'button.lightColor'.

    ButtonShadowColor      := StyleSheet colorAt:#'button.shadowColor'.

    ButtonHalfLightColor   := StyleSheet colorAt:#'button.halfLightColor'.

    ButtonHalfShadowColor  := StyleSheet colorAt:#'button.halfShadowColor'.

    ButtonEdgeStyle        := StyleSheet at:#'button.edgeStyle'.

    CheckToggleActiveImage := StyleSheet at:#'checkToggle.activeImage'.

    CheckToggleActiveImage isNil ifTrue:[

        CheckTogglePassiveImage := nil

    ] ifFalse:[

        CheckTogglePassiveImage := StyleSheet at:#'checkToggle.passiveImage'.

        CheckTogglePassiveImage isNil ifTrue:[

            CheckToggleActiveImage := nil

        ]

    ].

    ComboButtonForm   := nil.

    ComboButtonLevel  := nil.

    ComboButtonExtent := nil.

    CheckToggleForm   := nil.

    CheckToggleLevel  := nil.

    CheckToggleExtent := nil.

"

self updateStyleCache.

"

    "Modified: / 26.10.1997 / 17:09:07 / cg"

!

verticalSpacing

    "returns the default vertical space between rows

    "

    ^ 2

! !

!DSVColumnView class methodsFor:'resources'!

dragIconMulti

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self dragIconMulti inspect

     ImageEditor openOnClass:self andSelector:#dragIconMulti

    "

    <resource: #image>

    ^Icon

        constantNamed:#'DSVColumnView dragIconMulti'

        ifAbsentPut:[(Depth1Image new) width: 32; height: 32; photometric:(#palette); bitsPerSample:(#(1 )); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@O?<0@C??L@@<@@@@O@@@@C3??L@<??3@OO?<<C3??O@<??0@OO?<@C3???0<???<OO???C3???0<???<OO???@C???0@???<@O???@C???0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@b') ; colorMapFromArray:#[0 0 0 255 255 255]; mask:((ImageMask new) width: 32; height: 32; photometric:(#blackIs0); bitsPerSample:(#(1 )); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'@@@@@@@@@@@@@@@@@@@@@O??<@C???@@???<@O???@C????@????0O????C????0?????O????3?????????????????????????????????????????????????????@????0O???<C????@????0@@@@@@@@@@@@@@@@@@@@@b') ; yourself); yourself]

!

dragIconSingle

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self dragIconSingle inspect

     ImageEditor openOnClass:self andSelector:#dragIconSingle

    "

    <resource: #image>

    ^Icon

        constantNamed:#'DSVColumnView dragIconSingle'

        ifAbsentPut:[(Depth1Image new) width: 32; height: 32; photometric:(#palette); bitsPerSample:(#(1 )); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@O?<0@C??L@@??30@O?<<@C??@@@??0@@O???@C???0@???<@O???@C???0@???<@O???@C???0@???<@O???@C???0@???<@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@b') ; colorMapFromArray:#[0 0 0 255 255 255]; mask:((ImageMask new) width: 32; height: 32; photometric:(#blackIs0); bitsPerSample:(#(1 )); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'@@@@@@@@@@@@@@@@@@@@@O??<@C???@@???<@O???@C???<@????@O???<C????@????0O???<C????@????0O???<C????@????0O???<C????@????0O???<C????@????0O???<@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@b') ; yourself); yourself]

! !

!DSVColumnView methodsFor:'accessing'!

builder

    "get the builder (UIBuilder or nil)

    "

    ^ builder

!

builder:aBuilder

    "set the builder (UIBuilder or nil)

    "

    builder := aBuilder

!

columnView

    "returns self

    "

    ^ self

!

labelView:aView

    labelView := aView for:self.

    labelView layout:(LayoutFrame

                        leftFraction:0 offset:0 

                        rightFraction:1 offset:0 

                        topFraction:0 offset:0 

                        bottomFraction:0 offset:[self preferredLabelViewHeight]).

!

level:aLevel

    "change the level and thus the level of the labelView

    "

    aLevel ~~ level ifTrue:[

        super level:aLevel.

"/        labelView level:aLevel.

    ]

!

modifiedChannel

    "return the value of the instance variable 'modifiedChannel' (automatically generated)"

    ^ modifiedChannel

    "Created: / 30.1.2000 / 12:10:57 / cg"

!

modifiedChannel:something

    "set the value of the instance variable 'modifiedChannel' (automatically generated)"

    modifiedChannel := something.

    "Created: / 30.1.2000 / 12:10:57 / cg"

!

preferredLabelViewHeight

    ^ labelView preferredHeight + (labelView margin + self verticalSpacing * 2).

!

rowFontAscent

    "returns the inset of a printable text in a row

    "

    ^ rowFontAscent

! !

!DSVColumnView methodsFor:'accessing-actions'!

action:aOneArgAction

    "set the action block to be performed on select

    "

    actionBlock := aOneArgAction

!

doubleClickAction:aOneArgAction

    "set the action block to be performed on doubleclick

    "

    doubleClickActionBlock := aOneArgAction

!

rowIfAbsent:aOneArgAction

    "set the action block to be performed on each 'nil' entry into the

     list. The argument to the block is the index into the list. The

     block returns the row which is put to the list

    "

    rowIfAbsentBlock := aOneArgAction

!

tabAtEndAction:aNoneArgAction

    "set the action, called without any argument at end of the list entering

     tab next.

     The default is to give the focus to the view after self in the focusSequence

    "

    tabAtEndAction := aNoneArgAction

!

tabAtStartAction:aNoneArgAction

    "set the action, called without any argument at start of the list entering

     tab previous.

     The default is to give the focus to the view before self in the focusSequence

    "

    tabAtStartAction := aNoneArgAction

! !

!DSVColumnView methodsFor:'accessing-behavior'!

beDependentOfRows

    "make myself dependent of any row; in this case any change notification

     raised by a row is catched and the cell identified by the 'readSelector'

     is redrawn. In case of a nil readSelector, the whole raw is redrawn.

        -> row changed:'what'

     On default the attribute is set to false (disabled).

    "

    ^ beDependentOfRows

!

beDependentOfRows:aBool

    "make myself dependent of any row; in this case any change notification

     raised by a row is catched and the cell identified by the 'readSelector'

     is redrawn. In case of a nil readSelector, the whole raw is redrawn.

        -> row changed:'what'

     On default the attribute is set to false (disabled).

    "

    aBool ~~ beDependentOfRows ifTrue:[

        beDependentOfRows := aBool.

        list size ~~ 0 ifTrue:[

            list do:[:aRow| aRow notNil ifTrue:[

                beDependentOfRows ifTrue:[aRow addDependent:self]

                                 ifFalse:[aRow removeDependent:self]

                ]

            ]

        ]

    ]

!

enableChannel:aChannel

    enableChannel notNil ifTrue:[

        enableChannel removeDependent:self

    ].

    (enableChannel := aChannel) notNil ifTrue:[

        enableChannel addDependent:self

    ].

!

multipleSelectOk

    "allow/disallow multiple row selections; the default is false

    "

    ^ multipleSelectOk

!

multipleSelectOk:aState

    "allow/disallow multiple row selections; the default is false

    "

    aState == multipleSelectOk ifFalse:[

        multipleSelectOk := aState.

        self deselect

    ]

!

opaqueColumnResize

    ^ labelView opaqueColumnResize

!

opaqueColumnResize:aBoolean

    labelView opaqueColumnResize:aBoolean

!

scrollWhenUpdating

    "return the scroll behavior, when I get a new text 

     (via the model or the #contents/#list)

     Possible returnValues are:

        #keep / nil     -> no change

        #endOfText      -> scroll to the end

        #beginOfText    -> scroll to the top

     The default is #beginOfText.

     This may be useful for fields which get new values assigned from

     the program (i.e. not from the user)"

    ^ scrollWhenUpdating

!

scrollWhenUpdating:aSymbolOrNil

    "define how to scroll, when I get a new text 

     (via the model or the #contents/#list)

     Allowed arguments are:

        #keep / nil     -> no change

        #endOfText      -> scroll to the end

        #beginOfText    -> scroll to the top

     The default is #beginOfText.

     This may be useful for fields which get new values assigned from

     the program (i.e. not from the user)"

    scrollWhenUpdating := aSymbolOrNil

!