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

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ConstraintColumn class partitions an absolutely positioned container in the vertical plane. ConstraintColumn instances have 3 sizing options: fixed, percentage, and content. These options dictate the position of the constraint column, the amount of space the constraint column takes in the container, and how the constraint column deals with changes 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
		explicitWidth : Number Number that specifies the explicit width of the ConstraintColumn instance, in pixels, in the ConstraintColumn instance's coordinates.	ConstraintColumn
		id : String ID of the ConstraintColumn instance.	ConstraintColumn
		maxWidth : Number Number that specifies the maximum width of the ConstraintColumn instance, in pixels, in the ConstraintColumn instance's coordinates.	ConstraintColumn
		minWidth : Number Number that specifies the minimum width of the ConstraintColumn instance, in pixels, in the ConstraintColumn instance's coordinates.	ConstraintColumn
		percentWidth : Number Number that specifies the width of a component as a percentage of its parent container's size.	ConstraintColumn
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		width : Number Number that specifies the width of the ConstraintColumn instance, in pixels, in the parent container's coordinates.	ConstraintColumn

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ConstraintColumn() Constructor.	ConstraintColumn
		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 ConstraintColumn instance is created using an MXML tag.	ConstraintColumn
		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
		setActualWidth(w:Number):void Sizes the constraint column.	ConstraintColumn
		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

explicitWidth

property

explicitWidth:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the explicit width of the ConstraintColumn instance, in pixels, in the ConstraintColumn instance's coordinates.

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

Implementation
public function get explicitWidth():Number
public function set explicitWidth(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 ConstraintColumn instance. This value becomes the instance name of the ConstraintColumn instance and should not contain white space or special characters.

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

maxWidth

property

maxWidth:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the maximum width of the ConstraintColumn instance, in pixels, in the ConstraintColumn instance's coordinates.

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

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

minWidth

property

minWidth:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the minimum width of the ConstraintColumn instance, in pixels, in the ConstraintColumn instance's coordinates.

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

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

percentWidth

property

percentWidth:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the width of a component as a percentage of its parent container'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 percentWidthChanged event.

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

width

property

width:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Number that specifies the width of the ConstraintColumn instance, in pixels, in the parent container's coordinates.

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

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

Constructor Detail

ConstraintColumn

()

Constructor

public function ConstraintColumn()

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 ConstraintColumn instance is created using an MXML tag. If you create the ConstraintColumn instance 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 ConstraintColumn.

	`id:String` — Ignored.

setActualWidth

()

method

public function setActualWidth(w:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Sizes the constraint column.

Parameters

w:Number — Width of constaint column computed during parent container processing.