Packagelunas.core
Classpublic class EdgeMetrics
ImplementsGeometry

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



Public Properties
 PropertyDefined 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
 MethodDefined by
  
EdgeMetrics(left:Number = 0, top:Number = 0, right:Number = 0, bottom:Number = 0)
Creates a new EdgeMetrics instance.
EdgeMetrics
  
clone():*
Returns a shallow copy of this instance.
EdgeMetrics
  
equals(o:*):Boolean
Compares the specified object with this object for equality.
EdgeMetrics
  
filterNaNValue(value:Number, defaultValue:Number = 0):Number
[static] Filters the passed-in Number value, if the value is NaN the return value is the default value in second argument.
EdgeMetrics
  
toObject():Object
Returns the Object representation of this object.
EdgeMetrics
  
toSource(indent:int = 0):String
Returns the source code string representation of the object.
EdgeMetrics
  
toString():String
Returns the string representation of the object.
EdgeMetrics
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
bottomproperty
public var bottom:Number

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

leftproperty 
public var left:Number

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

rightproperty 
public var right:Number

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

topproperty 
public var top:Number

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)

Creates a new EdgeMetrics instance.

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():*

Returns a shallow copy of this instance.

Returns
* — a shallow copy of this instance.
equals()method 
public function equals(o:*):Boolean

Compares the specified object with this object for equality.

Parameters
o:*

Returns
Booleantrue if the the specified object is equal with this object.
filterNaNValue()method 
public static function filterNaNValue(value:Number, defaultValue:Number = 0):Number

Filters the passed-in Number value, if the value is NaN the return value is the default value in second argument.

Parameters
value:Number — The Number value to filter, if this value is NaN the value is changed.
 
defaultValue:Number (default = 0) — The default value to apply over the specified value if this value is NaN (default 0).

Returns
Number — The filter Number value.
toObject()method 
public function toObject():Object

Returns the Object representation of this object.

Returns
Object — the Object representation of this object.
toSource()method 
public function toSource(indent:int = 0):String

Returns the source code string representation of the object.

Parameters
indent:int (default = 0)

Returns
String — the source code string representation of the object.
toString()method 
public function toString():String

Returns the string representation of the object.

Returns
String — the string representation of the object.
Constant detail
EMPTYconstant
public static const EMPTY:EdgeMetrics

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