Class FlexibleSizingFunction

Object
   |
   +--Function
         |
         +--FlexibleSizingFunction

class FlexibleSizingFunction

extends Function

Defined in flexible_sizing_function.js

Constructor Detail

FlexibleSizingFunction

function FlexibleSizingFunction(<float> hMargin, <float> vMargin, <float> hGutter, <float> vGutter)

Creates a sizing function suitable for use with a GridLayout.

The parameters to the constructor are explained visually below:

	^
	|
	Top Margin
	|
	v
<- Left Margin ->	Widget		Widget		Widget	<- Right Margin ->
			^
			|
			vGutter
			|
			v
	Widget	<- hGutter ->	Widget	<- hGutter ->	Widget
			^
			|
			vGutter
			|
			v
	Widget		Widget		Widget
	^
	|
	Top Margin
	|
	v

Parameters:
hMargin - the number of pixels to use as the left and right margins
vMargin - the number of pixels to use as the top and bottom margins
hGutter - how many pixels to put to the left and right of each widget
vGutter - how many pixels to put above and below each widget

getColumnWidth

Object getColumnWidth(<int> column)

Returns the width of the given column. Internally determines whether or not the given column has a specified size or is the default size, and returns the appropriate structure.

Parameters:
column - the index of the column to query

Returns:
a structure describing the width of column column

getDefaultColumnWidth

Object getDefaultColumnWidth()

getDefaultRowHeight

Object getDefaultRowHeight()

getRowHeight

Object getRowHeight(<int> row)

Returns the height of the given row. Internally determines whether or not the given row has a specified size or is the default size, and returns the appropriate structure.

Parameters:
row - the index of the row to query

Returns:
a structure describing the height of row row

isColumnDefault

boolean isColumnDefault(<int> column)

Returns true if and only if column column has no specified width.

Parameters:
column - the index of the column to query

Returns:
true if column column will be sized to the default column width and false otherwise

isRowDefault

boolean isRowDefault(<int> row)

Returns true if and only if row row has no specified height.

Parameters:
row - the index of the row to query

Returns:
true if row row will be sized to the default row height and false otherwise

setBottomMargin

void setBottomMargin(<float> bMargin)

Sets the bottom margin to bMargin pixels.

Parameters:
bMargin - the new height of the bottom margin

setColumnWidth

void setColumnWidth(<int> column, <float> width, <float> weight, <boolean> usePixels)

Sets the width of column column to width. To set the given column back to the default settings, pass only column. width is a number of ems unless usePixels is true. If weight is zero then the given column will not grow (it will always be exactly width units wide). If weight is non-zero, then the given column will always be at least width units wide but will grow larger if there is extra space. The sum of the column weights must be between zero and one.

Parameters:
column - the index of column to affect
width - the width of the column as a float
weight - (Optional) - a number between zero and one indicating what portion of extra space should be allocated to this column. Defaults to zero.
usePixels - (Optional) - a boolean indicating whether width is a number of ems or pixels. Defaults to false.

setDefaultColumnWidth

void setDefaultColumnWidth(<float> width, <boolean> canGrow, <boolean> usePixels)

Sets the default column width to width. If canGrow is true then width is interpreted as a minimum width. If usePixels is true then width is interpreted as a pixel value, otherwise it is interpreted as an em value. canGrow and usePixels both default to false.

Parameters:
width - the number of ems (or pixels, if usePixels is true) wide to make columns with unspecified width. width is an float and must be non-negative.
canGrow - (Optional) - a boolean indicating whether or not default-width columns can grow wider than their specified minimum width. If canGrow is true then columns with no specified width will grow to use up any extra available width.
usePixels - (Optional) - a boolean indicating whether to interpret width as a number of pixels or a number of ems. width is a number of pixels if and only if usePixels is true.

void setDefaultRowHeight(<float> height, <boolean> canGrow, <boolean> usePixels)

void setHorizontalMargin(<float> hMargin)

void setLeftMargin(<float> lMargin)

void setRightMargin(<float> rMargin)

void setRowHeight(<int> row, <float> height, <float> weight, <boolean> usePixels)

void setTopMargin(<float> tMargin)

void setVerticalMargin(<float> vMargin)

<static> boolean computeSizes(<int> cells, <int> availSize, <float> pixelsPerEm, <Array> sizeCache, <Array> edgeCache, <Hash> cellDimensions, <float> reservedSize, <float> reservedWeight, <Object> defaultSize, <float> marginOne, <float> marginTwo, <float> gutter)