The HaruPage class

(PECL haru >= 0.0.1)

Introduction

Haru PDF Page Class.

Class synopsis

HaruPage {

/* Methods */

bool arc ( float $x , float $y , float $ray , float $ang1 , float $ang2 )

bool beginText ( void )

bool circle ( float $x , float $y , float $ray )

bool closePath ( void )

bool concat ( float $a , float $b , float $c , float $d , float $x , float $y )

object createDestination ( void )

object createLinkAnnotation ( array $rectangle , object $destination )

object createTextAnnotation ( array $rectangle , string $text [, object $encoder ] )

object createURLAnnotation ( array $rectangle , string $url )

bool curveTo2 ( float $x2 , float $y2 , float $x3 , float $y3 )

bool curveTo3 ( float $x1 , float $y1 , float $x3 , float $y3 )

bool curveTo ( float $x1 , float $y1 , float $x2 , float $y2 , float $x3 , float $y3 )

bool drawImage ( object $image , float $x , float $y , float $width , float $height )

bool ellipse ( float $x , float $y , float $xray , float $yray )

bool endPath ( void )

bool endText ( void )

bool eofill ( void )

bool eoFillStroke ([ bool $close_path = false ] )

bool fill ( void )

bool fillStroke ([ bool $close_path = false ] )

float getCharSpace ( void )

array getCMYKFill ( void )

array getCMYKStroke ( void )

object getCurrentFont ( void )

float getCurrentFontSize ( void )

array getCurrentPos ( void )

array getCurrentTextPos ( void )

array getDash ( void )

int getFillingColorSpace ( void )

float getFlatness ( void )

int getGMode ( void )

float getGrayFill ( void )

float getGrayStroke ( void )

float getHeight ( void )

float getHorizontalScaling ( void )

int getLineCap ( void )

int getLineJoin ( void )

float getLineWidth ( void )

float getMiterLimit ( void )

array getRGBFill ( void )

array getRGBStroke ( void )

int getStrokingColorSpace ( void )

float getTextLeading ( void )

array getTextMatrix ( void )

int getTextRenderingMode ( void )

float getTextRise ( void )

float getTextWidth ( string $text )

array getTransMatrix ( void )

float getWidth ( void )

float getWordSpace ( void )

bool lineTo ( float $x , float $y )

int measureText ( string $text , float $width [, bool $wordwrap = false ] )

bool moveTextPos ( float $x , float $y [, bool $set_leading = false ] )

bool moveTo ( float $x , float $y )

bool moveToNextLine ( void )

bool rectangle ( float $x , float $y , float $width , float $height )

bool setCharSpace ( float $char_space )

bool setCMYKFill ( float $c , float $m , float $y , float $k )

bool setCMYKStroke ( float $c , float $m , float $y , float $k )

bool setDash ( array $pattern , int $phase )

bool setFlatness ( float $flatness )

bool setFontAndSize ( object $font , float $size )

bool setGrayFill ( float $value )

bool setGrayStroke ( float $value )

bool setHeight ( float $height )

bool setHorizontalScaling ( float $scaling )

bool setLineCap ( int $cap )

bool setLineJoin ( int $join )

bool setLineWidth ( float $width )

bool setMiterLimit ( float $limit )

bool setRGBFill ( float $r , float $g , float $b )

bool setRGBStroke ( float $r , float $g , float $b )

bool setRotate ( int $angle )

bool setSize ( int $size , int $direction )

bool setSlideShow ( int $type , float $disp_time , float $trans_time )

bool setTextLeading ( float $text_leading )

bool setTextMatrix ( float $a , float $b , float $c , float $d , float $x , float $y )

bool setTextRenderingMode ( int $mode )

bool setTextRise ( float $rise )

bool setWidth ( float $width )

bool setWordSpace ( float $word_space )

bool showText ( string $text )

bool showTextNextLine ( string $text [, float $word_space = 0 [, float $char_space = 0 ]] )

bool stroke ([ bool $close_path = false ] )

bool textOut ( float $x , float $y , string $text )

bool textRect ( float $left , float $top , float $right , float $bottom , string $text [, int $align = HaruPage::TALIGN_LEFT ] )

}

Predefined Constants

Type	Name	Description
int	HaruPage::GMODE_PAGE_DESCRIPTION
int	HaruPage::GMODE_TEXT_OBJECT
int	HaruPage::GMODE_PATH_OBJECT
int	HaruPage::GMODE_CLIPPING_PATH
int	HaruPage::GMODE_SHADING
int	HaruPage::GMODE_INLINE_IMAGE
int	HaruPage::GMODE_EXTERNAL_OBJECT
int	HaruPage::BUTT_END
int	HaruPage::ROUND_END
int	HaruPage::PROJECTING_SCUARE_END
int	HaruPage::MITER_JOIN
int	HaruPage::ROUND_JOIN
int	HaruPage::BEVEL_JOIN
int	HaruPage::FILL
int	HaruPage::STROKE
int	HaruPage::FILL_THEN_STROKE
int	HaruPage::INVISIBLE
int	HaruPage::FILL_CLIPPING
int	HaruPage::STROKE_CLIPPING
int	HaruPage::FILL_STROKE_CLIPPING
int	HaruPage::CLIPPING
int	HaruPage::TALIGN_LEFT
int	HaruPage::TALIGN_RIGHT
int	HaruPage::TALIGN_CENTER
int	HaruPage::TALIGN_JUSTIFY
int	HaruPage::SIZE_LETTER
int	HaruPage::SIZE_LEGAL
int	HaruPage::SIZE_A3
int	HaruPage::SIZE_A4
int	HaruPage::SIZE_A5
int	HaruPage::SIZE_B4
int	HaruPage::SIZE_B5
int	HaruPage::SIZE_EXECUTIVE
int	HaruPage::SIZE_US4x6
int	HaruPage::SIZE_US4x8
int	HaruPage::SIZE_US5x7
int	HaruPage::SIZE_COMM10
int	HaruPage::PORTRAIT
int	HaruPage::LANDSCAPE
int	HaruPage::TS_WIPE_LIGHT
int	HaruPage::TS_WIPE_UP
int	HaruPage::TS_WIPE_LEFT
int	HaruPage::TS_WIPE_DOWN
int	HaruPage::TS_BARN_DOORS_HORIZONTAL_OUT
int	HaruPage::TS_BARN_DOORS_HORIZONTAL_IN
int	HaruPage::TS_BARN_DOORS_VERTICAL_OUT
int	HaruPage::TS_BARN_DOORS_VERTICAL_IN
int	HaruPage::TS_BOX_OUT
int	HaruPage::TS_BOX_IN
int	HaruPage::TS_BLINDS_HORIZONTAL
int	HaruPage::TS_BLINDS_VERTICAL
int	HaruPage::TS_DISSOLVE
int	HaruPage::TS_GLITTER_RIGHT
int	HaruPage::TS_GLITTER_DOWN
int	HaruPage::TS_GLITTER_TOP_LEFT_TO_BOTTOM_RIGHT
int	HaruPage::TS_REPLACE
int	HaruPage::NUM_STYLE_DECIMAL
int	HaruPage::NUM_STYLE_UPPER_ROMAN
int	HaruPage::NUM_STYLE_LOWER_ROMAN
int	HaruPage::NUM_STYLE_UPPER_LETTERS
int	HaruPage::NUM_STYLE_LOWER_LETTERS

HaruPage::arc — Append an arc to the current path
HaruPage::beginText — Begin a text object and set the current text position to (0,0)
HaruPage::circle — Append a circle to the current path
HaruPage::closePath — Append a straight line from the current point to the start point of the path
HaruPage::concat — Concatenate current transformation matrix of the page and the specified matrix
HaruPage::createDestination — Create new HaruDestination instance
HaruPage::createLinkAnnotation — Create new HaruAnnotation instance
HaruPage::createTextAnnotation — Create new HaruAnnotation instance
HaruPage::createURLAnnotation — Create and return new HaruAnnotation instance
HaruPage::curveTo2 — Append a Bezier curve to the current path
HaruPage::curveTo3 — Append a Bezier curve to the current path
HaruPage::curveTo — Append a Bezier curve to the current path
HaruPage::drawImage — Show image at the page
HaruPage::ellipse — Append an ellipse to the current path
HaruPage::endPath — End current path object without filling and painting operations
HaruPage::endText — End current text object
HaruPage::eofill — Fill current path using even-odd rule
HaruPage::eoFillStroke — Fill current path using even-odd rule, then paint the path
HaruPage::fill — Fill current path using nonzero winding number rule
HaruPage::fillStroke — Fill current path using nonzero winding number rule, then paint the path
HaruPage::getCharSpace — Get the current value of character spacing
HaruPage::getCMYKFill — Get the current filling color
HaruPage::getCMYKStroke — Get the current stroking color
HaruPage::getCurrentFont — Get the currently used font
HaruPage::getCurrentFontSize — Get the current font size
HaruPage::getCurrentPos — Get the current position for path painting
HaruPage::getCurrentTextPos — Get the current position for text printing
HaruPage::getDash — Get the current dash pattern
HaruPage::getFillingColorSpace — Get the current filling color space
HaruPage::getFlatness — Get the flatness of the page
HaruPage::getGMode — Get the current graphics mode
HaruPage::getGrayFill — Get the current filling color
HaruPage::getGrayStroke — Get the current stroking color
HaruPage::getHeight — Get the height of the page
HaruPage::getHorizontalScaling — Get the current value of horizontal scaling
HaruPage::getLineCap — Get the current line cap style
HaruPage::getLineJoin — Get the current line join style
HaruPage::getLineWidth — Get the current line width
HaruPage::getMiterLimit — Get the value of miter limit
HaruPage::getRGBFill — Get the current filling color
HaruPage::getRGBStroke — Get the current stroking color
HaruPage::getStrokingColorSpace — Get the current stroking color space
HaruPage::getTextLeading — Get the current value of line spacing
HaruPage::getTextMatrix — Get the current text transformation matrix of the page
HaruPage::getTextRenderingMode — Get the current text rendering mode
HaruPage::getTextRise — Get the current value of text rising
HaruPage::getTextWidth — Get the width of the text using current fontsize, character spacing and word spacing
HaruPage::getTransMatrix — Get the current transformation matrix of the page
HaruPage::getWidth — Get the width of the page
HaruPage::getWordSpace — Get the current value of word spacing
HaruPage::lineTo — Draw a line from the current point to the specified point
HaruPage::measureText — Calculate the byte length of characters which can be included on one line of the specified width
HaruPage::moveTextPos — Move text position to the specified offset
HaruPage::moveTo — Set starting point for new drawing path
HaruPage::moveToNextLine — Move text position to the start of the next line
HaruPage::rectangle — Append a rectangle to the current path
HaruPage::setCharSpace — Set character spacing for the page
HaruPage::setCMYKFill — Set filling color for the page
HaruPage::setCMYKStroke — Set stroking color for the page
HaruPage::setDash — Set the dash pattern for the page
HaruPage::setFlatness — Set flatness for the page
HaruPage::setFontAndSize — Set font and fontsize for the page
HaruPage::setGrayFill — Set filling color for the page
HaruPage::setGrayStroke — Sets stroking color for the page
HaruPage::setHeight — Set height of the page
HaruPage::setHorizontalScaling — Set horizontal scaling for the page
HaruPage::setLineCap — Set the shape to be used at the ends of lines
HaruPage::setLineJoin — Set line join style for the page
HaruPage::setLineWidth — Set line width for the page
HaruPage::setMiterLimit — Set the current value of the miter limit of the page
HaruPage::setRGBFill — Set filling color for the page
HaruPage::setRGBStroke — Set stroking color for the page
HaruPage::setRotate — Set rotation angle of the page
HaruPage::setSize — Set size and direction of the page
HaruPage::setSlideShow — Set transition style for the page
HaruPage::setTextLeading — Set text leading (line spacing) for the page
HaruPage::setTextMatrix — Set the current text transformation matrix of the page
HaruPage::setTextRenderingMode — Set text rendering mode for the page
HaruPage::setTextRise — Set the current value of text rising
HaruPage::setWidth — Set width of the page
HaruPage::setWordSpace — Set word spacing for the page
HaruPage::showText — Print text at the current position of the page
HaruPage::showTextNextLine — Move the current position to the start of the next line and print the text
HaruPage::stroke — Paint current path
HaruPage::textOut — Print the text on the specified position
HaruPage::textRect — Print the text inside the specified region

User Contributed Notes

There are no user contributed notes for this page.

The HaruPage class

Introduction

Class synopsis

Predefined Constants

Table of Contents

User Contributed Notes