Smalltalk/X Webserver

Documentation of class 'VariablePanel':

Class: VariablePanel

Inheritance
Description
Related information
Class protocol
- defaults
- image specs
Instance protocol
Private classes
Examples

Inheritance:

   Object
   |
   +--GraphicsMedium
      |
      +--DisplaySurface
         |
         +--SimpleView
            |
            +--VariablePanel
               |
               +--FileBrowserV2PanelView
               |
               +--VariableHorizontalPanel
               |
               +--VariableVerticalPanel

Package:: stx:libwidg

Category:: Views-Layout

Version:: rev: 1.130 date: 2019/07/15 18:00:30; user: cg; file: VariablePanel.st directory: libwidg; module: stx stc-classLibrary: libwidg

Author:: Claus Gittinger

Description:

a View to separate its subviews vertically by a movable bar;
the size-ratios of the subviews can be changed by moving this bar.

In order to correctly setup this kind of view, the subviews must
be created with a relative origin & relative corner.
The panel does not verify the relative subview bounds; 
therefore, it is your responsibility to set those relative sizes to fit
according the orientation (see bad example below).

The bar-handle is either an exposed knob (style == #motif)
or the form defined in Scroller (style ~~ #motif)
or nothing.

Typically creation is done as:

    p := VariablePanel in:superView.
    p orientation:#vertical.

    v1 := <someViewClass> origin:0.0 @ 0.0
                          corner:1.0 @ 0.5
                              in:p.
    v2 := <someViewClass> origin:0.0 @ 0.5 
                          corner:1.0 @ 0.8 
                              in:p.
    v3 := <someViewClass> origin:0.0 @ 0.8 
                          corner:1.0 @ 1.0
                              in:p.

The two subclasses VariableHorizontalPanel and VariableVerticalPanel
preset the orientation. They are a kept for backward compatibility
(in previous versions, there used to be no common VariablePanel (super-) class).

Notice: if it is required to insert a fixed-size view in the panel,
use an extra view & insets, and place the subview into that extra view.
See examples.

[instance Variables:]

    barHeight               <Integer>       the height of the bar (for verticalPanels)
    barWidth                <Integer>       the width of the bar  (for horizontalPanels)

    separatingLine          <Boolean>       show a separating line (as in motif style)

    shadowForm              <Image/Form>    form (shadow part) drawn as handle - if nonNil

    lightForm               <Image/Form>    form (light part) drawn as handle - if nonNil

    showHandle              <Boolean>       if false, no handle is drawn

    handlePosition          <Symbol>        where is the handle - one of #left, #center, #right

    handleColor             <Color>         inside color of handle - defaults to viewBackground

    handleStyle             <Symbol>        type of handle; one of #next, #motif or nil

    handleLevel             <Integer>       3D level of handle (only valid if no form is given)

    trackLine               <Boolean>       if true, an inverted line is drawn for tracking;
                                            otherwise, the whole bar is inverted.

    redrawLocked                            internal - locks redraws while tracking

    orientation             <Symbol>        one of #horizontal / #vertical


[styleSheet values:]
    variablePanel.showHandle        true/false - should a handle be shown (default:true)

    variablePanel.handleStyle       #next / #motif / #iris / #full / nil (special handles)

    variablePanel.handlePosition    #left / #center / #right (default:#right)

    variablePanel.handleLevel       3D level of heandle (default:2)

    variablePanel.trackingLine      when moved, track an inverted line (as in motif)
                                    as opposed to tracking the whole bar (default:false)
                                    (obsoleted by trackingStyle)

    variablePanel.trackingStyle     #solidRectangle / #solidLine / #dashedLine
                                    detailed control over how to draw tracking
                                    (obsoletes trackingLine above)

    variablePanel.separatingLine    draw a separating line in the bar as in motif (default:false)

    variablePanel.handleColor       color of the handle. (default:Black)

    variablePanel.handleEnteredColor 
                                    color of the handle when the pointer is in the bar (default:nil)

Related information:

    PanelView

Class protocol:

defaults

cursorForOrientation: orientation

return an appropriate cursor

cursorForOrientation: orientation onDevice: device

return an appropriate cursor

lightFormOn: aDisplay

use same handle as Scroller

shadowFormOn: aDisplay

use same handle as Scroller

snapIcons

return a dictionary of snapIcons

usage example(s):

        DefaultSnapIcons := nil.
        self snapIcons

updateStyleCache

extract values from the styleSheet and cache them in class variables

usage example(s):

     VariablePanel updateStyleCache

image specs

horizontalResizeCursor