Located in /File_PDF/PDF.php (line 39)
Current height of page format in user units.
Current height of page format in points.
Current width of page format in user units.
Current width of page format in points.
Current height of page in user units
Current height of page in points.
Current width of page in user units
Current width of page in points.
The current horizontal position for cell positioning.
Value is set in user units and is calculated from the top left corner as origin.
The current vertical position for cell positioning.
Value is set in user units and is calculated from the top left corner as origin.
Alias for total number of pages.
Automatic page breaking.
Break page margin size, the bottom margin which triggers a page break.
Buffer holding in-memory PDF.
Buffer length, including already flushed content.
Cell margin size.
Whether text color is different from fill color.
Flag indicating if PDF file is to be compressed or not.
An array of standard font names.
An array containing current font info.
The current page orientation.
The default page orientation.
An array of encoding differences.
Commands for drawing color.
Commands for filling color.
Whether the buffer has been flushed already.
An array of used fonts.
Current font family.
An array of font files.
Current font size in user units.
Current font size in points.
Current font style.
An array of used images.
An array containing the document info, consisting of:
Flag set when processing footer.
The height of the last cell printed.
Layout display mode.
Left page margin size.
Line width in user units.
An array of internal links.
Current object number.
Array of object offsets.
Array indicating orientation changes.
Current page number.
Array containing the pages.
Threshold used to trigger page breaks.
An array of links in pages.
Right page margin size.
Scale factor (number of points in user units).
Current document state.
Commands for text color.
Top page margin size.
Underlining flag.
Word spacing.
Zoom display mode.
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().
This method is called automatically and should not be called directly by the application.
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 location of the definition file (and the font file itself when embedding) must be found at the full path name included.
Example:
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(), {@link()} write, image() or link(). The destination is defined with setLink().
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.
The font which was set before calling is automatically restored. There is no need to call setFont() again if you want to continue with the same font. The same is true for colors and line width. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
Defines an alias for the total number of pages.
It will be substituted as the document is closed.
Example:
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.
Outputs a circle. It can be drawn (border only), filled (with no border) or both.
All coordinates can be negative to provide values from the right or bottom edge of the page (since File_PDF 0.2.0, Horde 3.2).
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.
Attempts to return a conrete PDF instance.
It allows to set up the page format, the orientation and the units of measurement used in all the methods (except for the font sizes).
Example:
Returns the current buffer content and resets the buffer.
Use this method when creating large files to avoid memory problems. This method doesn't work in combination with the output() or save() methods, use getOutput() at the end. Calling this method doubles the memory usage during the call.
This method is used to render the page footer.
It is automatically called by addPage() and close() and should not be called directly by the application. The implementation in File_PDF:: is empty, so you have to subclass it and override the method if you want a specific processing.
Example:
Returns the raw PDF file.
Returns the actual page height.
Returns the current page number.
Returns the actual page width.
Returns the length of a text string. A font must be selected.
Returns the abscissa of the current position in user units.
Returns the ordinate of the current position in user units.
This method is used to render the page header.
It is automatically called by addPage() and should not be called directly by the application. The implementation in File_PDF:: is empty, so you have to subclass it and override the method if you want a specific processing.
Example:
Prints an image in the page.
The upper-left corner and at least one of the dimensions must be specified; the height or the width can be calculated automatically in order to keep the image proportions. Supported formats are JPEG and PNG.
All coordinates can be negative to provide values from the right or bottom edge of the page (since File_PDF 0.2.0, Horde 3.2).
For JPEG, all flavors are allowed:
Remark: if an image is used several times, only one copy will be embedded in the file.
Draws a line between two points.
All coordinates can be negative to provide values from the right or bottom edge of the page (since File_PDF 0.2.0, Horde 3.2).
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.
All coordinates can be negative to provide values from the right or bottom edge of the page (since File_PDF 0.2.0, Horde 3.2).
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.
Performs a line break.
The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
This method begins the generation of the PDF document; it must be called before any output commands.
No page is created by this method, therefore it is necessary to call addPage().
Sends the buffered data to the browser.
Returns a PEAR_Error object.
Wraps around PEAR::raiseError() to avoid having to include PEAR.php unless an error occurs.
Outputs a rectangle.
It can be drawn (border only), filled (with no border) or both.
All coordinates can be negative to provide values from the right or bottom edge of the page (since File_PDF 0.2.0, Horde 3.2).
Saves the PDF file on the filesystem.
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.
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.
Note: the zlib extension is required for this feature. If not present, compression will be turned off.
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.
Sets the draw color, used when drawing lines.
Depending on the colorspace called, the number of color component parameters required can be either 1, 3 or 4. The method can be called before the first page is created and the color is retained from page to page.
Sets the fill color.
Depending on the colorspace called, the number of color component parameters required can be either 1, 3 or 4. The method can be called before the first page is created and the color is retained from page to page.
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. The font can be either a standard one or a font added via the addFont() method. Standard fonts use Windows encoding cp1252 (Western Europe).
The method can be called before the first page is created and the font is retained from page to page.
If you just wish to change the current font size, it is simpler to call setFontSize().
Defines the size of the current font.
Defines the style of the current font.
Set the info to a document.
Possible info settings are:
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.
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.
Defines the page and position a link points to.
Defines the left, top and right margins.
By default, they equal 1 cm. Call this method to change them.
Defines the right margin.
The method can be called before creating the first page.
Sets the text color.
Depending on the colorspace called, the number of color component parameters required can be either 1, 3 or 4. The method can be called before the first page is created and the color is retained from page to page.
Defines the top margin.
The method can be called before creating the first page.
Defines the abscissa of the current position.
If the passed value is negative, it is relative to the right of the page.
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.
Defines the ordinate of the current position.
If the passed value is negative, it is relative to the bottom of the page.
Prints a character string.
The origin is on the left of the first character, 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.
All coordinates can be negative to provide values from the right or bottom edge of the page (since File_PDF 0.2.0, Horde 3.2).
This method prints text from the current position.
When the right margin is reached (or the \n character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text.
It is possible to put a link on the text.
Example:
Writes text at an angle.
All coordinates can be negative to provide values from the right or bottom edge of the page (since File_PDF 0.2.0, Horde 3.2).
Documentation generated on Sun, 30 Jan 2011 05:20:21 +0000 by phpDocumentor 1.4.3