"

 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' }"

"{ NameSpace: Smalltalk }"

View subclass:#DSVColumnView

!

!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

"

    ColumnView part of a DataSetView.

    implements a scrollable selection view based on rows and columns.

    Used as the contents-part of a DataSetView.

    [Instance variables:]

        editValue               <Model>                 current editing model

        editView                <View>                  current editing component

        buttonReleaseAction     <Action or nil>         called if the mouse button is released

        buttonMotionAction      <Action or nil>         called during mouse motion with one

                                                        argument the point under the mouse.

        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

        minRowHeight            <Integer>               minimum height of all displayed labels

        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 empty 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

        dropTarget              <DropTarget>            drag & drop target

        dropSource              <DropSource>            drag & drop source

    [author:]

        Claus Atzkern

    [see also:]

        DataSetColumnSpec

        DataSetColumn

        DataSetView

"

! !

!DSVColumnView class methodsFor:'defaults'!

defaultFont

    ^ SelectionInListView defaultFont

!

horizontalSpacing

    "returns the default horizontal space between rows

    "

    ^ 4

!

preselectAllWhenOpeningEditor:aBoolean

    PreselectAllWhenOpeningEditor := aBoolean

    "Created: / 02-11-2010 / 22:00:28 / cg"

!

updateStyleCache

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

    <resource: #style (#textForegroundColor

                       #'scrollableView.backgroundColor'

                       #'button.lightColor'

                       #'button.shadowColor'

                       #'button.halfLightColor'

                       #'button.halfShadowColor'

                       #'button.edgeStyle'

                       #'checkToggle.activeImage'

                       #'checkToggle.passiveImage'

                       #'radioButton.activeImage'

                       #'radioButton.passiveImage'

                       #'selection.hilightForegroundColor'

                       #'selection.hilightBackgroundColor'

                       #'selection.hilightFrameColor'

                       #'dataSet.labelView.foregroundColor'

                       #'dataSet.labelView.backgroundColor'

    )>

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

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

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

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

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

    DefaultHilightForegroundColorNoFocus := StyleSheet colorAt:#'selection.hilightForegroundColorNoFocus'.

    DefaultHilightBackgroundColorNoFocus := StyleSheet colorAt:#'selection.hilightBackgroundColorNoFocus'.

    DefaultHilightFrameColor      := StyleSheet colorAt:#'selection.hilightFrameColor'. "/ no default; nil means: no frame

    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

        ]

    ].

    "/ CheckToggleDisabledActiveImage := StyleSheet at:#'checkToggle.disabledActiveImage'.

    "/ CheckToggleDisabledPassiveImage := StyleSheet at:#'checkToggle.disabledPassiveImage'.

    CheckToggleForm   := nil.

    CheckToggleLevel  := nil.

    CheckToggleExtent := nil.

    RadioButtonActiveImage := StyleSheet at:#'radioButton.activeImage'.

    RadioButtonPassiveImage := StyleSheet at:#'radioButton.passiveImage'.

    "/ RadioButtonDisabledActiveImage := StyleSheet at:#'radioButton.disabledActiveImage'.

    "/ RadioButtonDisabledPassiveImage := StyleSheet at:#'radioButton.disabledPassiveImage'.

    (RadioButtonActiveImage isNil or:[ RadioButtonPassiveImage isNil ]) ifTrue:[

        RadioButtonActiveImage := RadioButton roundOnForm.

        RadioButtonPassiveImage := RadioButton roundOffForm.

    ].

    ComboButtonForm   := nil.

    ComboButtonLevel  := nil.

    ComboButtonExtent := nil.

    DefaultLabelBackgroundColor := StyleSheet at:#'dataSet.labelView.backgroundColor' default:nil.

    DefaultLabelForegroundColor := StyleSheet at:#'dataSet.labelView.foregroundColor' default:nil.

    "

     self updateStyleCache.

    "

    "Modified: / 20-01-2011 / 08:44:28 / cg"

    "Modified (comment): / 17-08-2018 / 17:06:46 / Claus Gittinger"

!

verticalSpacing

    "returns the default vertical space between rows

    "

    ^ 2

! !

!DSVColumnView class methodsFor:'image specs'!

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

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'DSVColumnView class dragIconMulti'

        ifAbsentPut:[(Depth1Image width:32 height:32) 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 width:32 height:32) 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

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'DSVColumnView class dragIconSingle'

        ifAbsentPut:[(Depth1Image width:32 height:32) 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 width:32 height:32) bits:(ByteArray fromPackedString:'

@@@@@@@@@@@@@@@@@@@@@O??<@C???@@???<@O???@C???<@????@O???<C????@????0O???<C????@????0O???<C????@????0O???<C????@????0O??

?<C????@????0O???<@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@b'); yourself); yourself]

!

rowSelectorImage

    "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 rowSelectorImage inspect

     ImageEditor openOnClass:self andSelector:#rowSelectorImage

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'DSVColumnView class rowSelectorImage'

        ifAbsentPut:[(Depth2Image width:11 height:11) bits:(ByteArray fromPackedString:'@ @@@#@@*#0@@C,@O>(0N*($J*$P@BT@*!!P@@!!@@@ @@')

            colorMapFromArray:#[0 0 0 127 127 127 170 170 170 255 255 255]

            mask:((ImageMask width:11 height:11) bits:(ByteArray fromPackedString:'C@@N@@<@?8C?0O? ?<C? @<@C @L@@@a'); yourself); yourself]

! !

!DSVColumnView class methodsFor:'signal constants'!

stopRedrawSignal

    "returns the signal which is raised during drawing if the

     required label height is less than the current rowHeight

    "

    StopRedrawSignal isNil ifTrue:[

        StopRedrawSignal := Notification newSignalMayProceed:true.

        StopRedrawSignal nameClass:self message:#stopRedrawSignal.

    ].

    ^ StopRedrawSignal

! !

!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

!

heightOfContents

    "return the height of the contents in pixels"

    cachedPreferredExtent isNil ifTrue:[

        self preferredExtent

    ].

    ^ cachedPreferredExtent y

!

labelView

    ^labelView

!

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.

    ]

!

preferredLabelViewHeight

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

!

rowFontAscent

    "returns the inset of a printable text in a row"

    ^ rowFontAscent

!

selectedColIndex:newSelectedColIndex

    self selectedColIndexHolder value:newSelectedColIndex

!

selectedColIndexHolder

    selectedColIndexHolder isNil ifTrue:[

        selectedColIndexHolder := ValueHolder new.

    ].

    ^ selectedColIndexHolder

! !

!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

!

selectConditionBlock

    "get the select-conditionBlock; this block is evaluated before

     any selection change is performed (passing the to-be-changed row number

     index as arg).

     The change will not be done, if the block returns false. "

    ^ selectConditionBlock

!

selectConditionBlock:aOneArgBlockOrNil

    "set the select-conditionBlock; this block is evaluated before

     any selection change is performed (passing the to-be-changed row number

     index as arg).

     The change will not be done, if the block returns false. "

    selectConditionBlock := aOneArgBlockOrNil.

!

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"