Haru PDF

phpdoc:exceptionref

HaruException クラス

導入

Haru PDF 例外クラスです。

クラス概要

HaruException

class HaruException extends Exception {

/* Inherits */

final public string Exception::getMessage ( void )

final public int Exception::getCode ( void )

final public string Exception::getFile ( void )

final public string Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private string Exception::__clone ( void )

}

/phpdoc:exceptionref phpdoc:classref

HaruDoc クラス

導入

Haru PDF ドキュメントクラスです。

クラス概要

HaruDoc

class HaruDoc {

/* メソッド */

object addPage ( void )

bool addPageLabel ( int $first_page , int $style , int $first_num [, string $prefix ] )

void __construct ( void )

object createOutline ( string $title [, object $parent_outline [, object $encoder ]] )

object getCurrentEncoder ( void )

object getCurrentPage ( void )

object getEncoder ( string $encoding )

object getFont ( string $fontname [, string $encoding ] )

string getInfoAttr ( int $type )

int getPageLayout ( void )

int getPageMode ( void )

int getStreamSize ( void )

object insertPage ( object $page )

object loadJPEG ( string $filename )

object loadPNG ( string $filename [, bool $deferred ] )

object loadRaw ( string $filename , int $width , int $height , int $color_space )

string loadTTC ( string $fontfile , int $index [, bool $embed ] )

string loadTTF ( string $fontfile [, bool $embed ] )

string loadType1 ( string $afmfile [, string $pfmfile ] )

bool output ( void )

string readFromStream ( int $bytes )

bool resetError ( void )

bool resetStream ( void )

bool save ( string $file )

bool saveToStream ( void )

bool setCompressionMode ( int $mode )

bool setCurrentEncoder ( string $encoding )

bool setEncryptionMode ( int $mode [, int $key_len ] )

bool setInfoAttr ( int $type , string $info )

bool setInfoDateAttr ( int $type , int $year , int $month , int $day , int $hour , int $min , int $sec , string $ind , int $off_hour , int $off_min )

bool setOpenAction ( object $destination )

bool setPageLayout ( int $layout )

bool setPageMode ( int $mode )

bool setPagesConfiguration ( int $page_per_pages )

bool setPassword ( string $owner_password , string $user_password )

bool setPermission ( int $permission )

bool useCNSEncodings ( void )

bool useCNSFonts ( void )

bool useCNTEncodings ( void )

bool useCNTFonts ( void )

bool useJPEncodings ( void )

bool useJPFonts ( void )

bool useKREncodings ( void )

bool useKRFonts ( void )

}

定義済み定数

型	名前	説明
int	HaruDoc::CS_DEVICE_GRAY
int	HaruDoc::CS_DEVICE_RGB
int	HaruDoc::CS_DEVICE_CMYK
int	HaruDoc::CS_CAL_GRAY
int	HaruDoc::CS_CAL_RGB
int	HaruDoc::CS_LAB
int	HaruDoc::CS_ICC_BASED
int	HaruDoc::CS_SEPARATION
int	HaruDoc::CS_DEVICE_N
int	HaruDoc::CS_INDEXED
int	HaruDoc::CS_PATTERN
int	HaruDoc::ENABLE_READ
int	HaruDoc::ENABLE_PRINT
int	HaruDoc::ENABLE_EDIT_ALL
int	HaruDoc::ENABLE_COPY
int	HaruDoc::ENABLE_EDIT
int	HaruDoc::ENCRYPT_R2
int	HaruDoc::ENCRYPT_R3
int	HaruDoc::INFO_AUTHOR
int	HaruDoc::INFO_CREATOR
int	HaruDoc::INFO_TITLE
int	HaruDoc::INFO_SUBJECT
int	HaruDoc::INFO_KEYWORDS
int	HaruDoc::INFO_CREATION_DATE
int	HaruDoc::INFO_MOD_DATE
int	HaruDoc::COMP_NONE
int	HaruDoc::COMP_TEXT
int	HaruDoc::COMP_IMAGE
int	HaruDoc::COMP_METADATA
int	HaruDoc::COMP_ALL
int	HaruDoc::PAGE_LAYOUT_SINGLE
int	HaruDoc::PAGE_LAYOUT_ONE_COLUMN
int	HaruDoc::PAGE_LAYOUT_TWO_COLUMN_LEFT
int	HaruDoc::PAGE_LAYOUT_TWO_COLUMN_RIGHT
int	HaruDoc::PAGE_MODE_USE_NONE
int	HaruDoc::PAGE_MODE_USE_OUTLINE
int	HaruDoc::PAGE_MODE_USE_THUMBS
int	HaruDoc::PAGE_MODE_FULL_SCREEN

/phpdoc:classref phpdoc:classref

HaruPage クラス

導入

Haru PDF ページクラスです。

クラス概要

HaruPage

class HaruPage {

/* メソッド */

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 ] )

bool fill ( void )

bool fillStroke ([ bool $close_path ] )

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 ] )

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

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 [, float $char_space ]] )

bool stroke ([ bool $close_path ] )

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

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

}

定義済み定数

型	名前	説明
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

/phpdoc:classref phpdoc:classref

HaruFont クラス

導入

Haru PDF フォントクラスです。

クラス概要

HaruFont

class HaruFont {

/* メソッド */

int getAscent ( void )

int getCapHeight ( void )

int getDescent ( void )

string getEncodingName ( void )

string getFontName ( void )

array getTextWidth ( string $text )

int getUnicodeWidth ( int $character )

int getXHeight ( void )

int measureText ( string $text , float $width , float $font_size , float $char_space , float $word_space [, bool $word_wrap ] )

}

/phpdoc:classref phpdoc:classref

HaruImage クラス

導入

Haru PDF 画像クラスです。

クラス概要

HaruImage

class HaruImage {

/* メソッド */

int getBitsPerComponent ( void )

string getColorSpace ( void )

int getHeight ( void )

array getSize ( void )

int getWidth ( void )

bool setColorMask ( int $rmin , int $rmax , int $gmin , int $gmax , int $bmin , int $bmax )

bool setMaskImage ( object $mask_image )

}

/phpdoc:classref phpdoc:classref

HaruEncoder クラス

導入

Haru PDF エンコーダクラスです。

クラス概要

HaruEncoder

class HaruEncoder {

/* メソッド */

int getByteType ( string $text , int $index )

int getType ( void )

int getUnicode ( int $character )

int getWritingMode ( void )

}

定義済み定数

型	名前	説明
int	HaruEncoder::TYPE_SINGLE_BYTE
int	HaruEncoder::TYPE_DOUBLE_BYTE
int	HaruEncoder::TYPE_UNINITIALIZED
int	HaruEncoder::UNKNOWN
int	HaruEncoder::WMODE_HORIZONTAL
int	HaruEncoder::WMODE_VERTICAL
int	HaruEncoder::BYTE_TYPE_SINGLE
int	HaruEncoder::BYTE_TYPE_LEAD
int	HaruEncoder::BYTE_TYPE_TRAIL
int	HaruEncoder::BYTE_TYPE_UNKNOWN

/phpdoc:classref phpdoc:classref

HaruOutline クラス

導入

Haru PDF アウトラインクラスです。

クラス概要

HaruOutline

class HaruOutline {

/* メソッド */

bool setDestination ( object $destination )

bool setOpened ( bool $opened )

}

/phpdoc:classref phpdoc:classref

HaruAnnotation クラス

導入

Haru PDF アノテーションクラスです。

クラス概要

HaruAnnotation

class HaruAnnotation {

/* メソッド */

bool setBorderStyle ( float $width , int $dash_on , int $dash_off )

bool setHighlightMode ( int $mode )

bool setIcon ( int $icon )

bool setOpened ( bool $opened )

}

定義済み定数

型	名前	説明
int	HaruAnnotation::NO_HIGHLIGHT
int	HaruAnnotation::INVERT_BOX
int	HaruAnnotation::INVERT_BORDER
int	HaruAnnotation::DOWN_APPEARANCE
int	HaruAnnotation::ICON_COMMENT
int	HaruAnnotation::ICON_KEY
int	HaruAnnotation::ICON_NOTE
int	HaruAnnotation::ICON_HELP
int	HaruAnnotation::ICON_NEW_PARAGRAPH
int	HaruAnnotation::ICON_PARAGRAPH
int	HaruAnnotation::ICON_INSERT