Packageorg.purepdf.pdf
Classpublic class PdfPTable
InheritancePdfPTable Inheritance Object
Implements ILargeElement

This is a table that can be put at an absolute position but can also be added to the document as the class Table.



Public Properties
 PropertyDefined By
  absoluteWidths : Vector.<Number>
[read-only]
PdfPTable
  columnsCount : int
[read-only]
PdfPTable
  complete : Boolean
PdfPTable
  defaultCell : PdfPCell
[read-only]
PdfPTable
  extendLastRow : Boolean
PdfPTable
  footerHeight : Number
[read-only]
PdfPTable
  footerRows : int
PdfPTable
  headerHeight : Number
[read-only]
PdfPTable
  headerRows : int
PdfPTable
  headersInEvent : Boolean
PdfPTable
  horizontalAlignment : int
PdfPTable
  isContent : Boolean
[read-only]
PdfPTable
  isNestable : Boolean
[read-only]
PdfPTable
  keepTogether : Boolean
PdfPTable
  lockedWidth : Boolean
PdfPTable
  rows : Vector.<PdfPRow>
PdfPTable
  runDirection : int
[read-only]
PdfPTable
  RunDirection : int
[write-only]
PdfPTable
  size : int
[read-only]
PdfPTable
  skipFirstHeader : Boolean
PdfPTable
  skipLastFooter : Boolean
PdfPTable
  spacingAfter : Number
PdfPTable
  spacingBefore : Number
PdfPTable
  splitLate : Boolean
PdfPTable
  splitRows : Boolean
PdfPTable
  tableEvent : IPdfPTableEvent
PdfPTable
  totalHeight : Number
[read-only]
PdfPTable
  totalWidth : Number
PdfPTable
  type : int
[read-only]
PdfPTable
  widthPercentage : Number
PdfPTable
Protected Properties
 PropertyDefined By
  _absoluteWidths : Vector.<Number>
PdfPTable
  _complete : Boolean = true
PdfPTable
  currentRow : Vector.<PdfPCell>
PdfPTable
  currentRowIdx : int = 0
PdfPTable
  _defaultCell : PdfPCell
PdfPTable
  _headerRows : int = 0
PdfPTable
  isColspan : Boolean = false
PdfPTable
  relativeWidths : Vector.<Number>
PdfPTable
  rowCompleted : Boolean = true
PdfPTable
  _rows : Vector.<PdfPRow>
PdfPTable
  _runDirection : int = 0
PdfPTable
  _spacingAfter : Number = 0
PdfPTable
  _spacingBefore : Number = 0
PdfPTable
  _totalHeight : Number = 0
PdfPTable
  _totalWidth : Number = 0
PdfPTable
  _widthPercentage : Number = 80
PdfPTable
Public Methods
 MethodDefined By
  
PdfPTable(obj:Object = null)
Create a PdfPTable init constructor must be one of the following: Number, PdfPTable, Vector.<Number>
PdfPTable
  
addCell(cell:PdfPCell):void
PdfPTable
  
PdfPTable
  
addPhraseCell(phrase:Phrase):void
PdfPTable
  
addStringCell(text:String):void
PdfPTable
  
PdfPTable
  
[static]
PdfPTable
  
calculateHeights(firsttime:Boolean):Number
PdfPTable
  
PdfPTable
  
PdfPTable
  
PdfPTable
  
deleteLastRow():Boolean
PdfPTable
  
deleteRow(rowNumber:int):Boolean
PdfPTable
  
endWritingRows(canvases:Vector.<PdfContentByte>):void
[static]
PdfPTable
  
PdfPTable
  
getChunks():Vector.<Object>
PdfPTable
  
getRow(idx:int):PdfPRow
PdfPTable
  
getRowHeight(idx:int):Number
PdfPTable
  
getRowHeight1(idx:int, firsttime:Boolean):Number
PdfPTable
  
getRows(start:int, end:int):Vector.<PdfPRow>
PdfPTable
  
getRowspanHeight(rowIndex:int, cellIndex:int):Number
PdfPTable
  
isExtendLastRow(newPageFollows:Boolean):Boolean
PdfPTable
  
process(listener:IElementListener):Boolean
PdfPTable
  
rowSpanAbove(currRow:int, currCol:int):Boolean
Checks if there are rows above belonging to a rowspan
PdfPTable
  
setExtendLastRow(value1:Boolean, value2:Boolean):void
PdfPTable
  
setIntWidths(relativeWidths:Vector.<int>):void
PdfPTable
  
setNumberWidths($relativeWidths:Vector.<Number>):void
PdfPTable
  
setTotalWidths(value:Vector.<Number>):void
PdfPTable
  
setWidthPercentageAndSize(columnWidth:Vector.<Number>, pageSize:RectangleElement):void
PdfPTable
  
[static]
PdfPTable
  
toString():String
PdfPTable
  
writeSelectedRows(rowStart:int, rowEnd:int, xPos:Number, yPos:Number, canvases:Vector.<PdfContentByte>):Number
PdfPTable
  
writeSelectedRows1(colStart:int, colEnd:int, rowStart:int, rowEnd:int, xPos:Number, yPos:Number, canvases:Vector.<PdfContentByte>):Number
PdfPTable
  
writeSelectedRows2(rowStart:int, rowEnd:int, xPos:Number, yPos:Number, canvas:PdfContentByte):Number
PdfPTable
  
writeSelectedRows3(colStart:int, colEnd:int, rowStart:int, rowEnd:int, xPos:Number, yPos:Number, canvas:PdfContentByte):Number
PdfPTable
Protected Methods
 MethodDefined By
  
adjustCellsInRow(start:int, end:int):PdfPRow
PdfPTable
  
PdfPTable
  
copyFormat(sourceTable:PdfPTable):void
PdfPTable
Public Constants
 ConstantDefined By
  BACKGROUNDCANVAS : int = 1
[static]
PdfPTable
  BASECANVAS : int = 0
[static]
PdfPTable
  LINECANVAS : int = 2
[static]
PdfPTable
  TEXTCANVAS : int = 3
[static]
PdfPTable
Property Detail
_absoluteWidthsproperty
protected var _absoluteWidths:Vector.<Number>

_completeproperty 
protected var _complete:Boolean = true

_defaultCellproperty 
protected var _defaultCell:PdfPCell

_headerRowsproperty 
protected var _headerRows:int = 0

_rowsproperty 
protected var _rows:Vector.<PdfPRow>

_runDirectionproperty 
protected var _runDirection:int = 0

_spacingAfterproperty 
protected var _spacingAfter:Number = 0

_spacingBeforeproperty 
protected var _spacingBefore:Number = 0

_totalHeightproperty 
protected var _totalHeight:Number = 0

_totalWidthproperty 
protected var _totalWidth:Number = 0

_widthPercentageproperty 
protected var _widthPercentage:Number = 80

absoluteWidthsproperty 
absoluteWidths:Vector.<Number>  [read-only]


Implementation
    public function get absoluteWidths():Vector.<Number>
columnsCountproperty 
columnsCount:int  [read-only]


Implementation
    public function get columnsCount():int
completeproperty 
complete:Boolean


Implementation
    public function get complete():Boolean
    public function set complete(value:Boolean):void
currentRowproperty 
protected var currentRow:Vector.<PdfPCell>

currentRowIdxproperty 
protected var currentRowIdx:int = 0

defaultCellproperty 
defaultCell:PdfPCell  [read-only]


Implementation
    public function get defaultCell():PdfPCell
extendLastRowproperty 
extendLastRow:Boolean


Implementation
    public function get extendLastRow():Boolean
    public function set extendLastRow(value:Boolean):void
footerHeightproperty 
footerHeight:Number  [read-only]


Implementation
    public function get footerHeight():Number
footerRowsproperty 
footerRows:int


Implementation
    public function get footerRows():int
    public function set footerRows(value:int):void
headerHeightproperty 
headerHeight:Number  [read-only]


Implementation
    public function get headerHeight():Number
headerRowsproperty 
headerRows:int


Implementation
    public function get headerRows():int
    public function set headerRows(value:int):void
headersInEventproperty 
headersInEvent:Boolean


Implementation
    public function get headersInEvent():Boolean
    public function set headersInEvent(value:Boolean):void
horizontalAlignmentproperty 
horizontalAlignment:int


Implementation
    public function get horizontalAlignment():int
    public function set horizontalAlignment(value:int):void
isColspanproperty 
protected var isColspan:Boolean = false

isContentproperty 
isContent:Boolean  [read-only]


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


Implementation
    public function get isNestable():Boolean
keepTogetherproperty 
keepTogether:Boolean


Implementation
    public function get keepTogether():Boolean
    public function set keepTogether(value:Boolean):void
lockedWidthproperty 
lockedWidth:Boolean


Implementation
    public function get lockedWidth():Boolean
    public function set lockedWidth(value:Boolean):void
relativeWidthsproperty 
protected var relativeWidths:Vector.<Number>

rowCompletedproperty 
protected var rowCompleted:Boolean = true

rowsproperty 
rows:Vector.<PdfPRow>


Implementation
    public function get rows():Vector.<PdfPRow>
    public function set rows(value:Vector.<PdfPRow>):void
runDirectionproperty 
runDirection:int  [read-only]


Implementation
    public function get runDirection():int
RunDirectionproperty 
RunDirection:int  [write-only]


Implementation
    public function set RunDirection(value:int):void
sizeproperty 
size:int  [read-only]


Implementation
    public function get size():int
skipFirstHeaderproperty 
skipFirstHeader:Boolean


Implementation
    public function get skipFirstHeader():Boolean
    public function set skipFirstHeader(value:Boolean):void
skipLastFooterproperty 
skipLastFooter:Boolean


Implementation
    public function get skipLastFooter():Boolean
    public function set skipLastFooter(value:Boolean):void
spacingAfterproperty 
spacingAfter:Number


Implementation
    public function get spacingAfter():Number
    public function set spacingAfter(value:Number):void
spacingBeforeproperty 
spacingBefore:Number


Implementation
    public function get spacingBefore():Number
    public function set spacingBefore(value:Number):void
splitLateproperty 
splitLate:Boolean


Implementation
    public function get splitLate():Boolean
    public function set splitLate(value:Boolean):void
splitRowsproperty 
splitRows:Boolean


Implementation
    public function get splitRows():Boolean
    public function set splitRows(value:Boolean):void
tableEventproperty 
tableEvent:IPdfPTableEvent


Implementation
    public function get tableEvent():IPdfPTableEvent
    public function set tableEvent(value:IPdfPTableEvent):void
totalHeightproperty 
totalHeight:Number  [read-only]


Implementation
    public function get totalHeight():Number
totalWidthproperty 
totalWidth:Number


Implementation
    public function get totalWidth():Number
    public function set totalWidth(value:Number):void
typeproperty 
type:int  [read-only]


Implementation
    public function get type():int
widthPercentageproperty 
widthPercentage:Number


Implementation
    public function get widthPercentage():Number
    public function set widthPercentage(value:Number):void
Constructor Detail
PdfPTable()Constructor
public function PdfPTable(obj:Object = null)

Create a PdfPTable init constructor must be one of the following: Number, PdfPTable, Vector.<Number>

Parameters
obj:Object (default = null)
Method Detail
addCell()method
public function addCell(cell:PdfPCell):void

Parameters

cell:PdfPCell

addImageCell()method 
public function addImageCell(image:ImageElement):void

Parameters

image:ImageElement

addPhraseCell()method 
public function addPhraseCell(phrase:Phrase):void

Parameters

phrase:Phrase

addStringCell()method 
public function addStringCell(text:String):void

Parameters

text:String

addTableCell()method 
public function addTableCell(table:PdfPTable):void

Parameters

table:PdfPTable

adjustCellsInRow()method 
protected function adjustCellsInRow(start:int, end:int):PdfPRow

Parameters

start:int
 
end:int

Returns
PdfPRow
beginWritingRows()method 
public static function beginWritingRows(canvas:PdfContentByte):Vector.<PdfContentByte>

Parameters

canvas:PdfContentByte

Returns
Vector.<PdfContentByte>
calculateHeights()method 
public function calculateHeights(firsttime:Boolean):Number

Parameters

firsttime:Boolean

Returns
Number
calculateHeightsFast()method 
public function calculateHeightsFast():void

calculateWidths()method 
protected function calculateWidths():void

completeRow()method 
public function completeRow():void

copyFormat()method 
protected function copyFormat(sourceTable:PdfPTable):void

Parameters

sourceTable:PdfPTable

deleteBodyRows()method 
public function deleteBodyRows():void

deleteLastRow()method 
public function deleteLastRow():Boolean

Returns
Boolean
deleteRow()method 
public function deleteRow(rowNumber:int):Boolean

Parameters

rowNumber:int

Returns
Boolean
endWritingRows()method 
public static function endWritingRows(canvases:Vector.<PdfContentByte>):void

Parameters

canvases:Vector.<PdfContentByte>

flushContent()method 
public function flushContent():void

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

Returns
Vector.<Object>
getRow()method 
public function getRow(idx:int):PdfPRow

Parameters

idx:int

Returns
PdfPRow
getRowHeight()method 
public function getRowHeight(idx:int):Number

Parameters

idx:int

Returns
Number
getRowHeight1()method 
public function getRowHeight1(idx:int, firsttime:Boolean):Number

Parameters

idx:int
 
firsttime:Boolean

Returns
Number
getRows()method 
public function getRows(start:int, end:int):Vector.<PdfPRow>

Parameters

start:int
 
end:int

Returns
Vector.<PdfPRow>
getRowspanHeight()method 
public function getRowspanHeight(rowIndex:int, cellIndex:int):Number

Parameters

rowIndex:int
 
cellIndex:int

Returns
Number
isExtendLastRow()method 
public function isExtendLastRow(newPageFollows:Boolean):Boolean

Parameters

newPageFollows:Boolean

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

Parameters

listener:IElementListener

Returns
Boolean
rowSpanAbove()method 
public function rowSpanAbove(currRow:int, currCol:int):Boolean

Checks if there are rows above belonging to a rowspan

Parameters

currRow:int
 
currCol:int

Returns
Boolean
setExtendLastRow()method 
public function setExtendLastRow(value1:Boolean, value2:Boolean):void

Parameters

value1:Boolean
 
value2:Boolean

setIntWidths()method 
public function setIntWidths(relativeWidths:Vector.<int>):void

Parameters

relativeWidths:Vector.<int>


Throws
DocumentError
setNumberWidths()method 
public function setNumberWidths($relativeWidths:Vector.<Number>):void

Parameters

$relativeWidths:Vector.<Number>


Throws
DocumentError
setTotalWidths()method 
public function setTotalWidths(value:Vector.<Number>):void

Parameters

value:Vector.<Number>


Throws
DocumentError
setWidthPercentageAndSize()method 
public function setWidthPercentageAndSize(columnWidth:Vector.<Number>, pageSize:RectangleElement):void

Parameters

columnWidth:Vector.<Number>
 
pageSize:RectangleElement


Throws
DocumentError
shallowCopy()method 
public static function shallowCopy(table:PdfPTable):PdfPTable

Parameters

table:PdfPTable

Returns
PdfPTable
toString()method 
public function toString():String

Returns
String
writeSelectedRows()method 
public function writeSelectedRows(rowStart:int, rowEnd:int, xPos:Number, yPos:Number, canvases:Vector.<PdfContentByte>):Number

Parameters

rowStart:int
 
rowEnd:int
 
xPos:Number
 
yPos:Number
 
canvases:Vector.<PdfContentByte>

Returns
Number
writeSelectedRows1()method 
public function writeSelectedRows1(colStart:int, colEnd:int, rowStart:int, rowEnd:int, xPos:Number, yPos:Number, canvases:Vector.<PdfContentByte>):Number

Parameters

colStart:int
 
colEnd:int
 
rowStart:int
 
rowEnd:int
 
xPos:Number
 
yPos:Number
 
canvases:Vector.<PdfContentByte>

Returns
Number

Throws
RuntimeError
writeSelectedRows2()method 
public function writeSelectedRows2(rowStart:int, rowEnd:int, xPos:Number, yPos:Number, canvas:PdfContentByte):Number

Parameters

rowStart:int
 
rowEnd:int
 
xPos:Number
 
yPos:Number
 
canvas:PdfContentByte

Returns
Number
writeSelectedRows3()method 
public function writeSelectedRows3(colStart:int, colEnd:int, rowStart:int, rowEnd:int, xPos:Number, yPos:Number, canvas:PdfContentByte):Number

Parameters

colStart:int
 
colEnd:int
 
rowStart:int
 
rowEnd:int
 
xPos:Number
 
yPos:Number
 
canvas:PdfContentByte

Returns
Number
Constant Detail
BACKGROUNDCANVASConstant
public static const BACKGROUNDCANVAS:int = 1

BASECANVASConstant 
public static const BASECANVAS:int = 0

LINECANVASConstant 
public static const LINECANVAS:int = 2

TEXTCANVASConstant 
public static const TEXTCANVAS:int = 3