Support Joomla!

Packages

Package: com-tecnick-tcpdf

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.
Element index for package com-tecnick-tcpdf

Other package element indexes


a b c d e f g h i k l m n o p r s t u w x y z _
_
Method _addfield
Method _begindoc
Start document
Method _beginpage
_beginpage
Method _dochecks
Check for locale-related bug
Method _dounderline
Underline text
Method _enddoc
_enddoc
Method _endpage
End of page contents
Method _escape
Add \ before \, ( and )
Method _escapetext
Format a text string
Method _freadint
Read a 4-byte integer from file
Method _generateencryptionkey
Compute encryption key
Method _getfontpath
Return fonts path
Method _JScolor
Method _legacyparsejpg
Extract info from a JPEG file without using GD
Method _legacyparsepng
Extract info from a PNG file without using GD
Method _md5_16
Encrypts a string using MD5 and returns it's value as a binary string.
Method _newobj
Begin a new object
Method _objectkey
Compute encryption key depending on object number where the encrypted data is stored
Method _out
TCPDF::_out() in TCPDF
Output a string to the document.
Method _outCurve
Method _outLine
Method _outPoint
Method _outRect
Draws a rectangle.
Method _Ovalue
Compute O value (used for RC4 encryption)
Method _parsegif
Extract info from a GIF file
Method _parsejpg
Extract info from a JPEG file
Method _parsepng
Extract info from a PNG file
Method _putbookmarks
Method _putcatalog
_putcatalog
Method _putencryption
Put encryption on PDF document
Method _putfonts
Adds fonts
Method _putheader
_putheader
Method _putimages
_putimages
Method _putinfo
_putinfo
Method _putjavascript
Method _putpages
_putpages
Method _putresourcedict
_putresourcedict
Method _putresources
_putresources
Method _putstream
Output a stream.
Method _puttrailer
_puttrailer
Method _puttruetypeunicode
Adds unicode fonts.
Method _putxobjectdict
_putxobjectdict
Method _RC4
TCPDF::_RC4() in TCPDF
Returns the input text exrypted using RC4 algorithm and the specified key.
Method _textstring
Format a text string for meta information
Method _uristring
Format an URI string
Method _Uvalue
Compute U value (used for RC4 encryption)
a
Variable $AliasNbPages
Variable $author
Variable $AutoPageBreak
Method AcceptPageBreak
Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by SetAutoPageBreak().
Method AddFont
Imports a TrueType or Type1 font and makes it available. It is necessary to generate a font definition file first with the makefont.php utility. The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.
Method addHtmlLink
Output anchor link.
Method AddLink
Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.
The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().
Method AddPage
Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header.
Method AliasNbPages
Defines an alias for the total number of pages. It will be substituted as the document is closed.
Method arrUTF8ToUTF16BE
Converts array of UTF-8 characters to UTF16-BE string.
b
Variable $bMargin
Variable $buffer
Method Bookmark
Method Button
c
Variable $cMargin
Variable $ColorFlag
Variable $compress
Variable $CoreFonts
Variable $creator
Variable $CurOrientation
Variable $CurrentFont
Method Cell
TCPDF::Cell() in TCPDF
Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
Method CheckBox
Method Circle
Draws a circle.
Method Close
Terminates the PDF document. It is not necessary to call this method explicitly because Output() does it automatically. If the document contains no page, AddPage() is called to prevent from getting an invalid document.
Function code_to_utf8
code_to_utf8() in html_entity_decode_php4.php
Returns the UTF-8 string corresponding to unicode value.
Method ComboBox
Method Curve
Draws a Bezier curve.
d
Variable $DefOrientation
Variable $diffs
TCPDF::$diffs in TCPDF
Variable $DrawColor
e
Method Ellipse
Draws an ellipse.
Method Error
This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid.
File eng.php
eng.php in eng.php
f
Variable $fh
TCPDF::$fh in TCPDF
Variable $fhPt
TCPDF::$fhPt in TCPDF
Variable $FillColor
Variable $FontFamily
Variable $FontFiles
Variable $fonts
TCPDF::$fonts in TCPDF
Variable $FontSize
Variable $FontSizePt
Variable $FontStyle
Variable $fw
TCPDF::$fw in TCPDF
Variable $fwPt
TCPDF::$fwPt in TCPDF
Method Footer
This method is used to render the page footer.
g
Method GetAbsX
Returns the absolute X value of current position.
Method GetArrStringWidth
Returns the string length of an array of chars in user unit. A font must be selected.
Method getBreakMargin
Returns the page break margin.
Method GetCharWidth
Returns the length of the char in user unit. A font must be selected.
Method getImageScale
Returns the image scale.
Method GetLineWidth
Returns the current the line width.
Method GetNumChars
Returns the numbero of characters in a string.
Method getNumPages
Get the total number of insered pages.
Method getPage
Get current document page number.
Method getPageHeight
Returns the page height in units.
Method getPageWidth
Returns the page width in units.
Method getPDFData
Returns the PDF data.
Method getScaleFactor
Returns the scale factor (number of points in user unit).
Method GetStringWidth
Returns the length of a string in user unit. A font must be selected.
Method GetX
TCPDF::GetX() in TCPDF
Returns the relative X value of current position.
Method GetY
TCPDF::GetY() in TCPDF
Returns the ordinate of the current position.
h
Variable $h
TCPDF::$h in TCPDF
Variable $hPt
TCPDF::$hPt in TCPDF
Method Header
This method is used to render the page header.
Constant HEAD_MAGNIFICATION
HEAD_MAGNIFICATION in tcpdf_config.php
magnification factor for titles
Function html_entity_decode_php4
html_entity_decode_php4() in html_entity_decode_php4.php
Reverse function for htmlentities.
File html_entity_decode_php4.php
html_entity_decode_php4.php in html_entity_decode_php4.php
i
Variable $images
Variable $imgscale
Variable $img_rb_x
Variable $img_rb_y
Variable $InFooter
Variable $isunicode
Method Image
Puts an image in the page. The upper-left corner must be given. The dimensions can be specified in different ways:
  • explicit width and height (expressed in user unit)
  • one explicit dimension, the other being calculated automatically in order to keep the original proportions
  • no explicit dimension, in which case the image is put at 72 dpi
Supported formats are JPEG and PNG.
Method IncludeJS
k
Variable $k
TCPDF::$k in TCPDF
Variable $keywords
Constant K_BLANK_IMAGE
K_BLANK_IMAGE in tcpdf_config.php
blank image
Constant K_CELL_HEIGHT_RATIO
K_CELL_HEIGHT_RATIO in tcpdf_config.php
height of cell repect font height
Constant K_LRE
K_LRE in unicode_data.php
Left-to-Right Embedding
Constant K_LRM
K_LRM in unicode_data.php
Left-to-Right Mark
Constant K_LRO
K_LRO in unicode_data.php
Left-to-Right Override
Constant K_PATH_CACHE
K_PATH_CACHE in tcpdf_config.php
cache directory for temporary files (full path)
Constant K_PATH_FONTS
K_PATH_FONTS in tcpdf_config.php
path for PDF fonts
Constant K_PATH_IMAGES
K_PATH_IMAGES in tcpdf_config.php
images directory
Constant K_PATH_MAIN
K_PATH_MAIN in tcpdf_config.php
installation path (/var/www/tcpdf/)
Constant K_PATH_URL
K_PATH_URL in tcpdf_config.php
url path (http://localhost/tcpdf/)
Constant K_PATH_URL_CACHE
K_PATH_URL_CACHE in tcpdf_config.php
cache directory for temporary files (url path)
Constant K_PDF
K_PDF in unicode_data.php
Pop Directional Format
Constant K_RE_PATTERN_ARABIC
K_RE_PATTERN_ARABIC in unicode_data.php
Constant K_RE_PATTERN_RTL
K_RE_PATTERN_RTL in unicode_data.php
Constant K_RLE
K_RLE in unicode_data.php
Right-to-Left Embedding
Constant K_RLM
K_RLM in unicode_data.php
Right-to-Left Mark
Constant K_RLO
K_RLO in unicode_data.php
Right-to-Left Override
Constant K_SMALL_RATIO
K_SMALL_RATIO in tcpdf_config.php
reduction factor for small font
Constant K_TITLE_MAGNIFICATION
K_TITLE_MAGNIFICATION in tcpdf_config.php
title magnification respect main font size
l
Variable $lasth
TCPDF::$lasth in TCPDF
Variable $LayoutMode
Variable $LineWidth
Variable $links
TCPDF::$links in TCPDF
Variable $lMargin
Method lastPage
Reset pointer to the last document page.
Method Line
TCPDF::Line() in TCPDF
Draws a line between two points.
Method Link
TCPDF::Link() in TCPDF
Puts a link on a rectangular area of the page. Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.
Method ListBox
Method Ln
TCPDF::Ln() in TCPDF
Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
m
Method MirrorH
Horizontal Mirroring.
Method MirrorL
Reflection against a straight line through point (x, y) with the gradient angle (angle).
Method MirrorP
Point reflection mirroring.
Method MirrorV
Verical Mirroring.
Method MultiCell
This method allows printing text with line breaks. They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other.
Text can be aligned, centered or justified. The cell block can be framed and the background painted.
n
Variable $n
TCPDF::$n in TCPDF
o
Variable $offsets
Variable $OrientationChanges
Method Open
TCPDF::Open() in TCPDF
This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically.
Method Output
Send the document to a given destination: string, local file or browser. In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.
The method first calls Close() if necessary to terminate the document.
Method outputjpg
Get a JPEG filename and return a structure for the PDF creator.
p
Variable $page
TCPDF::$page in TCPDF
Variable $PageBreakTrigger
Variable $PageLinks
Variable $pages
TCPDF::$pages in TCPDF
Variable $PDFVersion
Method PageNo
Returns the current page number.
Constant PDF_AUTHOR
PDF_AUTHOR in tcpdf_config.php
document author
Constant PDF_CREATOR
PDF_CREATOR in tcpdf_config.php
document creator
Constant PDF_FONT_NAME_DATA
PDF_FONT_NAME_DATA in tcpdf_config.php
data font name
Constant PDF_FONT_NAME_MAIN
PDF_FONT_NAME_MAIN in tcpdf_config.php
main font name
Constant PDF_FONT_SIZE_DATA
PDF_FONT_SIZE_DATA in tcpdf_config.php
data font size
Constant PDF_FONT_SIZE_MAIN
PDF_FONT_SIZE_MAIN in tcpdf_config.php
main font size
Constant PDF_HEADER_LOGO
PDF_HEADER_LOGO in tcpdf_config.php
image logo
Constant PDF_HEADER_LOGO_WIDTH
PDF_HEADER_LOGO_WIDTH in tcpdf_config.php
header logo image width [mm]
Constant PDF_HEADER_STRING
PDF_HEADER_STRING in tcpdf_config.php
header description string
Constant PDF_HEADER_TITLE
PDF_HEADER_TITLE in tcpdf_config.php
header title
Constant PDF_IMAGE_SCALE_RATIO
PDF_IMAGE_SCALE_RATIO in tcpdf_config.php
scale factor for images (number of points in user unit)
Constant PDF_MARGIN_BOTTOM
PDF_MARGIN_BOTTOM in tcpdf_config.php
bottom margin
Constant PDF_MARGIN_FOOTER
PDF_MARGIN_FOOTER in tcpdf_config.php
footer margin
Constant PDF_MARGIN_HEADER
PDF_MARGIN_HEADER in tcpdf_config.php
header margin
Constant PDF_MARGIN_LEFT
PDF_MARGIN_LEFT in tcpdf_config.php
left margin
Constant PDF_MARGIN_RIGHT
PDF_MARGIN_RIGHT in tcpdf_config.php
right margin
Constant PDF_MARGIN_TOP
PDF_MARGIN_TOP in tcpdf_config.php
top margin
Constant PDF_PAGE_FORMAT
PDF_PAGE_FORMAT in tcpdf_config.php
page format
Constant PDF_PAGE_ORIENTATION
PDF_PAGE_ORIENTATION in tcpdf_config.php
page orientation (P=portrait, L=landscape)
Constant PDF_PRODUCER
PDF_PRODUCER in TCPDF
define default PDF document producer
Constant PDF_UNIT
PDF_UNIT in tcpdf_config.php
document unit of measure [pt=point, mm=millimeter, cm=centimeter, in=inch]
Method Polygon
Draws a polygon.
r
Variable $rMargin
Method RadioButton
Method Rect
TCPDF::Rect() in TCPDF
Draws a rectangle.
Method RegularPolygon
Draws a regular polygon.
Method Rotate
Rotate object.
Method RoundedRect
Draws a rounded rectangle.
s
Variable $state
TCPDF::$state in TCPDF
Variable $subject
Method Scale
Vertical and horizontal non-proportional Scaling.
Method ScaleX
Horizontal Scaling.
Method ScaleXY
Vertical and horizontal proportional Scaling.
Method ScaleY
Vertical Scaling.
Method SetAuthor
Defines the author of the document.
Method SetAutoPageBreak
Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.
Method setBarcode
Set document barcode.
Method SetCellPadding
Set the internal Cell padding.
Method SetCompression
Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default.
Method SetCreator
Defines the creator of the document. This is typically the name of the application that generates the PDF.
Method SetDisplayMode
Defines the way the document is to be displayed by the viewer. The zoom level can be set: pages can be displayed entirely on screen, occupy the full width of the window, use real size, be scaled by a specific zooming factor or use viewer default (configured in the Preferences menu of Acrobat). The page layout can be specified too: single at once, continuous display, two columns or viewer default. By default, documents use the full width mode with continuous display.
Method SetDrawColor
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Method SetFillColor
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Method SetFont
Sets the font used to print character strings. It is mandatory to call this method at least once before printing text or the resulting document would not be valid.
Method SetFontSize
Defines the size of the current font.
Method setFooterFont
Set footer font.
Method setFooterMargin
Set footer margin.
Method setHeaderData
Set header data.
Method setHeaderFont
Set header font.
Method setHeaderMargin
Set header margin.
Method setImageScale
Set the image scale.
Method SetKeywords
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Method setLanguageArray
Set language array.
Method setLastH
Set the last cell height.
Method SetLeftMargin
Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.
Method SetLineStyle
Set line style.
Method SetLineWidth
Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.
Method SetLink
Defines the page and position a link points to
Method SetMargins
Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.
Method setPage
Move pointer to the apecified document page.
Method setPrintFooter
Set a flag to print page footer.
Method setPrintHeader
Set a flag to print page header.
Method SetProtection
Set document protection
Method SetRightMargin
Defines the right margin. The method can be called before creating the first page.
Method setRTL
Enable or disable Right-To-Left language mode
Method SetSubject
Defines the subject of the document.
Method setTempRTL
Force temporary RTL language direction
Method SetTextColor
Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Method SetTitle
Defines the title of the document.
Method SetTopMargin
Defines the top margin. The method can be called before creating the first page.
Method SetX
TCPDF::SetX() in TCPDF
Defines the abscissa of the current position.
Method SetXY
Defines the abscissa and ordinate of the current position. If the passed values are negative, they are relative respectively to the right and bottom of the page.
Method SetY
TCPDF::SetY() in TCPDF
Moves the current abscissa back to the left margin and sets the ordinate.
Method Skew
TCPDF::Skew() in TCPDF
Skew.
Method SkewX
Skew horizontally.
Method SkewY
Skew vertically.
Method StarPolygon
Draws a star polygon
Method StartTransform
Starts a 2D tranformation saving current graphic state.
Method StopTransform
Stops a 2D tranformation restoring previous graphic state.
t
Variable $TextColor
Variable $title
TCPDF::$title in TCPDF
Variable $tMargin
Constructor TCPDF
This is the class constructor.
Class TCPDF
TCPDF in TCPDF
This is a PHP5 class for generating PDF files on-the-fly without requiring external extensions.
File tcpdf_config.php
tcpdf_config.php in tcpdf_config.php
File TCPDF
TCPDF in TCPDF
Method Text
TCPDF::Text() in TCPDF
Prints a character string. The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use Cell(), MultiCell() or Write() which are the standard methods to print text.
Method TextField
Method toJPEG
Convert the loaded php image to a JPEG and then return a structure for the PDF creator.
Method Transform
Apply graphic transformations.
Method Translate
Translate graphic object horizontally and vertically.
Method TranslateX
Translate graphic object horizontally.
Method TranslateY
Translate graphic object vertically.
u
Variable $underline
File unicode_data.php
unicode_data.php in unicode_data.php
Method unhtmlentities
Reverse function for htmlentities.
Method unichr
Returns the unicode caracter specified by UTF-8 code
Method UTF8ArrSubString
Extract a slice of the $strarr array and return it as string.
Method utf8Bidi
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Method UTF8StringToArray
Converts UTF-8 strings to codepoints array.
Method utf8StrRev
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Method UTF8ToUTF16BE
Converts UTF-8 strings to UTF16-BE.
w
Variable $w
TCPDF::$w in TCPDF
Variable $wPt
TCPDF::$wPt in TCPDF
Variable $ws
TCPDF::$ws in TCPDF
Method Write
This method prints text from the current position.
Method writeBarcode
Print Barcode.
Method writeHTML
Allows to preserve some HTML formatting.
Method writeHTMLCell
Prints a cell (rectangular area) with optional borders, background color and html text string. The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
x
Variable $x
TCPDF::$x in TCPDF
y
Variable $y
TCPDF::$y in TCPDF
z
Variable $ZoomMode
a b c d e f g h i k l m n o p r s t u w x y z _

Documentation generated on Sat, 14 Nov 2009 11:10:08 +0000 by phpDocumentor 1.3.1