"

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

"

SimpleView subclass:#FramedBox

	instanceVariableNames:'label labelPosition fgColor showFrame frame3D horizontalSpace

		verticalSpace innerHorizontalSpace innerVerticalSpace'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Layout'

!

!FramedBox class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1991 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

"

    a frame around something. The frame may have a label, whose position

    is controlled by the labelPosition variable, a symbol which may be one of:

    [#topCenter #topLeft #topRight #bottomLeft #bottomCenter #bottomRight]

    The default labelPosition is controlled by the styleSheet variable:

    'framedBoxLabelPosition' (usually, #topCenter).

    Its also possible, to not show the frame but only the label, by setting

    showFrame to false.

    The distance from the outer viewBorder to the frame is controlled by

    horizontalSpace / verticalSpace. The default is the fonts height.

    The distance from the frame to the interior area is controlled by

    innerHorizontalSpace / innerVerticalSpace. The default is 0.

    [author:]

        Claus Gittinger

    [see also:]

        PanelView Separator

"

!

examples 

"

    simple:

                                                                        [exBegin]

        |top frame1 frame2 frame3|

        top := StandardSystemView new.

        top extent:300@200.

        frame1 := FramedBox origin:0.0@0.0 corner:0.5@0.5 in:top.

        frame1 label:'frame1'.

        frame2 := FramedBox origin:0.5@0.0 corner:1.0@0.5 in:top.

        frame2 label:'frame2'.

        frame3 := FramedBox origin:0.0@0.5 corner:1.0@1.0 in:top.

        frame3 label:'frame3'.

        top open

                                                                        [exEnd]

    placing something inside:

                                                                        [exBegin]

        |top frame1 frame2 frame3 v1 v2 v3|

        top := StandardSystemView new.

        top extent:300@200.

        frame1 := FramedBox origin:0.0@0.0 corner:0.5@0.5 in:top.

        frame1 label:'frame1'.

        v1 := View origin:0.0@0.0 corner:1.0@1.0 in:frame1.

        v1 viewBackground:(Color yellow);

           level:1.

        frame2 := FramedBox origin:0.5@0.0 corner:1.0@0.5 in:top.

        frame2 label:'frame2'.

        v2 := View origin:0.0@0.0 corner:1.0@1.0 in:frame2.

        v2 viewBackground:(Color red);

           level:1.

        frame3 := FramedBox origin:0.0@0.5 corner:1.0@1.0 in:top.

        frame3 label:'frame3'.

        v3 := View origin:0.0@0.0 corner:1.0@1.0 in:frame3.

        v3 viewBackground:(Color green);

           level:1.

        top open

                                                                        [exEnd]

    placing something inside a frame in a dialog:

                                                                        [exBegin]

        |box panel frame1 frame2 frame3 v1 v1b v2 v3|

        box := Dialog new.

        frame1 := FramedBox label:'frame1'.

        panel := HorizontalPanelView origin:0.0@0.0 corner:1.0@1.0 in:frame1.

        v1 := View extent:100@100 in:panel.

        v1 viewBackground:(Color red);

           level:1.

        v1b := View extent:100@100 in:panel.

        v1b viewBackground:(Color yellow);

            level:1.

        box addComponent:frame1.

        frame2 := FramedBox label:'frame2'.

        v2 := View origin:0.0@0.0 corner:1.0@1.0 in:frame2.

        v2 viewBackground:(Color green);

           level:1.

        box addComponent:frame2.

        frame3 := FramedBox label:'frame3'.

        v3 := View origin:0.0@0.0 corner:1.0@1.0 in:frame3.

        v3 viewBackground:(Color blue);

           level:1.

        box addComponent:frame3.

        box addOkButton.

        box stickAtBottomWithVariableHeight:frame3.

        box open

                                                                        [exEnd]

    placing something inside a frame in a dialog:

                                                                        [exBegin]

        |box panel frame1 frame2 frame3 v1 v1b v2 v3|

        box := Dialog new.

        frame1 := FramedBox label:'frame1'.

        panel := VerticalPanelView origin:0.0@0.0 corner:1.0@1.0 in:frame1.

        v1 := View extent:100@100 in:panel.

        v1 viewBackground:(Color red);

           level:1.

        v1b := View extent:100@100 in:panel.

        v1b viewBackground:(Color yellow);

            level:1.

        box addComponent:frame1.

        frame2 := FramedBox label:'frame2'.

        v2 := View origin:0.0@0.0 corner:1.0@1.0 in:frame2.

        v2 viewBackground:(Color green);

           level:1.

        box addComponent:frame2.

        frame3 := FramedBox label:'frame3'.

        v3 := View origin:0.0@0.0 corner:1.0@1.0 in:frame3.

        v3 viewBackground:(Color blue);

           level:1.

        box addComponent:frame3.

        box addOkButton.

        box stickAtBottomWithVariableHeight:frame3.

        box open

                                                                        [exEnd]

    simple again, default spacings:

                                                                        [exBegin]

        |top frame v|

        top := StandardSystemView new.

        top extent:300@200.

        frame := FramedBox origin:0.0@0.0 corner:0.5@0.5 in:top.

        frame label:'frame'.

        v := View origin:0.0@0.0 corner:1.0@1.0 in:frame.

        v viewBackground:(Color yellow); level:1.

        top open

                                                                        [exEnd]

    changing spacings:

                                                                        [exBegin]

        |top frame v|

        top := StandardSystemView new.

        top extent:300@200.

        frame := FramedBox origin:0.0@0.0 corner:0.5@0.5 in:top.

        frame label:'frame'.

        frame horizontalSpace:30.

        frame verticalSpace:20.

        v := View origin:0.0@0.0 corner:1.0@1.0 in:frame.

        v viewBackground:(Color yellow); level:1.

        top open

                                                                        [exEnd]

    changing inner spacings:

                                                                        [exBegin]

        |top frame v|

        top := StandardSystemView new.

        top extent:300@200.

        frame := FramedBox origin:0.0@0.0 corner:0.5@0.5 in:top.

        frame label:'frame'.

        frame innerHorizontalSpace:30.

        frame innerVerticalSpace:20.

        v := View origin:0.0@0.0 corner:1.0@1.0 in:frame.

        v viewBackground:(Color yellow); level:1.

        top open

                                                                        [exEnd]

     label only (no frame around):

                                                                        [exBegin]

        |top frame v|

        top := StandardSystemView new.

        top extent:300@200.

        frame := FramedBox origin:0.0@0.0 corner:0.5@0.5 in:top.

        frame label:'frame'.

        frame showFrame:false.

        v := View origin:0.0@0.0 corner:1.0@1.0 in:frame.

        v viewBackground:(Color yellow); level:1.

        top open

                                                                        [exEnd]

"

! !

!FramedBox methodsFor:'accessing'!

font:aFont

    "set the frame labelstrings font.

     CAVEAT: with the addition of Text objects,

             this method is going to be obsoleted by a textStyle

             method, which allows specific control over

             normalFont/boldFont/italicFont parameters."

    (font ~= aFont) ifTrue:[

        super font:aFont.

        self invalidate

    ]

    "Modified: 29.5.1996 / 16:17:50 / cg"

!

foregroundColor

    "return the frame labels foreground color"

    ^ fgColor

!

foregroundColor:aColor

    "set the frame labels foreground color"

    aColor ~= fgColor ifTrue:[

        fgColor := aColor.

        self invalidate

    ]

    "Modified: 29.5.1996 / 16:17:54 / cg"

!

frameShown

    "return true, if frame is shown;

     if false, oly the label is shown.

     OBSOLETE; use #showFrame."

    ^ showFrame

!

horizontalSpace

    "return the number of pixels by which the frame is inset horizontally.

     The default, nil, lets the box compute the horizontal inset from the

     labels font height."

    ^ horizontalSpace

    "Modified: 5.9.1995 / 17:24:21 / claus"

!

horizontalSpace:aNumber 

    "set the number of pixels by which the frame is inset horizontally.

     The default, nil, lets the box compute the horizontal inset from the

     labels font height."

    horizontalSpace := aNumber

!

innerHorizontalSpace:aNumber 

    "set the number of pixels by which the interior is inset horizontally from the frame.

     The default is 0"

    innerHorizontalSpace := aNumber

    "Created: 10.1.1996 / 14:39:20 / cg"

!

innerVerticalSpace:aNumber 

    "set the number of pixels by which the interior is inset vertically from the frame.

     The default is 0"

    innerVerticalSpace := aNumber

    "Created: 10.1.1996 / 14:39:35 / cg"

!

label

    "return the frames labelstring"

    ^ label

!

label:aString

    "set the frames labelstring"

    (label ~= aString) ifTrue:[

        aString isEmpty ifTrue:[

            label := nil

        ] ifFalse:[

            label := aString.

        ].

        self invalidate

    ]

    "Modified: 5.9.1995 / 17:20:05 / claus"

    "Modified: 29.5.1996 / 16:17:56 / cg"

!

labelPosition

    "return the labelPosition, which is a symbol describing

     the labels position."

    ^ labelPosition

!

labelPosition:aSymbol

    "define the position of the label;

     aSymbol may be one of: 

        #topLeft, #topCenter, #topRight;

        #bottomLeft, #bottomCenter or #bottomRight"

    labelPosition ~~ aSymbol ifTrue:[

        labelPosition := aSymbol.

        self invalidate

    ]

    "Modified: 29.5.1996 / 16:17:58 / cg"

!

layout

    "OBSOLETE compatibility interface. Will vanish"

    self obsoleteMethodWarning:'use #labelPosition'.

    ^ labelPosition

!

layout:something

    "OBSOLETE compatibility interface. Will vanish.

     In the meantime, try to figure out what is meant ... a kludge"

    something isLayout ifTrue:[^ super layout:something].

    self obsoleteMethodWarning:'use #labelPosition:'.

    ^ self labelPosition:something

    "Modified: 31.8.1995 / 23:07:00 / claus"

!

showFrame

    "return if the view shows its frame.

     If false, only the label is drawn"

    ^ showFrame

    "Modified: 5.9.1995 / 17:21:37 / claus"

!

showFrame:aBoolean

    "turn on/off showing of the frame -

     without a frame, only the label is shown at its position"

    aBoolean ~~ showFrame ifTrue:[

        showFrame := aBoolean.

        self invalidate

    ]

    "Modified: 29.5.1996 / 16:17:59 / cg"

!

verticalSpace

    "return the number of pixels by which the frame is inset vertically.

     The default, nil, lets the box compute the vertical inset from the

     labels font height."

    ^ verticalSpace

    "Modified: 5.9.1995 / 17:24:21 / claus"

    "Created: 10.1.1996 / 14:38:21 / cg"

!

verticalSpace:aNumber 

    "set the number of pixels by which the frame is inset vertically.

     The default, nil, lets the box compute the vertical inset from the

     labels font height."

    verticalSpace := aNumber

    "Created: 10.1.1996 / 14:38:31 / cg"

! !

!FramedBox methodsFor:'drawing'!

drawFrame

    "redraw the frame"

    |halfSepX halfSepY w h|

    "

     if there is no label, give more real estate to the inside

    "

    label isNil ifTrue:[

        halfSepX := halfSepY := 2

    ] ifFalse:[

        halfSepX := halfSepY := (font heightOn:device) // 2.

    ].

    horizontalSpace notNil ifTrue:[

        halfSepX := horizontalSpace.

    ].

    verticalSpace notNil ifTrue:[

        halfSepY := verticalSpace.

    ].

    w := width - halfSepX - halfSepX.

    h := height - halfSepY - halfSepY.

    frame3D ifFalse:[

        self displayRectangleX:halfSepX 

                             y:halfSepY

                         width:w 

                        height:h.

        ^ self

    ].

    w := w + 1.

    h := h + 1.

    self paint:lightColor.

    self displayRectangleX:halfSepX 

                         y:halfSepY

                     width:w

                    height:h.

    self paint:shadowColor.

    self displayRectangleX:halfSepX-1 

                         y:halfSepY-1

                     width:w 

                    height:h.