Packageorg.purepdf.pdf
Classpublic class VerticalText
InheritanceVerticalText Inheritance Object



Public Properties
 PropertyDefined By
  alignment : int
VerticalText
  height : Number
VerticalText
  leading : Number
Sets the separation between the vertical lines.
VerticalText
  maxLines : int
VerticalText
  origin : Point
VerticalText
Protected Properties
 PropertyDefined By
  _alignment : int = 0
VerticalText
  chunks : Vector.<PdfChunk>
VerticalText
  currentChunkMarker : int = -1
VerticalText
  currentStandbyChunk : PdfChunk
VerticalText
  _height : Number
VerticalText
  _leading : Number = 0
VerticalText
  _maxLines : int
VerticalText
  _origin : Point
VerticalText
  splittedChunkText : String
VerticalText
  text : PdfContentByte
VerticalText
Public Methods
 MethodDefined By
  
VerticalText
  
addChunk(chunk:Chunk):void
VerticalText
  
addPhrase(phrase:Phrase):void
VerticalText
  
go(simulate:Boolean = false):int
Outputs the lines to the document.
VerticalText
  
setVerticalLayout(startX:Number, startY:Number, height:Number, maxLines:int, leading:Number):void
Sets the layout.
VerticalText
Protected Methods
 MethodDefined By
  
createLine(width:Number):PdfLine
Creates a line from the chunk array.
VerticalText
  
Normalizes the list of chunks when the line is accepted.
VerticalText
Public Constants
 ConstantDefined By
  NO_MORE_COLUMN : int = 2
[static]
VerticalText
  NO_MORE_TEXT : int = 1
[static]
VerticalText
Property Detail
_alignmentproperty
protected var _alignment:int = 0

_heightproperty 
protected var _height:Number

_leadingproperty 
protected var _leading:Number = 0

_maxLinesproperty 
protected var _maxLines:int

_originproperty 
protected var _origin:Point

alignmentproperty 
alignment:int


Implementation
    public function get alignment():int
    public function set alignment(value:int):void
chunksproperty 
protected var chunks:Vector.<PdfChunk>

currentChunkMarkerproperty 
protected var currentChunkMarker:int = -1

currentStandbyChunkproperty 
protected var currentStandbyChunk:PdfChunk

heightproperty 
height:Number


Implementation
    public function get height():Number
    public function set height(value:Number):void
leadingproperty 
leading:Number

Sets the separation between the vertical lines.


Implementation
    public function get leading():Number
    public function set leading(value:Number):void
maxLinesproperty 
maxLines:int


Implementation
    public function get maxLines():int
    public function set maxLines(value:int):void
originproperty 
origin:Point


Implementation
    public function get origin():Point
    public function set origin(value:Point):void
splittedChunkTextproperty 
protected var splittedChunkText:String

textproperty 
protected var text:PdfContentByte

Constructor Detail
VerticalText()Constructor
public function VerticalText(content:PdfContentByte)



Parameters
content:PdfContentByte
Method Detail
addChunk()method
public function addChunk(chunk:Chunk):void

Parameters

chunk:Chunk

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

Parameters

phrase:Phrase

createLine()method 
protected function createLine(width:Number):PdfLine

Creates a line from the chunk array.

Parameters

width:Number — the width of the line

Returns
PdfLine — the line or null if no more chunks
go()method 
public function go(simulate:Boolean = false):int

Outputs the lines to the document. The output can be simulated.

Parameters

simulate:Boolean (default = false)true to simulate the writing to the document

Returns
int — returns the result of the operation. It can be NO_MORE_TEXT and/or NO_MORE_COLUMN
setVerticalLayout()method 
public function setVerticalLayout(startX:Number, startY:Number, height:Number, maxLines:int, leading:Number):void

Sets the layout.

Parameters

startX:Number — the top right X line position
 
startY:Number — the top right Y line position
 
height:Number — the height of the lines
 
maxLines:int — the maximum number of lines
 
leading:Number — the separation between the lines

shortenChunkArray()method 
protected function shortenChunkArray():void

Normalizes the list of chunks when the line is accepted.

writeLine()method 
pdf_core function writeLine(line:PdfLine, text:PdfContentByte, graphics:PdfContentByte):void

Parameters

line:PdfLine
 
text:PdfContentByte
 
graphics:PdfContentByte

Constant Detail
NO_MORE_COLUMNConstant
public static const NO_MORE_COLUMN:int = 2

NO_MORE_TEXTConstant 
public static const NO_MORE_TEXT:int = 1