Package | com.ghostwire.ui.core |
Class | public class uiEdge |
uiEdge
represents the perimeter of a rectangular area and is used to describe
the thickness of edges such as the margin and padding of components.
The properties of an uiEdge
object are read-only.
Do not instantiate an uiEdge
object directly. Always use the getInstance()
static method to retrieve the object.
~ This class is available in Aspire UI Components Lite Edition ~
Property | Defined by | ||
---|---|---|---|
bottom : int [read-only]
The thickness of the bottom edge region, in pixels.
| uiEdge | ||
left : int [read-only]
The thickness of the left edge region, in pixels.
| uiEdge | ||
right : int [read-only]
The thickness of the right edge region, in pixels.
| uiEdge | ||
top : int [read-only]
The thickness of the top edge region, in pixels.
| uiEdge | ||
totalX : int [read-only]
The sum of the
left and right properties. | uiEdge | ||
totalY : int [read-only]
The sum of the
top and bottom properties. | uiEdge |
Method | Defined by | ||
---|---|---|---|
getInstance(id:Object):uiEdge
[static]
Returns a
uiEdge instance that has the properties described in the
id parameter. | uiEdge |
bottom | property |
bottom:int
[read-only]The thickness of the bottom edge region, in pixels.
Implementation public function get bottom():int
left | property |
left:int
[read-only]The thickness of the left edge region, in pixels.
Implementation public function get left():int
right | property |
right:int
[read-only]The thickness of the right edge region, in pixels.
Implementation public function get right():int
top | property |
top:int
[read-only]The thickness of the top edge region, in pixels.
Implementation public function get top():int
totalX | property |
totalX:int
[read-only]
The sum of the left
and right
properties.
public function get totalX():int
totalY | property |
totalY:int
[read-only]
The sum of the top
and bottom
properties.
public function get totalY():int
getInstance | () | method |
public static function getInstance(id:Object):uiEdge
Returns a uiEdge
instance that has the properties described in the
id
parameter.
id:Object — You may specify a positive integer, a comma-delimited string, or an
array of integers. If you specify an integer, you get a uiEdge object
with equal thickness on every side. To specify different values for each side, you
need to use a comma-delimited string or an array. The integers in the array or comma-delimited
string describe the top, right, bottom, and left sides respectively. If you supply two integers,
you set the top/bottom to the first value, and right/left to the second value. If you supply
three values, you set the top to the first value, right/left to the second value and bottom to
the third value.
Example uiEdge.getInstance(2); // 2px for top, right, bottom and left uiEdge.getInstance("2,5"); // 2px for top/bottom, 5px for right/left uiEdge.getInstance([2,5,0]); // 2px for top, 5px for right/left, 0px for bottom uiEdge.getInstance([2,0,1,2]); // 2px for top, 0px for right, 1px for bottom, 2px for left |
uiEdge |