The BoxColumn layout element specifies a column in a box layout.

Use BoxColumn for vertical control in a box layout.

The BoxColumn element features can be modified by using options. To simplify specifying options in the Maplets package, certain options and contents can be set without using an equation. The following table lists elements, symbols, and types (in the left column) and the corresponding option or content (in the right column) to which inputs of this type are, by default, assigned.

A BoxColumn element can contain any number of BoxCell, BoxColumn, or BoxRow elements.

A BoxColumn element can be contained in a BoxColumn, BoxLayout, or BoxRow element.

The following table describes the control and use of the BoxColumn element options.

An x in the I column indicates that the option can be initialized, that is, specified in the calling sequence (element definition).

An x in the R column indicates that the option is required in the calling sequence.

An x in the G column indicates that the option can be read, that is, retrieved by using the Get tool.

An x in the S column indicates that the option can be written, that is, set by using the SetOption element or the Set tool.

The opts argument can contain one or more of the following equations that set Maplet options.

background = color

The color of the highlights of the box column.  This can be a recognized color name, an RGB color structure, or a string of the form "#RRGGBB" where each pair is a two-digit hexadecimal number.

border = true or false

Whether the box has a border.  By default, the value is false.

caption = string

The text that appears above the box column.  The caption is visible only if the option border is set to true.

font = Font element or reference to a Font element (name or string)

The text font in the caption.

halign = left, center, right, or none

Specifies the default horizontal alignment for any BoxRow layout objects contained in the column. By default, the value is center. The none option allows finer control of the alignment of contents when used in combination with HorizontalGlue (see BoxRow for more detail).

Note: The halign option does not directly affect a box column object, but the specified halign value is inherited as the default horizontal alignment for any BoxRow elements it contains.

hscroll = never, as_needed, or always

This option determines when a horizontal scroll bar appears in the box column.  By default, the value is never.

inset = nonnegint

The amount of padding that surrounds the elements in the box column. The default inset is $5$ pixels.

spacing = nonnegint

The amount of padding that separates the individual elements in the box column.  The default inset is $5$ pixels.

valign = top, center, bottom, or none

Vertically aligns the contents of the column. By default, the value is center.

Vertical alignment of elements in a box column is accomplished by the addition of VerticalGlue spacing elements: top alignment is obtained by adding a VerticalGlue below the element, bottom alignment is obtained by adding a VerticalGlue above the element, and center alignment is obtained by adding a VerticalGlue both above and below the element. Choosing an alignment of none allows finer control by allowing specification of all VerticalGlue elements manually (see examples/AdvancedMapletsLayout for more detail).

visible = true or false

Whether the box is visible to the user.  By default, the value is true.

vscroll = never, as_needed, or always

This option determines when a vertical scroll bar appears in the box column.  By default, the value is never.

$\mathrm{with}\left(\mathrm{Maplets}\left[\mathrm{Elements}\right]\right)\:$

$\mathrm{maplet}≔\mathrm{Maplet}\left(\mathrm{Window}\left('\mathrm{layout}'='\mathrm{BL1}'\right)\,\mathrm{BoxLayout}\left['\mathrm{BL1}'\right]\left(\mathrm{BoxColumn}\left(\mathrm{BoxRow}\left(''Enter\; text:''\,\mathrm{TextField}\left['\mathrm{TF1}'\right]\left(\right)\right)\,\mathrm{Button}\left(''OK''\,\mathrm{Shutdown}\left(\left['\mathrm{TF1}'\right]\right)\right)\right)\right)\right)\:$

$\mathrm{Maplets}\left[\mathrm{Display}\right]\left(\mathrm{maplet}\right)$

$\mathrm{maplet}≔\mathrm{Maplet}\left(\left[\left[''Enter\; text:''\,\mathrm{TextField}\left['\mathrm{TF1}'\right]\left(\right)\right]\,\mathrm{Button}\left(''OK''\,\mathrm{Shutdown}\left(\left['\mathrm{TF1}'\right]\right)\right)\right]\right)\:$

$\mathrm{Maplets}\left[\mathrm{Display}\right]\left(\mathrm{maplet}\right)$

$\mathrm{maplet}≔\mathrm{Maplet}\left(\mathrm{BoxLayout}\left(\mathrm{BoxColumn}\left('\mathrm{halign}'='\mathrm{left}'\,'\mathrm{valign}'='\mathrm{none}'\,\mathrm{Button}\left(''Very\; top''\,\mathrm{Shutdown}\left(\left[\right]\right)\right)\,\mathrm{Button}\left(''Next\; to\; top''\,\mathrm{Shutdown}\left(\left[\right]\right)\right)\,\mathrm{VerticalGlue}\left(\right)\,\mathrm{Button}\left(''Closer\; to\; top\; buttons\; than\; bottom''\,\mathrm{Shutdown}\left(\left[\right]\right)\right)\,\mathrm{VerticalGlue}\left(\right)\,\mathrm{VerticalGlue}\left(\right)\,\mathrm{Button}\left(''Very\; bottom''\,\mathrm{Shutdown}\left(\left[\right]\right)\right)\right)\right)\right)\:$

$\mathrm{Maplets}\left[\mathrm{Display}\right]\left(\mathrm{maplet}\right)$

$\mathrm{maplet}≔\mathrm{Maplet}\left(\mathrm{BoxLayout}\left(\mathrm{BoxColumn}\left('\mathrm{halign}'='\mathrm{left}'\,'\mathrm{valign}'='\mathrm{none}'\,\mathrm{BoxRow}\left(\mathrm{Button}\left(''Very\; top''\,\mathrm{Shutdown}\left(\left[\right]\right)\right)\right)\,\mathrm{BoxRow}\left(\mathrm{Button}\left(''Next\; to\; top''\,\mathrm{Shutdown}\left(\left[\right]\right)\right)\right)\,\mathrm{VerticalGlue}\left(\right)\,\mathrm{BoxRow}\left(\mathrm{Button}\left(''Closer\; to\; top\; buttons\; than\; bottom''\,\mathrm{Shutdown}\left(\left[\right]\right)\right)\right)\,\mathrm{VerticalGlue}\left(\right)\,\mathrm{VerticalGlue}\left(\right)\,\mathrm{BoxRow}\left(\mathrm{Button}\left(''Very\; bottom''\,\mathrm{Shutdown}\left(\left[\right]\right)\right)\right)\right)\right)\right)\:$

$\mathrm{Maplets}\left[\mathrm{Display}\right]\left(\mathrm{maplet}\right)$