"

 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 thumbFrameSizeDifference tallyLevel

                tallyMarks fixThumbHeight frameBeforeMove ghostColor

                ghostFrameColor ghostLevel rangeStart rangeEnd rangeStep'

	 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'

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

    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.

    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.

  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

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

"

!

examples

"

    basic scroller setup:

	|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

    setting its thumb-height:

	|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

    setting its thumb-origin:

	|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

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

	|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

    create a scroller in its default extent and have it positioned

    at the right; beside another view:

	|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

    using a model (ST-80 style):

	|top s m|

	m := 0 asValue.

	m inspect. '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

    using a different changeSelector:

	|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

"

! !

!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 := Form fromFile:'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

!

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 := Form fromFile:'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

!

updateStyleCache

    DefaultViewBackground := StyleSheet colorAt:'scrollerViewBackground'.

    DefaultFullViewBackground := StyleSheet colorAt:'scrollerFullViewBackground'.

    DefaultThumbColor := StyleSheet colorAt:'scrollerThumbColor'.

    DefaultShadowColor := StyleSheet colorAt:'scrollerShadowColor'.

    DefaultLightColor := StyleSheet colorAt:'scrollerLightColor'.

    DefaultThumbShadowColor := StyleSheet colorAt:'scrollerThumbShadowColor'.

    DefaultThumbLightColor := StyleSheet colorAt:'scrollerThumbLightColor'.

    DefaultThumbHalfShadowColor := StyleSheet colorAt:'scrollerThumbHalfShadowColor'.

    DefaultThumbHalfLightColor := StyleSheet colorAt:'scrollerThumbHalfLightColor'.

    DefaultThumbFrameColor := StyleSheet colorAt:'scrollerThumbFrameColor'.

    DefaultGhostColor := StyleSheet colorAt:'scrollerGhostColor' default:nil.

    DefaultGhostFrameColor := StyleSheet colorAt:'scrollerGhostFrameColor' default:nil.

    DefaultGhostLevel := StyleSheet at:'scrollerGhostLevel' default:0.

    DefaultTallyMarks := StyleSheet at:'scrollerNTallyMarks' default:0.

    DefaultTallyLevel := 0.

    DefaultTallyMarks ~~ 0 ifTrue:[

	DefaultTallyLevel := StyleSheet at:'scrollerTallyLevel' default:1.

    ].

    DefaultLevel := StyleSheet at:'scrollerLevel' default:0.

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

    DefaultThumbLevel := StyleSheet at:'scrollerThumbLevel' default:0.

    DefaultInset := StyleSheet at:'scrollerThumbInset' default:0.

    DefaultFixThumbHeight := StyleSheet at:'scrollerThumbFixHeight' default:false.

    DefaultEdgeStyle := StyleSheet at:'scrollerThumbEdgeStyle'.

    StyleSheet fileReadFailed ifTrue:[

	DefaultViewBackground := Grey.

	DefaultThumbColor := White.

	DefaultThumbFrameColor := Black.

	DefaultInset := 1.

    ]

! !

!Scroller methodsFor:'accessing'!

action:aBlock

    "for protocol compatibility; same as scrollAction:"

    self scrollAction:aBlock

!

asynchronousOperation

    "set scroll-mode to be asynchronous - scroll action is performed after

     scrolling, when mouse-button is finally released"

    synchronousOperation := false

!

is3D

    styleSheet name = #mswindows ifTrue:[^ true].

    ^ super is3D

!

orientation 

    "return the scrollers orientation (#vertical or #horizontal)"

    ^ orientation

!

scrollAction

    "answer the scroll action block"

    ^ scrollAction

!

scrollAction:aBlock

    "set the scroll action, aBlock which is evaluated when scrolled"

    scrollAction := aBlock

!

scrollDownAction:aBlock

    "ignored -

     but implemented, so that scroller can be used in place of a scrollbar"

!

scrollUpAction:aBlock

    "ignored -

     but implemented, so that scroller can be used in place of a scrollbar"

!

setThumbFor:aView

    "get contents and size info from aView and adjust thumb"

    |percentSize percentOrigin contentsSize contentsPosition viewsSize|

    "

     get the content's size

    "

    aView isNil ifTrue:[

	contentsSize := 0

    ] ifFalse:[

	orientation == #vertical ifTrue:[

	    contentsSize := aView heightOfContents.

	    aView transformation notNil ifTrue:[

		contentsSize := aView transformation applyScaleY:contentsSize.

	    ].

	] ifFalse:[

	    contentsSize := aView widthOfContents.

	    aView transformation notNil ifTrue:[

		contentsSize := aView transformation applyScaleX:contentsSize.

	    ].

	]

    ].

    (contentsSize = 0) ifTrue:[

	percentSize := 100.

	percentOrigin := 100

    ] ifFalse:[

	(orientation == #vertical) ifTrue:[

	    viewsSize := aView innerHeight.

	    contentsPosition := aView yOriginOfContents.

	] ifFalse:[

	    viewsSize := aView innerWidth.

	    contentsPosition := aView xOriginOfContents

	].

	percentSize := viewsSize * 100.0 / contentsSize.

	percentOrigin := contentsPosition * 100.0 / contentsSize.

	percentOrigin + percentSize > 100.0 ifTrue:[

	    "actually showing stuff below contents of view"

"

	    contentsSize := contentsPosition + aView innerHeight.

	    percentSize := viewsSize * 100.0 / contentsSize.

	    percentOrigin := contentsPosition * 100.0 / contentsSize

"

	]

    ].

    (percentSize = thumbHeight) ifTrue:[

	self thumbOrigin:percentOrigin

    ] ifFalse:[

	(percentOrigin = thumbOrigin) ifTrue:[

	    self thumbHeight:percentSize

	] ifFalse:[

	    self thumbOrigin:percentOrigin thumbHeight:percentSize

	]

    ]

!

setThumbHeightFor:aView

    "get contents and size info from aView and adjust thumb height"

    |percent total viewsSize|

    (orientation == #vertical) ifTrue:[

	total := aView heightOfContents.

	aView transformation notNil ifTrue:[

	    total := aView transformation applyScaleY:total.

	].

    ] ifFalse:[

	total := aView widthOfContents.

	aView transformation notNil ifTrue:[

	    total := aView transformation applyScaleX:total.

	].

    ].

    (total = 0) ifTrue:[

	percent := 100

    ] ifFalse:[

	viewsSize := (orientation == #vertical) ifTrue:[aView innerHeight]

					   ifFalse:[aView innerWidth].

	percent := viewsSize * 100.0 / total

    ].

    self thumbHeight:percent

!

setThumbOriginFor:aView

    "get contents and size info from aView and adjust thumb origin"

    |percent total contentsPosition|

    (orientation == #vertical) ifTrue:[

	total := aView heightOfContents.

	aView transformation notNil ifTrue:[

	    total := aView transformation applyScaleY:total.

	].

    ] ifFalse:[

	total := aView widthOfContents.

	aView transformation notNil ifTrue:[

	    total := aView transformation applyScaleX:total.

	].

    ].

    (total = 0) ifTrue:[

	percent := 100

    ] ifFalse:[

	contentsPosition := (orientation == #vertical) ifTrue:[aView yOriginOfContents]

						  ifFalse:[aView xOriginOfContents].

	percent := contentsPosition * 100.0 / total

    ].

    self thumbOrigin:percent

!

start 

    "return the scrollers range min"

    ^ rangeStart

!