Package | mx.core |
Class | public class EdgeMetrics |
Inheritance | EdgeMetrics Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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 theviewMetrics
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
Property | Defined By | ||
---|---|---|---|
bottom : Number
The height, in pixels, of the bottom edge region. | EdgeMetrics | ||
constructor : 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 | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
right : Number
The width, in pixels, of the right edge region. | EdgeMetrics | ||
top : Number
The height, in pixels, of the top edge region. | EdgeMetrics |
Method | Defined By | ||
---|---|---|---|
Constructor. | EdgeMetrics | ||
Returns a copy of this EdgeMetrics object. | EdgeMetrics | ||
Indicates whether an object has a specified property defined. | Object | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object |
Constant | Defined By | ||
---|---|---|---|
EMPTY : EdgeMetrics [static]
An EdgeMetrics object with a value of zero for its
left, top, right,
and bottom properties. | EdgeMetrics |
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.
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.
Parametersleft: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.
|
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.
ReturnsEdgeMetrics — A copy of this EdgeMetrics object.
|
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.
Mon Nov 28 2011, 06:48 AM -08:00