Packageorg.purepdf.elements
Classpublic class RectangleElement
InheritanceRectangleElement Inheritance Object
Implements IElement
Subclasses HeaderFooter, ImageElement, PdfPCell, ReadOnlyRectangle, SimpleCell, SimpleTable



Public Properties
 PropertyDefined By
  backgroundColor : RGBColor
RectangleElement
  border : int
RectangleElement
  borderColor : RGBColor
RectangleElement
  borderColorBottom : RGBColor
RectangleElement
  borderColorLeft : RGBColor
RectangleElement
  borderColorRight : RGBColor
RectangleElement
  borderColorTop : RGBColor
RectangleElement
  borderSides : int
[write-only] Enables/Disables the border on the specified sides.
RectangleElement
  borderWidth : Number
RectangleElement
  borderWidthBottom : Number
RectangleElement
  borderWidthLeft : Number
RectangleElement
  borderWidthRight : Number
RectangleElement
  borderWidthTop : Number
RectangleElement
  grayFill : Number
RectangleElement
  height : Number
[read-only]
RectangleElement
  isContent : Boolean
[read-only]
RectangleElement
  isNestable : Boolean
[read-only]
RectangleElement
  rotation : int
[read-only]
RectangleElement
  type : int
[read-only]
RectangleElement
  useVariableBorders : Boolean
[read-only]
RectangleElement
  width : Number
[read-only]
RectangleElement
Protected Properties
 PropertyDefined By
  _backgroundColor : RGBColor = null
RectangleElement
  _border : int = -1
RectangleElement
  _borderColor : RGBColor = null
RectangleElement
  _borderColorBottom : RGBColor = null
RectangleElement
  _borderColorLeft : RGBColor = null
RectangleElement
  _borderColorRight : RGBColor = null
RectangleElement
  _borderColorTop : RGBColor = null
RectangleElement
  _borderWidth : Number = -1
RectangleElement
  _borderWidthBottom : Number = -1
RectangleElement
  _borderWidthLeft : Number = -1
RectangleElement
  _borderWidthRight : Number = -1
RectangleElement
  _borderWidthTop : Number = -1
RectangleElement
  llx : Number
RectangleElement
  lly : Number
RectangleElement
  _rotation : int = 0
RectangleElement
  urx : Number
RectangleElement
  ury : Number
RectangleElement
  _useVariableBorders : Boolean = false
RectangleElement
Public Methods
 MethodDefined By
  
RectangleElement($llx:Number, $lly:Number, $urx:Number, $ury:Number)
RectangleElement
  
[static]
RectangleElement
  
RectangleElement
  
disableBorderSide(side:int):void
RectangleElement
  
enableBorderSide(side:int):void
RectangleElement
  
getBottom(margin:Number = 0):Number
RectangleElement
  
getChunks():Vector.<Object>
RectangleElement
  
getLeft(margin:Number = 0):Number
RectangleElement
  
getRight(margin:Number = 0):Number
RectangleElement
  
getTop(margin:Number = 0):Number
RectangleElement
  
hasBorder(borderType:int):Boolean
RectangleElement
  
hasBorders():Boolean
RectangleElement
  
normalize():void
Normalizes the rectangle.
RectangleElement
  
process(listener:IElementListener):Boolean
RectangleElement
  
rectangle(top:Number, bottom:Number):RectangleElement
RectangleElement
  
rotate(value:uint = 90):RectangleElement
Return a new rotated RectangleElement ( rotation of the current rectangle plus the value passed )
RectangleElement
  
setBottom($lly:Number):void
RectangleElement
  
setLeft($llx:Number):void
RectangleElement
  
setRight($urx:Number):void
RectangleElement
  
setTop($ury:Number):void
RectangleElement
  
Copies each of the parameters, except the position
RectangleElement
  
toString():String
RectangleElement
Public Constants
 ConstantDefined By
  ALL : int
[static]
RectangleElement
  BOTTOM : int = 2
[static]
RectangleElement
  BOX : int = 15.0
[static]
RectangleElement
  LEFT : int = 4
[static]
RectangleElement
  NO_BORDER : int = 0
[static]
RectangleElement
  RIGHT : int = 8
[static]
RectangleElement
  TOP : int = 1
[static]
RectangleElement
  UNDEFINED : int = -1
[static]
RectangleElement
Property Detail
_backgroundColorproperty
protected var _backgroundColor:RGBColor = null

_borderproperty 
protected var _border:int = -1

_borderColorproperty 
protected var _borderColor:RGBColor = null

_borderColorBottomproperty 
protected var _borderColorBottom:RGBColor = null

_borderColorLeftproperty 
protected var _borderColorLeft:RGBColor = null

_borderColorRightproperty 
protected var _borderColorRight:RGBColor = null

_borderColorTopproperty 
protected var _borderColorTop:RGBColor = null

_borderWidthproperty 
protected var _borderWidth:Number = -1

_borderWidthBottomproperty 
protected var _borderWidthBottom:Number = -1

_borderWidthLeftproperty 
protected var _borderWidthLeft:Number = -1

_borderWidthRightproperty 
protected var _borderWidthRight:Number = -1

_borderWidthTopproperty 
protected var _borderWidthTop:Number = -1

_rotationproperty 
protected var _rotation:int = 0

_useVariableBordersproperty 
protected var _useVariableBorders:Boolean = false

backgroundColorproperty 
backgroundColor:RGBColor


Implementation
    public function get backgroundColor():RGBColor
    public function set backgroundColor(value:RGBColor):void
borderproperty 
border:int


Implementation
    public function get border():int
    public function set border(value:int):void
borderColorproperty 
borderColor:RGBColor


Implementation
    public function get borderColor():RGBColor
    public function set borderColor(value:RGBColor):void
borderColorBottomproperty 
borderColorBottom:RGBColor


Implementation
    public function get borderColorBottom():RGBColor
    public function set borderColorBottom(value:RGBColor):void
borderColorLeftproperty 
borderColorLeft:RGBColor


Implementation
    public function get borderColorLeft():RGBColor
    public function set borderColorLeft(value:RGBColor):void
borderColorRightproperty 
borderColorRight:RGBColor


Implementation
    public function get borderColorRight():RGBColor
    public function set borderColorRight(value:RGBColor):void
borderColorTopproperty 
borderColorTop:RGBColor


Implementation
    public function get borderColorTop():RGBColor
    public function set borderColorTop(value:RGBColor):void
borderSidesproperty 
borderSides:int  [write-only]

Enables/Disables the border on the specified sides. The border is specified as an integer bitwise combination of the constants: LEFT, RIGHT, TOP, BOTTOM, ALL.

Example:

rect.borderSides = RectangleElement.LEFT | RectangleElement.TOP;


Implementation
    public function set borderSides(value:int):void

See also

borderWidthproperty 
borderWidth:Number


Implementation
    public function get borderWidth():Number
    public function set borderWidth(value:Number):void
borderWidthBottomproperty 
borderWidthBottom:Number


Implementation
    public function get borderWidthBottom():Number
    public function set borderWidthBottom(value:Number):void
borderWidthLeftproperty 
borderWidthLeft:Number


Implementation
    public function get borderWidthLeft():Number
    public function set borderWidthLeft(value:Number):void
borderWidthRightproperty 
borderWidthRight:Number


Implementation
    public function get borderWidthRight():Number
    public function set borderWidthRight(value:Number):void
borderWidthTopproperty 
borderWidthTop:Number


Implementation
    public function get borderWidthTop():Number
    public function set borderWidthTop(value:Number):void
grayFillproperty 
grayFill:Number


Implementation
    public function get grayFill():Number
    public function set grayFill(value:Number):void
heightproperty 
height:Number  [read-only]


Implementation
    public function get height():Number
isContentproperty 
isContent:Boolean  [read-only]


Implementation
    public function get isContent():Boolean
isNestableproperty 
isNestable:Boolean  [read-only]


Implementation
    public function get isNestable():Boolean
llxproperty 
protected var llx:Number

llyproperty 
protected var lly:Number

rotationproperty 
rotation:int  [read-only]


Implementation
    public function get rotation():int
typeproperty 
type:int  [read-only]


Implementation
    public function get type():int
urxproperty 
protected var urx:Number

uryproperty 
protected var ury:Number

useVariableBordersproperty 
useVariableBorders:Boolean  [read-only]


Implementation
    public function get useVariableBorders():Boolean
widthproperty 
width:Number  [read-only]


Implementation
    public function get width():Number
Constructor Detail
RectangleElement()Constructor
public function RectangleElement($llx:Number, $lly:Number, $urx:Number, $ury:Number)



Parameters
$llx:Number
 
$lly:Number
 
$urx:Number
 
$ury:Number
Method Detail
clone()method
public static function clone(other:RectangleElement):RectangleElement

Parameters

other:RectangleElement

Returns
RectangleElement
cloneNonPositionParameters()method 
public function cloneNonPositionParameters(rect:RectangleElement):void

Parameters

rect:RectangleElement

disableBorderSide()method 
public function disableBorderSide(side:int):void

Parameters

side:int

enableBorderSide()method 
public function enableBorderSide(side:int):void

Parameters

side:int

getBottom()method 
public function getBottom(margin:Number = 0):Number

Parameters

margin:Number (default = 0)

Returns
Number
getChunks()method 
public function getChunks():Vector.<Object>

Returns
Vector.<Object>
getLeft()method 
public function getLeft(margin:Number = 0):Number

Parameters

margin:Number (default = 0)

Returns
Number
getRight()method 
public function getRight(margin:Number = 0):Number

Parameters

margin:Number (default = 0)

Returns
Number
getTop()method 
public function getTop(margin:Number = 0):Number

Parameters

margin:Number (default = 0)

Returns
Number
hasBorder()method 
public function hasBorder(borderType:int):Boolean

Parameters

borderType:int

Returns
Boolean
hasBorders()method 
public function hasBorders():Boolean

Returns
Boolean
normalize()method 
public function normalize():void

Normalizes the rectangle. Switches lower left with upper right if necessary.

process()method 
public function process(listener:IElementListener):Boolean

Parameters

listener:IElementListener

Returns
Boolean
rectangle()method 
public function rectangle(top:Number, bottom:Number):RectangleElement

Parameters

top:Number
 
bottom:Number

Returns
RectangleElement
rotate()method 
public function rotate(value:uint = 90):RectangleElement

Return a new rotated RectangleElement ( rotation of the current rectangle plus the value passed )

Parameters

value:uint (default = 90)

Returns
RectangleElement — the rotated RectangleElement

Throws
ArgumentError — if value is not eq to 0, 90, 180, 270
setBottom()method 
public function setBottom($lly:Number):void

Parameters

$lly:Number

setLeft()method 
public function setLeft($llx:Number):void

Parameters

$llx:Number

setRight()method 
public function setRight($urx:Number):void

Parameters

$urx:Number

setTop()method 
public function setTop($ury:Number):void

Parameters

$ury:Number

softCloneNonPositionParameters()method 
public function softCloneNonPositionParameters(rect:RectangleElement):void

Copies each of the parameters, except the position

Parameters

rect:RectangleElement

toString()method 
public function toString():String

Returns
String
Constant Detail
ALLConstant
public static const ALL:int

BOTTOMConstant 
public static const BOTTOM:int = 2

BOXConstant 
public static const BOX:int = 15.0

LEFTConstant 
public static const LEFT:int = 4

NO_BORDERConstant 
public static const NO_BORDER:int = 0

RIGHTConstant 
public static const RIGHT:int = 8

TOPConstant 
public static const TOP:int = 1

UNDEFINEDConstant 
public static const UNDEFINED:int = -1