232 lines
6.3 KiB
Go
232 lines
6.3 KiB
Go
// 13 february 2014
|
|
|
|
package ui
|
|
|
|
import (
|
|
"fmt"
|
|
)
|
|
|
|
type orientation bool
|
|
|
|
const (
|
|
horizontal orientation = false
|
|
vertical orientation = true
|
|
)
|
|
|
|
// A Stack stacks controls horizontally or vertically within the Stack's parent.
|
|
// A horizontal Stack gives all controls the same height and their preferred widths.
|
|
// A vertical Stack gives all controls the same width and their preferred heights.
|
|
// Any extra space at the end of a Stack is left blank.
|
|
// Some controls may be marked as "stretchy": when the Window they are in changes size, stretchy controls resize to take up the remaining space after non-stretchy controls are laid out. If multiple controls are marked stretchy, they are alloted equal distribution of the remaining space.
|
|
type Stack interface {
|
|
Control
|
|
|
|
// SetStretchy marks a control in a Stack as stretchy.
|
|
// It panics if index is out of range.
|
|
SetStretchy(index int)
|
|
|
|
// Padded and SetPadded get and set whether the controls of the Stack have padding between them.
|
|
// The size of the padding is platform-dependent.
|
|
Padded() bool
|
|
SetPadded(padded bool)
|
|
}
|
|
|
|
type stack struct {
|
|
orientation orientation
|
|
controls []Control
|
|
stretchy []bool
|
|
width, height []int // caches to avoid reallocating these each time
|
|
container *container
|
|
padded bool
|
|
}
|
|
|
|
func newStack(o orientation, controls ...Control) Stack {
|
|
s := &stack{
|
|
orientation: o,
|
|
controls: controls,
|
|
stretchy: make([]bool, len(controls)),
|
|
width: make([]int, len(controls)),
|
|
height: make([]int, len(controls)),
|
|
container: newContainer(),
|
|
}
|
|
p := s.container.parent()
|
|
for _, c := range s.controls {
|
|
c.setParent(p)
|
|
}
|
|
return s
|
|
}
|
|
|
|
// NewHorizontalStack creates a new Stack that arranges the given Controls horizontally.
|
|
func NewHorizontalStack(controls ...Control) Stack {
|
|
return newStack(horizontal, controls...)
|
|
}
|
|
|
|
// NewVerticalStack creates a new Stack that arranges the given Controls vertically.
|
|
func NewVerticalStack(controls ...Control) Stack {
|
|
return newStack(vertical, controls...)
|
|
}
|
|
|
|
func (s *stack) SetStretchy(index int) {
|
|
if index < 0 || index > len(s.stretchy) {
|
|
panic(fmt.Errorf("index %d out of range in Stack.SetStretchy()", index))
|
|
}
|
|
s.stretchy[index] = true
|
|
}
|
|
|
|
func (s *stack) Padded() bool {
|
|
return s.padded
|
|
}
|
|
|
|
func (s *stack) SetPadded(padded bool) {
|
|
s.padded = padded
|
|
}
|
|
|
|
func (s *stack) setParent(parent *controlParent) {
|
|
s.container.setParent(parent)
|
|
}
|
|
|
|
func (s *stack) resize(x int, y int, width int, height int, d *sizing) {
|
|
var stretchywid, stretchyht int
|
|
|
|
s.container.resize(x, y, width, height, d)
|
|
if len(s.controls) == 0 { // do nothing if there's nothing to do
|
|
return
|
|
}
|
|
// -1) get this Stack's padding
|
|
xpadding := d.xpadding
|
|
ypadding := d.ypadding
|
|
if !s.padded {
|
|
xpadding = 0
|
|
ypadding = 0
|
|
}
|
|
// 0) inset the available rect by the needed padding and reset the x/y coordinates for the children
|
|
if s.orientation == horizontal {
|
|
width -= (len(s.controls) - 1) * xpadding
|
|
} else {
|
|
height -= (len(s.controls) - 1) * ypadding
|
|
}
|
|
x = 0
|
|
y = 0
|
|
// 1) get height and width of non-stretchy controls; figure out how much space is alloted to stretchy controls
|
|
stretchywid = width
|
|
stretchyht = height
|
|
nStretchy := 0
|
|
for i, c := range s.controls {
|
|
if s.stretchy[i] {
|
|
nStretchy++
|
|
continue
|
|
}
|
|
w, h := c.preferredSize(d)
|
|
if s.orientation == horizontal { // all controls have same height
|
|
s.width[i] = w
|
|
s.height[i] = height
|
|
stretchywid -= w
|
|
} else { // all controls have same width
|
|
s.width[i] = width
|
|
s.height[i] = h
|
|
stretchyht -= h
|
|
}
|
|
}
|
|
// 2) figure out size of stretchy controls
|
|
if nStretchy != 0 {
|
|
if s.orientation == horizontal { // split rest of width
|
|
stretchywid /= nStretchy
|
|
} else { // split rest of height
|
|
stretchyht /= nStretchy
|
|
}
|
|
}
|
|
for i := range s.controls {
|
|
if !s.stretchy[i] {
|
|
continue
|
|
}
|
|
s.width[i] = stretchywid
|
|
s.height[i] = stretchyht
|
|
}
|
|
// 3) now actually place controls
|
|
for i, c := range s.controls {
|
|
c.resize(x, y, s.width[i], s.height[i], d)
|
|
if s.orientation == horizontal {
|
|
x += s.width[i] + xpadding
|
|
} else {
|
|
y += s.height[i] + ypadding
|
|
}
|
|
}
|
|
return
|
|
}
|
|
|
|
// The preferred size of a Stack is the sum of the preferred sizes of non-stretchy controls + (the number of stretchy controls * the largest preferred size among all stretchy controls).
|
|
func (s *stack) preferredSize(d *sizing) (width int, height int) {
|
|
max := func(a int, b int) int {
|
|
if a > b {
|
|
return a
|
|
}
|
|
return b
|
|
}
|
|
|
|
var nStretchy int
|
|
var maxswid, maxsht int
|
|
|
|
if len(s.controls) == 0 { // no controls, so return emptiness
|
|
return 0, 0
|
|
}
|
|
xpadding := d.xpadding
|
|
ypadding := d.ypadding
|
|
if !s.padded {
|
|
xpadding = 0
|
|
ypadding = 0
|
|
}
|
|
if s.orientation == horizontal {
|
|
width = (len(s.controls) - 1) * xpadding
|
|
} else {
|
|
height = (len(s.controls) - 1) * ypadding
|
|
}
|
|
for i, c := range s.controls {
|
|
w, h := c.preferredSize(d)
|
|
if s.stretchy[i] {
|
|
nStretchy++
|
|
maxswid = max(maxswid, w)
|
|
maxsht = max(maxsht, h)
|
|
}
|
|
if s.orientation == horizontal { // max vertical size
|
|
if !s.stretchy[i] {
|
|
width += w
|
|
}
|
|
height = max(height, h)
|
|
} else {
|
|
width = max(width, w)
|
|
if !s.stretchy[i] {
|
|
height += h
|
|
}
|
|
}
|
|
}
|
|
if s.orientation == horizontal {
|
|
width += nStretchy * maxswid
|
|
} else {
|
|
height += nStretchy * maxsht
|
|
}
|
|
return
|
|
}
|
|
|
|
func (s *stack) nTabStops() int {
|
|
n := 0
|
|
for _, c := range s.controls {
|
|
n += c.nTabStops()
|
|
}
|
|
return n
|
|
}
|
|
|
|
// TODO the below needs to be changed
|
|
|
|
// Space returns a null Control intended for padding layouts with blank space.
|
|
// It appears to its owner as a Control of 0x0 size.
|
|
//
|
|
// For a Stack, Space can be used to insert spaces in the beginning or middle of Stacks (Stacks by nature handle spaces at the end themselves). In order for this to work properly, make the Space stretchy.
|
|
//
|
|
// For a SimpleGrid, Space can be used to have an empty cell. A stretchy Grid cell with a Space can be used to anchor the perimeter of a Grid to the respective Window edges without making one of the other controls stretchy instead (leaving empty space in the Window otherwise). Otherwise, you do not need to do anything special for the Space to work (though remember that an entire row or column of Spaces will appear as having height or width zero, respectively, unless one is marked as stretchy).
|
|
//
|
|
// The value returned from Space() is guaranteed to be unique.
|
|
func Space() Control {
|
|
// Grid's rules require this to be unique on every call
|
|
return newStack(horizontal)
|
|
}
|