ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.core 

EdgeMetrics  - AS3 Flex
Packagemx.core
Classpublic class EdgeMetrics
InheritanceEdgeMetrics Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The EdgeMetrics class specifies the thickness, in pixels, of the four edge regions around a visual component.

The following Flex properties have values that are EdgeMetrics objects:

  • The borderMetrics property of the mx.core.Container and mx.skins.Border classes includes only the border in the calculations of the property values of the EdgeMetrics object.
  • The viewMetrics property of the mx.core.Container class, and of subclasses of the Container class, includes possible scrollbars and non-content elements -- such as a Panel container's header area and the area for a ControlBar component -- in the calculations of the property values of the EdgeMetrics object.
  • The viewMetricsAndPadding property of the mx.core.Container class includes the items listed for the viewMetrics property, plus the any areas defined by the margins of the container in the calculations of the property values of the EdgeMetrics object.

These three properites all return a reference to the same EdgeMetrics object that the Container is using for its measurement and layout; they do not return a copy of this object. If you need a copy, call the clone() method.

Related API Elements

mx.core.Container
mx.skins.Border
mx.containers.Panel

Public Properties
 PropertyDefined By
  bottom : Number
The height, in pixels, of the bottom edge region.
EdgeMetrics
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  left : Number
The width, in pixels, of the left edge region.
EdgeMetrics
  right : Number
The width, in pixels, of the right edge region.
EdgeMetrics
  top : Number
The height, in pixels, of the top edge region.
EdgeMetrics
Public Methods
 MethodDefined By
  
EdgeMetrics(left:Number = 0, top:Number = 0, right:Number = 0, bottom:Number = 0)
Constructor.
EdgeMetrics
  
clone():EdgeMetrics
Returns a copy of this EdgeMetrics object.
EdgeMetrics
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  EMPTY : EdgeMetrics
[static] An EdgeMetrics object with a value of zero for its left, top, right, and bottom properties.
EdgeMetrics
Property Detail

bottom

property
public var bottom:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The height, in pixels, of the bottom edge region.

left

property 
public var left:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The width, in pixels, of the left edge region.

right

property 
public var right:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The width, in pixels, of the right edge region.

top

property 
public var top:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The height, in pixels, of the top edge region.

Constructor Detail

EdgeMetrics

()Constructor
public function EdgeMetrics(left:Number = 0, top:Number = 0, right:Number = 0, bottom:Number = 0)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
left:Number (default = 0) — The width, in pixels, of the left edge region.
 
top:Number (default = 0) — The height, in pixels, of the top edge region.
 
right:Number (default = 0) — The width, in pixels, of the right edge region.
 
bottom:Number (default = 0) — The height, in pixels, of the bottom edge region.
Method Detail

clone

()method
public function clone():EdgeMetrics

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns a copy of this EdgeMetrics object.

Returns
EdgeMetrics — A copy of this EdgeMetrics object.
Constant Detail

EMPTY

Constant
public static const EMPTY:EdgeMetrics

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An EdgeMetrics object with a value of zero for its left, top, right, and bottom properties.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy