Packageorg.purepdf.elements
Classpublic class HeaderFooter
InheritanceHeaderFooter Inheritance RectangleElement Inheritance Object



Public Properties
 PropertyDefined By
  alignment : int
HeaderFooter
 InheritedbackgroundColor : RGBColor
RectangleElement
 Inheritedborder : int
RectangleElement
 InheritedborderColor : RGBColor
RectangleElement
 InheritedborderColorBottom : RGBColor
RectangleElement
 InheritedborderColorLeft : RGBColor
RectangleElement
 InheritedborderColorRight : RGBColor
RectangleElement
 InheritedborderColorTop : RGBColor
RectangleElement
 InheritedborderSides : int
[write-only] Enables/Disables the border on the specified sides.
RectangleElement
 InheritedborderWidth : Number
RectangleElement
 InheritedborderWidthBottom : Number
RectangleElement
 InheritedborderWidthLeft : Number
RectangleElement
 InheritedborderWidthRight : Number
RectangleElement
 InheritedborderWidthTop : Number
RectangleElement
 InheritedgrayFill : Number
RectangleElement
 Inheritedheight : Number
[read-only]
RectangleElement
 InheritedisContent : Boolean
[read-only]
RectangleElement
 InheritedisNestable : Boolean
[read-only]
RectangleElement
  numbered : Boolean
[read-only]
HeaderFooter
  pageNumber : int
HeaderFooter
  paragraph : Paragraph
[read-only]
HeaderFooter
 Inheritedrotation : int
[read-only]
RectangleElement
 Inheritedtype : int
[read-only]
RectangleElement
 InheriteduseVariableBorders : Boolean
[read-only]
RectangleElement
 Inheritedwidth : Number
[read-only]
RectangleElement
Protected Properties
 PropertyDefined By
 Inherited_backgroundColor : RGBColor = null
RectangleElement
 Inherited_border : int = -1
RectangleElement
 Inherited_borderColor : RGBColor = null
RectangleElement
 Inherited_borderColorBottom : RGBColor = null
RectangleElement
 Inherited_borderColorLeft : RGBColor = null
RectangleElement
 Inherited_borderColorRight : RGBColor = null
RectangleElement
 Inherited_borderColorTop : RGBColor = null
RectangleElement
 Inherited_borderWidth : Number = -1
RectangleElement
 Inherited_borderWidthBottom : Number = -1
RectangleElement
 Inherited_borderWidthLeft : Number = -1
RectangleElement
 Inherited_borderWidthRight : Number = -1
RectangleElement
 Inherited_borderWidthTop : Number = -1
RectangleElement
 Inheritedllx : Number
RectangleElement
 Inheritedlly : Number
RectangleElement
 Inherited_rotation : int = 0
RectangleElement
 Inheritedurx : Number
RectangleElement
 Inheritedury : Number
RectangleElement
 Inherited_useVariableBorders : Boolean = false
RectangleElement
Public Methods
 MethodDefined By
  
HeaderFooter(before:Phrase, after:Phrase = null, numbered:Boolean = true)
Header/Footer If both before and after are passed then numbered is forced to true
HeaderFooter
 Inherited
[static]
RectangleElement
 Inherited
RectangleElement
 Inherited
disableBorderSide(side:int):void
RectangleElement
 Inherited
enableBorderSide(side:int):void
RectangleElement
 Inherited
getBottom(margin:Number = 0):Number
RectangleElement
 Inherited
getChunks():Vector.<Object>
RectangleElement
 Inherited
getLeft(margin:Number = 0):Number
RectangleElement
 Inherited
getRight(margin:Number = 0):Number
RectangleElement
 Inherited
getTop(margin:Number = 0):Number
RectangleElement
 Inherited
hasBorder(borderType:int):Boolean
RectangleElement
 Inherited
hasBorders():Boolean
RectangleElement
 Inherited
normalize():void
Normalizes the rectangle.
RectangleElement
 Inherited
process(listener:IElementListener):Boolean
RectangleElement
 Inherited
rectangle(top:Number, bottom:Number):RectangleElement
RectangleElement
 Inherited
rotate(value:uint = 90):RectangleElement
Return a new rotated RectangleElement ( rotation of the current rectangle plus the value passed )
RectangleElement
 Inherited
setBottom($lly:Number):void
RectangleElement
 Inherited
setLeft($llx:Number):void
RectangleElement
 Inherited
setRight($urx:Number):void
RectangleElement
 Inherited
setTop($ury:Number):void
RectangleElement
 Inherited
Copies each of the parameters, except the position
RectangleElement
 Inherited
toString():String
RectangleElement
Public Constants
 ConstantDefined By
 InheritedALL : int
[static]
RectangleElement
 InheritedBOTTOM : int = 2
[static]
RectangleElement
 InheritedBOX : int = 15.0
[static]
RectangleElement
 InheritedLEFT : int = 4
[static]
RectangleElement
 InheritedNO_BORDER : int = 0
[static]
RectangleElement
 InheritedRIGHT : int = 8
[static]
RectangleElement
 InheritedTOP : int = 1
[static]
RectangleElement
 InheritedUNDEFINED : int = -1
[static]
RectangleElement
Property Detail
alignmentproperty
alignment:int


Implementation
    public function get alignment():int
    public function set alignment(value:int):void
numberedproperty 
numbered:Boolean  [read-only]


Implementation
    public function get numbered():Boolean
pageNumberproperty 
pageNumber:int


Implementation
    public function get pageNumber():int
    public function set pageNumber(value:int):void
paragraphproperty 
paragraph:Paragraph  [read-only]


Implementation
    public function get paragraph():Paragraph
Constructor Detail
HeaderFooter()Constructor
public function HeaderFooter(before:Phrase, after:Phrase = null, numbered:Boolean = true)

Header/Footer If both before and after are passed then numbered is forced to true

Parameters
before:Phrase
 
after:Phrase (default = null)
 
numbered:Boolean (default = true)

Throws
AssertionError