"

 COPYRIGHT (c) 1989 by 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.

"

View subclass:#Scroller

	instanceVariableNames:'thumbOrigin thumbHeight thumbColor thumbFrameColor scrollAction

		orientation thumbFrame thumbLevel scrolling pressOffset

		synchronousOperation shadowForm lightForm inset thumbShadowColor

		thumbLightColor thumbEdgeStyle thumbHalfShadowColor

		thumbHalfLightColor thumbEnteredColor thumbFrameSizeDifference

		tallyLevel tallyMarks fixThumbHeight frameBeforeMove ghostColor

		ghostFrameColor ghostLevel rangeStart rangeEnd rangeStep entered

	classVariableNames:'HandleShadowForm HandleLightForm DefaultViewBackground

		DefaultShadowColor DefaultLightColor DefaultThumbColor

		DefaultThumbShadowColor DefaultThumbLightColor

		DefaultThumbHalfShadowColor DefaultThumbHalfLightColor

		DefaultHalfShadowColor DefaultHalfLightColor DefaultTallyMarks

		DefaultTallyLevel DefaultLevel DefaultBorderWidth

		DefaultThumbLevel DefaultInset DefaultThumbFrameColor

		DefaultGhostColor DefaultGhostFrameColor DefaultGhostLevel

		DefaultFixThumbHeight DefaultEdgeStyle DefaultFullViewBackground

		DefaultThumbEnteredColor DefaultThumbActiveLevel SnapBackDistance

	poolDictionaries:''

	category:'Views-Interactors'

!

!Scroller class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 by 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.

"

!

documentation

"

    this class implements the scroller for scrollbars.

    it can also be used by itself for scrollbars without step-buttons.

    When moved, either a predefined action is performed (scrollAction),

    or a model is informed via the changeMsg (which is #value: by default).

    The scroller can work synchronous (i.e. every move leads to an immediate evaluation

    of the action, or asynchronous (i.e. perform action on end-of move).

    By default, scrollers are synchronous. Asynchronous operation makes sense, 

    if the scroll operation (redraw) is expensive and takes a long time.

    This class is used both for concrete instances (vertical scrollers)

    and as an abstract superclass for horizontalScrollers, sliders and

    miniScrollers.

  range:

    the value passed to the model or via the action blocks is scaled according

    to the min/maxRange instance variables.

    These default to 0..100 for percentage values.

    It does not make sense to change the range for scrollbar-scrollers,

    but may be useful with Sliders or in special applications.

  style stuff:

    Beside the obvious 3D rectangle, a scroller may draw a know-form

    (as in NeXT) or little tally marks (as on SGI) in itself.

    These are controlled by the shadowForm, lightForm, tallyLevel and tallyMarks

    instance variables. All of this is initialized from the styleSheet.

  [Instance variables:]

    thumbOrigin                 <Number>        origin of thumb (in percent)

    thumbHeight                 <Number>        height of thumb (in percent)

    thumbColor                  <Color>         color of thumb

    thumbFrameColor             <Color>         color of the frame around the thumb

    scrollAction                <Block>         1 arg block to be evaluated when scrolled

                                                (arg is position in percent)

    orientation                 <Symbol>        #horizontal or #vertical

    thumbFrame                  <Rectangle>     frame of thumb in pixels (cached)

    thumbLevel                  <Number>        level of thumb if 3d

    scrolling                   <Boolean>       true during scroll

    pressOffset                 <Number>        temporary (offset into frame when move started)

    synchronousOperation        <Boolean>       true if synchronous (i.e. dont wait till release

                                                to perform action)

    shadowForm                  <Form>          bitmap of knob if any (shadow part)

    lightForm                   <Form>          bitmap of knob if any (light part)

    inset                       <Integer>       number of pixels to inset thumb from view borders

    thumbShadowColor            <Color>         color do draw dark parts of thumb

    thumblightColor             <Color>         color to draw light parts of thumb

    thumbEdgeStyle              <SymbolOrNil>   #soft or nil

    thumbHalfShadowColor        <Color>         used to draw smooth edges

    thumbHalfLightColor         <Color>         used to draw smooth edges

    thumbFrameSizeDifference    <Integer>       number of pixels the thumb is larger than 

                                                it should be (can be negative for mswin-style)

    tallyLevel                  <Integer>       if not zero, specifies if tally-marks should

                                                go into or out of the display (actually only <0/>0 is checked)

                                                I dont know of a better word for these ...

    tallyMarks                  <Integer>       number of tally marks

    fixThumbHeight              <Boolean>       perform 'wrong' height computation a la mswindows

    rangeStart                  <Number>        the range of the scroller

    rangeEnd                                    (defaults to 0..100)

    rangeStep                                   not currently implemented

  [style settings:]

    scrollerLevel               <Integer>       the level of the scroller w.r.t. its enclosing view

    scrollerBorderWidth         <Integer>       the borderWidth (ignored for 3D styles)

    scrollerViewBackground      <Color>         the viewBackground (color or image)

    scrollerShadowColor         <Color>         the color of 3D shadowed edges (ignored in 2D styles)

    scrollerLightColor          <Color>         the color of 3D lighted edges (ignored in 2D styles)

    scrollerThumbColor          <Color>         the thumbs color (color or image)

    scrollerThumbShadowColor    <Color>         the color of the thumbs shadowed edges (ignored in 2D styles)

    scrollerThumbLightColor     <Color>         the color of the thumbs shadowed edges (ignored in 2D styles)

    scrollerThumbEdgeStyle      <Symbol>        the edge style for the thumb (#soft or nil)

    scrollerThumbLevel          <Integer>       the 3D height of the thumb

    scrollerThumbHalfShadowColor<Color>         the halfShadow for soft edged thumbs

    scrollerThumbHalfLightColor <Color>         the halfLight for soft edged thumbs

    scrollerThumbFrameColor     <Color>         if non-nil, a rectangle is drawn around the thumb is this color

    scrollerThumbInset          <Integer>       inset of thumb from the scrollers boundary

    scrollerThumbFixHeight      <Boolean>       if true, use a fix thumb height (as in mswindows)

    scrollerGhostColor          <Color>         the color in which a ghost-rectangle is drawn

    scrollerGhostFrameColor     <Color>         if non-nil, a rectangle is drawn around the ghost is this color

    scrollerGhostLevel          <Color>         the 3D level of the ghost rectangle

    scrollerNTallyMarks         <Integer>       number of tally-marks to draw on the thumb

    scrollerTallyLevel          <Integer>       the 3D level of any tally marks

    scrollerSnapBack            <Boolean>       win95 behavior: snap back to original position if scrollers view

                                                is left by mouse (with some distance)

    scrollerMiddleButtonJump    <Boolean>       xterm behavior: middle button has shift-click behavior

                                                (positions absolute to click position)

    notice: for mswindows style, we force a WRONG thumb-frame

    computation, to make the thumb have constant size; 

    if you dont like that (I do not :-), 

    set scrollerThumbFixHeight to false (in the StyleSheet).

    [author:]

        Claus Gittinger

    [see also:]

        ScrollBar

        ScrollableView HVScrollableView

"

!

examples

"

    basic scroller setup:

                                                                        [exBegin]

        |top s|

        top := StandardSystemView new extent:200@200.

        s := Scroller in:top.

        s origin:(0.0@0.0) corner:(20@1.0).

        s thumbHeight:10.  'percent'.     

        top open

                                                                        [exEnd]

    setting its thumb-height:

                                                                        [exBegin]

        |top s|

        top := StandardSystemView new extent:200@200.

        s := Scroller in:top.

        s origin:(0.0@0.0) corner:(20@1.0).

        s thumbHeight:50.  'percent'.     

        top open

                                                                        [exEnd]

    setting its thumb-origin:

                                                                        [exBegin]

        |top s|

        top := StandardSystemView new extent:200@200.

        s := Scroller in:top.

        s origin:(0.0@0.0) corner:(20@1.0).

        s thumbHeight:10.  'percent'.     

        s thumbOrigin:30.  'percent'.     

        top open

                                                                        [exEnd]

    a scroller with action block (ST/X style):

                                                                        [exBegin]

        |top s|

        top := StandardSystemView new extent:200@200.

        s := Scroller in:top.

        s origin:(0.0@0.0) corner:(20@1.0).

        s thumbHeight:10.  'percent'.     

        s scrollAction:[:percent | Transcript show:'moved to: '; showCR:percent asFloat].

        top open

                                                                        [exEnd]

    setting its range:

                                                                        [exBegin]

        |top s|

        top := StandardSystemView new extent:200@200.

        s := Scroller in:top.

        s origin:(0.0@0.0) corner:(20@1.0).

        s thumbHeight:10.  'percent'.     

        s scrollAction:[:percent | Transcript show:'moved to: '; showCR:percent asFloat].

        s start:0 stop:1.

        top open

                                                                        [exEnd]

    create a scroller in its default extent and have it positioned

    at the side; beside another view:

                                                                        [exBegin]

        |top s v|

        top := StandardSystemView new extent:200@200.

        s := Scroller in:top.

        s origin:(0.0@0.0) corner:(0.0@1.0).

        s rightInset:(s preferredExtent x negated).

        s thumbHeight:10.

        s level:1.

        v := View in:top.

        v origin:0.0@0.0 corner:1.0@1.0.

        v leftInset:(s preferredExtent x).

        v viewBackground:Color red.

        v level:2.

        top open

                                                                        [exEnd]

    using a model (ST-80 style):

                                                                        [exBegin]

        |top s m|

        m := 0 asValue.

        InspectorView openOn:m monitor:'value'.  'look at value'.

        top := StandardSystemView new extent:200@200.

        s := Scroller in:top.

        s origin:(0.0@0.0) corner:(20@1.0).

        s thumbHeight:10.  'percent'.     

        s model:m.

        top open

                                                                        [exEnd]

    using a different changeSelector:

                                                                        [exBegin]

        |top s1 s2 m|

        m := Plug new.

        m respondTo:#value1: with:[:v | Transcript show:'scroller 1 moved to: '; showCR:v].

        m respondTo:#value2: with:[:v | Transcript show:'scroller 2 moved to: '; showCR:v].

        top := StandardSystemView new extent:200@200.

        s1 := Scroller in:top.

        s1 origin:(0.0@0.0) corner:(20@1.0).

        s1 thumbHeight:10.  'percent'.     

        s1 model:m; change:#value1:.

        s2 := Scroller in:top.

        s2 origin:(30@0.0) corner:(50@1.0).

        s2 thumbHeight:10.  'percent'.     

        s2 model:m; change:#value2:.

        top open

                                                                        [exEnd]

"

! !

!Scroller class methodsFor:'defaults'!

handleLightFormOn:aDisplay

    "answer the form used for the handles light area;

     cache the one for Display for the next round"

    |f|

    ((aDisplay == Display) and:[HandleLightForm notNil]) ifTrue:[

        ^ HandleLightForm

    ].

    f := Image fromFile:'bitmaps/HandleLight.xbm' resolution:100 on:aDisplay.

    f isNil ifTrue:[

        f := Form width:8 height:8 fromArray:#[2r00000000

                                               2r00000010

                                               2r00000011

                                               2r00000011

                                               2r00000011

                                               2r00000011

                                               2r00000110

                                               2r00111100]

                                              on:aDisplay

    ].

    (aDisplay == Display) ifTrue:[

        HandleLightForm := f

    ].

    ^ f

    "Modified: 23.10.2031 / 01:00:00 / cg"

!

handleShadowFormOn:aDisplay

    "answer the form used for the handles shadow area;

     cache the one for Display for the next round"

    |f|

    ((aDisplay == Display) and:[HandleShadowForm notNil]) ifTrue:[

        ^ HandleShadowForm

    ].

    f := Image fromFile:'bitmaps/HandleShadow.xbm' resolution:100 on:aDisplay.

    f isNil ifTrue:[

        f := Form width:8 height:8 fromArray:#[2r00111100

                                               2r01100000

                                               2r11000000

                                               2r11000000

                                               2r11000000

                                               2r11000000

                                               2r01000000

                                               2r00000000]

                                           on:aDisplay

    ].

    (aDisplay == Display) ifTrue:[

        HandleShadowForm := f

    ].

    ^ f

    "Modified: 19.12.1996 / 01:00:00 / cg"

!

updateStyleCache

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

    <resource: #style (#'scroller.viewBackground' #'scroller.fullViewBackground'

                       #'scroller.thumbColor' 

                       #'scroller.shadowColor' #'scroller.lightColor'

                       #'scroller.thumbShadowColor' #'scroller.thumbLightColor'

                       #'scroller.thumbHalfShadowColor' #'scroller.thumbHalfLightColor'

                       #'scroller.thumbFrameColor' #'scroller.ghostColor'

                       #'scroller.ghostLevel' #'scroller.ghostFrameColor'

                       #'scroller.NTallyMarks' #'scroller.tallyLevel'

                       #'scroller.level' #'scroller.borderWidth'

                       #'scroller.thumbLevel' #'scroller.thumbInset'

                       #'scroller.thumbFixHeight' #'scroller.thumbEdgeStyle'

                       #'scroller.thumbEnteredColor' #'scroller.thumbActiveLevel'

                       #'scroller.middleButtonJump' 

                       #'scroller.newCursors')>

    DefaultViewBackground := StyleSheet colorAt:'scroller.viewBackground'.

    DefaultFullViewBackground := StyleSheet colorAt:'scroller.fullViewBackground'.

    DefaultThumbColor := StyleSheet colorAt:'scroller.thumbColor'.

    DefaultThumbEnteredColor := StyleSheet colorAt:'scroller.thumbEnteredColor'.

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

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

    DefaultThumbShadowColor := StyleSheet colorAt:'scroller.thumbShadowColor'.

    DefaultThumbLightColor := StyleSheet colorAt:'scroller.thumbLightColor'.

    DefaultThumbHalfShadowColor := StyleSheet colorAt:'scroller.thumbHalfShadowColor'.

    DefaultThumbHalfLightColor := StyleSheet colorAt:'scroller.thumbHalfLightColor'.

    DefaultThumbFrameColor := StyleSheet colorAt:'scroller.thumbFrameColor'.

    DefaultGhostColor := StyleSheet colorAt:'scroller.ghostColor' default:nil.

    DefaultGhostFrameColor := StyleSheet colorAt:'scroller.ghostFrameColor' default:nil.

    DefaultGhostLevel := StyleSheet at:'scroller.ghostLevel' default:0.

    DefaultTallyMarks := StyleSheet at:'scroller.NTallyMarks' default:0.

    DefaultTallyLevel := 0.

    DefaultTallyMarks ~~ 0 ifTrue:[

        DefaultTallyLevel := StyleSheet at:'scroller.tallyLevel' default:1.

    ].

    DefaultLevel := StyleSheet at:'scroller.level' default:0.

    DefaultBorderWidth := StyleSheet at:'scroller.borderWidth' default:(StyleSheet at:'borderWidth').

    DefaultThumbLevel := StyleSheet at:'scroller.thumbLevel' default:0.

    DefaultThumbActiveLevel := StyleSheet at:'scroller.thumbActiveLevel' default:DefaultThumbLevel.

    DefaultInset := StyleSheet at:'scroller.thumbInset' default:0.

    DefaultFixThumbHeight := StyleSheet at:'scroller.thumbFixHeight' default:false.

    DefaultEdgeStyle := StyleSheet at:'scroller.thumbEdgeStyle'.

    DefaultMiddleButtonJump := StyleSheet at:'scroller.middleButtonJump' default:false.

    NewCursors := StyleSheet at:'scroller.newCursors' default:true.

    StyleSheet fileReadFailed ifTrue:[

        DefaultViewBackground := Grey.

        DefaultThumbColor := White.

        DefaultThumbFrameColor := Black.

        DefaultInset := 1.

    ].

    SnapBackDistance := 30.

    "

     self updateStyleCache

    "

! !

!Scroller methodsFor:'accessing'!

start 

    "return the scrollers range min.

     (not used with Scrollers, but provided for subclasses)"

    ^ rangeStart

!

start:start

    "set the scrollers range min.

     (not used with Scrollers, but provided for subclasses)"

    self start:start stop:rangeEnd.

    "Modified: 25.5.1996 / 11:28:22 / cg"

!

start:start stop:stop

    "set the range.

     (not used with Scrollers, but provided for subclasses)"

    |org|

    org := self thumbOrigin.

    rangeStart := start.

    rangeEnd := stop.

    rangeStart = rangeEnd ifTrue:[

        self halt:'invalud slider range (start = stop)'.

        rangeStep isNil ifTrue:[

            rangeEnd := rangeStart + 1

        ] ifFalse:[

            rangeEnd := rangeStart + rangeStep.

        ]

    ].

    org < rangeStart ifTrue:[

        org := rangeStart

    ] ifFalse:[

        org > rangeEnd ifTrue:[

            org := rangeEnd

        ]

    ].

    self thumbOrigin:org.

    "Modified: / 21.1.1998 / 19:22:07 / cg"

!

start:start stop:stop step:step

    "set the range.

     (not used with Scrollers, but provided for subclasses)"

    self start:start stop:stop.

    rangeStep := step.

    "Created: 25.5.1996 / 11:24:09 / cg"

    "Modified: 25.5.1996 / 11:27:43 / cg"

!

step

    "return the scrollers range step.

     (not used with Scrollers, but provided for subclasses)"

    ^ rangeStep

!

step:step

    "set the scrollers range step.

     (not used with Scrollers, but provided for subclasses)"

    rangeStep := step

!

stop

    "return the scrollers range max.

     (not used with Scrollers, but provided for subclasses)"

    ^ rangeEnd

!