pack - Factor Documentation

pack
Factor handbook » UI framework » Building user interfaces » Gadget hierarchy and layouts » Pack layouts

Vocabulary
ui.gadgets.packs

Class description
A gadget which lays out its children along a single axis stored in the orientation slot. Can be constructed with one of the following words:

•	<pack>
•	<pile>
•	<shelf>

Packs have the following slots:

•	align a rational number between 0 and 1, or +baseline+; the alignment of gadgets along the axis perpendicular to the pack's orientation
•	fill a rational number between 0 and 1, where 0 gives each gadget its preferred size and 1 fills the dimension perpendicular to the pack's orientation
•	gap a pair of integers, the horizontal and vertical gap between children

Custom gadgets can inherit from the pack class and implement their own pref-dim* and layout* methods, reusing pack layout logic by calling pack-pref-dim and pack-layout.

Definition

USING: ui.baseline-alignment ;

IN: ui.gadgets.packs

TUPLE: pack < aligned-gadget
{ align initial: 0 } { fill initial: 0 }
{ gap initial: { 0 0 } } ;

Methods

USING: accessors combinators kernel ui.baseline-alignment
ui.gadgets ui.gadgets.packs ui.gadgets.packs.private ;

M: pack baseline*
dup orientation>> {
{ vertical [ vertical-baseline ] }
{ horizontal [ horizontal-baseline ] }
} case ;

USING: ui.baseline-alignment ui.gadgets.packs
ui.gadgets.packs.private ;

M: pack cap-height* pack-cap-height ;

USING: accessors kernel ui.gadgets ui.gadgets.packs ;

M: pack children-on
[ orientation>> ] [ children>> ] bi
[ loc>> ] fast-children-on ;

USING: accessors kernel ui.gadgets ui.gadgets.packs ;

M: pack layout* dup children>> pref-dims pack-layout ;

USING: ui.gadgets.packs ui.gadgets.panes.private ;

M: pack pane-line pane-text ;

USING: accessors kernel ui.gadgets ui.gadgets.packs
ui.gadgets.packs.private ;

M: pack pref-dim* dup children>> pref-dims pack-pref-dim ;

USING: accessors kernel ui.gadgets.packs
ui.gadgets.panes.private ui.gadgets.private ;

M: pack sloppy-pick-up*
[ orientation>> ] [ children>> ] bi
[ loc>> ] (fast-children-on) ;