Class: ScrollBar

• Inheritance
• Description
• Class protocol
  • style changes
• Instance protocol
  • accessing
  • accessing-behavior
  • accessing-components
  • accessing-look
  • change & update
  • events
  • focus handling
  • forced scroll
  • initialization
  • native widget support
  • private
  • private-scrollview interface
  • queries

Inheritance:

   Object
   |
   +--GraphicsMedium
      |
      +--DisplaySurface
         |
         +--SimpleView
            |
            +--ScrollBar
               |
               +--HorizontalScrollBar
               |
               +--SteppingSlider

Package:

stx:libwidg

Category:

Views-Interactors

Version:

rev: 1.104 date: 2021/08/28 07:10:25

user: cg

file: ScrollBar.st directory: libwidg

module: stx stc-classLibrary: libwidg

Description:

this class implements vertical scrollbars with scroller and
2 step-scroll buttons. when moved or stepped, it performs a
predefined action.

The action is specified by:                 the block to be evaluated for step-up
    aScrollBar scrollUpAction:aBlock
    (scrollLeftAction for hor-Scrollbars)

    aScrollBar scrollDownAction:aBlock      the block to be evaluated for step-down
    (scrollRightAction for hor-Scrollbars)

    aScrollbar scrollAction:aBlock          the block to be evaluated for scroll
                                            passing percentage as argument.

Scrollbars can scroll synchronous (i.e. every movement is notified immediately via the
scrollAction) or asynchronous (i.e. only one notification takes place at the end of the movement).
The choice is up to the user of the scrollbar (typically, views which are complicated to redraw,
will set it to asynchronous.)

Most often scrollbars are used hidden with ScrollableView or HVScrollableView (i.e. you
don't have to care for all the details).

The scrollBars and scrollers protocols have been made similar enough to
allow transparent use of either a scroller or a scrollBar in applications.

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.

Class protocol:

 updateStyleCache

extract values from the styleSheet and cache them in class variables

Instance protocol:

 thumbHeight

return height of thumb in percent

 thumbHeight: newHeight

set height of thumb in percent

 thumbOrigin

return position of (top of) thumb in percent

 thumbOrigin: newOrigin

set position of (top of) thumb in percent

 thumbOrigin: newOrigin thumbHeight: newHeight

set origin and height of thumb (both in percent)

 asynchronousOperation

** This is an obsolete interface - do not use it (it may vanish in future versions) **

 beAsynchronous

set asynchronous-mode - scroll action is performed after movement
of scroller when mouse-button is finally released (no tracking).
This is forwarded to the scroller here.

 beSynchronous

set synchronous-mode - scroll action is performed for every movement
of scroller (tracking).
This is forwarded to the scroller here.

 isSynchronous

return true if the scroll-mode is synchronous.
If true, the scroll action is performed for every movement of the thumb (tracking).
If false, the scroll action is only performed at the end.

 scrollAction: aBlock

set the action, aBlock to be performed when the scroller is moved.
The block will be called with positionInPercent as argument.
This is forwarded to the scroller here.

 scrollDownAction

return the action which is performed on scroll-down.
(vertical scrollBars)

 scrollDownAction: aBlock

set the action, aBlock to be performed when the down-button is pressed.
(for vertical scrollBars)

 scrollLeftAction

return the action which is performed on scroll-left
(for horizontal scrollBars)

 scrollLeftAction: aBlock

set the action to be performed on scroll-left.
(for horizontal scrollBars)

 scrollRightAction

return the action which is performed on scroll-right.
(for horizontal scrollBars)

 scrollRightAction: aBlock

set the action to be performed on scroll-right.
(for horizontal scrollBars)

 scrollUpAction

return the action which is performed on scroll-up.
(for vertical scrollBars)

 scrollUpAction: aBlock

set the action, aBlock to be performed when the up-button is pressed.
(for vertical scrollBars)

 synchronousOperation

** This is an obsolete interface - do not use it (it may vanish in future versions) **

 downButton

return the down-button
(Please: only use this direct access for special applications)

Usage example(s):

|v| v := ScrollableView for:EditTextView. v scrolledView contents:('/etc/passwd' asFilename contentsOfEntireFile). v scrollBar upButton activeForegroundColor:Color red. v scrollBar downButton activeForegroundColor:Color red. v open

 thumb

return the thumb (i.e. the scroller subview)
(Please: only use this direct access for special applications)

Usage example(s):

|v| v := ScrollableView for:EditTextView. v scrolledView contents:('/etc/passwd' asFilename contentsOfEntireFile). v scrollBar thumb thumbColor:(Color red). v open

 upButton

return the up-button
(Please: only use this direct access for special applications)

Usage example(s):

|v| v := ScrollableView for:EditTextView. v scrolledView contents:('/etc/passwd' asFilename contentsOfEntireFile). v scrollBar upButton foregroundColor:(Color red). v scrollBar upButton enteredForegroundColor:(Color red lightened). v scrollBar downButton foregroundColor:(Color green). v scrollBar downButton enteredForegroundColor:(Color green lightened). v open

 allViewBackground: something if: condition

blocked for all scrollBars (I want my own background)

Usage example(s):

^ super allViewBackground:something

 orientation

for ST-80 compatibility, answer this query

 orientation: aSymbol

set the orientation; either #horizontal or #vertical

 thumbColor: aColor

set the thumbs color

 upButtonLabel: label1 downButtonLabel: label2

set the labels shown in the buttons.
Because of the fixed button sizes, this only makes sense with
single-character strings or small bitmaps.

Usage example(s):

also possible : |v| v := ScrollableView for:EditTextView. v scrolledView contents:('/etc/passwd' asFilename contentsOfEntireFile). v scrollBar upButtonLabel:'u' downButtonLabel:'d'. v open

 update: something with: aParameter from: changedObject

(comment from inherited method)
an update request

 keyPress: key x: x y: y

(comment from inherited method)
a key has been pressed. If there are components,
pass it to the corresponding one.
Otherwise, forward it to the superview, if there is any.

 sizeChanged: how from: oldExtentOrNil

when my size changes, I have to resize/reposition the subviews.
Also, if I became too small, hide thumb/buttons.