Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
EdgeMetrics

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 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.

See also

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

Public Properties

| Property | Defined By
--- | --- | ---
|  | bottom : Number The height, in pixels, of the bottom edge region. | EdgeMetrics
|  | 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

| Method | Defined 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

Public Constants

| Constant | Defined 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.

Sun Mar 5 2017, 03:42 PM +11:00