Packageorg.alivepdf.layout
Classpublic final class Size

Represents the size of the printed page.


Public Properties
 PropertyDefined by
  A3 : Size
[static] Constants representing the various paper sizes.
Size
  A4 : Size
[static]
Size
  A5 : Size
[static]
Size
  dimensions : Array
The dimensions used by the PDF engine to determine page extents.
Size
  fullLabel : String
[read-only]
Size
  inchesSize : Array
The dimensions, in inches.
Size
  label : String = ""
A friendly label for users.
Size
  LEGAL : Size
[static]
Size
  LETTER : Size
[static]
Size
  mmSize : Array
The dimensions, in mm.
Size
  sizes : Array
[static] An array containing all the available paper sizes.
Size
  TABLOID : Size
[static]
Size
Public Methods
 MethodDefined by
  
Size(pPixelsSize:Array, pLabel:String, pInchesSize:Array, pMmSize:Array)
Size
  
getSize(value:Object):Size
[static] Given a String representing the label of a size, or a Size object, this returns the Size object that corresponds to it.
Size
Property detail
A3property
public static var A3:Size

Constants representing the various paper sizes.

A4property 
public static var A4:Size
A5property 
public static var A5:Size
dimensionsproperty 
public var dimensions:Array

The dimensions used by the PDF engine to determine page extents.

fullLabelproperty 
fullLabel:String  [read-only]Implementation
    public function get fullLabel():String
inchesSizeproperty 
public var inchesSize:Array

The dimensions, in inches. This should be used for a friendly display for users and not in dimension calculations.

labelproperty 
public var label:String = ""

A friendly label for users.

LEGALproperty 
public static var LEGAL:Size
LETTERproperty 
public static var LETTER:Size
mmSizeproperty 
public var mmSize:Array

The dimensions, in mm. This should be used for a friendly display for users and not in dimension calculations.

sizesproperty 
public static var sizes:Array

An array containing all the available paper sizes.

TABLOIDproperty 
public static var TABLOID:Size
Constructor detail
Size()constructor
public function Size(pPixelsSize:Array, pLabel:String, pInchesSize:Array, pMmSize:Array)Parameters
pPixelsSize:Array
 
pLabel:String
 
pInchesSize:Array
 
pMmSize:Array
Method detail
getSize()method
public static function getSize(value:Object):Size

Given a String representing the label of a size, or a Size object, this returns the Size object that corresponds to it. Returns null on invalid size.

Parameters
value:Object

Returns
Size



Thibault Imbert - AlivePDF 0.1.4 Documentation - http://www.alivepdf.org/