"

 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.

"

"{ Package: 'stx:libwidg' }"

"{ NameSpace: Smalltalk }"

PanelView subclass:#HorizontalPanelView

	instanceVariableNames:'reverseOrderIfOKAtLeft'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Layout'

!

!HorizontalPanelView 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

"

    a View which arranges its child-views in a horizontal row.

    All real work is done in PanelView - only the layout computation is

    redefined here.

    The layout is controlled the instance variables: 

	horizontalLayout and verticalLayout

    in addition to 

	horizontalSpace and verticalSpace.

    HorizontalSpace and verticalSpace control the spacing between elements;

    they default to some 1mm.

    The horizontal layout can be any of:

	#left           arrange elements at left

	#leftSpace      arrange elements at the left, start with spacing

	#fixLeft        same as #left, but do not reduce spacing in case of no fit

	#fixLeftSpace   same as #leftSpace, but do not reduce spacing in case of no fit

	#right          arrange elements at the right

	#rightSpace     arrange elements at the right, start with spacing

	#center         arrange elements in the center

	#spread         spread elements evenly

	#spreadSpace    spread elements evenly with spacing at the ends

	#fit            like #spread, but resize elements for tight packing

	#fitSpace       like #fit, with additional spacing at the far ends

	#leftFit        like #left, but extend the last (rightMost) element to the right

	#leftSpaceFit   like #leftSpace, but extend the last (rightMost) element to the right

	#rightFit       like #right, but extend the first (leftMost) element to the left

	#rightSpaceFit  like #rightSpace, but extend the first (leftMost) element to the left

	#leftMax        like corresponding non-Max layouts,

	#leftSpaceMax   but resize all components to width of widest components

	#rightMax

	#rightSpaceMax

	#centerMax

	#spreadMax

	#spreadSpaceMax

    the vertical layout can be:

	#top            place element at the top

	#topSpace       place element at the top, offset by verticalSpace

	#center         place it horizontally centered

	#bottom         place it at the bottom

	#bottomSpace    place it at the bottom, offset by verticalSpace

	#fit            resize elements vertically to fit this panel

	#fitSpace       like #fit, but with spacing

	#topMax         like #top, but resize all views vertically to max height

	#topSpaceMax    like #topSpace, but resize all views vertically to max height

	#bottomMax      like #bottom, but resize all views vertically to max height

	#bottomSpaceMax like #bottomSpace, but resize all views vertically to max height

	#centerMax      like #center, but resize all views vertically to max height

    The defaults is #center for both directions.

    The layout is changed by the messages #verticalLayout: and #horizontalLayout:.

    For backward compatibility (to times, where only hLayout existed), the simple

    #layout: does the same as #horizontalLayout:. 

    Do not use this old method; it will vanish and currently outputs a warning.

    The panel assumes, that the elements do not resize themselfes, after it

    became visible. This is not true for all widgets (buttons, labels or

    inputFields may like to change). 

    If you have changing elements, tell this to the panel

    with 'aPanel elementsChangeSize:true'. In that case, the panel will react

    to size changes of its elements, and reorganize things.

    By combining Horizontal- and VerticalPanels (i.e. place a hPanel into a

    vPanel), most layouts should be implementable.

    However, iff none of these layout/space combinations is exactly what you need 

    in your application, create a subclass, and redefine the setChildPositions 

    method there.

    TODO: for completeness, support #fixRight, #fixRightSpace,

	  #rightFit, #rightSpaceFit layouts

    CAVEAT: this class started with #left and no vertical alignments;

    as time went by, more layouts were added (by users requests)

    and now, many layout combinations are possible.

    Reflecting this, the setup should be changed to use different selectors 

    for space-on/off, max-resize and alignment

    (i.e. having more and more layout symbols makes things a bit confusing ...)

    [see also:]

	VerticalPanelView

	VariableVerticalPanel VariableHorizontalPanel

	Label

    [author:]

	Claus Gittinger

    [author:]

	Claus Gittinger

"

!

examples

"

    These examples show the effect of various horizontalLayout and

    verticalLayout settings. Try them all. Especially, notice the

    differences between the xxx and xxxSpace layouts and the effect of

    setting different values for the spacing.

    Try resizing the view and see how the elements get rearranged.

    Most of the examples below place 3 buttons onto a panel; 

    Of course, you can put any other view into a panel ... the last examples show this.

    (The fit layouts are especially useful to be used with SelectionInListViews;

     you can combine multiple labels & editFields with a selectionInListView, which

     is expanded to fill the remaining area of the view)

    example: default layout (center)

        centers components

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        v label:'default: center'.

        p := HorizontalPanelView in:v.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: same (default center layout) with different sized elements

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        v label:'default: center'.

        p := HorizontalPanelView in:v.

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

        b1 := Button label:'but1' in:p. b1 font:(b1 font size:8).

        b2 := Button label:'b2' in:p.      b2 font:(b1 font size:24).

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: horizontal default (center); vertical centerMax

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        v label:'vL=centerMax'.

        p := HorizontalPanelView in:v.

        p verticalLayout:#centerMax.

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

        b1 := Button label:'but1' in:p. b1 font:(b1 font size:8).

        b2 := Button label:'b2' in:p.      b2 font:(b1 font size:24).

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: horizontal default (center); vertical topMax

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        v label:'vL=topMax'.

        p := HorizontalPanelView in:v.

        p verticalLayout:#topMax.

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

        b1 := Button label:'but1' in:p. b1 font:(b1 font size:8).

        b2 := Button label:'b2' in:p.      b2 font:(b1 font size:24).

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: horizontal default (center); vertical topSpaceMax

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        v label:'vL=topSpaceMax'.

        p := HorizontalPanelView in:v.

        p verticalLayout:#topSpaceMax.

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

        b1 := Button label:'but1' in:p. b1 font:(b1 font size:8).

        b2 := Button label:'b2' in:p.      b2 font:(b1 font size:24).

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: horizontal default (center); vertical bottomMax

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        v label:'vL=bottomMax'.

        p := HorizontalPanelView in:v.

        p verticalLayout:#bottomMax.

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

        b1 := Button label:'but1' in:p. b1 font:(b1 font size:8).

        b2 := Button label:'b2' in:p.      b2 font:(b1 font size:24).

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: horizontal default (center); vertical bottomSpaceMax

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        v label:'vL=bottomSpaceMax'.

        p := HorizontalPanelView in:v.

        p verticalLayout:#bottomSpaceMax.

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

        b1 := Button label:'but1' in:p. b1 font:(b1 font size:8).

        b2 := Button label:'b2' in:p.      b2 font:(b1 font size:24).

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: left-layout (vertical is default -> center)

        fills left-to-right; no spacing before leftMost component

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        v label:'hL=left; vL=default (center)'.

        p horizontalLayout:#left.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: left starting with spacing (vertical is default -> center)

        fills left-to-right; spacing before leftMost component

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        v label:'hL=leftSpace; vL=center'.

        p horizontalLayout:#leftSpace.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: leftFit-layout (vertical is default -> center)

        fills left-to-right; resizes the rightMost component to fit

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        v label:'hL=leftFit; vL=center'.

        p horizontalLayout:#leftFit.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: leftSpaceFit-layout (vertical is default -> center)

        fills left-to-right; 

        starts with spacing & resizes the rightMost component to fit with spacing

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        v label:'hL=leftSpaceFit; vL=center'.

        p horizontalLayout:#leftSpaceFit.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: right-layout (vertical is default -> center)

        right-to-left

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        v viewBackground:Color yellow.

        p := HorizontalPanelView in:v.

        p viewBackground:Color red.

        v label:'hL=right; vL=center'.

        p horizontalLayout:#rightSpaceFit.

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

        b1 := View in:p. b1 viewBackground:(Color green).

        b2 := View in:p. b2 viewBackground:(Color gray). 

        b3 := View in:p. b3 viewBackground:(Color white). 

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: right with initial spacing (vertical is default -> center)

        right-to-left with spacing after last component

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        v label:'hL=rightSpace; vL=center'.

        p horizontalLayout:#rightSpace.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: rightFit-layout (vertical is default -> center)

        right-to-left; resize the leftMost component to fit

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        v label:'hL=rightFit; vL=center'.

        p horizontalLayout:#rightFit.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: rightSpaceFit with initial spacing (vertical is default -> center)

        right-to-left; start with spacing & resize the leftMost to fit

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        v label:'hL=rightSpaceFit; vL=center'.

        p horizontalLayout:#rightSpaceFit.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: fit-layout (vertical is default -> center)

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        p horizontalLayout:#fit.

        v label:'hL=fit; vL=center'.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: full fit i.e. no spacing (vertical is default -> center)

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        p horizontalLayout:#fit.

        p horizontalSpace:0.

        v label:'hL=fit hS=0; vL=center'.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: fit with spacing (vertical is default -> center)

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.

        p := HorizontalPanelView in:v.

        v label:'hL=fitSpace; vL=center'.

        p horizontalLayout:#fitSpace.

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

        b1 := Button label:'button1' in:p.

        b2 := Button label:'button2' in:p.

        b3 := Button label:'button3' in:p.

        v extent:300 @ 100.

        v open

                                                                        [exEnd]

    example: spread-layout (vertical is default -> center)

                                                                        [exBegin]

        |v p b1 b2 b3|

        v := StandardSystemView new.