Packageorg.purepdf.elements
Classpublic class Section
InheritanceSection Inheritance Object
Implements ITextElementaryArray, ILargeElement, IIterable
Subclasses Chapter


Public Properties
 PropertyDefined By
  addedCompletely : Boolean
Section
  bookmarkOpen : Boolean
Section
  bookmarkTitle : String
[write-only]
Section
  chapterNumber : uint
[write-only]
Section
  complete : Boolean
Section
  depth : uint
[read-only]
Section
  indentation : Number
Section
  indentationLeft : Number
Section
  indentationRight : Number
Section
  isChapter : Boolean
[read-only]
Section
  isContent : Boolean
[read-only]
Section
  isNestable : Boolean
[read-only]
Section
  isSection : Boolean
[read-only]
Section
  notAddedYet : Boolean
Section
  numberDepth : int
Section
  numbers : Vector.<Number>
[read-only]
Section
  numberStyle : int
Section
  size : uint
[read-only]
Section
  title : Paragraph
Section
  triggerNewPage : Boolean
Section
  type : int
[read-only]
Section
Protected Properties
 PropertyDefined By
  _addedCompletely : Boolean = false
Section
  _bookmarkOpen : Boolean = true
Section
  _bookmarkTitle : String
Section
  _complete : Boolean = true
Section
  _hideNumbers : Boolean
Section
  _indentation : Number = 0
Section
  _indentationLeft : Number = 0
Section
  _indentationRight : Number = 0
Section
  _notAddedYet : Boolean = true
Section
  _numberDepth : int = 0
Section
  _numbers : Vector.<Number> = null
Section
  _numberStyle : int = 0
Section
  subsections : int = 0
Section
  _title : Paragraph
Section
  _triggerNewPage : Boolean = false
Section
Public Methods
 MethodDefined By
  
Section($title:Paragraph, $depth:int = 1)
Section
  
add(o:Object):Boolean
Section
  
addAll(collection:Vector.<IElement>):Boolean
Section
  
addMarkedSection():MarkedSection
Section
  
addSection(title:String):Section
Section
  
addSection1(title:Paragraph):Section
Section
  
addSection2(indentation:Number, title:Paragraph, numberDepth:int):Section
Section
  
addSection3(indentation:Number, title:Paragraph):Section
Section
  
addSection4(title:Paragraph, numberDepth:int):Section
Section
  
addSection5(indentation:Number, title:String, numberDepth:int):Section
Section
  
addSection6(title:String, numberDepth:int):Section
Section
  
addSection7(indentation:Number, title:String):Section
Section
  
constructTitle(title:Paragraph, numbers:Vector.<Number>, numberDepth:int, numberStyle:int):Paragraph
[static]
Section
  
flushContent():void
Section
  
getBookmarkTitle():Paragraph
Section
  
getChunks():Vector.<Object>
Section
  
insert(index:int, o:Object):void
Section
  
iterator():Iterator
Section
  
newPage():void
Section
  
process(listener:IElementListener):Boolean
Section
  
toString():String
Section
Public Constants
 ConstantDefined By
  NUMBERSTYLE_DOTTED : int = 0
[static]
Section
  NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT : int = 1
[static]
Section
  NUMBERSTYLE_NONE : int = -1
[static] hide default number in title
Section
Property Detail
_addedCompletelyproperty
protected var _addedCompletely:Boolean = false

_bookmarkOpenproperty 
protected var _bookmarkOpen:Boolean = true

_bookmarkTitleproperty 
protected var _bookmarkTitle:String

_completeproperty 
protected var _complete:Boolean = true

_hideNumbersproperty 
protected var _hideNumbers:Boolean

_indentationproperty 
protected var _indentation:Number = 0

_indentationLeftproperty 
protected var _indentationLeft:Number = 0

_indentationRightproperty 
protected var _indentationRight:Number = 0

_notAddedYetproperty 
protected var _notAddedYet:Boolean = true

_numberDepthproperty 
protected var _numberDepth:int = 0

_numbersproperty 
protected var _numbers:Vector.<Number> = null

_numberStyleproperty 
protected var _numberStyle:int = 0

_titleproperty 
protected var _title:Paragraph

_triggerNewPageproperty 
protected var _triggerNewPage:Boolean = false

addedCompletelyproperty 
addedCompletely:Boolean


Implementation
    public function get addedCompletely():Boolean
    public function set addedCompletely(value:Boolean):void
bookmarkOpenproperty 
bookmarkOpen:Boolean


Implementation
    public function get bookmarkOpen():Boolean
    public function set bookmarkOpen(value:Boolean):void
bookmarkTitleproperty 
bookmarkTitle:String  [write-only]


Implementation
    public function set bookmarkTitle(value:String):void
chapterNumberproperty 
chapterNumber:uint  [write-only]


Implementation
    public function set chapterNumber(value:uint):void
completeproperty 
complete:Boolean


Implementation
    public function get complete():Boolean
    public function set complete(value:Boolean):void
depthproperty 
depth:uint  [read-only]


Implementation
    public function get depth():uint
indentationproperty 
indentation:Number


Implementation
    public function get indentation():Number
    public function set indentation(value:Number):void
indentationLeftproperty 
indentationLeft:Number


Implementation
    public function get indentationLeft():Number
    public function set indentationLeft(value:Number):void
indentationRightproperty 
indentationRight:Number


Implementation
    public function get indentationRight():Number
    public function set indentationRight(value:Number):void
isChapterproperty 
isChapter:Boolean  [read-only]


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


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


Implementation
    public function get isNestable():Boolean
isSectionproperty 
isSection:Boolean  [read-only]


Implementation
    public function get isSection():Boolean
notAddedYetproperty 
notAddedYet:Boolean


Implementation
    public function get notAddedYet():Boolean
    public function set notAddedYet(value:Boolean):void
numberDepthproperty 
numberDepth:int


Implementation
    public function get numberDepth():int
    public function set numberDepth(value:int):void
numbersproperty 
numbers:Vector.<Number>  [read-only]


Implementation
    public function get numbers():Vector.<Number>
numberStyleproperty 
numberStyle:int


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


Implementation
    public function get size():uint
subsectionsproperty 
protected var subsections:int = 0

titleproperty 
title:Paragraph


Implementation
    public function get title():Paragraph
    public function set title(value:Paragraph):void
triggerNewPageproperty 
triggerNewPage:Boolean


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


Implementation
    public function get type():int
Constructor Detail
Section()Constructor
public function Section($title:Paragraph, $depth:int = 1)



Parameters
$title:Paragraph
 
$depth:int (default = 1)
Method Detail
add()method
public function add(o:Object):Boolean

Parameters

o:Object

Returns
Boolean
addAll()method 
public function addAll(collection:Vector.<IElement>):Boolean

Parameters

collection:Vector.<IElement>

Returns
Boolean
addMarkedSection()method 
public function addMarkedSection():MarkedSection

Returns
MarkedSection
addSection()method 
public function addSection(title:String):Section

Parameters

title:String

Returns
Section
addSection1()method 
public function addSection1(title:Paragraph):Section

Parameters

title:Paragraph

Returns
Section
addSection2()method 
public function addSection2(indentation:Number, title:Paragraph, numberDepth:int):Section

Parameters

indentation:Number
 
title:Paragraph
 
numberDepth:int

Returns
Section
addSection3()method 
public function addSection3(indentation:Number, title:Paragraph):Section

Parameters

indentation:Number
 
title:Paragraph

Returns
Section
addSection4()method 
public function addSection4(title:Paragraph, numberDepth:int):Section

Parameters

title:Paragraph
 
numberDepth:int

Returns
Section
addSection5()method 
public function addSection5(indentation:Number, title:String, numberDepth:int):Section

Parameters

indentation:Number
 
title:String
 
numberDepth:int

Returns
Section
addSection6()method 
public function addSection6(title:String, numberDepth:int):Section

Parameters

title:String
 
numberDepth:int

Returns
Section
addSection7()method 
public function addSection7(indentation:Number, title:String):Section

Parameters

indentation:Number
 
title:String

Returns
Section
constructTitle()method 
public static function constructTitle(title:Paragraph, numbers:Vector.<Number>, numberDepth:int, numberStyle:int):Paragraph

Parameters

title:Paragraph
 
numbers:Vector.<Number>
 
numberDepth:int
 
numberStyle:int

Returns
Paragraph
flushContent()method 
public function flushContent():void

getBookmarkTitle()method 
public function getBookmarkTitle():Paragraph

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

Returns
Vector.<Object>
insert()method 
public function insert(index:int, o:Object):void

Parameters

index:int
 
o:Object

iterator()method 
public function iterator():Iterator

Returns
Iterator
newPage()method 
public function newPage():void

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

Parameters

listener:IElementListener

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

Returns
String
Constant Detail
NUMBERSTYLE_DOTTEDConstant
public static const NUMBERSTYLE_DOTTED:int = 0

NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOTConstant 
public static const NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT:int = 1

NUMBERSTYLE_NONEConstant 
public static const NUMBERSTYLE_NONE:int = -1

hide default number in title





Thu May 27 2010, 07:51 AM +02:00