com.yahoo.astra.fl.containers.BorderPane

Package	com.yahoo.astra.fl.containers
Class	public class BorderPane
Inheritance	BorderPane AdvancedLayoutPane BaseLayoutPane BaseScrollPane UIComponent flash.display.Sprite

A container that arranges its children similar to a non-scrolling document page. Top and bottom constraints define headers and footers. Left and right constraints define sidebars, and a center constraint stetches the main contents to fill the remaining space.

This layout container supports advanced options specified through the configuration property.

Available Configuration Options

target : DisplayObject: A display object to be configured.
constraint : String: The BorderConstraints value to be used on the target by the layout algorithm. The default value is BorderConstraints.CENTER.
maintainAspectRatio : Boolean: If true, the aspect ratio of the target will be maintained if it is resized.
horizontalAlign : String: The horizontal alignment used when positioning the target. Used in combination with maintainAspectRatio.
verticalAlign : String: The vertical alignment used when positioning the target. Used in combination with maintainAspectRatio.
aspectRatio : Number: The desired aspect ratio to use with maintainAspectRatio. This value is optional. If no aspect ratio is provided, it will be determined based on the target's original width and height.
includeInLayout : Boolean: If false, the target will not be included in layout calculations. The default value is true.

Example
The following code sets the configuration options for a BorderPane

  pane.configuration =  [
   { target: headerSprite, constraint: BorderContstraints.TOP },
   { target: contentSprite, constraint: BorderConstraints.CENTER,
    maintainAspectRatio: true, horizontalAlign: "center",
    verticalAlign: "middle" }
  ];

See also

com.yahoo.astra.layout.BorderConstraints
com.yahoo.astra.layout.HorizontalAlignment
com.yahoo.astra.layout.VerticalAlignment

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		autoSize : Boolean If true, the container will automatically calculate the ideal width and height for itself.	BaseLayoutPane
		configuration : Array A list of settings used by the layout algorithm for specific children of the container.	AdvancedLayoutPane
		debugMode : Boolean If true, a simple border around the layout pane will identify its bounds.	BaseLayoutPane
		enabled : Boolean Gets or sets a value that indicates whether the component can accept user interaction.	UIComponent
		focusEnabled : Boolean Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		focusManager : IFocusManager Gets or sets the FocusManager that controls focus for this component and its peers.	UIComponent
		height : Number Gets or sets the height of the component, in pixels.	UIComponent
		horizontalGap : Number The number of horizontal pixels between each item displayed by this container.	BorderPane
		horizontalLineScrollSize : Number Gets or sets a value that describes the amount of content to be scrolled, horizontally, when a scroll arrow is clicked.	BaseScrollPane
		horizontalPageScrollSize : Number Gets or sets the count of pixels by which to move the scroll thumb on the horizontal scroll bar when the scroll bar track is pressed.	BaseScrollPane
		horizontalScrollBar : ScrollBar Gets a reference to the horizontal scroll bar.	BaseScrollPane
		horizontalScrollPolicy : String Gets or sets a value that indicates the state of the horizontal scroll bar.	BaseScrollPane
		horizontalScrollPosition : Number Gets or sets a value that describes the horizontal position of the horizontal scroll bar in the scroll pane, in pixels.	BaseScrollPane
		layoutMode : ILayoutMode The algorithm used to layout children of this container (no default).	BaseLayoutPane
		maxHorizontalScrollPosition : Number Gets the maximum horizontal scroll position for the current content, in pixels.	BaseScrollPane
		maxVerticalScrollPosition : Number Gets the maximum vertical scroll position for the current content, in pixels.	BaseScrollPane
		mouseFocusEnabled : Boolean Gets or sets a value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		paddingBottom : Number The number of pixels of extra spacing between the bottom edge of the container and its children.	AdvancedLayoutPane
		paddingLeft : Number The number of pixels of extra spacing between the left edge of the container and its children.	AdvancedLayoutPane
		paddingRight : Number The number of pixels of extra spacing between the right edge of the container and its children.	AdvancedLayoutPane
		paddingTop : Number The number of pixels of extra spacing between the top edge of the container and its children.	AdvancedLayoutPane
		scaleX : Number Multiplies the current width of the component by a scale factor.	UIComponent
		scaleY : Number Multiplies the current height of the component by a scale factor.	UIComponent
		useBitmapScrolling : Boolean When set to `true`, the `cacheAsBitmap` property for the scrolling content is set to `true`; when set to `false` this value is turned off.	BaseScrollPane
		version : String = "3.0.0.15" The version number of the components.	UIComponent
		verticalGap : Number The number of vertical pixels between each item displayed by this container.	BorderPane
		verticalLineScrollSize : Number Gets or sets a value that describes how many pixels to scroll vertically when a scroll arrow is clicked.	BaseScrollPane
		verticalPageScrollSize : Number Gets or sets the count of pixels by which to move the scroll thumb on the vertical scroll bar when the scroll bar track is pressed.	BaseScrollPane
		verticalScrollBar : ScrollBar Gets a reference to the vertical scroll bar.	BaseScrollPane
		verticalScrollPolicy : String Gets or sets a value that indicates the state of the vertical scroll bar.	BaseScrollPane
		verticalScrollPosition : Number Gets or sets a value that describes the vertical position of the vertical scroll bar in the scroll pane, in pixels.	BaseScrollPane
		visible : Boolean Gets or sets a value that indicates whether the current component instance is visible.	UIComponent
		width : Number Gets or sets the width of the component, in pixels.	UIComponent
		x : Number Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.	UIComponent
		y : Number Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.	UIComponent

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined by
		layoutContainer : ILayoutContainer The generic container used for the children.	BaseLayoutPane

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		BorderPane(configuration:Array = null) Constructor.	BorderPane
		clearStyle(style:String):void Deletes a style property from this component instance.	UIComponent
		drawFocus(focused:Boolean):void Shows or hides the focus indicator on this component.	UIComponent
		drawNow():void Initiates an immediate draw operation, without invalidating everything as `invalidateNow` does.	UIComponent
		getFocus():InteractiveObject Retrieves the object that currently has focus.	UIComponent
		getStyle(style:String):Object Retrieves a style property that is set in the style lookup chain of the component.	UIComponent
		getStyleDefinition():Object [static] Retrieves the default style map for the current component.	BaseLayoutPane
		invalidate(property:String, callLater:Boolean = true):void Marks a property as invalid and redraws the component on the next frame unless otherwise specified.	UIComponent
		mergeStyles(... list):Object [static] Merges the styles from multiple classes into one object.	UIComponent
		move(x:Number, y:Number):void Moves the component to the specified position within its parent.	UIComponent
		setFocus():void Sets the focus to this component.	UIComponent
		setSize(w:Number, h:Number):void Sets the component to the specified width and height.	BaseLayoutPane
		setStyle(style:String, value:Object):void Sets a style property on this component instance.	UIComponent
		validateNow():void Validates and updates the properties and layout of this object, redrawing it if necessary.	UIComponent

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
hide	Dispatched after the component visibility changes from visible to invisible.	UIComponent
move	Dispatched after the component is moved.	UIComponent
resize	Dispatched after the component is resized.	UIComponent
scroll	Dispatched when the user scrolls content by using the scroll bars on the component or the wheel on a mouse device.	BaseScrollPane
show	Dispatched after the component visibility changes from invisible to visible.	UIComponent

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined by
contentPadding	Type: Number Format: Length Padding between the content (the component and scroll bar), and the outside edge of the background, in pixels.	BaseScrollPane
disabledAlpha	Type: Number Format: Length When the `enabled` property is set to `false`, interaction with the component is prevented and a white overlay is displayed over the component, dimming the component contents.	BaseScrollPane
disabledTextFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label when the button is disabled.	UIComponent
downArrowDisabledSkin	Type: Class Name of the class to use as the skin for the down arrow button of the scroll bar when it is disabled.	BaseScrollPane
downArrowDownSkin	Type: Class Name of the class to use as the skin for the down arrow button of the scroll bar when you click the arrow button.	BaseScrollPane
downArrowOverSkin	Type: Class Name of the class to use as the skin for the down arrow button of the scroll bar when the mouse pointer is over the arrow button.	BaseScrollPane
downArrowUpSkin	Type: Class Name of the class to use as the skin for the down arrow button of the scroll bar.	BaseScrollPane
focusRectPadding	Type: Number Format: Length The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels.	UIComponent
focusRectSkin	Type: Class The skin to be used to display focus indicators.	UIComponent
repeatDelay	Type: Number Format: Time The number of milliseconds to wait after the `buttonDown` event is first dispatched before sending a second `buttonDown` event.	BaseScrollPane
repeatInterval	Type: Number Format: Time The interval, in milliseconds, between `buttonDown` events that are dispatched after the delay that is specified by the `repeatDelay` style.	BaseScrollPane
skin	Type: Class The skin to be used as the background of the scroll pane.	BaseScrollPane
textFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label.	UIComponent
thumbDisabledSkin	Type: Class The skin that is used to indicate the disabled state of the thumb.	BaseScrollPane
thumbDownSkin	Type: Class Name of the class to use as the skin for the thumb of the scroll bar when you click the thumb.	BaseScrollPane
thumbIcon	Type: Class Name of the class to use as the icon for the thumb of the scroll bar.	BaseScrollPane
thumbOverSkin	Type: Class Name of the class to use as the skin for the thumb of the scroll bar when the mouse pointer is over the thumb.	BaseScrollPane
thumbUpSkin	Type: Class Name of the class to use as the skin used for the thumb of the scroll bar.	BaseScrollPane
trackDisabledSkin	Type: Class The skin that is used to indicate a disabled track.	BaseScrollPane
trackDownSkin	Type: Class The skin that is used to indicate the down state of a disabled skin.	BaseScrollPane
trackOverSkin	Type: Class The skin that is used to indicate the mouseover state for the scroll track.	BaseScrollPane
trackUpSkin	Type: Class The skin used to indicate the mouse up state for the scroll track.	BaseScrollPane
upArrowDisabledSkin	Type: Class Name of the class to use as the skin for the up arrow button of the scroll bar when it is disabled.	BaseScrollPane
upArrowDownSkin	Type: Class Name of the class to use as the skin for the up arrow button of the scroll bar when you click the arrow button.	BaseScrollPane
upArrowOverSkin	Type: Class Name of the class to use as the skin for the up arrow button of the scroll bar when the mouse pointer is over the arrow button.	BaseScrollPane
upArrowUpSkin	Type: Class Name of the class to use as the skin for the up arrow button of the scroll bar.	BaseScrollPane

Property detail

horizontalGap

property

horizontalGap:Number [read-write]

The number of horizontal pixels between each item displayed by this container.

Implementation
public function get horizontalGap():Number
public function set horizontalGap(value:Number):void

verticalGap

property

verticalGap:Number [read-write]

The number of vertical pixels between each item displayed by this container.

Implementation
public function get verticalGap():Number
public function set verticalGap(value:Number):void

Constructor detail

BorderPane

()

constructor

public function BorderPane(configuration:Array = null)

Constructor.

Parameters

configuration:Array (default = null) — An Array of optional configurations for the layout container's children.

Visit ydn-flash for Yahoo! ASTRA feedback and support

Astra Library Documentation
Class BorderPane
Properties \| Methods \| Events \| Styles	All Packages \| All Classes \| Index \| Frames No Frames