org.alivepdf.billing.Invoice

	Property	Defined By
		dataEx : Array [static]	Invoice
		totalFonts : int [read-only] Lets you retrieve the total number of fonts used in the PDF document.	PDF
		totalPages : int [read-only] Lets you retrieve the number of pages in the PDF document.	PDF

Public Methods

	Method		Defined By
		Invoice(orientation:String = Portrait, unit:String = Mm, autoPageBreak:Boolean = true, pageSize:Size = null, rotation:int = 0)	Invoice
		addAnnotation(annotation:Annotation):void Lets you add an annotation to the current page	PDF
		addBookmark(text:String, level:int = 0, y:Number = -1, color:RGBColor = null):void Lets you add a bookmark.	PDF
		addCadreTVAs():void	Invoice
		addCell(width:Number = 0, height:Number = 0, text:String, border:* = 0, ln:Number = 0, align:String, fill:Number = 0, link:ILink = null):void Add a cell with some text to the current page.	PDF
		addCellFitScale(width:Number, height:Number = 0, text:String, border:* = 0, ln:Number = 0, align:String, fill:Number = 0, link:ILink = null):void Adds a cell with horizontal scaling only if necessary	PDF
		addCellFitScaleForce(width:Number, height:Number = 0, text:String, border:* = 0, ln:Number = 0, align:String, fill:Number = 0, link:ILink = null):void Adds a cell with horizontal scaling always	PDF
		addCellFitSpace(width:Number, height:Number = 0, text:String, border:* = 0, ln:Number = 0, align:String, fill:Number = 0, link:ILink = null):void Adds a cell with character spacing only if necessary	PDF
		addCellFitSpaceForce(width:Number, height:Number = 0, text:String, border:* = 0, ln:Number = 0, align:String, fill:Number = 0, link:ILink = null):void Adds a cell with character spacing always	PDF
		addClientAddress(company:Company):void	Invoice
		addCodaBar(codaBar:CodaBar):void Allows you to add a CodaBar (Monarch) to the current page at any position.	PDF
		addCompany(company:Company):void	Invoice
		addCompanyBox(company:Company, y:Number, align:String = L):void	Invoice
		addDate(date:Object):void	Invoice
		addEcheance(date:Object):void	Invoice
		addEPSImage(stream:ByteArray, x:Number = 0, y:Number = 0, w:Number = 0, h:Number = 0, useBoundingBox:Boolean = true):void The addEPSImage method takes an incoming EPS (.eps) file or Adobe® Illustrator® file (.ai) and render it on the current page.	PDF
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void	PDF
		addGrid(grid:Grid, x:Number = 0, y:Number = 0, repeatHeader:Boolean = true):void Adds a dynamic table to the current page.	PDF
		addImage(displayObject:DisplayObject, resizeMode:Resize = null, x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0, rotation:Number = 0, alpha:Number = 1, keepTransformation:Boolean = true, imageFormat:String = PNG, quality:Number = 100, blendMode:String = Normal, link:ILink = null):void The addImage method takes an incoming DisplayObject.	PDF
		addImageStream(imageBytes:ByteArray, colorSpace:String, resizeMode:Resize = null, x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0, rotation:Number = 0, alpha:Number = 1, blendMode:String = Normal, link:ILink = null):void The addImageStream method takes an incoming image as a ByteArray.	PDF
		addJavaScript(script:String):void The addJavaScript allows you to inject JavaScript code to be executed when the PDF document is opened.	PDF
		addLink(x:Number, y:Number, width:Number, height:Number, link:ILink, highlight:String = I):void Lets you add clickable link to a specific position Link can be internal (document level navigation) or external (HTTP).	PDF
		addMultiCell(width:Number, height:Number, text:String, border:* = 0, align:String = J, filled:int = 0):void Add a multicell with some text to the current page.	PDF
		addPage(page:Page = null):Page Lets you add a page to the current PDF.	PDF
		addReglement(mode:String):void	Invoice
		addRemarque(remarque:String):void	Invoice
		addText(text:String, x:Number = 0, y:Number = 0):void Lets you set some text to any position on the page.	PDF
		addTransition(style:String = R, duration:Number = 1, dimension:String = H, motionDirection:String = I, transitionDirection:int = 0):void Lets you add a transition between each PDF page Note : PDF must be shown in fullscreen to see the transitions, use the setDisplayMode method with the PageMode.FULL_SCREEN parameter.	PDF
		beginBitmapFill(bitmap:BitmapData, matrix:Matrix = null):void The beginBitmapFill method fills a surface with a bitmap as a texture.	PDF
		beginFill(color:IColor, tint:Number = 100):void Sets the filling color for different color spaces CMYK, RGB or DEVICEGRAY.	PDF
		clip(x:Number, y:Number, width:Number, height:Number):void	PDF
		clippedCell(width:Number, height:Number = 0, text:String, border:* = 0, ln:Number = 0, align:String, fill:Number = 0, link:ILink = null):void	PDF
		clippingCircle(x:Number, y:Number, radius:Number, outline:Boolean = false):void	PDF
		clippingEllipse(x:Number, y:Number, ty:Number, ry:Number, outline:Boolean = false):void	PDF
		clippingPolygon(points:Array, outline:Boolean = false):void	PDF
		clippingRect(x:Number, y:Number, width:Number, height:Number, outline:Boolean = false):void	PDF
		clippingRoundedRect(x:Number, y:Number, width:Number, height:Number, radius:Number, outline:Boolean = false):void	PDF
		clippingText(x:Number, y:Number, text:String, outline:Boolean = false):void	PDF
		configureDateFormatter(formatString:String):void	Invoice
		createGrid(data:Array):void	Invoice
		curveTo(controlX1:Number, controlY1:Number, controlX2:Number, controlY2:Number, finalX3:Number, finalY3:Number):void The curveTo method draws a cubic bezier curve.	PDF
		dispatchEvent(event:Event):Boolean	PDF
		drawCircle(x:Number, y:Number, radius:Number):void The drawCircle method draws a circle.	PDF
		drawEllipse(x:Number, y:Number, radiusX:Number, radiusY:Number):void The drawEllipse method draws an ellipse.	PDF
		drawLine(x1:Number, y1:Number, x2:Number, y2:Number):void	PDF
		drawPolygone(points:Array):void The drawPolygone method draws a polygone.	PDF
		drawRect(rect:Rectangle):void The drawRect method draws a rectangle shape.	PDF
		drawRoundRect(rect:Rectangle, ellipseWidth:Number):void The drawRoundedRect method draws a rounded rectangle shape.	PDF
		drawRoundRectComplex(rect:Rectangle, topLeftEllipseWidth:Number, topRightEllipseWidth:Number, bottomLeftEllipseWidth:Number, bottomRightEllipseWidth:Number):void The drawComplexRoundRect method draws a rounded rectangle shape.	PDF
		drawSector(xCenter:Number, yCenter:Number, radius:Number, a:Number, b:Number, style:String = FD, clockWise:Boolean = true, angleOrigin:Number = 90):void The drawSector method draws a sector, which allows you to draw a pie chart.	PDF
		end(closePath:Boolean = true):void The end method closes the stroke.	PDF
		endFill():void Ends all previous filling.	PDF
		footer(footerText:String, showPageNumber:Boolean = false, position:String = left):void	PDF
		getCurrentInternalLink():InternalLink Returns an InternalLink object linked to the current page at the current Y in the page.	PDF
		getCurrentPage():Page Lets you retrieve the current Page.	PDF
		getDefaultOrientation():String Returns the default PDF orientation.	PDF
		getDefaultSize():Size Returns the default PDF Size.	PDF
		getDefaultUnit():String Returns the default PDF unit unit.	PDF
		getFonts():Array Lets you retrieve the fonts used in the PDF document.	PDF
		getMargins():Rectangle Lets you retrieve the margins dimensions.	PDF
		getPage(index:int):Page Lets you retrieve a Page object.	PDF
		getPages():Array Lets you retrieve all the PDF pages.	PDF
		getX():Number Lets you retrieve the X position for the current page.	PDF
		getY():Number Lets you retrieve the Y position for the current page.	PDF
		gotoPage(index:int):void Lets you move to a Page in the PDF.	PDF
		hasEventListener(type:String):Boolean	PDF
		header(headerText:String):void	PDF
		linearGradient(x:Number, y:Number, width:Number, height:Number, col1:Array, col2:Array, coordinates:Array):void	PDF
		lineStyle(color:IColor, thickness:Number = 1, flatness:Number = 0, alpha:Number = 1, rule:String = NonZeroWinding, blendMode:String = Normal, style:DashedLine = null, caps:String = null, joints:String = null, miterLimit:Number = 3):void Sets the stroke style.	PDF
		lineTo(x:Number, y:Number):void Lets you draw a stroke from the current point to the new point.	PDF
		maxWidth():Number	Invoice
		moveTo(x:Number, y:Number):void Lets you move the current drawing point to the specified destination.	PDF
		newLine(height:*):void Lets you insert a line break for text.	PDF
		radialGradient(x:Number, y:Number, width:Number, height:Number, col1:Array, col2:Array, coordinates:Array):void	PDF
		removeAllPages():void Lets you remove all the pages from the PDF.	PDF
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void	PDF
		removeFont(font:IFont):void Lets you remove an embedded font from the PDF.	PDF
		removePage(index:int):Page Lets you remove a Page from the PDF.	PDF
		resetMargins():void Lets you reset the margins dimensions.	PDF
		rotate(angle:Number, x:Number = -1, y:Number = -1):void Allows you to rotate any content drawn after the rotate() call	PDF
		rotatePage(number:int, rotation:Number):void Lets you rotate a specific page (between 1 and n-1).	PDF
		RoundedRect(x:Number, y:Number, w:Number, h:Number, r:Number, style:String):void	Invoice
		save(method:String, url:String, downloadMethod:String = inline, fileName:String = generated.pdf, frame:String = _blank):* Allows you to save the PDF locally (Flash Player 10 minmum required) or remotely through a server-side script.	PDF
		setAdvanceTiming(timing:int):void Lets you set specify the timing (in seconds) a page is shown when the PDF is shown in fullscreen mode.	PDF
		setAliasNbPages(alias:String = {nb}):void Lets you specify an alias for the total number of pages.	PDF
		setAlpha(alpha:Number, blendMode:String = Normal):void Lets you specify the opacity for the next drawing operations, from 0 (100% transparent) to 1 (100% opaque).	PDF
		setAuthor(author:String):void Sets the specified author for the PDF.	PDF
		setAutoPageBreak(auto:Boolean, margin:Number):void Lets you enable or disable auto page break mode and triggering margin.	PDF
		setBottomMargin(margin:Number):void Lets you specify the bottom margin	PDF
		setCreator(creator:String):void Sets the specified creator for the PDF.	PDF
		setDisplayMode(zoom:String = FullWidth, layout:String = SinglePage, mode:String = UseNone, zoomValue:Number = 1):void Lets you set a specific display mode, the DisplayMode takes care of the general layout of the PDF in the PDF reader	PDF
		setFont(font:IFont, size:int = 12, underlined:Boolean = false):void Lets you set a specific font.	PDF
		setFontSize(size:int):void Lets you set a new size for the current font.	PDF
		setGridPositionOnNextPages(xvalue:Number = 10, yvalue:Number = 10):void This method is used to add grid when used in auto mode for big chunck of data into other pages.	PDF
		setKeywords(keywords:String):void Sets the specified keywords for the PDF.	PDF
		setLeftMargin(margin:Number):void Lets you specify the left margin.	PDF
		setMargins(left:Number, top:Number, right:Number = -1, bottom:Number = 20):void Lets you specify the left, top, and right margins.	PDF
		setRightMargin(margin:Number):void Lets you specify the right margin.	PDF
		setStartingPage(index:int):void Lets you specify which page should be viewed by default when the document is opened.	PDF
		setSubject(subject:String):void Lets you set a subject for the PDF.	PDF
		setTitle(title:String):void Lets you set a title for the PDF.	PDF
		setTopMargin(margin:Number):void Lets you specify the top margin.	PDF
		setViewerPreferences(toolbar:String = false, menubar:String = false, windowUI:String = false, fitWindow:String = false, centeredWindow:String = false, displayTitle:String = false):void Lets you control the way the document is to be presented on the screen or in print.	PDF
		setVisible(visible:String):void	PDF
		setX(x:Number):void Lets you specify the X position for the current page.	PDF
		setXY(x:Number, y:Number):void Lets you specify the X and Y position for the current page.	PDF
		setY(y:Number):void Lets you specify the Y position for the current page.	PDF
		SizeOfText(texte:String, largeur:Number):Number Returns the number of lines to display properly this text in the specific width	Invoice
		skew(ax:Number, ay:Number, x:Number = -1, y:Number = -1):void Allows you to skew any content drawn after the skew() call	PDF
		textStyle(color:IColor, alpha:Number = 1, rendering:int = 0, wordSpace:Number = 0, characterSpace:Number = 0, scale:Number = 100, leading:Number = 0):void Sets the text style with an appropriate color, alpha etc.	PDF
		toString():String	PDF
		unsetClipping():void	PDF
		willTrigger(type:String):Boolean	PDF
		writeFlashHtmlText(pHeight:Number, pText:String, pLink:ILink = null):void Lets you write some text with basic HTML type formatting.	PDF
		writeText(lineHeight:Number, text:String, link:ILink = null):void Lets you write some text in the current page.	PDF

Summary	Defined By
added	Dispatched when a page has been added to the PDF.	PDF
complete	Dispatched when PDF has been generated and available.	PDF
pageTree	Dispatched when the PDF page tree has been generated.	PDF
resources	Dispatched when the required resources (fonts, images, etc.) haven been written into the PDF.	PDF
started	Dispatched when the PDF generation has been initiated.	PDF

Property Detail

dataEx

property

public static var dataEx:Array

Constructor Detail

Invoice

()

Constructor

public function Invoice(orientation:String = Portrait, unit:String = Mm, autoPageBreak:Boolean = true, pageSize:Size = null, rotation:int = 0)

Parameters

	`orientation:String` (default = `Portrait`)

	`unit:String` (default = `Mm`)

	`autoPageBreak:Boolean` (default = `true`)

	`pageSize:Size` (default = `null`)

	`rotation:int` (default = `0`)

Method Detail

addCadreTVAs

()

method

public function addCadreTVAs():void

addClientAddress

()

method

public function addClientAddress(company:Company):void

Parameters

company:Company

addCompany

()

method

public function addCompany(company:Company):void

Parameters

company:Company

addCompanyBox

()

method

public function addCompanyBox(company:Company, y:Number, align:String = L):void

Parameters

	`company:Company`

	`y:Number`

	`align:String` (default = `L`)

addDate

()

method

public function addDate(date:Object):void

Parameters

date:Object

addEcheance

()

method

public function addEcheance(date:Object):void

Parameters

date:Object

addReglement

()

method

public function addReglement(mode:String):void

Parameters

mode:String

addRemarque

()

method

public function addRemarque(remarque:String):void

Parameters

remarque:String

configureDateFormatter

()

method

public function configureDateFormatter(formatString:String):void

Parameters

formatString:String

createGrid

()

method

public function createGrid(data:Array):void

Parameters

data:Array

maxWidth

()

method

public function maxWidth():Number

Returns

Number

RoundedRect

()

method

public function RoundedRect(x:Number, y:Number, w:Number, h:Number, r:Number, style:String):void

Parameters

	`x:Number`

	`y:Number`

	`w:Number`

	`h:Number`

	`r:Number`

	`style:String`

SizeOfText

()

method

public function SizeOfText(texte:String, largeur:Number):Number

Returns the number of lines to display properly this text in the specific width

Parameters

	`texte:String` — String The text on which the calcul is done

	`largeur:Number` — String The specific width where the text will be displayed

Returns

Number — Number Number of lines

Sun Jan 16 2011, 12:39 AM -08:00

AlivePDF 0.1.5 RC API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Invoice	Properties \| Methods \| Events

Package	org.alivepdf.billing
Class	public class Invoice
Inheritance	Invoice PDF Object