Package | org.purepdf.elements |
Class | public class RectangleElement |
Inheritance | RectangleElement Object |
Implements | IElement |
Subclasses | HeaderFooter, ImageElement, PdfPCell, ReadOnlyRectangle, SimpleCell, SimpleTable |
Property | Defined 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 |
Property | Defined 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 |
Method | Defined By | ||
---|---|---|---|
RectangleElement($llx:Number, $lly:Number, $urx:Number, $ury:Number) | RectangleElement | ||
[static] | RectangleElement | ||
cloneNonPositionParameters(rect:RectangleElement):void | 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 | ||
softCloneNonPositionParameters(rect:RectangleElement):void
Copies each of the parameters, except the position
| RectangleElement | ||
toString():String | RectangleElement |
Constant | Defined 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 |
_backgroundColor | property |
protected var _backgroundColor:RGBColor = null
_border | property |
protected var _border:int = -1
_borderColor | property |
protected var _borderColor:RGBColor = null
_borderColorBottom | property |
protected var _borderColorBottom:RGBColor = null
_borderColorLeft | property |
protected var _borderColorLeft:RGBColor = null
_borderColorRight | property |
protected var _borderColorRight:RGBColor = null
_borderColorTop | property |
protected var _borderColorTop:RGBColor = null
_borderWidth | property |
protected var _borderWidth:Number = -1
_borderWidthBottom | property |
protected var _borderWidthBottom:Number = -1
_borderWidthLeft | property |
protected var _borderWidthLeft:Number = -1
_borderWidthRight | property |
protected var _borderWidthRight:Number = -1
_borderWidthTop | property |
protected var _borderWidthTop:Number = -1
_rotation | property |
protected var _rotation:int = 0
_useVariableBorders | property |
protected var _useVariableBorders:Boolean = false
backgroundColor | property |
backgroundColor:RGBColor
public function get backgroundColor():RGBColor
public function set backgroundColor(value:RGBColor):void
border | property |
border:int
public function get border():int
public function set border(value:int):void
borderColor | property |
borderColor:RGBColor
public function get borderColor():RGBColor
public function set borderColor(value:RGBColor):void
borderColorBottom | property |
borderColorBottom:RGBColor
public function get borderColorBottom():RGBColor
public function set borderColorBottom(value:RGBColor):void
borderColorLeft | property |
borderColorLeft:RGBColor
public function get borderColorLeft():RGBColor
public function set borderColorLeft(value:RGBColor):void
borderColorRight | property |
borderColorRight:RGBColor
public function get borderColorRight():RGBColor
public function set borderColorRight(value:RGBColor):void
borderColorTop | property |
borderColorTop:RGBColor
public function get borderColorTop():RGBColor
public function set borderColorTop(value:RGBColor):void
borderSides | property |
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;
public function set borderSides(value:int):void
See also
borderWidth | property |
borderWidth:Number
public function get borderWidth():Number
public function set borderWidth(value:Number):void
borderWidthBottom | property |
borderWidthBottom:Number
public function get borderWidthBottom():Number
public function set borderWidthBottom(value:Number):void
borderWidthLeft | property |
borderWidthLeft:Number
public function get borderWidthLeft():Number
public function set borderWidthLeft(value:Number):void
borderWidthRight | property |
borderWidthRight:Number
public function get borderWidthRight():Number
public function set borderWidthRight(value:Number):void
borderWidthTop | property |
borderWidthTop:Number
public function get borderWidthTop():Number
public function set borderWidthTop(value:Number):void
grayFill | property |
grayFill:Number
public function get grayFill():Number
public function set grayFill(value:Number):void
height | property |
height:Number
[read-only] public function get height():Number
isContent | property |
isContent:Boolean
[read-only] public function get isContent():Boolean
isNestable | property |
isNestable:Boolean
[read-only] public function get isNestable():Boolean
llx | property |
protected var llx:Number
lly | property |
protected var lly:Number
rotation | property |
rotation:int
[read-only] public function get rotation():int
type | property |
type:int
[read-only] public function get type():int
urx | property |
protected var urx:Number
ury | property |
protected var ury:Number
useVariableBorders | property |
useVariableBorders:Boolean
[read-only] public function get useVariableBorders():Boolean
width | property |
width:Number
[read-only] public function get width():Number
RectangleElement | () | Constructor |
public function RectangleElement($llx:Number, $lly:Number, $urx:Number, $ury:Number)
$llx:Number | |
$lly:Number | |
$urx:Number | |
$ury:Number |
clone | () | method |
public static function clone(other:RectangleElement):RectangleElement
Parameters
other:RectangleElement |
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 )
|
Number |
getChunks | () | method |
public function getChunks():Vector.<Object>
ReturnsVector.<Object> |
getLeft | () | method |
public function getLeft(margin:Number = 0):Number
Parameters
margin:Number (default = 0 )
|
Number |
getRight | () | method |
public function getRight(margin:Number = 0):Number
Parameters
margin:Number (default = 0 )
|
Number |
getTop | () | method |
public function getTop(margin:Number = 0):Number
Parameters
margin:Number (default = 0 )
|
Number |
hasBorder | () | method |
public function hasBorder(borderType:int):Boolean
Parameters
borderType:int |
Boolean |
hasBorders | () | method |
public function hasBorders():Boolean
ReturnsBoolean |
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 |
Boolean |
rectangle | () | method |
public function rectangle(top:Number, bottom:Number):RectangleElement
Parameters
top:Number | |
bottom:Number |
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 )
|
RectangleElement — the rotated RectangleElement
|
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
ReturnsString |
ALL | Constant |
public static const ALL:int
BOTTOM | Constant |
public static const BOTTOM:int = 2
BOX | Constant |
public static const BOX:int = 15.0
LEFT | Constant |
public static const LEFT:int = 4
NO_BORDER | Constant |
public static const NO_BORDER:int = 0
RIGHT | Constant |
public static const RIGHT:int = 8
TOP | Constant |
public static const TOP:int = 1
UNDEFINED | Constant |
public static const UNDEFINED:int = -1