PDF::API2::Page (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/PDF::API2::Page.3pm".)

NAME

PDF::API2::Page - Methods to interact with individual pages

METHODS

$page = PDF::API2::Page->new $pdf, $parent, $index

Returns a page object (called from $pdf->page).

$page = PDF::API2::Page->coerce $pdf, $pdfpage

Returns a page object converted from $pdfpage (called from $pdf->openpage).

$page->update

Marks a page to be updated (by $pdf->update).

$page->mediabox $w, $h

$page->mediabox $llx, $lly, $urx, $ury

$page->mediabox $alias

Sets the mediabox. This method supports the following aliases: '4A', '2A', 'A0', 'A1', 'A2', 'A3', 'A4', 'A5', 'A6', '4B', '2B', 'B0', 'B1', 'B2', 'B3', 'B4', 'B5', 'B6', '

LETTER

', '

BROADSHEET

', '

LEDGER

', '

TABLOID

', '

LEGAL

', '

EXECUTIVE

', and '36X36'.

($llx, $lly, $urx, $ury) = $page->get_mediabox

Gets the mediabox based on best estimates or the default.

$page->cropbox $w, $h

$page->cropbox $llx, $lly, $urx, $ury

$page->cropbox $alias

Sets the cropbox. This method supports the same aliases as mediabox.

($llx, $lly, $urx, $ury) = $page->get_cropbox

Gets the cropbox based on best estimates or the default.

$page->bleedbox $w, $h

$page->bleedbox $llx, $lly, $urx, $ury

$page->bleedbox $alias

Sets the bleedbox. This method supports the same aliases as mediabox.

($llx, $lly, $urx, $ury) = $page->get_bleedbox

Gets the bleedbox based on best estimates or the default.

$page->trimbox $w, $h

$page->trimbox $llx, $lly, $urx, $ury

Sets the trimbox. This method supports the same aliases as mediabox.

($llx, $lly, $urx, $ury) = $page->get_trimbox

Gets the trimbox based on best estimates or the default.

$page->artbox $w, $h

$page->artbox $llx, $lly, $urx, $ury

$page->artbox $alias

Sets the artbox. This method supports the same aliases as mediabox.

($llx, $lly, $urx, $ury) = $page->get_artbox

Gets the artbox based on best estimates or the default.

$page->rotate $deg

Rotates the page by the given degrees, which must be a multiple of 90.

(This allows you to auto-rotate to landscape without changing the mediabox!)

$gfx = $page->gfx $prepend

Returns a graphics content object. If $prepend is true the content will be prepended to the page description.

$txt = $page->text $prepend

Returns a text content object. If $prepend is true the content will be prepended to the page description.

$ant = $page->annotation

Returns a new annotation object.

$page->resource $type, $key, $obj

Adds a resource to the page-inheritance tree.

Example:

    $co->resource('Font',$fontkey,$fontobj);
    $co->resource('XObject',$imagekey,$imageobj);
    $co->resource('Shading',$shadekey,$shadeobj);
    $co->resource('ColorSpace',$spacekey,$speceobj);

Note: You only have to add the required resources, if they are

NOT

handled by the *font*, *image*, *shade* or *space* methods.