YUI Flash Component Documentation |
Class BorderConstraints

Package | com.yahoo.astra.layout.modes
Class | public class BorderConstraints

Constraint values available in BorderLayout.

See also

BorderLayout

Public Constants

| Constant | Defined by
--- | --- | ---
|  | BOTTOM : String = "bottom" [static] The target will be constrained to the bottom edge. | BorderConstraints
|  | CENTER : String = "center" [static] The target will be constrained to the center of the container. | BorderConstraints
|  | LEFT : String = "left" [static] The target will be constrained to the left edge. | BorderConstraints
|  | RIGHT : String = "right" [static] The target will be constrained to the right edge. | BorderConstraints
|  | TOP : String = "top" [static] The target will be constrained to the top edge. | BorderConstraints

Constant detail

BOTTOM | constant

`public static const BOTTOM:String = "bottom"`

The target will be constrained to the bottom edge. Its width will be altered to fit to the width of the container. Its height will remain unchanged.

Consider the `BOTTOM` constraint to work like a page's footer. It appears below all other constrained children, with no other children appearing to the left or right. Multiple `BOTTOM` constraints will be arranged vertically from the bottom up in the order that they were registered as clients of the BorderLayout algorithm.

CENTER | constant |

`public static const CENTER:String = "center"`

The target will be constrained to the center of the container. It will appear between all other constrained children. Its height will be altered to fill the remaining height of the container (after the TOP and BOTTOM constraints are measured) and its width will be altered to fill the remaining width of the container (after the LEFT and RIGHT constraints are measured).

Consider the `CENTER` constraint to work like a page's primary content. It appears in between all other constraints and changes size to fill the remaining area (after all other constraints are measured). Multiple `CENTER` constraints will be arranged vertically from top down starting from the bottom edge of the `TOP` constraints to the top edge of any `BOTTOM` constraints.

LEFT | constant |

`public static const LEFT:String = "left"`

The target will be constrained to the left edge. It will appear below any items constrained to the top and above items constrained to the bottom. Its height will be altered to fill the remaining height of the container (after the TOP and BOTTOM constraints are measured), and its width will remain unchanged.

Consinder the `LEFT` constraint to work like a page's sidebar that is aligned to the left. It appears to the left of all other children, with only the top and bottom constraints taking precendence. Multiple `LEFT` constraints will be arranged horizontally from left to right in the order that they were registered as clients of the BorderLayout algorithm.

RIGHT | constant |

`public static const RIGHT:String = "right"`

The target will be constrained to the right edge. It will appear below any items constrained to the top and above items constrained to the bottom. Its height will be altered to fill the remaining height of the container (after the TOP and BOTTOM constraints are measured), and its width will remain unchanged.

Consinder the `RIGHT` constraint to work like a page's sidebar that is aligned to the right. It appears to the right of all other children, with only the top and bottom constraints taking precendence. Multiple `RIGHT` constraints will be arranged horizontally from right to left in the order that they were registered as clients of the BorderLayout algorithm.

TOP | constant |

`public static const TOP:String = "top"`

The target will be constrained to the top edge. Its width will be altered to fit to the width of the container. Its height will remain unchanged.

Consider the `TOP` constraint to work like a page's header. It appears above all other constrained children, with no other children appearing to the left or right. Multiple `TOP` constraints will be arranged vertically from the top down in the order that they were registered as clients of the BorderLayout algorithm.