mx.containers.utilityClasses.ConstraintRow - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.containers.utilityClasses
Class	public class ConstraintRow
Inheritance	ConstraintRow EventDispatcher Object
Implements	IMXMLObject

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

ConstraintRow class partitions an absolutely positioned container in the horizontal plane. ConstraintRow instances have 3 sizing options: fixed, percentage, and content. These options dictate the position of the constraint row, the amount of space the constraint row takes in the container, and how the constraint row deals with a change in the size of the container.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		explicitHeight : Number Number that specifies the explicit height of the ConstraintRow instance, in pixels, in the ConstraintRow instance's coordinates.	ConstraintRow
		height : Number Number that specifies the height of the ConstraintRow instance, in pixels, in the parent's coordinates.	ConstraintRow
		id : String ID of the ConstraintRow instance.	ConstraintRow
		maxHeight : Number Number that specifies the maximum height of the ConstraintRow instance, in pixels, in the ConstraintRow instance's coordinates.	ConstraintRow
		minHeight : Number Number that specifies the minimum height of the ConstraintRow instance, in pixels, in the ConstraintRow instance's coordinates.	ConstraintRow
		percentHeight : Number Number that specifies the height of a component as a percentage of its parent's size.	ConstraintRow
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ConstraintRow() Constructor.	ConstraintRow
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialized(document:Object, id:String):void Called automatically by the MXML compiler when the ConstraintRow instance is created using an MXML tag.	ConstraintRow
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setActualHeight(h:Number):void Sizes the ConstraintRow	ConstraintRow
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

explicitHeight

property

explicitHeight:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the explicit height of the ConstraintRow instance, in pixels, in the ConstraintRow instance's coordinates.

This property can be used as the source for data binding. When this property is modified, it dispatches the explicitHeightChanged event.

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

height

property

height:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the height of the ConstraintRow instance, in pixels, in the parent's coordinates.

This property can be used as the source for data binding. When this property is modified, it dispatches the heightChanged event.

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

id

property

id:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

ID of the ConstraintRow instance. This value becomes the instance name of the constraint row and should not contain white space or special characters.

Implementation
public function get id():String
public function set id(value:String):void

maxHeight

property

maxHeight:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the maximum height of the ConstraintRow instance, in pixels, in the ConstraintRow instance's coordinates.

This property can be used as the source for data binding. When this property is modified, it dispatches the maxHeightChanged event.

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

minHeight

property

minHeight:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the minimum height of the ConstraintRow instance, in pixels, in the ConstraintRow instance's coordinates.

This property can be used as the source for data binding. When this property is modified, it dispatches the minHeightChanged event.

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

percentHeight

property

percentHeight:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the height of a component as a percentage of its parent's size. Allowed values are 0-100. The default value is NaN. Setting the width property resets this property to NaN.

This property can be used as the source for data binding. When this property is modified, it dispatches the percentHeightChanged event.

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

Constructor Detail

ConstraintRow

()

Constructor

public function ConstraintRow()

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Method Detail

initialized

()

method

public function initialized(document:Object, id:String):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Called automatically by the MXML compiler when the ConstraintRow instance is created using an MXML tag. If you create the constraint row through ActionScript, you must call this method passing in the MXML document and null for the id.

Parameters

	`document:Object` — The MXML document containing this ConstraintRow.

	`id:String` — Ignored.

setActualHeight

()

method

public function setActualHeight(h:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Sizes the ConstraintRow

Parameters

h:Number — Height of constaint row computed during parent container processing.