Öffentliche Methoden | |
__construct ($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false, $pdfa=false) | |
__destruct () | |
setPageUnit ($unit) | |
setPageOrientation ($orientation, $autopagebreak='', $bottommargin='') | |
setSpacesRE ($re='/[^\S\xa0]/') | |
setRTL ($enable, $resetx=true) | |
getRTL () | |
setTempRTL ($mode) | |
isRTLTextDir () | |
setLastH ($h) | |
getCellHeight ($fontsize, $padding=TRUE) | |
resetLastH () | |
getLastH () | |
setImageScale ($scale) | |
getImageScale () | |
getPageDimensions ($pagenum='') | |
getPageWidth ($pagenum='') | |
getPageHeight ($pagenum='') | |
getBreakMargin ($pagenum='') | |
getScaleFactor () | |
SetMargins ($left, $top, $right=-1, $keepmargins=false) | |
SetLeftMargin ($margin) | |
SetTopMargin ($margin) | |
SetRightMargin ($margin) | |
SetCellPadding ($pad) | |
setCellPaddings ($left='', $top='', $right='', $bottom='') | |
getCellPaddings () | |
setCellMargins ($left='', $top='', $right='', $bottom='') | |
getCellMargins () | |
SetAutoPageBreak ($auto, $margin=0) | |
getAutoPageBreak () | |
SetDisplayMode ($zoom, $layout='SinglePage', $mode='UseNone') | |
SetCompression ($compress=true) | |
setSRGBmode ($mode=false) | |
SetDocInfoUnicode ($unicode=true) | |
SetTitle ($title) | |
SetSubject ($subject) | |
SetAuthor ($author) | |
SetKeywords ($keywords) | |
SetCreator ($creator) | |
Error ($msg) | |
Open () | |
Close () | |
setPage ($pnum, $resetmargins=false) | |
lastPage ($resetmargins=false) | |
getPage () | |
getNumPages () | |
addTOCPage ($orientation='', $format='', $keepmargins=false) | |
endTOCPage () | |
AddPage ($orientation='', $format='', $keepmargins=false, $tocpage=false) | |
endPage ($tocpage=false) | |
startPage ($orientation='', $format='', $tocpage=false) | |
setPageMark () | |
setHeaderData ($ln='', $lw=0, $ht='', $hs='', $tc=array(0, 0, 0), $lc=array(0, 0, 0)) | |
setFooterData ($tc=array(0, 0, 0), $lc=array(0, 0, 0)) | |
getHeaderData () | |
setHeaderMargin ($hm=10) | |
getHeaderMargin () | |
setFooterMargin ($fm=10) | |
getFooterMargin () | |
setPrintHeader ($val=true) | |
setPrintFooter ($val=true) | |
getImageRBX () | |
getImageRBY () | |
resetHeaderTemplate () | |
setHeaderTemplateAutoreset ($val=true) | |
Header () | |
Footer () | |
PageNo () | |
getAllSpotColors () | |
AddSpotColor ($name, $c, $m, $y, $k) | |
setSpotColor ($type, $name, $tint=100) | |
SetDrawSpotColor ($name, $tint=100) | |
SetFillSpotColor ($name, $tint=100) | |
SetTextSpotColor ($name, $tint=100) | |
setColorArray ($type, $color, $ret=false) | |
SetDrawColorArray ($color, $ret=false) | |
SetFillColorArray ($color, $ret=false) | |
SetTextColorArray ($color, $ret=false) | |
setColor ($type, $col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
SetDrawColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
SetFillColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
SetTextColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
GetStringWidth ($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) | |
GetArrStringWidth ($sa, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) | |
GetCharWidth ($char, $notlast=true) | |
getRawCharWidth ($char) | |
GetNumChars ($s) | |
unichr ($c) | |
addTTFfont ($fontfile, $fonttype='', $enc='', $flags=32, $outpath='', $platid=3, $encid=1, $addcbbox=false) | |
AddFont ($family, $style='', $fontfile='', $subset='default') | |
SetFont ($family, $style='', $size=null, $fontfile='', $subset='default', $out=true) | |
SetFontSize ($size, $out=true) | |
getFontBBox () | |
getAbsFontMeasure ($s) | |
getCharBBox ($char) | |
getFontDescent ($font, $style='', $size=0) | |
getFontAscent ($font, $style='', $size=0) | |
isCharDefined ($char, $font='', $style='') | |
replaceMissingChars ($text, $font='', $style='', $subs=array()) | |
SetDefaultMonospacedFont ($font) | |
AddLink () | |
SetLink ($link, $y=0, $page=-1) | |
Link ($x, $y, $w, $h, $link, $spaces=0) | |
Annotation ($x, $y, $w, $h, $text, $opt=array('Subtype'=>'Text'), $spaces=0) | |
Text ($x, $y, $txt, $fstroke=false, $fclip=false, $ffill=true, $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M', $rtloff=false) | |
AcceptPageBreak () | |
Cell ($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M') | |
MultiCell ($w, $h, $txt, $border=0, $align='J', $fill=false, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0, $valign='T', $fitcell=false) | |
getNumLines ($txt, $w=0, $reseth=false, $autopadding=true, $cellpadding='', $border=0) | |
getStringHeight ($w, $txt, $reseth=false, $autopadding=true, $cellpadding='', $border=0) | |
Write ($h, $txt, $link='', $fill=false, $align='', $ln=false, $stretch=0, $firstline=false, $firstblock=false, $maxh=0, $wadj=0, $margin='') | |
Image ($file, $x='', $y='', $w=0, $h=0, $type='', $link='', $align='', $resize=false, $dpi=300, $palign='', $ismask=false, $imgmask=false, $border=0, $fitbox=false, $hidden=false, $fitonpage=false, $alt=false, $altimgs=array()) | |
Ln ($h='', $cell=false) | |
GetX () | |
GetAbsX () | |
GetY () | |
SetX ($x, $rtloff=false) | |
SetY ($y, $resetx=true, $rtloff=false) | |
SetXY ($x, $y, $rtloff=false) | |
SetAbsX ($x) | |
SetAbsY ($y) | |
SetAbsXY ($x, $y) | |
Output ($name='doc.pdf', $dest='I') | |
_destroy ($destroyall=false, $preserve_objcopy=false) | |
setExtraXMP ($xmp) | |
setDocCreationTimestamp ($time) | |
setDocModificationTimestamp ($time) | |
getDocCreationTimestamp () | |
getDocModificationTimestamp () | |
setHeaderFont ($font) | |
getHeaderFont () | |
setFooterFont ($font) | |
getFooterFont () | |
setLanguageArray ($language) | |
getPDFData () | |
addHtmlLink ($url, $name, $fill=false, $firstline=false, $color='', $style=-1, $firstblock=false) | |
pixelsToUnits ($px) | |
unhtmlentities ($text_to_convert) | |
SetProtection ($permissions=array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'), $user_pass='', $owner_pass=null, $mode=0, $pubkeys=null) | |
StartTransform () | |
StopTransform () | |
ScaleX ($s_x, $x='', $y='') | |
ScaleY ($s_y, $x='', $y='') | |
ScaleXY ($s, $x='', $y='') | |
Scale ($s_x, $s_y, $x='', $y='') | |
MirrorH ($x='') | |
MirrorV ($y='') | |
MirrorP ($x='', $y='') | |
MirrorL ($angle=0, $x='', $y='') | |
TranslateX ($t_x) | |
TranslateY ($t_y) | |
Translate ($t_x, $t_y) | |
Rotate ($angle, $x='', $y='') | |
SkewX ($angle_x, $x='', $y='') | |
SkewY ($angle_y, $x='', $y='') | |
Skew ($angle_x, $angle_y, $x='', $y='') | |
SetLineWidth ($width) | |
GetLineWidth () | |
SetLineStyle ($style, $ret=false) | |
Line ($x1, $y1, $x2, $y2, $style=array()) | |
Rect ($x, $y, $w, $h, $style='', $border_style=array(), $fill_color=array()) | |
Curve ($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style='', $line_style=array(), $fill_color=array()) | |
Polycurve ($x0, $y0, $segments, $style='', $line_style=array(), $fill_color=array()) | |
Ellipse ($x0, $y0, $rx, $ry='', $angle=0, $astart=0, $afinish=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) | |
Circle ($x0, $y0, $r, $angstr=0, $angend=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) | |
PolyLine ($p, $style='', $line_style=array(), $fill_color=array()) | |
Polygon ($p, $style='', $line_style=array(), $fill_color=array(), $closed=true) | |
RegularPolygon ($x0, $y0, $r, $ns, $angle=0, $draw_circle=false, $style='', $line_style=array(), $fill_color=array(), $circle_style='', $circle_outLine_style=array(), $circle_fill_color=array()) | |
StarPolygon ($x0, $y0, $r, $nv, $ng, $angle=0, $draw_circle=false, $style='', $line_style=array(), $fill_color=array(), $circle_style='', $circle_outLine_style=array(), $circle_fill_color=array()) | |
RoundedRect ($x, $y, $w, $h, $r, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) | |
RoundedRectXY ($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) | |
Arrow ($x0, $y0, $x1, $y1, $head_style=0, $arm_size=5, $arm_angle=15) | |
setDestination ($name, $y=-1, $page='', $x=-1) | |
getDestination () | |
setBookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1, $link='') | |
Bookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1, $link='') | |
IncludeJS ($script) | |
addJavascriptObject ($script, $onload=false) | |
setFormDefaultProp ($prop=array()) | |
getFormDefaultProp () | |
TextField ($name, $w, $h, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
RadioButton ($name, $w, $prop=array(), $opt=array(), $onvalue='On', $checked=false, $x='', $y='', $js=false) | |
ListBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
ComboBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
CheckBox ($name, $w, $checked=false, $prop=array(), $opt=array(), $onvalue='Yes', $x='', $y='', $js=false) | |
Button ($name, $w, $h, $caption, $action, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
setUserRights ($enable=true, $document='/FullSave', $annots='/Create/Delete/Modify/Copy/Import/Export', $form='/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate', $signature='/Modify', $ef='/Create/Delete/Modify/Import', $formex='') | |
setSignature ($signing_cert='', $private_key='', $private_key_password='', $extracerts='', $cert_type=2, $info=array()) | |
setSignatureAppearance ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') | |
addEmptySignatureAppearance ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') | |
startPageGroup ($page='') | |
setStartingPageNumber ($num=1) | |
getAliasRightShift () | |
getAliasNbPages () | |
getAliasNumPage () | |
getPageGroupAlias () | |
getPageNumGroupAlias () | |
getGroupPageNo () | |
getGroupPageNoFormatted () | |
PageNoFormatted () | |
startLayer ($name='', $print=true, $view=true) | |
endLayer () | |
setVisibility ($v) | |
setOverprint ($stroking=true, $nonstroking='', $mode=0) | |
getOverprint () | |
setAlpha ($stroking=1, $bm='Normal', $nonstroking='', $ais=false) | |
getAlpha () | |
setJPEGQuality ($quality) | |
setDefaultTableColumns ($cols=4) | |
setCellHeightRatio ($h) | |
getCellHeightRatio () | |
setPDFVersion ($version='1.7') | |
setViewerPreferences ($preferences) | |
colorRegistrationBar ($x, $y, $w, $h, $transition=true, $vertical=false, $colors='A, R, G, B, C, M, Y, K') | |
cropMark ($x, $y, $w, $h, $type='T, R, B, L', $color=array(100, 100, 100, 100,'All')) | |
registrationMark ($x, $y, $r, $double=false, $cola=array(100, 100, 100, 100,'All'), $colb=array(0, 0, 0, 0,'None')) | |
registrationMarkCMYK ($x, $y, $r) | |
LinearGradient ($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0, 0, 1, 0)) | |
RadialGradient ($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0.5, 0.5, 0.5, 0.5, 1)) | |
CoonsPatchMesh ($x, $y, $w, $h, $col1=array(), $col2=array(), $col3=array(), $col4=array(), $coords=array(0.00, 0.0, 0.33, 0.00, 0.67, 0.00, 1.00, 0.00, 1.00, 0.33, 1.00, 0.67, 1.00, 1.00, 0.67, 1.00, 0.33, 1.00, 0.00, 1.00, 0.00, 0.67, 0.00, 0.33), $coords_min=0, $coords_max=1, $antialias=false) | |
Gradient ($type, $coords, $stops, $background=array(), $antialias=false) | |
PieSector ($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90) | |
PieSectorXY ($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2) | |
ImageEps ($file, $x='', $y='', $w=0, $h=0, $link='', $useBoundingBox=true, $align='', $palign='', $border=0, $fitonpage=false, $fixoutvals=false) | |
setBarcode ($bc='') | |
getBarcode () | |
write1DBarcode ($code, $type, $x='', $y='', $w='', $h='', $xres='', $style='', $align='') | |
write2DBarcode ($code, $type, $x='', $y='', $w='', $h='', $style='', $align='', $distort=false) | |
getMargins () | |
getOriginalMargins () | |
getFontSize () | |
getFontSizePt () | |
getFontFamily () | |
getFontStyle () | |
fixHTMLCode ($html, $default_css='', $tagvs='', $tidy_options='') | |
getCSSPadding ($csspadding, $width=0) | |
getCSSMargin ($cssmargin, $width=0) | |
getCSSBorderMargin ($cssbspace, $width=0) | |
getHTMLFontUnits ($val, $refsize=12, $parent_size=12, $defaultunit='pt') | |
serializeTCPDFtagParameters ($pararray) | |
writeHTMLCell ($w, $h, $x, $y, $html='', $border=0, $ln=0, $fill=false, $reseth=true, $align='', $autopadding=true) | |
writeHTML ($html, $ln=true, $fill=false, $reseth=false, $cell=false, $align='') | |
setLIsymbol ($symbol='!') | |
SetBooklet ($booklet=true, $inner=-1, $outer=-1) | |
setHtmlVSpace ($tagvs) | |
setListIndentWidth ($width) | |
setOpenCell ($isopen) | |
setHtmlLinksStyle ($color=array(0, 0, 255), $fontstyle='U') | |
getHTMLUnitToUnits ($htmlval, $refsize=1, $defaultunit='px', $points=false) | |
movePage ($frompage, $topage) | |
deletePage ($page) | |
copyPage ($page=0) | |
addTOC ($page='', $numbersfont='', $filler='.', $toc_name='TOC', $style='', $color=array(0, 0, 0)) | |
addHTMLTOC ($page='', $toc_name='TOC', $templates=array(), $correct_align=true, $style='', $color=array(0, 0, 0)) | |
startTransaction () | |
commitTransaction () | |
rollbackTransaction ($self=false) | |
setEqualColumns ($numcols=0, $width=0, $y='') | |
resetColumns () | |
setColumnsArray ($columns) | |
selectColumn ($col='') | |
getColumn () | |
getNumberOfColumns () | |
setTextRenderingMode ($stroke=0, $fill=true, $clip=false) | |
setTextShadow ($params=array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal')) | |
getTextShadow () | |
hyphenateText ($text, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8) | |
setRasterizeVectorImages ($mode) | |
setFontSubsetting ($enable=true) | |
getFontSubsetting () | |
stringLeftTrim ($str, $replace='') | |
stringRightTrim ($str, $replace='') | |
stringTrim ($str, $replace='') | |
isUnicodeFont () | |
getFontFamilyName ($fontfamily) | |
startTemplate ($w=0, $h=0, $group=false) | |
endTemplate () | |
printTemplate ($id, $x='', $y='', $w=0, $h=0, $align='', $palign='', $fitonpage=false) | |
setFontStretching ($perc=100) | |
getFontStretching () | |
setFontSpacing ($spacing=0) | |
getFontSpacing () | |
getPageRegions () | |
setPageRegions ($regions=array()) | |
addPageRegion ($region) | |
removePageRegion ($key) | |
ImageSVG ($file, $x='', $y='', $w=0, $h=0, $link='', $align='', $palign='', $border=0, $fitonpage=false) | |
Geschützte Methoden | |
setPageFormat ($format, $orientation='P') | |
adjustCellPadding ($brd=0) | |
setContentMark ($page=0) | |
setHeader () | |
setFooter () | |
inPageBody () | |
setTableHeader () | |
getFontsList () | |
_putEmbeddedFiles () | |
checkPageBreak ($h=0, $y='', $addpage=true) | |
getCellCode ($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M') | |
replaceChar ($oldchar, $newchar) | |
getCellBorder ($x, $y, $w, $h, $brd) | |
getRemainingWidth () | |
fitBlock ($w, $h, $x, $y, $fitonpage=false) | |
ImagePngAlpha ($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $filehash='') | |
getGDgamma ($img, $c) | |
_dochecks () | |
getInternalPageNumberAliases ($a= '') | |
getAllInternalPageNumberAliases () | |
replaceRightShiftPageNumAliases ($page, $aliases, $diff) | |
setPageBoxTypes ($boxes) | |
_putpages () | |
_putannotsrefs ($n) | |
_getannotsrefs ($n) | |
_putannotsobjs () | |
_putAPXObject ($w=0, $h=0, $stream='') | |
_putfonts () | |
_puttruetypeunicode ($font) | |
_putcidfont0 ($font) | |
_putimages () | |
_putxobjects () | |
_putspotcolors () | |
_getxobjectdict () | |
_putresourcedict () | |
_putresources () | |
_putinfo () | |
_putXMP () | |
_putcatalog () | |
_putviewerpreferences () | |
_putheader () | |
_enddoc () | |
_beginpage ($orientation='', $format='') | |
_endpage () | |
_newobj () | |
_getobj ($objid='') | |
_dounderline ($x, $y, $txt) | |
_dounderlinew ($x, $y, $w) | |
_dolinethrough ($x, $y, $txt) | |
_dolinethroughw ($x, $y, $w) | |
_dooverline ($x, $y, $txt) | |
_dooverlinew ($x, $y, $w) | |
_datastring ($s, $n=0) | |
_datestring ($n=0, $timestamp=0) | |
_textstring ($s, $n=0) | |
_escapetext ($s) | |
_getrawstream ($s, $n=0) | |
_getstream ($s, $n=0) | |
_putstream ($s, $n=0) | |
_out ($s) | |
_objectkey ($n) | |
_encrypt_data ($n, $s) | |
_putencryption () | |
_Uvalue () | |
_UEvalue () | |
_Ovalue () | |
_OEvalue () | |
_fixAES256Password ($password) | |
_generateencryptionkey () | |
Transform ($tm) | |
_outPoint ($x, $y) | |
_outLine ($x, $y) | |
_outRect ($x, $y, $w, $h, $op) | |
_outCurve ($x1, $y1, $x2, $y2, $x3, $y3) | |
_outCurveV ($x2, $y2, $x3, $y3) | |
_outCurveY ($x1, $y1, $x3, $y3) | |
_outellipticalarc ($xc, $yc, $rx, $ry, $xang=0, $angs=0, $angf=360, $pie=false, $nc=2, $startpoint=true, $ccw=true, $svg=false) | |
_putdests () | |
sortBookmarks () | |
_putbookmarks () | |
_putjavascript () | |
_addfield ($type, $name, $x, $y, $w, $h, $prop) | |
_putsignature () | |
getSignatureAppearanceArray ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') | |
_putocg () | |
addExtGState ($parms) | |
setExtGState ($gs) | |
_putextgstates () | |
Clip ($x, $y, $w, $h) | |
_putshaders () | |
getCSSBorderWidth ($width) | |
getCSSBorderDashStyle ($style) | |
getCSSBorderStyle ($cssborder) | |
getCSSFontSpacing ($spacing, $parent=0) | |
getCSSFontStretching ($stretch, $parent=100) | |
getHtmlDomArray ($html) | |
getSpaceString () | |
openHTMLTagHandler ($dom, $key, $cell) | |
closeHTMLTagHandler ($dom, $key, $cell, $maxbottomliney=0) | |
addHTMLVertSpace ($hbz=0, $hb=0, $cell=false, $firsttag=false, $lasttag=false) | |
getBorderStartPosition () | |
drawHTMLTagBorder ($tag, $xmax) | |
swapMargins ($reverse=true) | |
putHtmlListBullet ($listdepth, $listtype='', $size=10) | |
getGraphicVars () | |
setGraphicVars ($gvars, $extended=false) | |
_outSaveGraphicsState () | |
_outRestoreGraphicsState () | |
writeDiskCache ($filename, $data, $append=false) | |
readDiskCache ($filename) | |
setBuffer ($data) | |
replaceBuffer ($data) | |
getBuffer () | |
setPageBuffer ($page, $data, $append=false) | |
getPageBuffer ($page) | |
setImageBuffer ($image, $data) | |
setImageSubBuffer ($image, $key, $data) | |
getImageBuffer ($image) | |
setFontBuffer ($font, $data) | |
setFontSubBuffer ($font, $key, $data) | |
getFontBuffer ($font) | |
hyphenateWord ($word, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8) | |
checkPageRegions ($h, $x, $y) | |
convertSVGtMatrix ($tm) | |
SVGTransform ($tm) | |
setSVGStyles ($svgstyle, $prevsvgstyle, $x=0, $y=0, $w=1, $h=1, $clip_function='', $clip_params=array()) | |
SVGPath ($d, $style='') | |
startSVGElementHandler ($parser, $name, $attribs, $ctm=array()) | |
endSVGElementHandler ($parser, $name) | |
segSVGContentHandler ($parser, $data) | |
PHP class for generating PDF documents without requiring external extensions. TCPDF project (http://www.tcpdf.org) has been originally derived in 2002 from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org), but now is almost entirely rewritten.
__construct | ( | $orientation = 'P' , |
|
$unit = 'mm' , |
|||
$format = 'A4' , |
|||
$unicode = true , |
|||
$encoding = 'UTF-8' , |
|||
$diskcache = false , |
|||
$pdfa = false |
|||
) |
This is the class constructor. It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).
IMPORTANT: Please note that this method sets the mb_internal_encoding to ASCII, so if you are using the mbstring module functions with TCPDF you need to correctly set/unset the mb_internal_encoding when needed.
$orientation | (string) page orientation. Possible values are (case insensitive):
|
$unit | (string) User measure unit. Possible values are:
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit. |
$format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
$unicode | (boolean) TRUE means that the input text is unicode (default = true) |
$encoding | (string) Charset encoding (used only when converting back html entities); default is UTF-8. |
$diskcache | (boolean) If TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower). |
$pdfa | (boolean) If TRUE set the document to PDF/A mode. |
Definiert in Zeile 1831 der Datei tcpdf.php.
Benutzt $diskcache, $doc_creation_timestamp, $encoding, $k, $lMargin, $rMargin, _dochecks(), getFontsList(), getGraphicVars(), TCPDF_STATIC\getRandomSeed(), PDF_FONT_NAME_MAIN, SetAutoPageBreak(), setCellMargins(), setCellPaddings(), SetCompression(), SetDisplayMode(), SetFont(), setFooterFont(), setHeaderFont(), SetMargins(), setPageFormat(), setPageUnit(), setPDFVersion(), setSpacesRE(), setTextShadow() und TCPDF_FONTS\utf8Bidi().
__destruct | ( | ) |
Default destructor.
Definiert in Zeile 1984 der Datei tcpdf.php.
Benutzt _destroy().
|
protected |
Adds a javascript form field.
$type | (string) field type |
$name | (string) field name |
$x | (int) horizontal position |
$y | (int) vertical position |
$w | (int) width |
$h | (int) height |
$prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
Definiert in Zeile 12590 der Datei tcpdf.php.
Benutzt $h, $k, $w, $x, $y und TCPDF_COLORS\_JScolor().
Wird benutzt von Button(), ListBox(), RadioButton() und TextField().
|
protected |
Initialize a new page.
$orientation | (string) page orientation. Possible values are (case insensitive):
|
$format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
Definiert in Zeile 9984 der Datei tcpdf.php.
Benutzt $CurOrientation, $currpagegroup, $lMargin, $page, $rMargin, $tMargin, TCPDF_STATIC\empty_string(), setPageBuffer(), setPageFormat() und setPageOrientation().
Wird benutzt von startPage().
|
protected |
Format a data string for meta information
$s | (string) data string to escape. |
$n | (int) object ID |
Definiert in Zeile 10143 der Datei tcpdf.php.
Benutzt $n, _encrypt_data() und TCPDF_STATIC\_escape().
Wird benutzt von _datestring() und _textstring().
|
protected |
Returns a formatted date for meta information
$n | (int) Object ID. |
$timestamp | (int) Timestamp to convert. |
Definiert in Zeile 10205 der Datei tcpdf.php.
Benutzt $doc_creation_timestamp, $n, _datastring() und TCPDF_STATIC\getFormattedDate().
_destroy | ( | $destroyall = false , |
|
$preserve_objcopy = false |
|||
) |
Unset all class variables except the following critical variables.
$destroyall | (boolean) if true destroys all class variables, otherwise preserves critical variables. |
$preserve_objcopy | (boolean) if true preserves the objcopy variable |
Definiert in Zeile 7739 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string().
Wird benutzt von __destruct(), Close() und Error().
|
protected |
Check for locale-related bug
Definiert in Zeile 7777 der Datei tcpdf.php.
Benutzt Error().
Wird benutzt von __construct().
|
protected |
Line through text.
$x | (int) X coordinate |
$y | (int) Y coordinate |
$txt | (string) text to linethrough |
Definiert in Zeile 10091 der Datei tcpdf.php.
Benutzt $w, $x, $y, _dolinethroughw() und GetStringWidth().
|
protected |
Line through for rectangular text area.
$x | (int) X coordinate |
$y | (int) Y coordinate |
$w | (int) line length (width) |
Definiert in Zeile 10104 der Datei tcpdf.php.
Benutzt $FontSizePt, $w, $x und $y.
Wird benutzt von _dolinethrough().
|
protected |
Overline text.
$x | (int) X coordinate |
$y | (int) Y coordinate |
$txt | (string) text to overline |
Definiert in Zeile 10117 der Datei tcpdf.php.
Benutzt $w, $x, $y, _dooverlinew() und GetStringWidth().
|
protected |
Overline for rectangular text area.
$x | (int) X coordinate |
$y | (int) Y coordinate |
$w | (int) width to overline |
Definiert in Zeile 10130 der Datei tcpdf.php.
Benutzt $FontSizePt, $w, $x und $y.
Wird benutzt von _dooverline().
|
protected |
Underline text.
$x | (int) X coordinate |
$y | (int) Y coordinate |
$txt | (string) text to underline |
Definiert in Zeile 10066 der Datei tcpdf.php.
Benutzt $w, $x, $y, _dounderlinew() und GetStringWidth().
|
protected |
Underline for rectangular text area.
$x | (int) X coordinate |
$y | (int) Y coordinate |
$w | (int) width to underline |
Definiert in Zeile 10079 der Datei tcpdf.php.
Benutzt $FontSizePt, $w, $x und $y.
Wird benutzt von _dounderline().
|
protected |
Encrypt the input string.
$n | (int) object number |
$s | (string) data string to encrypt |
Definiert in Zeile 10482 der Datei tcpdf.php.
Benutzt $n, TCPDF_STATIC\_AES(), _objectkey() und TCPDF_STATIC\_RC4().
Wird benutzt von _datastring() und _getrawstream().
|
protected |
Output end of document (EOF).
Definiert in Zeile 9882 der Datei tcpdf.php.
Benutzt $bufferlen, $n, _getobj(), _out(), _putcatalog(), _putheader(), _putinfo(), _putpages(), _putresources(), _putsignature() und setFontSubBuffer().
Wird benutzt von Close().
|
protected |
Mark end of page.
Definiert in Zeile 10027 der Datei tcpdf.php.
Benutzt setVisibility().
Wird benutzt von endPage().
|
protected |
THIS METHOD IS DEPRECATED Format a text string
$s | (string) string to escape. |
Definiert in Zeile 10235 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\_escape(), TCPDF_FONTS\utf8StrRev() und TCPDF_FONTS\UTF8ToLatin1().
|
protected |
Convert password for AES-256 encryption mode
$password | (string) password |
Definiert in Zeile 10728 der Datei tcpdf.php.
Benutzt TCPDF_FONTS\unichr(), TCPDF_FONTS\utf8Bidi() und TCPDF_FONTS\UTF8StringToArray().
Wird benutzt von _generateencryptionkey().
|
protected |
Compute encryption key
Definiert in Zeile 10743 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$enc_padding, _fixAES256Password(), TCPDF_STATIC\_md5_16(), _OEvalue(), _Ovalue(), _UEvalue(), _Uvalue(), Error(), TCPDF_STATIC\getEncPermissionsString(), TCPDF_STATIC\getObjFilename(), TCPDF_STATIC\getRandomSeed() und TCPDF_STATIC\getUserPermissionCode().
Wird benutzt von SetProtection().
|
protected |
Get references to page annotations.
$n | (int) page number |
Definiert in Zeile 8057 der Datei tcpdf.php.
Benutzt $n.
Wird benutzt von _putannotsrefs() und _putpages().
|
protected |
Return the starting object string for the selected object ID.
$objid | (int) Object ID (leave empty to get a new ID). |
Definiert in Zeile 10049 der Datei tcpdf.php.
Benutzt $bufferlen, $n und $page.
Wird benutzt von _enddoc(), _newobj(), _putannotsobjs(), _putAPXObject(), _putcidfont0(), _putEmbeddedFiles(), _putfonts(), _putjavascript(), _putpages(), _putresourcedict(), _putsignature(), _puttruetypeunicode() und _putxobjects().
|
protected |
get raw output stream.
$s | (string) string to output. |
$n | (int) object reference for encryption mode |
Definiert in Zeile 10255 der Datei tcpdf.php.
Benutzt $n und _encrypt_data().
Wird benutzt von _getstream(), _putAPXObject(), _putcatalog(), _putEmbeddedFiles(), _putfonts(), _putimages(), _putpages(), _putshaders(), _puttruetypeunicode() und _putxobjects().
|
protected |
Format output stream (DEPRECATED).
$s | (string) string to output. |
$n | (int) object reference for encryption mode |
Definiert in Zeile 10270 der Datei tcpdf.php.
Benutzt $n und _getrawstream().
Wird benutzt von _putstream().
|
protected |
Return XObjects Dictionary.
Definiert in Zeile 9320 der Datei tcpdf.php.
Wird benutzt von _putresourcedict().
|
protected |
Begin a new object and return the object number.
Definiert in Zeile 10037 der Datei tcpdf.php.
Benutzt $n, _getobj() und _out().
Wird benutzt von _putbookmarks(), _putcatalog(), _putcidfont0(), _putdests(), _putencryption(), _putextgstates(), _putfonts(), _putimages(), _putinfo(), _putjavascript(), _putocg(), _putpages(), _putshaders(), _putspotcolors(), _puttruetypeunicode() und _putXMP().
|
protected |
Compute encryption key depending on object number where the encrypted data is stored. This is used for all strings and streams without crypt filter specifier.
$n | (int) object number |
Definiert in Zeile 10462 der Datei tcpdf.php.
Benutzt $n und TCPDF_STATIC\_md5_16().
Wird benutzt von _encrypt_data().
|
protected |
Compute OE value (used for encryption)
Definiert in Zeile 10714 der Datei tcpdf.php.
Wird benutzt von _generateencryptionkey().
|
protected |
Output a string to the document.
$s | (string) string to output. |
Definiert in Zeile 10290 der Datei tcpdf.php.
Benutzt $page, $xobjid, getPageBuffer(), setBuffer() und setPageBuffer().
Wird benutzt von _enddoc(), _newobj(), _outCurve(), _outCurveV(), _outCurveY(), _outLine(), _outPoint(), _outRect(), _putannotsobjs(), _putannotsrefs(), _putAPXObject(), _putbookmarks(), _putcatalog(), _putcidfont0(), _putdests(), _putEmbeddedFiles(), _putencryption(), _putextgstates(), _putfonts(), _putheader(), _putimages(), _putinfo(), _putjavascript(), _putocg(), _putpages(), _putresourcedict(), _putshaders(), _putsignature(), _putspotcolors(), _putstream(), _puttruetypeunicode(), _putXMP(), _putxobjects(), Cell(), Clip(), CoonsPatchMesh(), Curve(), Ellipse(), endLayer(), Gradient(), Image(), ImageEps(), Line(), PieSectorXY(), Polycurve(), Polygon(), RoundedRectXY(), setColor(), setExtGState(), SetFontSize(), setFooter(), SetLineStyle(), SetLineWidth(), setSpotColor(), setVisibility(), startLayer() und Transform().
|
protected |
Append a cubic Bezier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bezier control points. The new current point shall be (x3, y3).
$x1 | (float) Abscissa of control point 1. |
$y1 | (float) Ordinate of control point 1. |
$x2 | (float) Abscissa of control point 2. |
$y2 | (float) Ordinate of control point 2. |
$x3 | (float) Abscissa of end point. |
$y3 | (float) Ordinate of end point. |
Definiert in Zeile 11454 der Datei tcpdf.php.
Benutzt _out().
Wird benutzt von _outellipticalarc(), Curve(), Polycurve() und RoundedRectXY().
|
protected |
Append a cubic Bezier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bezier control points. The new current point shall be (x3, y3).
$x2 | (float) Abscissa of control point 2. |
$y2 | (float) Ordinate of control point 2. |
$x3 | (float) Abscissa of end point. |
$y3 | (float) Ordinate of end point. |
Definiert in Zeile 11470 der Datei tcpdf.php.
Benutzt _out().
|
protected |
Append a cubic Bezier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bezier control points. The new current point shall be (x3, y3).
$x1 | (float) Abscissa of control point 1. |
$y1 | (float) Ordinate of control point 1. |
$x3 | (float) Abscissa of end point. |
$y3 | (float) Ordinate of end point. |
Definiert in Zeile 11486 der Datei tcpdf.php.
Benutzt _out().
|
protected |
Append an elliptical arc to the current path. An ellipse is formed from n Bezier curves.
$xc | (float) Abscissa of center point. |
$yc | (float) Ordinate of center point. |
$rx | (float) Horizontal radius. |
$ry | (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0. |
$xang,: | (float) Angle between the X-axis and the major axis of the ellipse. Default value: 0. |
$angs,: | (float) Angle start of draw line. Default value: 0. |
$angf,: | (float) Angle finish of draw line. Default value: 360. |
$pie | (boolean) if true do not mark the border point (used to draw pie sectors). |
$nc | (integer) Number of curves used to draw a 90 degrees portion of ellipse. |
$startpoint | (boolean) if true output a starting point. |
$ccw | (boolean) if true draws in counter-clockwise. |
$svg | (boolean) if true the angles are in svg mode (already calculated). |
Definiert in Zeile 11715 der Datei tcpdf.php.
Benutzt $alpha, $k, _outCurve(), _outLine() und _outPoint().
Wird benutzt von Ellipse() und PieSectorXY().
|
protected |
Append a straight line segment from the current point to the point (x, y). The new current point shall be (x, y).
$x | (float) Abscissa of end point. |
$y | (float) Ordinate of end point. |
Definiert in Zeile 11420 der Datei tcpdf.php.
Wird benutzt von _outellipticalarc(), Line(), Polygon() und RoundedRectXY().
|
protected |
Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
$x | (float) Abscissa of point. |
$y | (float) Ordinate of point. |
Definiert in Zeile 11406 der Datei tcpdf.php.
Wird benutzt von _outellipticalarc(), Curve(), Line(), Polycurve(), Polygon() und RoundedRectXY().
|
protected |
Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space.
$x | (float) Abscissa of upper-left corner. |
$y | (float) Ordinate of upper-left corner. |
$w | (float) Width. |
$h | (float) Height. |
$op | (string) options |
Definiert in Zeile 11436 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y und _out().
Wird benutzt von Rect().
|
protected |
Outputs the "restore graphics state" operator 'Q'
Definiert in Zeile 20556 der Datei tcpdf.php.
Wird benutzt von Close(), CoonsPatchMesh(), Gradient(), setFooter(), setHeader() und StopTransform().
|
protected |
Outputs the "save graphics state" operator 'q'
Definiert in Zeile 20548 der Datei tcpdf.php.
Wird benutzt von Close(), setFooter(), setHeader() und StartTransform().
|
protected |
Compute O value (used for encryption)
Definiert in Zeile 10676 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\_md5_16(), TCPDF_STATIC\_RC4() und TCPDF_STATIC\getRandomSeed().
Wird benutzt von _generateencryptionkey().
|
protected |
Output annotations objects for all pages. !!! THIS METHOD IS NOT YET COMPLETED !!! See section 12.5 of PDF 32000_2008 reference.
Definiert in Zeile 8101 der Datei tcpdf.php.
Benutzt $k, $l, $n, $numpages, _getobj(), _out(), _putAPXObject(), _textstring(), getImageBuffer() und unhtmlentities().
Wird benutzt von _putresources().
|
protected |
|
protected |
Put appearance streams XObject used to define annotation's appearance states.
$w | (int) annotation width |
$h | (int) annotation height |
$stream | (string) appearance stream |
Definiert in Zeile 8732 der Datei tcpdf.php.
Benutzt $h, $n, $w, _getobj(), _getrawstream() und _out().
Wird benutzt von _putannotsobjs().
|
protected |
Create a bookmark PDF string.
Definiert in Zeile 12377 der Datei tcpdf.php.
Benutzt $l, $n, $title, _newobj(), _out(), sortBookmarks(), stringTrim() und unhtmlentities().
Wird benutzt von _putresources().
|
protected |
Output Catalog.
Definiert in Zeile 9618 der Datei tcpdf.php.
Benutzt _getrawstream(), _newobj(), _out(), _putviewerpreferences(), _putXMP(), TCPDF_STATIC\empty_string() und getFontBuffer().
Wird benutzt von _enddoc().
|
protected |
Output CID-0 fonts. A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format
$font | (array) font data |
Definiert in Zeile 9018 der Datei tcpdf.php.
Benutzt $k, _getobj(), _newobj() und _out().
|
protected |
Insert Named Destinations.
Definiert in Zeile 12275 der Datei tcpdf.php.
Wird benutzt von _putresources().
|
protected |
Embedd the attached files.
Definiert in Zeile 4842 der Datei tcpdf.php.
Benutzt _getobj(), _getrawstream(), _out() und TCPDF_STATIC\fileGetContents().
Wird benutzt von _putresources().
|
protected |
Put encryption on PDF document.
Definiert in Zeile 10510 der Datei tcpdf.php.
Wird benutzt von _putresources().
|
protected |
Put extgstates for object transparency
Definiert in Zeile 13798 der Datei tcpdf.php.
Benutzt $k, _newobj() und _out().
Wird benutzt von _putresources().
|
protected |
Output fonts.
Definiert in Zeile 8762 der Datei tcpdf.php.
Benutzt $k, $n, _getobj(), _getrawstream(), TCPDF_FONTS\_getTrueTypeFontSubset(), _newobj(), _out(), TCPDF_STATIC\empty_string(), Error(), TCPDF_STATIC\get_mqr(), getFontBuffer(), TCPDF_FONTS\getFontFullPath() und TCPDF_STATIC\set_mqr().
Wird benutzt von _putresources().
|
protected |
|
protected |
Output images.
Definiert in Zeile 9088 der Datei tcpdf.php.
Benutzt $compress, _getrawstream(), _newobj(), _out(), getImageBuffer() und setImageSubBuffer().
Wird benutzt von _putresources().
|
protected |
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
Definiert in Zeile 9419 der Datei tcpdf.php.
Benutzt $isunicode, _newobj(), _out(), TCPDF_STATIC\empty_string() und TCPDF_STATIC\getTCPDFProducer().
Wird benutzt von _enddoc().
|
protected |
Create a javascript PDF string.
Definiert in Zeile 12532 der Datei tcpdf.php.
Benutzt _getobj(), _newobj() und _out().
Wird benutzt von _putresources().
|
protected |
Put pdf layers.
Definiert in Zeile 13655 der Datei tcpdf.php.
Wird benutzt von _putresources().
|
protected |
Output pages (and replace page number aliases).
Definiert in Zeile 7881 der Datei tcpdf.php.
Benutzt $compress, $k, $n, $numpages, $pagelen, _getannotsrefs(), _getobj(), _getrawstream(), _newobj(), _out(), TCPDF_STATIC\formatPageNumber(), getAllInternalPageNumberAliases(), GetNumChars(), getPageBuffer(), TCPDF_STATIC\replacePageNumAliases(), replaceRightShiftPageNumAliases() und TCPDF_FONTS\UTF8ToUTF16BE().
Wird benutzt von _enddoc().
|
protected |
Output Resources Dictionary.
Definiert in Zeile 9332 der Datei tcpdf.php.
Benutzt $k, _getobj(), _getxobjectdict(), _out() und getFontBuffer().
Wird benutzt von _putresources().
|
protected |
Output Resources.
Definiert in Zeile 9396 der Datei tcpdf.php.
Benutzt _putannotsobjs(), _putbookmarks(), _putdests(), _putEmbeddedFiles(), _putencryption(), _putextgstates(), _putfonts(), _putimages(), _putjavascript(), _putocg(), _putresourcedict(), _putshaders(), _putspotcolors() und _putxobjects().
Wird benutzt von _enddoc().
|
protected |
Output gradient shaders.
Definiert in Zeile 14534 der Datei tcpdf.php.
Benutzt $n, _getrawstream(), _newobj() und _out().
Wird benutzt von _putresources().
|
protected |
Add certification signature (DocMDP or UR3) You can set only one signature type
Definiert in Zeile 13299 der Datei tcpdf.php.
Benutzt _getobj(), _out() und TCPDF_STATIC\empty_string().
Wird benutzt von _enddoc().
|
protected |
|
protected |
|
protected |
Adds unicode fonts.
Based on PDF Reference 1.3 (section 5)
$font | (array) font data |
Definiert in Zeile 8914 der Datei tcpdf.php.
Benutzt $compress, TCPDF_FONT_DATA\$uni_identity_h, _getobj(), _getrawstream(), _newobj(), _out(), TCPDF_STATIC\empty_string(), Error() und TCPDF_FONTS\getFontFullPath().
|
protected |
Output viewer preferences.
Definiert in Zeile 9801 der Datei tcpdf.php.
Benutzt $k, $viewer_preferences und TCPDF_STATIC\empty_string().
Wird benutzt von _putcatalog().
|
protected |
Put XMP data object and return ID.
Definiert in Zeile 9480 der Datei tcpdf.php.
Benutzt $custom_xmp, $encrypted, $isunicode, TCPDF_STATIC\_escapeXML(), _newobj(), _out(), TCPDF_STATIC\getFormattedDate() und TCPDF_STATIC\getTCPDFProducer().
Wird benutzt von _putcatalog().
|
protected |
Output Form XObjects Templates.
Definiert in Zeile 9197 der Datei tcpdf.php.
Benutzt $k, _getobj(), _getrawstream() und _out().
Wird benutzt von _putresources().
|
protected |
Format a text string for meta information
$s | (string) string to escape. |
$n | (int) object ID |
Definiert in Zeile 10219 der Datei tcpdf.php.
Benutzt $n, _datastring() und TCPDF_FONTS\UTF8ToUTF16BE().
Wird benutzt von _putannotsobjs() und Button().
|
protected |
Compute UE value (used for encryption)
Definiert in Zeile 10663 der Datei tcpdf.php.
Wird benutzt von _generateencryptionkey().
|
protected |
Compute U value (used for encryption)
Definiert in Zeile 10630 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$enc_padding, TCPDF_STATIC\_md5_16(), TCPDF_STATIC\_RC4() und TCPDF_STATIC\getRandomSeed().
Wird benutzt von _generateencryptionkey().
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().
This method is called automatically and should not be called directly by the application.
Definiert in Zeile 4920 der Datei tcpdf.php.
Benutzt $AutoPageBreak, AddPage() und selectColumn().
Wird benutzt von checkPageBreak() und Write().
addEmptySignatureAppearance | ( | $x = 0 , |
|
$y = 0 , |
|||
$w = 0 , |
|||
$h = 0 , |
|||
$page = -1 , |
|||
$name = '' |
|||
) |
Add an empty digital signature appearance (a cliccable rectangle area to get signature properties)
$x | (float) Abscissa of the upper-left corner. |
$y | (float) Ordinate of the upper-left corner. |
$w | (float) Width of the signature area. |
$h | (float) Height of the signature area. |
$page | (int) option page number (if < 0 the current page is used). |
$name | (string) Name of the signature. |
Definiert in Zeile 13473 der Datei tcpdf.php.
Benutzt $h, $n, $page, $w, $x, $y und getSignatureAppearanceArray().
|
protected |
Add transparency parameters to the current extgstate
$parms | (array) parameters |
Definiert in Zeile 13754 der Datei tcpdf.php.
Wird benutzt von setAlpha() und setOverprint().
AddFont | ( | $family, | |
$style = '' , |
|||
$fontfile = '' , |
|||
$subset = 'default' |
|||
) |
Imports a TrueType, Type1, core, or CID0 font and makes it available. It is necessary to generate a font definition file first (read /fonts/utils/README.TXT). 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.
$family | (string) Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font. |
$style | (string) Font style. Possible values are (case insensitive):
|
$fontfile | (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces. |
$subset | (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font. |
Definiert in Zeile 4190 der Datei tcpdf.php.
Benutzt $font_subsetting, $FontFamily, $numfonts, $xobjid, TCPDF_STATIC\empty_string(), Error(), getFontBuffer(), TCPDF_FONTS\getFontFullPath(), setFontBuffer() und setFontSubBuffer().
Wird benutzt von getFontAscent(), getFontDescent(), isCharDefined(), RadioButton(), replaceMissingChars() und SetFont().
addHtmlLink | ( | $url, | |
$name, | |||
$fill = false , |
|||
$firstline = false , |
|||
$color = '' , |
|||
$style = -1 , |
|||
$firstblock = false |
|||
) |
Output anchor link.
$url | (string) link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>) |
$name | (string) link name |
$fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
$firstline | (boolean) if true prints only the first line and return the remaining string. |
$color | (array) array of RGB text color |
$style | (string) font style (U, D, B, I) |
$firstblock | (boolean) if true the string is the starting of a line. |
Definiert in Zeile 10391 der Datei tcpdf.php.
Benutzt $fgcolor, $FontStyle, $page, AddLink(), SetFont(), SetLink(), SetTextColorArray() und Write().
Wird benutzt von writeHTML().
addHTMLTOC | ( | $page = '' , |
|
$toc_name = 'TOC' , |
|||
$templates = array() , |
|||
$correct_align = true , |
|||
$style = '' , |
|||
$color = array(0,0,0) |
|||
) |
Output a Table Of Content Index (TOC) using HTML templates. This method must be called after all Bookmarks were set. Before calling this method you have to open the page using the addTOCPage() method. After calling this method you have to call endTOCPage() to close the TOC page.
$page | (int) page number where this TOC should be inserted (leave empty for current page). |
$toc_name | (string) name to use for TOC bookmark. |
$templates | (array) array of html templates. Use: "#TOC_DESCRIPTION#" for bookmark title, "#TOC_PAGE_NUMBER#" for page number. |
$correct_align | (boolean) if true correct the number alignment (numbers must be in monospaced font like courier and right aligned on LTR, or left aligned on RTL) |
$style | (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic. |
$color | (array) RGB color array for title (values from 0 to 255). |
Definiert in Zeile 21462 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string(), TCPDF_STATIC\formatTOCPageNumber() und TCPDF_FONTS\UTF8ToUTF16BE().
|
protected |
Add vertical spaces if needed.
$hbz | (string) Distance between current y and line bottom. |
$hb | (string) The height of the break. |
$cell | (boolean) if true add the default left (or right if RTL) padding to each new line (default false). |
$firsttag | (boolean) set to true when the tag is the first. |
$lasttag | (boolean) set to true when the tag is the last. |
Definiert in Zeile 19784 der Datei tcpdf.php.
Wird benutzt von openHTMLTagHandler().
addJavascriptObject | ( | $script, | |
$onload = false |
|||
) |
Adds a javascript object and return object ID
$script | (string) Javascript code |
$onload | (boolean) if true executes this object when opening the document |
Definiert in Zeile 12516 der Datei tcpdf.php.
Benutzt $n.
Wird benutzt von Button().
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().
Definiert in Zeile 4696 der Datei tcpdf.php.
Benutzt $n.
Wird benutzt von addHtmlLink() und openHTMLTagHandler().
AddPage | ( | $orientation = '' , |
|
$format = '' , |
|||
$keepmargins = false , |
|||
$tocpage = false |
|||
) |
Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer (if enabled). Then the page is added, the current position set to the top-left corner according to the left and top margins (or top-right if in RTL mode), and Header() is called to display the header (if enabled). The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.
$orientation | (string) page orientation. Possible values are (case insensitive):
|
$format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
$keepmargins | (boolean) if true overwrites the default page margins with the current margins |
$tocpage | (boolean) if true set the tocpage state to true (the added page will be used to display Table Of Content). |
Definiert in Zeile 3089 der Datei tcpdf.php.
Benutzt $lMargin, $rMargin, $tocpage, endPage() und startPage().
Wird benutzt von AcceptPageBreak(), addTOCPage(), checkPageBreak() und Close().
addPageRegion | ( | $region) |
Add a single no-write region on selected page. A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment. You can set multiple regions for the same page.
$region | (array) array of a single no-write region array: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right). |
AddSpotColor | ( | $name, | |
$c, | |||
$m, | |||
$y, | |||
$k | |||
) |
Defines a new spot color. 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.
$name | (string) Full name of the spot color. |
$c | (float) Cyan color for CMYK. Value between 0 and 100. |
$m | (float) Magenta color for CMYK. Value between 0 and 100. |
$y | (float) Yellow color for CMYK. Value between 0 and 100. |
$k | (float) Key (Black) color for CMYK. Value between 0 and 100. |
Definiert in Zeile 3703 der Datei tcpdf.php.
Wird benutzt von ImageEps() und setColor().
addTOC | ( | $page = '' , |
|
$numbersfont = '' , |
|||
$filler = '.' , |
|||
$toc_name = 'TOC' , |
|||
$style = '' , |
|||
$color = array(0,0,0) |
|||
) |
Output a Table of Content Index (TOC). This method must be called after all Bookmarks were set. Before calling this method you have to open the page using the addTOCPage() method. After calling this method you have to call endTOCPage() to close the TOC page. You can override this method to achieve different styles.
$page | (int) page number where this TOC should be inserted (leave empty for current page). |
$numbersfont | (string) set the font for page numbers (please use monospaced font for better alignment). |
$filler | (string) string used to fill the space between text and page number. |
$toc_name | (string) name to use for TOC bookmark. |
$style | (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic. |
$color | (array) RGB color array for bookmark title (values from 0 to 255). |
Definiert in Zeile 21252 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string(), TCPDF_STATIC\formatTOCPageNumber() und TCPDF_FONTS\UTF8ToUTF16BE().
addTOCPage | ( | $orientation = '' , |
|
$format = '' , |
|||
$keepmargins = false |
|||
) |
Adds a new TOC (Table Of Content) page to the document.
$orientation | (string) page orientation. |
$format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
$keepmargins | (boolean) if true overwrites the default page margins with the current margins |
Definiert in Zeile 3064 der Datei tcpdf.php.
Benutzt AddPage().
addTTFfont | ( | $fontfile, | |
$fonttype = '' , |
|||
$enc = '' , |
|||
$flags = 32 , |
|||
$outpath = '' , |
|||
$platid = 3 , |
|||
$encid = 1 , |
|||
$addcbbox = false |
|||
) |
Convert and add the selected TrueType or Type1 font to the fonts folder (that must be writeable).
$fontfile | (string) Font file (full path). |
$fonttype | (string) Font type. Leave empty for autodetect mode. Valid values are: TrueTypeUnicode, TrueType, Type1, CID0JP = CID-0 Japanese, CID0KR = CID-0 Korean, CID0CS = CID-0 Chinese Simplified, CID0CT = CID-0 Chinese Traditional. |
$enc | (string) Name of the encoding table to use. Leave empty for default mode. Omit this parameter for TrueType Unicode and symbolic fonts like Symbol or ZapfDingBats. |
$flags | (int) Unsigned 32-bit integer containing flags specifying various characteristics of the font (PDF32000:2008 - 9.8.2 Font Descriptor Flags): +1 for fixed font; +4 for symbol or +32 for non-symbol; +64 for italic. Fixed and Italic mode are generally autodetected so you have to set it to 32 = non-symbolic font (default) or 4 = symbolic font. |
$outpath | (string) Output path for generated font files (must be writeable by the web server). Leave empty for default font folder. |
$platid | (int) Platform ID for CMAP table to extract (when building a Unicode font for Windows this value should be 3, for Macintosh should be 1). |
$encid | (int) Encoding ID for CMAP table to extract (when building a Unicode font for Windows this value should be 1, for Macintosh should be 0). When Platform ID is 3, legal values for Encoding ID are: 0=Symbol, 1=Unicode, 2=ShiftJIS, 3=PRC, 4=Big5, 5=Wansung, 6=Johab, 7=Reserved, 8=Reserved, 9=Reserved, 10=UCS-4. |
$addcbbox | (boolean) If true includes the character bounding box information on the php font file. |
Definiert in Zeile 4173 der Datei tcpdf.php.
Benutzt TCPDF_FONTS\addTTFfont().
|
protected |
Adjust the internal Cell padding array to take account of the line width.
$brd | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
Definiert in Zeile 2702 der Datei tcpdf.php.
Benutzt $cell_padding und $LineWidth.
Wird benutzt von Cell(), getCellCode(), getNumLines(), getStringHeight() und MultiCell().
Annotation | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$text, | |||
$opt = array('Subtype'=>'Text') , |
|||
$spaces = 0 |
|||
) |
Puts a markup annotation on a rectangular area of the page. !!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!
$x | (float) Abscissa of the upper-left corner of the rectangle |
$y | (float) Ordinate of the upper-left corner of the rectangle |
$w | (float) Width of the rectangle |
$h | (float) Height of the rectangle |
$text | (string) annotation text or alternate content |
$opt | (array) array of options (see section 8.4 of PDF reference 1.7). |
$spaces | (int) number of spaces on the text to link |
Definiert in Zeile 4752 der Datei tcpdf.php.
Benutzt $h, $k, $page, $w, $x, $xobjid, $y, checkPageRegions(), TCPDF_STATIC\empty_string(), Image() und TCPDF_STATIC\isValidURL().
Wird benutzt von Button(), Link(), RadioButton() und TextField().
Arrow | ( | $x0, | |
$y0, | |||
$x1, | |||
$y1, | |||
$head_style = 0 , |
|||
$arm_size = 5 , |
|||
$arm_angle = 15 |
|||
) |
Draws a grahic arrow.
$x0 | (float) Abscissa of first point. |
$y0 | (float) Ordinate of first point. |
$x1 | (float) Abscissa of second point. |
$y1 | (float) Ordinate of second point. |
$head_style | (int) (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead) |
$arm_size | (float) length of arrowhead arms |
$arm_angle | (int) angle between an arm and the shaft |
Definiert in Zeile 12163 der Datei tcpdf.php.
Benutzt $LineWidth, Line() und Polygon().
Bookmark | ( | $txt, | |
$level = 0 , |
|||
$y = -1 , |
|||
$page = '' , |
|||
$style = '' , |
|||
$color = array(0,0,0) , |
|||
$x = -1 , |
|||
$link = '' |
|||
) |
Adds a bookmark.
$txt | (string) Bookmark description. |
$level | (int) Bookmark level (minimum value is 0). |
$y | (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;). |
$page | (int) Target page number (leave empty for current page). |
$style | (string) Font style: B = Bold, I = Italic, BI = Bold + Italic. |
$color | (array) RGB color array (values from 0 to 255). |
$x | (float) X position in user units of the bookmark on the selected page (default = -1 = current position;). |
$link | (mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name). |
Definiert in Zeile 12318 der Datei tcpdf.php.
Benutzt $h, $page, $w, $x, $y, GetX(), GetY() und PageNo().
Wird benutzt von setBookmark().
Button | ( | $name, | |
$w, | |||
$h, | |||
$caption, | |||
$action, | |||
$prop = array() , |
|||
$opt = array() , |
|||
$x = '' , |
|||
$y = '' , |
|||
$js = false |
|||
) |
Creates a button field
$name | (string) field name |
$w | (int) width |
$h | (int) height |
$caption | (string) caption. |
$action | (mixed) action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008. |
$prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
$opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
$x | (float) Abscissa of the upper-left corner of the rectangle |
$y | (float) Ordinate of the upper-left corner of the rectangle |
$js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definiert in Zeile 13132 der Datei tcpdf.php.
Benutzt $h, $k, $n, $w, $x, $y, _addfield(), _textstring(), addJavascriptObject(), Annotation(), Cell(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), SetFillColor() und startTemplate().
Wird benutzt von openHTMLTagHandler().
Cell | ( | $w, | |
$h = 0 , |
|||
$txt = '' , |
|||
$border = 0 , |
|||
$ln = 0 , |
|||
$align = '' , |
|||
$fill = false , |
|||
$link = '' , |
|||
$stretch = 0 , |
|||
$ignore_min_height = false , |
|||
$calign = 'T' , |
|||
$valign = 'M' |
|||
) |
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.
$w | (float) Cell width. If 0, the cell extends up to the right margin. |
$h | (float) Cell height. Default value: 0. |
$txt | (string) String to print. Default value: empty string. |
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
$ln | (int) Indicates where the current position should go after the call. Possible values are:
|
$align | (string) Allows to center or align the text. Possible values are:
|
$fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
$link | (mixed) URL or identifier returned by AddLink(). |
$stretch | (int) font stretch mode:
|
$ignore_min_height | (boolean) if true ignore automatic minimum height value. |
$calign | (string) cell vertical alignment relative to the specified Y value. Possible values are:
|
$valign | (string) text vertical alignment inside the cell. Possible values are:
|
Definiert in Zeile 5001 der Datei tcpdf.php.
Benutzt $alpha, $bgcolor, $cell_margin, $cell_padding, $fgcolor, $h, $strokecolor, $w, $x, $y, _out(), adjustCellPadding(), checkPageBreak(), getCellCode(), getCellHeight(), setAlpha(), SetDrawColorArray(), SetFillColorArray() und SetTextColorArray().
Wird benutzt von Button(), Close(), Footer(), Header(), Image(), ImageEps(), Text(), Write() und write1DBarcode().
CheckBox | ( | $name, | |
$w, | |||
$checked = false , |
|||
$prop = array() , |
|||
$opt = array() , |
|||
$onvalue = 'Yes' , |
|||
$x = '' , |
|||
$y = '' , |
|||
$js = false |
|||
) |
Creates a CheckBox field
$name | (string) field name |
$w | (int) width |
$checked | (boolean) define the initial state. |
$prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
$opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
$onvalue | (string) value to be returned if selected. |
$x | (float) Abscissa of the upper-left corner of the rectangle |
$y | (float) Ordinate of the upper-left corner of the rectangle |
$js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definiert in Zeile 13052 der Datei tcpdf.php.
Wird benutzt von openHTMLTagHandler().
|
protected |
Add page if needed.
$h | (float) Cell height. Default value: 0. |
$y | (mixed) starting y position, leave empty for current position. |
$addpage | (boolean) if true add a page, otherwise only return the true/false state |
Definiert in Zeile 4947 der Datei tcpdf.php.
Benutzt $h, $page, $tMargin, $x, $y, AcceptPageBreak(), AddPage(), TCPDF_STATIC\empty_string() und inPageBody().
Wird benutzt von Cell(), fitBlock(), MultiCell(), openHTMLTagHandler() und writeHTML().
|
protected |
Check page for no-write regions and adapt current coordinates and page margins if necessary. A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
$h | (float) height of the text/image/object to print in user units |
$x | (float) current X coordinate in user units |
$y | (float) current Y coordinate in user units |
Definiert in Zeile 22532 der Datei tcpdf.php.
Wird benutzt von Annotation(), Button(), getCellCode(), getRemainingWidth(), Image(), ImageEps(), ListBox(), MultiCell(), RadioButton(), TextField(), Write(), write1DBarcode() und write2DBarcode().
Circle | ( | $x0, | |
$y0, | |||
$r, | |||
$angstr = 0 , |
|||
$angend = 360 , |
|||
$style = '' , |
|||
$line_style = array() , |
|||
$fill_color = array() , |
|||
$nc = 2 |
|||
) |
Draws a circle. A circle is formed from n Bezier curves.
$x0 | (float) Abscissa of center point. |
$y0 | (float) Ordinate of center point. |
$r | (float) Radius. |
$angstr,: | (float) Angle start of draw line. Default value: 0. |
$angend,: | (float) Angle finish of draw line. Default value: 360. |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$line_style | (array) Line style of circle. Array like for SetLineStyle(). Default value: default line style (empty array). |
$fill_color | (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
$nc | (integer) Number of curves used to draw a 90 degrees portion of circle. |
Definiert in Zeile 11846 der Datei tcpdf.php.
Benutzt Ellipse().
Wird benutzt von registrationMark(), registrationMarkCMYK(), RegularPolygon() und StarPolygon().
|
protected |
Set a rectangular clipping area.
$x | (float) abscissa of the top left corner of the rectangle (or top right corner for RTL mode). |
$y | (float) ordinate of the top left corner of the rectangle. |
$w | (float) width of the rectangle. |
$h | (float) height of the rectangle. |
Definiert in Zeile 14400 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y und _out().
Wird benutzt von CoonsPatchMesh(), LinearGradient() und RadialGradient().
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.
Definiert in Zeile 2938 der Datei tcpdf.php.
Benutzt $k, _destroy(), _enddoc(), _outRestoreGraphicsState(), _outSaveGraphicsState(), AddPage(), Cell(), endLayer(), endPage(), getGraphicVars(), PDF_FONT_NAME_MAIN, SetAutoPageBreak(), setEqualColumns(), SetFont(), setGraphicVars() und setTextRenderingMode().
Wird benutzt von getPDFData() und Output().
|
protected |
Process closing tags.
$dom | (array) html dom array |
$key | (int) current element id |
$cell | (boolean) if true add the default left (or right if RTL) padding to each new line (default false). |
$maxbottomliney | (int) maximum y value of current line |
Definiert in Zeile 19249 der Datei tcpdf.php.
Wird benutzt von writeHTML().
colorRegistrationBar | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$transition = true , |
|||
$vertical = false , |
|||
$colors = 'A , |
|||
R | , | ||
G | , | ||
B | , | ||
C | , | ||
M | , | ||
Y | , | ||
K' | |||
) |
Paints color transition registration bars
$x | (float) abscissa of the top left corner of the rectangle. |
$y | (float) ordinate of the top left corner of the rectangle. |
$w | (float) width of the rectangle. |
$h | (float) height of the rectangle. |
$transition | (boolean) if true prints tcolor transitions to white. |
$vertical | (boolean) if true prints bar vertically. |
$colors | (string) colors to print separated by comma. Valid values are: A,W,R,G,B,C,M,Y,K,RGB,CMYK,ALL,ALLSPOT,<SPOT_COLOR_NAME>. Where: A = grayscale black, W = grayscale white, R = RGB red, G RGB green, B RGB blue, C = CMYK cyan, M = CMYK magenta, Y = CMYK yellow, K = CMYK key/black, RGB = RGB registration color, CMYK = CMYK registration color, ALL = Spot registration color, ALLSPOT = print all defined spot colors, <SPOT_COLOR_NAME> = name of the spot color to print. |
Definiert in Zeile 13985 der Datei tcpdf.php.
Benutzt $h, $spot_colors, $w, $x, $y, TCPDF_COLORS\getSpotColor(), LinearGradient(), Rect() und SetFillColorArray().
ComboBox | ( | $name, | |
$w, | |||
$h, | |||
$values, | |||
$prop = array() , |
|||
$opt = array() , |
|||
$x = '' , |
|||
$y = '' , |
|||
$js = false |
|||
) |
Creates a Combo-box field
$name | (string) field name |
$w | (int) width |
$h | (int) height |
$values | (array) array containing the list of values. |
$prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
$opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
$x | (float) Abscissa of the upper-left corner of the rectangle |
$y | (float) Ordinate of the upper-left corner of the rectangle |
$js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
commitTransaction | ( | ) |
|
protected |
CoonsPatchMesh | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$col1 = array() , |
|||
$col2 = array() , |
|||
$col3 = array() , |
|||
$col4 = array() , |
|||
$coords = array(0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33) , |
|||
$coords_min = 0 , |
|||
$coords_max = 1 , |
|||
$antialias = false |
|||
) |
Paints a coons patch mesh.
$x | (float) abscissa of the top left corner of the rectangle. |
$y | (float) ordinate of the top left corner of the rectangle. |
$w | (float) width of the rectangle. |
$h | (float) height of the rectangle. |
$col1 | (array) first color (lower left corner) (RGB components). |
$col2 | (array) second color (lower right corner) (RGB components). |
$col3 | (array) third color (upper right corner) (RGB components). |
$col4 | (array) fourth color (upper left corner) (RGB components). |
$coords | (array)
|
$coords_min | (array) minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0 |
$coords_max | (array) maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1 |
$antialias | (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts. |
Definiert in Zeile 14308 der Datei tcpdf.php.
Benutzt $h, $n, $w, $x, $xobjid, $y, _out(), _outRestoreGraphicsState() und Clip().
copyPage | ( | $page = 0 ) |
cropMark | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$type = 'T , |
|||
R | , | ||
B | , | ||
L' | , | ||
$color = array(100,100,100,100,'All') |
|||
) |
Paints crop marks.
$x | (float) abscissa of the crop mark center. |
$y | (float) ordinate of the crop mark center. |
$w | (float) width of the crop mark. |
$h | (float) height of the crop mark. |
$type | (string) type of crop mark, one symbol per type separated by comma: T = TOP, F = BOTTOM, L = LEFT, R = RIGHT, TL = A = TOP-LEFT, TR = B = TOP-RIGHT, BL = C = BOTTOM-LEFT, BR = D = BOTTOM-RIGHT. |
$color | (array) crop mark color (default spot registration color). |
Definiert in Zeile 14125 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y, Line() und SetLineStyle().
Curve | ( | $x0, | |
$y0, | |||
$x1, | |||
$y1, | |||
$x2, | |||
$y2, | |||
$x3, | |||
$y3, | |||
$style = '' , |
|||
$line_style = array() , |
|||
$fill_color = array() |
|||
) |
Draws a Bezier curve. The Bezier curve is a tangent to the line between the control points at either end of the curve.
$x0 | (float) Abscissa of start point. |
$y0 | (float) Ordinate of start point. |
$x1 | (float) Abscissa of control point 1. |
$y1 | (float) Ordinate of control point 1. |
$x2 | (float) Abscissa of control point 2. |
$y2 | (float) Ordinate of control point 2. |
$x3 | (float) Abscissa of end point. |
$y3 | (float) Ordinate of end point. |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$line_style | (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array). |
$fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array). |
Definiert in Zeile 11604 der Datei tcpdf.php.
Benutzt _out(), _outCurve(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray() und SetLineStyle().
deletePage | ( | $page) |
|
protected |
Draw an HTML block border and fill
$tag | (array) array of tag properties. |
$xmax | (int) end X coordinate for border. |
Definiert in Zeile 19826 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string() und TCPDF_STATIC\getBorderMode().
Ellipse | ( | $x0, | |
$y0, | |||
$rx, | |||
$ry = '' , |
|||
$angle = 0 , |
|||
$astart = 0 , |
|||
$afinish = 360 , |
|||
$style = '' , |
|||
$line_style = array() , |
|||
$fill_color = array() , |
|||
$nc = 2 |
|||
) |
Draws an ellipse. An ellipse is formed from n Bezier curves.
$x0 | (float) Abscissa of center point. |
$y0 | (float) Ordinate of center point. |
$rx | (float) Horizontal radius. |
$ry | (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0. |
$angle,: | (float) Angle oriented (anti-clockwise). Default value: 0. |
$astart,: | (float) Angle start of draw line. Default value: 0. |
$afinish,: | (float) Angle finish of draw line. Default value: 360. |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$line_style | (array) Line style of ellipse. Array like for SetLineStyle(). Default value: default line style (empty array). |
$fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array). |
$nc | (integer) Number of curves used to draw a 90 degrees portion of ellipse. |
Definiert in Zeile 11674 der Datei tcpdf.php.
Benutzt _out(), _outellipticalarc(), TCPDF_STATIC\empty_string(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray() und SetLineStyle().
Wird benutzt von Circle().
endLayer | ( | ) |
End the current PDF layer.
Definiert in Zeile 13702 der Datei tcpdf.php.
Benutzt _out().
Wird benutzt von Close() und setVisibility().
endPage | ( | $tocpage = false ) |
Terminate the current page
$tocpage | (boolean) if true set the tocpage state to false (end the page used to display Table Of Content). |
Definiert in Zeile 3113 der Datei tcpdf.php.
Benutzt $page, $tocpage, _endpage() und setFooter().
Wird benutzt von AddPage(), Close() und endTOCPage().
|
protected |
Sets the closing SVG element handler function for the XML parser.
$parser | (resource) The first parameter, parser, is a reference to the XML parser calling the handler. |
$name | (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters. |
endTemplate | ( | ) |
End the current XObject Template started with startTemplate() and restore the previous graphic state. An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
Definiert in Zeile 22253 der Datei tcpdf.php.
Wird benutzt von Button(), Header() und TextField().
endTOCPage | ( | ) |
Terminate the current TOC (Table Of Content) page
Definiert in Zeile 3074 der Datei tcpdf.php.
Benutzt endPage().
Error | ( | $msg) |
Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.
$msg | (string) The error message |
Definiert in Zeile 2908 der Datei tcpdf.php.
Benutzt _destroy() und K_TCPDF_THROW_EXCEPTION_ERROR.
Wird benutzt von _dochecks(), _generateencryptionkey(), _putfonts(), _puttruetypeunicode(), AddFont(), Image(), ImageEps(), ImagePngAlpha(), TCPDF_IMPORT\importPDF(), openHTMLTagHandler(), Output(), Scale(), SetDisplayMode(), setPage(), setPageUnit(), SetProtection(), setSignature(), setSpotColor(), setVisibility(), Skew(), write1DBarcode(), write2DBarcode() und writeHTML().
|
protected |
Set the block dimensions accounting for page breaks and page/column fitting
$w | (float) width |
$h | (float) height |
$x | (float) X coordinate |
$y | (float) Y coodiante |
$fitonpage | (boolean) if true the block is resized to not exceed page dimensions. |
Definiert in Zeile 6706 der Datei tcpdf.php.
Benutzt $h, $lMargin, $PageBreakTrigger, $rMargin, $tMargin, $w, $x, $y und checkPageBreak().
Wird benutzt von Image(), ImageEps(), write1DBarcode() und write2DBarcode().
fixHTMLCode | ( | $html, | |
$default_css = '' , |
|||
$tagvs = '' , |
|||
$tidy_options = '' |
|||
) |
Cleanup HTML code (requires HTML Tidy library).
$html | (string) htmlcode to fix |
$default_css | (string) CSS commands to add |
$tagvs | (array) parameters for setHtmlVSpace method |
$tidy_options | (array) options for tidy_parse_string function |
Definiert in Zeile 15789 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\fixHTMLCode().
Footer | ( | ) |
This method is used to render the page footer. It is automatically called by AddPage() and could be overwritten in your own inherited class.
Definiert in Zeile 3456 der Datei tcpdf.php.
Benutzt $barcode, $k, $y, Cell(), getAliasNbPages(), getAliasRightShift(), getBarcode(), getPageGroupAlias(), getRTL(), Ln(), SetLineStyle(), SetTextColorArray(), SetX(), SetY() und write1DBarcode().
Wird benutzt von setFooter().
getAbsFontMeasure | ( | $s) |
Convert a relative font measure into absolute value.
$s | (int) Font measure. |
Definiert in Zeile 4553 der Datei tcpdf.php.
Wird benutzt von getFontBBox(), getRawCharWidth() und RadioButton().
GetAbsX | ( | ) |
getAliasNbPages | ( | ) |
Returns the string alias used for the total number of pages. If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in the document.
Definiert in Zeile 13568 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$alias_tot_pages und isUnicodeFont().
Wird benutzt von Footer().
getAliasNumPage | ( | ) |
Returns the string alias used for the page number. If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number.
Definiert in Zeile 13583 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$alias_num_page und isUnicodeFont().
getAliasRightShift | ( | ) |
Returns the string alias used right align page numbers. If the current font is unicode type, the returned string wil contain an additional open curly brace.
Definiert in Zeile 13542 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$alias_num_page, TCPDF_STATIC\$alias_right_shift, TCPDF_STATIC\$alias_tot_pages, GetNumChars(), GetStringWidth() und isUnicodeFont().
Wird benutzt von Footer().
|
protected |
Return an array containing all internal page aliases.
Definiert in Zeile 7815 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$alias_group_num_page, TCPDF_STATIC\$alias_group_tot_pages, TCPDF_STATIC\$alias_num_page, TCPDF_STATIC\$alias_right_shift, TCPDF_STATIC\$alias_tot_pages, $k und getInternalPageNumberAliases().
Wird benutzt von _putpages().
getAllSpotColors | ( | ) |
Returns the array of spot colors.
Definiert in Zeile 3686 der Datei tcpdf.php.
Benutzt $spot_colors.
getAlpha | ( | ) |
GetArrStringWidth | ( | $sa, | |
$fontname = '' , |
|||
$fontstyle = '' , |
|||
$fontsize = 0 , |
|||
$getarray = false |
|||
) |
Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.
$sa | (string) The array of chars whose total length is to be computed |
$fontname | (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained. |
$fontstyle | (string) Font style. Possible values are (case insensitive):
|
$fontsize | (float) Font size in points. The default value is the current size. |
$getarray | (boolean) if true returns an array of characters widths, if false returns the total length. |
Definiert in Zeile 4035 der Datei tcpdf.php.
Benutzt $FontFamily, $FontSizePt, $FontStyle, $w, TCPDF_STATIC\empty_string(), GetCharWidth(), isUnicodeFont(), SetFont() und TCPDF_FONTS\UTF8ArrToLatin1Arr().
Wird benutzt von getCellCode(), getNumLines(), GetStringWidth() und Write().
getAutoPageBreak | ( | ) |
Return the auto-page-break mode (true or false).
Definiert in Zeile 2789 der Datei tcpdf.php.
Benutzt $AutoPageBreak.
getBarcode | ( | ) |
|
protected |
getBreakMargin | ( | $pagenum = '' ) |
Returns the page break margin.
$pagenum | (int) page number (empty = current page) |
Definiert in Zeile 2520 der Datei tcpdf.php.
Benutzt $bMargin.
|
protected |
|
protected |
Returns the code to draw the cell border
$x | (float) X coordinate. |
$y | (float) Y coordinate. |
$w | (float) Cell width. |
$h | (float) Cell height. |
$brd | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
Definiert in Zeile 5561 der Datei tcpdf.php.
Benutzt $h, $k, $LineWidth, $w, $x, $y und SetLineStyle().
Wird benutzt von getCellCode().
|
protected |
Returns the PDF string code to print 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.
$w | (float) Cell width. If 0, the cell extends up to the right margin. |
$h | (float) Cell height. Default value: 0. |
$txt | (string) String to print. Default value: empty string. |
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
$ln | (int) Indicates where the current position should go after the call. Possible values are:
|
$align | (string) Allows to center or align the text. Possible values are:
|
$fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
$link | (mixed) URL or identifier returned by AddLink(). |
$stretch | (int) font stretch mode:
|
$ignore_min_height | (boolean) if true ignore automatic minimum height value. |
$calign | (string) cell vertical alignment relative to the specified Y value. Possible values are:
|
$valign | (string) text vertical alignment inside the cell. Possible values are:
|
Definiert in Zeile 5070 der Datei tcpdf.php.
Benutzt $cell_margin, $cell_padding, $font_spacing, $font_stretching, $FontAscent, $FontDescent, $FontSize, $h, $k, $lMargin, $rMargin, $w, $x, $y, TCPDF_STATIC\_escape(), adjustCellPadding(), TCPDF_FONTS\arrUTF8ToUTF16BE(), checkPageRegions(), TCPDF_STATIC\empty_string(), GetArrStringWidth(), getCellBorder(), getCellHeight(), GetNumChars(), GetStringWidth(), isCharDefined(), isUnicodeFont(), K_THAI_TOPCHARS, Link(), TCPDF_STATIC\removeSHY(), replaceChar(), setFontSubBuffer(), TCPDF_FONTS\unichr(), TCPDF_FONTS\utf8Bidi(), TCPDF_FONTS\UTF8StringToArray() und TCPDF_FONTS\UTF8ToLatin1().
Wird benutzt von Cell() und MultiCell().
getCellHeight | ( | $fontsize, | |
$padding = TRUE |
|||
) |
Return the cell height
$fontsize | (int) Font size in internal units |
$padding | (boolean) If true add cell padding |
Definiert in Zeile 2414 der Datei tcpdf.php.
Benutzt $cell_height_ratio.
Wird benutzt von Cell(), getCellCode(), getStringHeight(), Header(), openHTMLTagHandler(), resetLastH(), Write(), write1DBarcode() und writeHTML().
getCellHeightRatio | ( | ) |
return the height of cell repect font height.
Definiert in Zeile 13940 der Datei tcpdf.php.
Benutzt $cell_height_ratio.
getCellMargins | ( | ) |
Get the internal Cell margin array.
Definiert in Zeile 2691 der Datei tcpdf.php.
Benutzt $cell_margin.
getCellPaddings | ( | ) |
Get the internal Cell padding array.
Definiert in Zeile 2655 der Datei tcpdf.php.
Benutzt $cell_padding.
getCharBBox | ( | $char) |
GetCharWidth | ( | $char, | |
$notlast = true |
|||
) |
Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).
$char | (int) The char code whose length is to be returned |
$notlast | (boolean) If false ignore the font-spacing. |
Definiert in Zeile 4074 der Datei tcpdf.php.
Benutzt $font_spacing und getRawCharWidth().
Wird benutzt von GetArrStringWidth() und Write().
getColumn | ( | ) |
|
protected |
Returns the border dash style from CSS property
$style | (string) border style to convert |
Definiert in Zeile 15820 der Datei tcpdf.php.
Wird benutzt von getCSSBorderStyle() und getHtmlDomArray().
getCSSBorderMargin | ( | $cssbspace, | |
$width = 0 |
|||
) |
Get the border-spacing from CSS attribute.
$cssbspace | (string) border-spacing CSS properties |
$width | (float) width of the containing element |
Definiert in Zeile 16015 der Datei tcpdf.php.
Benutzt $rMargin und getHTMLUnitToUnits().
Wird benutzt von getHtmlDomArray().
|
protected |
Returns the border style array from CSS border properties
$cssborder | (string) border properties |
Definiert in Zeile 15856 der Datei tcpdf.php.
Benutzt TCPDF_COLORS\convertHTMLColorToDec(), getCSSBorderDashStyle() und getCSSBorderWidth().
Wird benutzt von getHtmlDomArray().
|
protected |
Returns the border width from CSS property
$width | (string) border width |
Definiert in Zeile 15800 der Datei tcpdf.php.
Benutzt $k und getHTMLUnitToUnits().
Wird benutzt von getCSSBorderStyle() und getHtmlDomArray().
|
protected |
Returns the letter-spacing value from CSS value
$spacing | (string) letter-spacing value |
$parent | (float) font spacing (tracking) value of the parent element |
Definiert in Zeile 16049 der Datei tcpdf.php.
Benutzt getHTMLUnitToUnits().
Wird benutzt von getHtmlDomArray().
|
protected |
Returns the percentage of font stretching from CSS value
$stretch | (string) stretch mode |
$parent | (float) stretch value of the parent element |
Definiert in Zeile 16080 der Datei tcpdf.php.
Benutzt getHTMLUnitToUnits().
Wird benutzt von getHtmlDomArray().
getCSSMargin | ( | $cssmargin, | |
$width = 0 |
|||
) |
Get the internal Cell margin from CSS attribute.
$cssmargin | (string) margin properties |
$width | (float) width of the containing element |
Definiert in Zeile 15961 der Datei tcpdf.php.
Benutzt $cell_margin, $rMargin und getHTMLUnitToUnits().
Wird benutzt von getHtmlDomArray().
getCSSPadding | ( | $csspadding, | |
$width = 0 |
|||
) |
Get the internal Cell padding from CSS attribute.
$csspadding | (string) padding properties |
$width | (float) width of the containing element |
Definiert in Zeile 15907 der Datei tcpdf.php.
Benutzt $cell_padding, $rMargin und getHTMLUnitToUnits().
Wird benutzt von getHtmlDomArray().
getDestination | ( | ) |
getDocCreationTimestamp | ( | ) |
Returns document creation timestamp in seconds.
Definiert in Zeile 10183 der Datei tcpdf.php.
Benutzt $doc_creation_timestamp.
getDocModificationTimestamp | ( | ) |
Returns document modification timestamp in seconds.
Definiert in Zeile 10193 der Datei tcpdf.php.
Benutzt $doc_modification_timestamp.
getFontAscent | ( | $font, | |
$style = '' , |
|||
$size = 0 |
|||
) |
Return the font ascent value.
$font | (string) font name |
$style | (string) font style |
$size | (float) The size (in points) |
Definiert in Zeile 4601 der Datei tcpdf.php.
Benutzt AddFont() und getFontBuffer().
Wird benutzt von writeHTML().
getFontBBox | ( | ) |
Returns the bounding box of the current font in user units.
Definiert in Zeile 4514 der Datei tcpdf.php.
Benutzt $w und getAbsFontMeasure().
|
protected |
Get font buffer content.
$font | (string) font key |
Definiert in Zeile 20809 der Datei tcpdf.php.
Wird benutzt von _putcatalog(), _putfonts(), _putresourcedict(), AddFont(), getFontAscent(), getFontDescent(), isCharDefined(), RadioButton(), replaceMissingChars() und SetFont().
getFontDescent | ( | $font, | |
$style = '' , |
|||
$size = 0 |
|||
) |
Return the font descent value
$font | (string) font name |
$style | (string) font style |
$size | (float) The size (in points) |
Definiert in Zeile 4580 der Datei tcpdf.php.
Benutzt AddFont() und getFontBuffer().
Wird benutzt von writeHTML().
getFontFamily | ( | ) |
Returns the current font family name.
Definiert in Zeile 15763 der Datei tcpdf.php.
Benutzt $FontFamily.
getFontFamilyName | ( | $fontfamily) |
Return normalized font name
$fontfamily | (string) property string containing font family names |
Definiert in Zeile 22145 der Datei tcpdf.php.
Wird benutzt von getHtmlDomArray().
getFontSize | ( | ) |
getFontSizePt | ( | ) |
Returns the current font size in points unit.
Definiert in Zeile 15753 der Datei tcpdf.php.
Benutzt $FontSizePt.
|
protected |
Fill the list of available fonts ($this->fontlist).
Definiert in Zeile 4134 der Datei tcpdf.php.
Benutzt TCPDF_FONTS\_getfontpath().
Wird benutzt von __construct().
getFontSpacing | ( | ) |
getFontStretching | ( | ) |
getFontStyle | ( | ) |
Returns the current font style.
Definiert in Zeile 15773 der Datei tcpdf.php.
Benutzt $FontStyle.
getFontSubsetting | ( | ) |
getFooterFont | ( | ) |
Get Footer font.
Definiert in Zeile 10349 der Datei tcpdf.php.
Benutzt $footer_font.
getFooterMargin | ( | ) |
Returns footer margin in user units.
Definiert in Zeile 3318 der Datei tcpdf.php.
Benutzt $footer_margin.
getFormDefaultProp | ( | ) |
Return the default properties for form fields.
Definiert in Zeile 12637 der Datei tcpdf.php.
Benutzt $default_form_prop.
Wird benutzt von Button(), RadioButton() und TextField().
|
protected |
Get the GD-corrected PNG gamma value from alpha color
$img | (int) GD image Resource ID. |
$c | (int) alpha color |
Definiert in Zeile 7312 der Datei tcpdf.php.
Wird benutzt von ImagePngAlpha().
|
protected |
Returns current graphic variables as array.
Definiert in Zeile 20423 der Datei tcpdf.php.
Wird benutzt von __construct(), Close(), openHTMLTagHandler(), setFooter(), setTableHeader(), startPage(), write1DBarcode(), write2DBarcode() und writeHTML().
getGroupPageNo | ( | ) |
Return the current page in the group.
Definiert in Zeile 13626 der Datei tcpdf.php.
Benutzt $currpagegroup.
Wird benutzt von getGroupPageNoFormatted().
getGroupPageNoFormatted | ( | ) |
Returns the current group page number formatted as a string.
Definiert in Zeile 13636 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\formatPageNumber() und getGroupPageNo().
getHeaderData | ( | ) |
Returns header data:
Definiert in Zeile 3271 der Datei tcpdf.php.
Benutzt $header_line_color, $header_logo, $header_logo_width, $header_string, $header_text_color und $header_title.
Wird benutzt von Header().
getHeaderFont | ( | ) |
Get header font.
Definiert in Zeile 10329 der Datei tcpdf.php.
Benutzt $header_font.
Wird benutzt von Header().
getHeaderMargin | ( | ) |
Returns header margin in user units.
Definiert in Zeile 3298 der Datei tcpdf.php.
Benutzt $header_margin.
|
protected |
Returns the HTML DOM array.
$html | (string) html code |
Definiert in Zeile 16206 der Datei tcpdf.php.
Benutzt $cell_height_ratio, $cell_margin, $cell_padding, $default_monospaced_font, $fgcolor, $font_spacing, $font_stretching, $FontFamily, $FontSizePt, $FontStyle, $htmlLinkColorArray, $htmlLinkFontStyle, $strokecolor, $textstrokewidth, $thead, TCPDF_COLORS\convertHTMLColorToDec(), TCPDF_STATIC\empty_string(), TCPDF_STATIC\extractCSSproperties(), TCPDF_STATIC\fileGetContents(), getCSSBorderDashStyle(), getCSSBorderMargin(), getCSSBorderStyle(), getCSSBorderWidth(), TCPDF_STATIC\getCSSdataArray(), getCSSFontSpacing(), getCSSFontStretching(), getCSSMargin(), getCSSPadding(), getFontFamilyName(), getHTMLFontUnits(), getHTMLUnitToUnits(), TCPDF_STATIC\getTagStyleFromCSSarray(), K_SMALL_RATIO, stringTrim() und unhtmlentities().
Wird benutzt von writeHTML().
getHTMLFontUnits | ( | $val, | |
$refsize = 12 , |
|||
$parent_size = 12 , |
|||
$defaultunit = 'pt' |
|||
) |
Convert HTML string containing font size value to points
$val | (string) String containing font size value and unit. |
$refsize | (float) Reference font size in points. |
$parent_size | (float) Parent font size in points. |
$defaultunit | (string) Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt). |
Definiert in Zeile 16152 der Datei tcpdf.php.
Benutzt TCPDF_FONTS\getFontRefSize() und getHTMLUnitToUnits().
Wird benutzt von getHtmlDomArray().
getHTMLUnitToUnits | ( | $htmlval, | |
$refsize = 1 , |
|||
$defaultunit = 'px' , |
|||
$points = false |
|||
) |
Convert HTML string containing value and unit of measure to user's units or points.
$htmlval | (string) String containing values and unit. |
$refsize | (string) Reference value in points. |
$defaultunit | (string) Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt). |
$points | (boolean) If true returns points, otherwise returns value in user's units. |
Definiert in Zeile 20137 der Datei tcpdf.php.
Wird benutzt von getCSSBorderMargin(), getCSSBorderWidth(), getCSSFontSpacing(), getCSSFontStretching(), getCSSMargin(), getCSSPadding(), getHtmlDomArray(), getHTMLFontUnits(), Image(), openHTMLTagHandler() und writeHTML().
|
protected |
Get image buffer content.
$image | (string) image key |
Definiert in Zeile 20747 der Datei tcpdf.php.
Wird benutzt von _putannotsobjs(), _putimages() und Image().
getImageRBX | ( | ) |
getImageRBY | ( | ) |
getImageScale | ( | ) |
|
protected |
Return an array containing variations for the basic page number alias.
$a | (string) Base alias. |
Definiert in Zeile 7794 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\_escape(), TCPDF_FONTS\utf8StrRev() und TCPDF_FONTS\UTF8ToLatin1().
Wird benutzt von getAllInternalPageNumberAliases().
getLastH | ( | ) |
GetLineWidth | ( | ) |
Returns the current the line width.
Definiert in Zeile 11317 der Datei tcpdf.php.
Benutzt $LineWidth.
Wird benutzt von openHTMLTagHandler().
getMargins | ( | ) |
Returns an array containing current margins:
getNumberOfColumns | ( | ) |
GetNumChars | ( | $s) |
Returns the numbero of characters in a string.
$s | (string) The input string. |
Definiert in Zeile 4122 der Datei tcpdf.php.
Benutzt isUnicodeFont() und TCPDF_FONTS\UTF8StringToArray().
Wird benutzt von _putpages(), getAliasRightShift() und getCellCode().
getNumLines | ( | $txt, | |
$w = 0 , |
|||
$reseth = false , |
|||
$autopadding = true , |
|||
$cellpadding = '' , |
|||
$border = 0 |
|||
) |
This method return the estimated number of lines for print a simple text string using Multicell() method.
$txt | (string) String for calculating his height |
$w | (float) Width of cells. If 0, they extend up to the right margin of the page. |
$reseth | (boolean) if true reset the last cell height (default false). |
$autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true). |
$cellpadding | (float) Internal cell padding, if empty uses default cell padding. |
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
Definiert in Zeile 6112 der Datei tcpdf.php.
Benutzt $cell_padding, $lasth, $lMargin, $w, $x, adjustCellPadding(), TCPDF_STATIC\empty_string(), GetArrStringWidth(), resetLastH(), TCPDF_FONTS\unichr(), TCPDF_FONTS\utf8Bidi() und TCPDF_FONTS\UTF8StringToArray().
Wird benutzt von getStringHeight().
getNumPages | ( | ) |
getOriginalMargins | ( | ) |
getOverprint | ( | ) |
Get the overprint mode array (OP, op, OPM). (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Definiert in Zeile 13853 der Datei tcpdf.php.
Benutzt $overprint.
getPage | ( | ) |
Get current document page number.
Definiert in Zeile 3040 der Datei tcpdf.php.
Benutzt $page.
|
protected |
Get page buffer content.
$page | (int) page number |
Definiert in Zeile 20685 der Datei tcpdf.php.
Wird benutzt von _out(), _putpages(), MultiCell() und writeHTML().
getPageDimensions | ( | $pagenum = '' ) |
Returns an array of page dimensions:
$pagenum | (int) page number (empty = current page) |
Definiert in Zeile 2472 der Datei tcpdf.php.
Benutzt $page.
getPageGroupAlias | ( | ) |
Return the alias for the total number of pages in the current page group. If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in this group.
Definiert in Zeile 13598 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$alias_group_tot_pages und isUnicodeFont().
Wird benutzt von Footer().
getPageHeight | ( | $pagenum = '' ) |
Returns the page height in units.
$pagenum | (int) page number (empty = current page) |
Definiert in Zeile 2504 der Datei tcpdf.php.
Benutzt $h.
getPageNumGroupAlias | ( | ) |
Return the alias for the page number on the current page group. If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number (relative to the belonging group).
Definiert in Zeile 13613 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$alias_group_num_page und isUnicodeFont().
getPageRegions | ( | ) |
Return an array of no-write page regions
getPageWidth | ( | $pagenum = '' ) |
Returns the page width in units.
$pagenum | (int) page number (empty = current page) |
Definiert in Zeile 2488 der Datei tcpdf.php.
Benutzt $w.
getPDFData | ( | ) |
getRawCharWidth | ( | $char) |
Returns the length of the char in user unit for the current font.
$char | (int) The char code whose length is to be returned |
Definiert in Zeile 4096 der Datei tcpdf.php.
Benutzt $w und getAbsFontMeasure().
Wird benutzt von GetCharWidth().
|
protected |
Returns the remaining width between the current position and margins.
Definiert in Zeile 6686 der Datei tcpdf.php.
Benutzt checkPageRegions().
Wird benutzt von Write().
getRTL | ( | ) |
getScaleFactor | ( | ) |
|
protected |
Get the array that defines the signature appearance (page and rectangle coordinates).
$x | (float) Abscissa of the upper-left corner. |
$y | (float) Ordinate of the upper-left corner. |
$w | (float) Width of the signature area. |
$h | (float) Height of the signature area. |
$page | (int) option page number (if < 0 the current page is used). |
$name | (string) Name of the signature. |
Definiert in Zeile 13491 der Datei tcpdf.php.
Benutzt $h, $k, $page, $w, $x und $y.
Wird benutzt von addEmptySignatureAppearance() und setSignatureAppearance().
|
protected |
Returns the string used to find spaces
Definiert in Zeile 16990 der Datei tcpdf.php.
Benutzt isUnicodeFont().
Wird benutzt von writeHTML().
getStringHeight | ( | $w, | |
$txt, | |||
$reseth = false , |
|||
$autopadding = true , |
|||
$cellpadding = '' , |
|||
$border = 0 |
|||
) |
This method return the estimated height needed for printing a simple text string using the Multicell() method. Generally, if you want to know the exact height for a block of content you can use the following alternative technique:
$w | (float) Width of cells. If 0, they extend up to the right margin of the page. |
$txt | (string) String for calculating his height |
$reseth | (boolean) if true reset the last cell height (default false). |
$autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true). |
$cellpadding | (float) Internal cell padding, if empty uses default cell padding. |
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
Definiert in Zeile 6231 der Datei tcpdf.php.
Benutzt $cell_padding, $lasth, $w, adjustCellPadding(), getCellHeight() und getNumLines().
Wird benutzt von MultiCell().
GetStringWidth | ( | $s, | |
$fontname = '' , |
|||
$fontstyle = '' , |
|||
$fontsize = 0 , |
|||
$getarray = false |
|||
) |
Returns the length of a string in user unit. A font must be selected.
$s | (string) The string whose length is to be computed |
$fontname | (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained. |
$fontstyle | (string) Font style. Possible values are (case insensitive):
|
$fontsize | (float) Font size in points. The default value is the current size. |
$getarray | (boolean) if true returns an array of characters widths, if false returns the total length. |
Definiert in Zeile 4019 der Datei tcpdf.php.
Benutzt GetArrStringWidth(), TCPDF_FONTS\utf8Bidi() und TCPDF_FONTS\UTF8StringToArray().
Wird benutzt von _dolinethrough(), _dooverline(), _dounderline(), getAliasRightShift(), getCellCode(), openHTMLTagHandler(), Write(), write1DBarcode() und writeHTML().
getTextShadow | ( | ) |
GetX | ( | ) |
Returns the relative X value of current position. The value is relative to the left border for LTR languages and to the right border for RTL languages.
Definiert in Zeile 7372 der Datei tcpdf.php.
Benutzt $x.
Wird benutzt von Bookmark(), MultiCell(), openHTMLTagHandler() und setDestination().
GetY | ( | ) |
Returns the ordinate of the current position.
Definiert in Zeile 7399 der Datei tcpdf.php.
Benutzt $y.
Wird benutzt von Bookmark(), MultiCell(), openHTMLTagHandler() und setDestination().
Gradient | ( | $type, | |
$coords, | |||
$stops, | |||
$background = array() , |
|||
$antialias = false |
|||
) |
Output gradient.
$type | (int) type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported) |
$coords | (array) array of coordinates. |
$stops | (array) array gradient color components: color = array of GRAY, RGB or CMYK color components; offset = (0 to 1) represents a location along the gradient vector; exponent = exponent of the exponential interpolation function (default = 1). |
$background | (array) An array of colour components appropriate to the colour space, specifying a single background colour value. |
$antialias | (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts. |
Definiert in Zeile 14427 der Datei tcpdf.php.
Benutzt $n, $xobjid, _out() und _outRestoreGraphicsState().
Wird benutzt von LinearGradient() und RadialGradient().
Header | ( | ) |
This method is used to render the page header. It is automatically called by AddPage() and could be overwritten in your own inherited class.
Definiert in Zeile 3379 der Datei tcpdf.php.
Benutzt $header_margin, $original_lMargin, $original_rMargin, $x, $y, Cell(), endTemplate(), getCellHeight(), getHeaderData(), getHeaderFont(), TCPDF_IMAGES\getImageFileType(), getImageRBY(), getRTL(), Image(), ImageEps(), ImageSVG(), K_BLANK_IMAGE, MultiCell(), printTemplate(), SetFont(), SetLineStyle(), SetTextColorArray(), SetX(), SetY() und startTemplate().
Wird benutzt von setHeader().
hyphenateText | ( | $text, | |
$patterns, | |||
$dictionary = array() , |
|||
$leftmin = 1 , |
|||
$rightmin = 2 , |
|||
$charmin = 1 , |
|||
$charmax = 8 |
|||
) |
Returns text with soft hyphens.
$text | (string) text to process |
$patterns | (mixed) Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/ |
$dictionary | (array) Array of words to be returned without applying the hyphenation algoritm. |
$leftmin | (int) Minimum number of character to leave on the left of the word without applying the hyphens. |
$rightmin | (int) Minimum number of character to leave on the right of the word without applying the hyphens. |
$charmin | (int) Minimum word length to apply the hyphenation algoritm. |
$charmax | (int) Maximum length of broken piece of word. |
Definiert in Zeile 22009 der Datei tcpdf.php.
Benutzt TCPDF_FONT_DATA\$uni_type, TCPDF_STATIC\empty_string(), TCPDF_STATIC\getHyphenPatternsFromTEX(), TCPDF_FONTS\UTF8ArrSubString() und TCPDF_FONTS\UTF8StringToArray().
|
protected |
Returns an array of chars containing soft hyphens.
$word | (array) array of chars |
$patterns | (array) Array of hypenation patterns. |
$dictionary | (array) Array of words to be returned without applying the hyphenation algoritm. |
$leftmin | (int) Minimum number of character to leave on the left of the word without applying the hyphens. |
$rightmin | (int) Minimum number of character to leave on the right of the word without applying the hyphens. |
$charmin | (int) Minimum word length to apply the hyphenation algoritm. |
$charmax | (int) Maximum length of broken piece of word. |
Definiert in Zeile 21933 der Datei tcpdf.php.
Benutzt TCPDF_FONTS\unichr(), TCPDF_FONTS\UTF8ArrSubString() und TCPDF_FONTS\UTF8StringToArray().
Image | ( | $file, | |
$x = '' , |
|||
$y = '' , |
|||
$w = 0 , |
|||
$h = 0 , |
|||
$type = '' , |
|||
$link = '' , |
|||
$align = '' , |
|||
$resize = false , |
|||
$dpi = 300 , |
|||
$palign = '' , |
|||
$ismask = false , |
|||
$imgmask = false , |
|||
$border = 0 , |
|||
$fitbox = false , |
|||
$hidden = false , |
|||
$fitonpage = false , |
|||
$alt = false , |
|||
$altimgs = array() |
|||
) |
Puts an image in the page. The upper-left corner must be given. The dimensions can be specified in different ways:
Supported formats are JPEG and PNG images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM; The format can be specified explicitly or inferred from the file extension.
It is possible to put a link on the image.
Remark: if an image is used several times, only one copy will be embedded in the file.
$file | (string) Name of the file containing the image or a '@' character followed by the image data string. To link an image without embedding it on the document, set an asterisk character before the URL (i.e.: '*http://www.example.com/image.jpg'). |
$x | (float) Abscissa of the upper-left corner (LTR) or upper-right corner (RTL). |
$y | (float) Ordinate of the upper-left corner (LTR) or upper-right corner (RTL). |
$w | (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
$h | (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
$type | (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension. |
$link | (mixed) URL or identifier returned by AddLink(). |
$align | (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
|
$resize | (mixed) If true resize (reduce) the image to fit $w and $h (requires GD or ImageMagick library); if false do not resize; if 2 force resize in all cases (upscaling and downscaling). |
$dpi | (int) dot-per-inch resolution used on resize |
$palign | (string) Allows to center or align the image on the current line. Possible values are:
|
$ismask | (boolean) true if this image is a mask, false otherwise |
$imgmask | (mixed) image object returned by this function or false |
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
$fitbox | (mixed) If not false scale image dimensions proportionally to fit within the ($w, $h) box. $fitbox can be true or a 2 characters string indicating the image alignment inside the box. The first character indicate the horizontal alignment (L = left, C = center, R = right) the second character indicate the vertical algnment (T = top, M = middle, B = bottom). |
$hidden | (boolean) If true do not display the image. |
$fitonpage | (boolean) If true the image is resized to not exceed page dimensions. |
$alt | (boolean) If true the image will be added as alternative and not directly printed (the ID of the image will be returned). |
$altimgs | (array) Array of alternate images IDs. Each alternative image must be an array with two values: an integer representing the image ID (the value returned by the Image method) and a boolean value to indicate if the image is the default for printing. |
Definiert in Zeile 6801 der Datei tcpdf.php.
Benutzt $dpi, $h, $img_rb_x, $img_rb_y, $k, $lMargin, $w, $x, $xobjid, $y, _out(), TCPDF_IMAGES\_parsejpeg(), TCPDF_IMAGES\_toJPEG(), TCPDF_IMAGES\_toPNG(), Cell(), checkPageRegions(), Error(), TCPDF_STATIC\fileGetContents(), fitBlock(), TCPDF_STATIC\get_mqr(), getHTMLUnitToUnits(), getImageBuffer(), TCPDF_IMAGES\getImageFileType(), TCPDF_STATIC\getObjFilename(), ImagePngAlpha(), Link(), pixelsToUnits(), TCPDF_STATIC\set_mqr(), TCPDF_IMAGES\setGDImageTransparency(), setImageBuffer() und SetY().
Wird benutzt von Annotation(), Header(), ImageEps(), ImagePngAlpha() und openHTMLTagHandler().
ImageEps | ( | $file, | |
$x = '' , |
|||
$y = '' , |
|||
$w = 0 , |
|||
$h = 0 , |
|||
$link = '' , |
|||
$useBoundingBox = true , |
|||
$align = '' , |
|||
$palign = '' , |
|||
$border = 0 , |
|||
$fitonpage = false , |
|||
$fixoutvals = false |
|||
) |
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files. NOTE: EPS is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library. Only vector drawing is supported, not text or bitmap. Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).
$file | (string) Name of the file containing the image or a '@' character followed by the EPS/AI data string. |
$x | (float) Abscissa of the upper-left corner. |
$y | (float) Ordinate of the upper-left corner. |
$w | (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
$h | (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
$link | (mixed) URL or identifier returned by AddLink(). |
$useBoundingBox | (boolean) specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true. |
$align | (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
|
$palign | (string) Allows to center or align the image on the current line. Possible values are:
|
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
$fitonpage | (boolean) if true the image is resized to not exceed page dimensions. |
$fixoutvals | (boolean) if true remove values outside the bounding box. |
Definiert in Zeile 14791 der Datei tcpdf.php.
Benutzt $h, $img_rb_x, $img_rb_y, $k, $lMargin, $w, $x, $y, _out(), AddSpotColor(), Cell(), checkPageRegions(), Error(), TCPDF_STATIC\fileGetContents(), fitBlock(), Image(), Link() und SetY().
Wird benutzt von Header() und openHTMLTagHandler().
|
protected |
Extract info from a PNG image with alpha channel using the Imagick or GD library.
$file | (string) Name of the file containing the image. |
$x | (float) Abscissa of the upper-left corner. |
$y | (float) Ordinate of the upper-left corner. |
$wpx | (float) Original width of the image in pixels. |
$hpx | (float) original height of the image in pixels. |
$w | (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
$h | (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
$type | (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension. |
$link | (mixed) URL or identifier returned by AddLink(). |
$align | (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
|
$resize | (boolean) If true resize (reduce) the image to fit $w and $h (requires GD library). |
$dpi | (int) dot-per-inch resolution used on resize |
$palign | (string) Allows to center or align the image on the current line. Possible values are:
|
$filehash | (string) File hash used to build unique file names. |
Definiert in Zeile 7215 der Datei tcpdf.php.
Benutzt $alpha, $dpi, $h, $w, $x, $y, Error(), getGDgamma(), Image() und TCPDF_STATIC\objclone().
Wird benutzt von Image().
ImageSVG | ( | $file, | |
$x = '' , |
|||
$y = '' , |
|||
$w = 0 , |
|||
$h = 0 , |
|||
$link = '' , |
|||
$align = '' , |
|||
$palign = '' , |
|||
$border = 0 , |
|||
$fitonpage = false |
|||
) |
Embedd a Scalable Vector Graphics (SVG) image. NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
$file | (string) Name of the SVG file or a '@' character followed by the SVG data string. |
$x | (float) Abscissa of the upper-left corner. |
$y | (float) Ordinate of the upper-left corner. |
$w | (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
$h | (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
$link | (mixed) URL or identifier returned by AddLink(). |
$align | (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
|
$palign | (string) Allows to center or align the image on the current line. Possible values are:
|
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
$fitonpage | (boolean) if true the image is resized to not exceed page dimensions. |
Definiert in Zeile 22635 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\fileGetContents().
Wird benutzt von Header() und openHTMLTagHandler().
IncludeJS | ( | $script) |
|
protected |
Check if we are on the page body (excluding page header and footer).
Definiert in Zeile 3600 der Datei tcpdf.php.
Wird benutzt von checkPageBreak(), MultiCell(), Write() und writeHTML().
isCharDefined | ( | $char, | |
$font = '' , |
|||
$style = '' |
|||
) |
Return true in the character is present in the specified font.
$char | (mixed) Character to check (integer value or string) |
$font | (string) Font name (family name). |
$style | (string) Font style. |
Definiert in Zeile 4621 der Datei tcpdf.php.
Benutzt $FontFamily, AddFont(), TCPDF_STATIC\empty_string(), getFontBuffer() und TCPDF_FONTS\UTF8StringToArray().
Wird benutzt von getCellCode() und replaceChar().
isRTLTextDir | ( | ) |
Return the current temporary RTL status
Definiert in Zeile 2393 der Datei tcpdf.php.
Wird benutzt von Write() und writeHTML().
isUnicodeFont | ( | ) |
Return true if the current font is unicode type.
Definiert in Zeile 22133 der Datei tcpdf.php.
Wird benutzt von getAliasNbPages(), getAliasNumPage(), getAliasRightShift(), GetArrStringWidth(), getCellCode(), GetNumChars(), getPageGroupAlias(), getPageNumGroupAlias(), getSpaceString(), Write() und writeHTML().
lastPage | ( | $resetmargins = false ) |
Reset pointer to the last document page.
$resetmargins | (boolean) if true reset left, right, top margins and Y position. |
Definiert in Zeile 3029 der Datei tcpdf.php.
Benutzt getNumPages() und setPage().
Line | ( | $x1, | |
$y1, | |||
$x2, | |||
$y2, | |||
$style = array() |
|||
) |
Draws a line between two points.
$x1 | (float) Abscissa of first point. |
$y1 | (float) Ordinate of first point. |
$x2 | (float) Abscissa of second point. |
$y2 | (float) Ordinate of second point. |
$style | (array) Line style. Array like for SetLineStyle(). Default value: default line style (empty array). |
Definiert in Zeile 11503 der Datei tcpdf.php.
Benutzt _out(), _outLine(), _outPoint() und SetLineStyle().
Wird benutzt von Arrow(), cropMark(), openHTMLTagHandler(), Rect() und registrationMarkCMYK().
LinearGradient | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$col1 = array() , |
|||
$col2 = array() , |
|||
$coords = array(0,0,1,0) |
|||
) |
Paints a linear colour gradient.
$x | (float) abscissa of the top left corner of the rectangle. |
$y | (float) ordinate of the top left corner of the rectangle. |
$w | (float) width of the rectangle. |
$h | (float) height of the rectangle. |
$col1 | (array) first color (Grayscale, RGB or CMYK components). |
$col2 | (array) second color (Grayscale, RGB or CMYK components). |
$coords | (array) array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0). |
Definiert in Zeile 14267 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y, Clip() und Gradient().
Wird benutzt von colorRegistrationBar().
Link | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$link, | |||
$spaces = 0 |
|||
) |
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.
$x | (float) Abscissa of the upper-left corner of the rectangle |
$y | (float) Ordinate of the upper-left corner of the rectangle |
$w | (float) Width of the rectangle |
$h | (float) Height of the rectangle |
$link | (mixed) URL or identifier returned by AddLink() |
$spaces | (int) number of spaces on the text to link |
Definiert in Zeile 4735 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y und Annotation().
Wird benutzt von getCellCode(), Image() und ImageEps().
ListBox | ( | $name, | |
$w, | |||
$h, | |||
$values, | |||
$prop = array() , |
|||
$opt = array() , |
|||
$x = '' , |
|||
$y = '' , |
|||
$js = false |
|||
) |
Creates a List-box field
$name | (string) field name |
$w | (int) width |
$h | (int) height |
$values | (array) array containing the list of values. |
$prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
$opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
$x | (float) Abscissa of the upper-left corner of the rectangle |
$y | (float) Ordinate of the upper-left corner of the rectangle |
$js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definiert in Zeile 12879 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y, _addfield() und checkPageRegions().
Ln | ( | $h = '' , |
|
$cell = false |
|||
) |
Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
$h | (float) The height of the break. By default, the value equals the height of the last printed cell. |
$cell | (boolean) if true add the current left (or right o for RTL) padding to the X coordinate |
Definiert in Zeile 7337 der Datei tcpdf.php.
Wird benutzt von Footer(), setRTL() und writeHTML().
MirrorH | ( | $x = '' ) |
Horizontal Mirroring.
$x | (int) abscissa of the point. Default is current x position |
Definiert in Zeile 11088 der Datei tcpdf.php.
MirrorL | ( | $angle = 0 , |
|
$x = '' , |
|||
$y = '' |
|||
) |
Reflection against a straight line through point (x, y) with the gradient angle (angle).
$angle | (float) gradient angle of the straight line. Default is 0 (horizontal line). |
$x | (int) abscissa of the point. Default is current x position |
$y | (int) ordinate of the point. Default is current y position |
Definiert in Zeile 11124 der Datei tcpdf.php.
Benutzt $x, $y, Rotate() und Scale().
MirrorP | ( | $x = '' , |
|
$y = '' |
|||
) |
Point reflection mirroring.
$x | (int) abscissa of the point. Default is current x position |
$y | (int) ordinate of the point. Default is current y position |
Definiert in Zeile 11111 der Datei tcpdf.php.
MirrorV | ( | $y = '' ) |
Verical Mirroring.
$y | (int) ordinate of the point. Default is current y position |
Definiert in Zeile 11099 der Datei tcpdf.php.
movePage | ( | $frompage, | |
$topage | |||
) |
MultiCell | ( | $w, | |
$h, | |||
$txt, | |||
$border = 0 , |
|||
$align = 'J' , |
|||
$fill = false , |
|||
$ln = 1 , |
|||
$x = '' , |
|||
$y = '' , |
|||
$reseth = true , |
|||
$stretch = 0 , |
|||
$ishtml = false , |
|||
$autopadding = true , |
|||
$maxh = 0 , |
|||
$valign = 'T' , |
|||
$fitcell = false |
|||
) |
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
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.
$w | (float) Width of cells. If 0, they extend up to the right margin of the page. |
$h | (float) Cell minimum height. The cell extends automatically if needed. |
$txt | (string) String to print |
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
$align | (string) Allows to center or align the text. Possible values are:
|
$fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
$ln | (int) Indicates where the current position should go after the call. Possible values are:
|
$x | (float) x position in user units |
$y | (float) y position in user units |
$reseth | (boolean) if true reset the last cell height (default true). |
$stretch | (int) font stretch mode:
|
$ishtml | (boolean) INTERNAL USE ONLY – set to true if $txt is HTML content (default = false). Never set this parameter to true, use instead writeHTMLCell() or writeHTML() methods. |
$autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width. |
$maxh | (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false. |
$valign | (string) Vertical alignment of text (requires $maxh = $h > 0). Possible values are:
|
$fitcell | (boolean) if true attempt to fit all the text within the cell by reducing the font size (do not work in HTML mode). |
Definiert in Zeile 5764 der Datei tcpdf.php.
Benutzt $bMargin, $cell_margin, $cell_padding, $check_page_regions, $current_column, $FontSizePt, $h, $lMargin, $num_columns, $page, $rMargin, $tMargin, $w, $x, $xobjid, $y, adjustCellPadding(), checkPageBreak(), checkPageRegions(), TCPDF_STATIC\empty_string(), TCPDF_STATIC\getBorderMode(), getCellCode(), getPageBuffer(), getStringHeight(), GetX(), GetY(), inPageBody(), resetLastH(), selectColumn(), setCellMargins(), setContentMark(), SetFontSize(), setPage(), setPageBuffer(), SetX(), SetY(), Write() und writeHTML().
Wird benutzt von Header(), TextField(), writeHTML() und writeHTMLCell().
Open | ( | ) |
This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically. Note: no page is created by this method
Definiert in Zeile 2926 der Datei tcpdf.php.
Wird benutzt von startPage().
|
protected |
Process opening tags.
$dom | (array) html dom array |
$key | (int) current element id |
$cell | (boolean) if true add the default left (or right if RTL) padding to each new line (default false). |
Definiert in Zeile 18598 der Datei tcpdf.php.
Benutzt $cell_padding, $form_action, $h, $k, $listindent, $listindentlevel, $listnum, $lisymbol, $lMargin, $n, $page, $rMargin, $w, $x, $y, addHTMLVertSpace(), AddLink(), Button(), CheckBox(), checkPageBreak(), TCPDF_STATIC\empty_string(), Error(), getCellHeight(), getGraphicVars(), getHTMLUnitToUnits(), TCPDF_IMAGES\getImageFileType(), GetLineWidth(), GetStringWidth(), GetX(), GetY(), Image(), ImageEps(), ImageSVG(), K_TCPDF_CALLS_IN_HTML, Line(), RadioButton(), SetCellPadding(), SetLineWidth(), SetLink(), setTempRTL(), SetXY() und TextField().
Wird benutzt von writeHTML().
Output | ( | $name = 'doc.pdf' , |
|
$dest = 'I' |
|||
) |
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.
$name | (string) The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character. |
$dest | (string) Destination where to send the document. It can take one of the following values:
|
Definiert in Zeile 7528 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$byterange_string, Close(), Error(), getBuffer(), TCPDF_STATIC\getObjFilename() und TCPDF_STATIC\sendOutputData().
PageNo | ( | ) |
Returns the current page number.
Definiert in Zeile 3676 der Datei tcpdf.php.
Benutzt $page.
Wird benutzt von Bookmark(), PageNoFormatted() und setDestination().
PageNoFormatted | ( | ) |
Returns the current page number formatted as a string.
Definiert in Zeile 13646 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\formatPageNumber() und PageNo().
PieSector | ( | $xc, | |
$yc, | |||
$r, | |||
$a, | |||
$b, | |||
$style = 'FD' , |
|||
$cw = true , |
|||
$o = 90 |
|||
) |
Draw the sector of a circle. It can be used for instance to render pie charts.
$xc | (float) abscissa of the center. |
$yc | (float) ordinate of the center. |
$r | (float) radius. |
$a | (float) start angle (in degrees). |
$b | (float) end angle (in degrees). |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$cw,: | (float) indicates whether to go clockwise (default: true). |
$o,: | (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90. |
Definiert in Zeile 14726 der Datei tcpdf.php.
Benutzt PieSectorXY().
Wird benutzt von registrationMark() und registrationMarkCMYK().
PieSectorXY | ( | $xc, | |
$yc, | |||
$rx, | |||
$ry, | |||
$a, | |||
$b, | |||
$style = 'FD' , |
|||
$cw = false , |
|||
$o = 0 , |
|||
$nc = 2 |
|||
) |
Draw the sector of an ellipse. It can be used for instance to render pie charts.
$xc | (float) abscissa of the center. |
$yc | (float) ordinate of the center. |
$rx | (float) the x-axis radius. |
$ry | (float) the y-axis radius. |
$a | (float) start angle (in degrees). |
$b | (float) end angle (in degrees). |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$cw,: | (float) indicates whether to go clockwise. |
$o,: | (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). |
$nc | (integer) Number of curves used to draw a 90 degrees portion of arc. |
Definiert in Zeile 14747 der Datei tcpdf.php.
Benutzt _out(), _outellipticalarc() und TCPDF_STATIC\getPathPaintOperator().
Wird benutzt von PieSector().
pixelsToUnits | ( | $px) |
Converts pixels to User's Units.
$px | (int) pixels |
Definiert in Zeile 10436 der Datei tcpdf.php.
Wird benutzt von Image().
Polycurve | ( | $x0, | |
$y0, | |||
$segments, | |||
$style = '' , |
|||
$line_style = array() , |
|||
$fill_color = array() |
|||
) |
Draws a poly-Bezier curve. Each Bezier curve segment is a tangent to the line between the control points at either end of the curve.
$x0 | (float) Abscissa of start point. |
$y0 | (float) Ordinate of start point. |
$segments | (float) An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3). |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$line_style | (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array). |
$fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array). |
Definiert in Zeile 11634 der Datei tcpdf.php.
Benutzt _out(), _outCurve(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray() und SetLineStyle().
Polygon | ( | $p, | |
$style = '' , |
|||
$line_style = array() , |
|||
$fill_color = array() , |
|||
$closed = true |
|||
) |
Draws a polygon.
$p | (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1)) |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$line_style | (array) Line style of polygon. Array with keys among the following:
|
$fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array). |
$closed | (boolean) if true the polygon is closes, otherwise will remain open |
Definiert in Zeile 11883 der Datei tcpdf.php.
Benutzt _out(), _outLine(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray() und SetLineStyle().
Wird benutzt von Arrow(), PolyLine(), RegularPolygon() und StarPolygon().
PolyLine | ( | $p, | |
$style = '' , |
|||
$line_style = array() , |
|||
$fill_color = array() |
|||
) |
Draws a polygonal line
$p | (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1)) |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$line_style | (array) Line style of polygon. Array with keys among the following:
|
$fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array). |
Definiert in Zeile 11864 der Datei tcpdf.php.
Benutzt Polygon().
printTemplate | ( | $id, | |
$x = '' , |
|||
$y = '' , |
|||
$w = 0 , |
|||
$h = 0 , |
|||
$align = '' , |
|||
$palign = '' , |
|||
$fitonpage = false |
|||
) |
Print an XObject Template. You can print an XObject Template inside the currently opened Template. An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
$id | (string) The ID of XObject Template to print. |
$x | (int) X position in user units (empty string = current x position) |
$y | (int) Y position in user units (empty string = current y position) |
$w | (int) Width in user units (zero = remaining page width) |
$h | (int) Height in user units (zero = remaining page height) |
$align | (string) Indicates the alignment of the pointer next to template insertion relative to template height. The value can be:
|
$palign | (string) Allows to center or align the template on the current line. Possible values are:
|
$fitonpage | (boolean) If true the template is resized to not exceed page dimensions. |
Definiert in Zeile 22282 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\getTransformationMatrixProduct().
Wird benutzt von Header().
|
protected |
Output an HTML list bullet or ordered item symbol
$listdepth | (int) list nesting level |
$listtype | (string) type of list |
$size | (float) current font size |
Definiert in Zeile 20221 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string(), TCPDF_STATIC\intToRoman() und TCPDF_FONTS\unichr().
Wird benutzt von writeHTML().
RadialGradient | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$col1 = array() , |
|||
$col2 = array() , |
|||
$coords = array(0.5,0.5,0.5,0.5,1) |
|||
) |
Paints a radial colour gradient.
$x | (float) abscissa of the top left corner of the rectangle. |
$y | (float) ordinate of the top left corner of the rectangle. |
$w | (float) width of the rectangle. |
$h | (float) height of the rectangle. |
$col1 | (array) first color (Grayscale, RGB or CMYK components). |
$col2 | (array) second color (Grayscale, RGB or CMYK components). |
$coords | (array) array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined. |
Definiert in Zeile 14285 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y, Clip() und Gradient().
RadioButton | ( | $name, | |
$w, | |||
$prop = array() , |
|||
$opt = array() , |
|||
$onvalue = 'On' , |
|||
$checked = false , |
|||
$x = '' , |
|||
$y = '' , |
|||
$js = false |
|||
) |
Creates a RadioButton field.
$name | (string) Field name. |
$w | (int) Width of the radio button. |
$prop | (array) Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
$opt | (array) Annotation parameters. Possible values are described on official PDF32000_2008 reference. |
$onvalue | (string) Value to be returned if selected. |
$checked | (boolean) Define the initial state. |
$x | (float) Abscissa of the upper-left corner of the rectangle |
$y | (float) Ordinate of the upper-left corner of the rectangle |
$js | (boolean) If true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definiert in Zeile 12776 der Datei tcpdf.php.
Benutzt $k, $n, $page, $w, $x, $y, _addfield(), AddFont(), Annotation(), checkPageRegions(), TCPDF_STATIC\empty_string(), getAbsFontMeasure(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFontBuffer() und getFormDefaultProp().
Wird benutzt von openHTMLTagHandler().
|
protected |
Rect | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$style = '' , |
|||
$border_style = array() , |
|||
$fill_color = array() |
|||
) |
Draws a rectangle.
$x | (float) Abscissa of upper-left corner. |
$y | (float) Ordinate of upper-left corner. |
$w | (float) Width. |
$h | (float) Height. |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$border_style | (array) Border style of rectangle. Array with keys among the following:
|
$fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array). |
Definiert in Zeile 11533 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y, _outRect(), TCPDF_STATIC\getPathPaintOperator(), Line(), SetFillColorArray() und SetLineStyle().
Wird benutzt von colorRegistrationBar(), RoundedRectXY(), write1DBarcode() und write2DBarcode().
registrationMark | ( | $x, | |
$y, | |||
$r, | |||
$double = false , |
|||
$cola = array(100,100,100,100,'All') , |
|||
$colb = array(0,0,0,0,'None') |
|||
) |
Paints a registration mark
$x | (float) abscissa of the registration mark center. |
$y | (float) ordinate of the registration mark center. |
$r | (float) radius of the crop mark. |
$double | (boolean) if true print two concentric crop marks. |
$cola | (array) crop mark color (default spot registration color 'All'). |
$colb | (array) second crop mark color (default spot registration color 'None'). |
Definiert in Zeile 14196 der Datei tcpdf.php.
Benutzt $x, $y, Circle(), PieSector() und SetFillColorArray().
registrationMarkCMYK | ( | $x, | |
$y, | |||
$r | |||
) |
Paints a CMYK registration mark
$x | (float) abscissa of the registration mark center. |
$y | (float) ordinate of the registration mark center. |
$r | (float) radius of the crop mark. |
Definiert in Zeile 14223 der Datei tcpdf.php.
Benutzt $x, $y, Circle(), Line(), PieSector() und SetFillColorArray().
RegularPolygon | ( | $x0, | |
$y0, | |||
$r, | |||
$ns, | |||
$angle = 0 , |
|||
$draw_circle = false , |
|||
$style = '' , |
|||
$line_style = array() , |
|||
$fill_color = array() , |
|||
$circle_style = '' , |
|||
$circle_outLine_style = array() , |
|||
$circle_fill_color = array() |
|||
) |
Draws a regular polygon.
$x0 | (float) Abscissa of center point. |
$y0 | (float) Ordinate of center point. |
$r,: | (float) Radius of inscribed circle. |
$ns | (integer) Number of sides. |
$angle | (float) Angle oriented (anti-clockwise). Default value: 0. |
$draw_circle | (boolean) Draw inscribed circle or not. Default value: false. |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$line_style | (array) Line style of polygon sides. Array with keys among the following:
|
$fill_color | (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
$circle_style | (string) Style of rendering of inscribed circle (if draws). Possible values are:
|
$circle_outLine_style | (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array). |
$circle_fill_color | (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array). |
Definiert in Zeile 11984 der Datei tcpdf.php.
Benutzt Circle() und Polygon().
removePageRegion | ( | $key) |
Remove a single no-write region.
$key | (int) region key |
|
protected |
Replace the buffer content
$data | (string) data |
Definiert in Zeile 20624 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string() und TCPDF_STATIC\getObjFilename().
|
protected |
Replace a char if is defined on the current font.
$oldchar | (int) Integer code (unicode) of the character to replace. |
$newchar | (int) Integer code (unicode) of the new character. |
Definiert in Zeile 5538 der Datei tcpdf.php.
Benutzt isCharDefined().
Wird benutzt von getCellCode().
replaceMissingChars | ( | $text, | |
$font = '' , |
|||
$style = '' , |
|||
$subs = array() |
|||
) |
Replace missing font characters on selected font with specified substitutions.
$text | (string) Text to process. |
$font | (string) Font name (family name). |
$style | (string) Font style. |
$subs | (array) Array of possible character substitutions. The key is the character to check (integer value) and the value is a single intege value or an array of possible substitutes. |
Definiert in Zeile 4648 der Datei tcpdf.php.
Benutzt $FontFamily, $k, AddFont(), TCPDF_STATIC\empty_string(), getFontBuffer(), TCPDF_FONTS\UniArrSubString(), TCPDF_FONTS\UTF8ArrayToUniArray() und TCPDF_FONTS\UTF8StringToArray().
|
protected |
Replace right shift page number aliases with spaces to correct right alignment. This works perfectly only when using monospaced fonts.
$page | (string) Page content. |
$aliases | (array) Array of page aliases. |
$diff | (int) initial difference to add. |
Definiert in Zeile 7833 der Datei tcpdf.php.
Benutzt $page und TCPDF_FONTS\UTF8ToUTF16BE().
Wird benutzt von _putpages().
resetColumns | ( | ) |
resetHeaderTemplate | ( | ) |
resetLastH | ( | ) |
Reset the last cell height.
Definiert in Zeile 2427 der Datei tcpdf.php.
Benutzt getCellHeight().
Wird benutzt von getNumLines(), MultiCell() und writeHTML().
rollbackTransaction | ( | $self = false ) |
This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
$self | (boolean) if true restores current class object to previous state without the need of reassignment via the returned value. |
Definiert in Zeile 21626 der Datei tcpdf.php.
Wird benutzt von writeHTML().
Rotate | ( | $angle, | |
$x = '' , |
|||
$y = '' |
|||
) |
Rotate object.
$angle | (float) angle in degrees for counter-clockwise rotation |
$x | (int) abscissa of the rotation center. Default is current x position |
$y | (int) ordinate of the rotation center. Default is current y position |
Definiert in Zeile 11181 der Datei tcpdf.php.
Benutzt $k, $x, $y und Transform().
Wird benutzt von MirrorL().
RoundedRect | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$r, | |||
$round_corner = '1111' , |
|||
$style = '' , |
|||
$border_style = array() , |
|||
$fill_color = array() |
|||
) |
Draws a rounded rectangle.
$x | (float) Abscissa of upper-left corner. |
$y | (float) Ordinate of upper-left corner. |
$w | (float) Width. |
$h | (float) Height. |
$r | (float) the radius of the circle used to round off the corners of the rectangle. |
$round_corner | (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top right, bottom right, bottom left and top left. Default value: all rounded corner ("1111"). |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$border_style | (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array). |
$fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array). |
Definiert in Zeile 12074 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y und RoundedRectXY().
RoundedRectXY | ( | $x, | |
$y, | |||
$w, | |||
$h, | |||
$rx, | |||
$ry, | |||
$round_corner = '1111' , |
|||
$style = '' , |
|||
$border_style = array() , |
|||
$fill_color = array() |
|||
) |
Draws a rounded rectangle.
$x | (float) Abscissa of upper-left corner. |
$y | (float) Ordinate of upper-left corner. |
$w | (float) Width. |
$h | (float) Height. |
$rx | (float) the x-axis radius of the ellipse used to round off the corners of the rectangle. |
$ry | (float) the y-axis radius of the ellipse used to round off the corners of the rectangle. |
$round_corner | (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top right, bottom right, bottom left and top left. Default value: all rounded corner ("1111"). |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$border_style | (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array). |
$fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array). |
Definiert in Zeile 12093 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y, _out(), _outCurve(), _outLine(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), Rect(), SetFillColorArray() und SetLineStyle().
Wird benutzt von RoundedRect().
Scale | ( | $s_x, | |
$s_y, | |||
$x = '' , |
|||
$y = '' |
|||
) |
Vertical and horizontal non-proportional Scaling.
$s_x | (float) scaling factor for width as percent. 0 is not allowed. |
$s_y | (float) scaling factor for height as percent. 0 is not allowed. |
$x | (int) abscissa of the scaling center. Default is current x position |
$y | (int) ordinate of the scaling center. Default is current y position |
Definiert in Zeile 11055 der Datei tcpdf.php.
Benutzt $k, $x, $y, Error() und Transform().
Wird benutzt von MirrorH(), MirrorL(), MirrorP(), MirrorV(), ScaleX(), ScaleXY() und ScaleY().
ScaleX | ( | $s_x, | |
$x = '' , |
|||
$y = '' |
|||
) |
Horizontal Scaling.
$s_x | (float) scaling factor for width as percent. 0 is not allowed. |
$x | (int) abscissa of the scaling center. Default is current x position |
$y | (int) ordinate of the scaling center. Default is current y position |
Definiert in Zeile 11015 der Datei tcpdf.php.
ScaleXY | ( | $s, | |
$x = '' , |
|||
$y = '' |
|||
) |
Vertical and horizontal proportional Scaling.
$s | (float) scaling factor for width and height as percent. 0 is not allowed. |
$x | (int) abscissa of the scaling center. Default is current x position |
$y | (int) ordinate of the scaling center. Default is current y position |
Definiert in Zeile 11041 der Datei tcpdf.php.
ScaleY | ( | $s_y, | |
$x = '' , |
|||
$y = '' |
|||
) |
Vertical Scaling.
$s_y | (float) scaling factor for height as percent. 0 is not allowed. |
$x | (int) abscissa of the scaling center. Default is current x position |
$y | (int) ordinate of the scaling center. Default is current y position |
Definiert in Zeile 11028 der Datei tcpdf.php.
|
protected |
Sets the character data handler function for the XML parser.
$parser | (resource) The first parameter, parser, is a reference to the XML parser calling the handler. |
$data | (string) The second parameter, data, contains the character data as a string. |
selectColumn | ( | $col = '' ) |
Set position at a given column
$col | (int) column number (from 0 to getNumberOfColumns()-1); empty string = current column. |
Definiert in Zeile 21717 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string().
Wird benutzt von AcceptPageBreak(), MultiCell() und writeHTML().
serializeTCPDFtagParameters | ( | $pararray) |
Serialize an array of parameters to be used with TCPDF tag in HTML code.
$pararray | (array) parameters array |
Definiert in Zeile 17006 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\serializeTCPDFtagParameters().
SetAbsX | ( | $x) |
Set the absolute X coordinate of the current pointer.
$x | (float) The value of the abscissa in user units. |
Definiert in Zeile 7490 der Datei tcpdf.php.
Benutzt $x.
Wird benutzt von SetAbsXY().
SetAbsXY | ( | $x, | |
$y | |||
) |
Set the absolute X and Y coordinates of the current pointer.
$x | (float) The value of the abscissa in user units. |
$y | (float) (float) The value of the ordinate in user units. |
Definiert in Zeile 7513 der Datei tcpdf.php.
Benutzt $x, $y, SetAbsX() und SetAbsY().
SetAbsY | ( | $y) |
Set the absolute Y coordinate of the current pointer.
$y | (float) (float) The value of the ordinate in user units. |
Definiert in Zeile 7501 der Datei tcpdf.php.
Benutzt $y.
Wird benutzt von SetAbsXY().
setAlpha | ( | $stroking = 1 , |
|
$bm = 'Normal' , |
|||
$nonstroking = '' , |
|||
$ais = false |
|||
) |
Set alpha for stroking (CA) and non-stroking (ca) operations.
$stroking | (float) Alpha value for stroking operations: real value from 0 (transparent) to 1 (opaque). |
$bm | (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity |
$nonstroking | (float) Alpha value for non-stroking operations: real value from 0 (transparent) to 1 (opaque). |
$ais | (boolean) |
Definiert in Zeile 13866 der Datei tcpdf.php.
Benutzt addExtGState(), TCPDF_STATIC\empty_string() und setExtGState().
Wird benutzt von Cell().
SetAuthor | ( | $author) |
Defines the author of the document.
$author | (string) The name of the author. |
Definiert in Zeile 2876 der Datei tcpdf.php.
Benutzt $author.
SetAutoPageBreak | ( | $auto, | |
$margin = 0 |
|||
) |
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.
$auto | (boolean) Boolean indicating if mode should be on or off. |
$margin | (float) Distance from the bottom of the page. |
Definiert in Zeile 2777 der Datei tcpdf.php.
Wird benutzt von __construct(), Close(), setPage() und setPageOrientation().
setBarcode | ( | $bc = '' ) |
SetBooklet | ( | $booklet = true , |
|
$inner = -1 , |
|||
$outer = -1 |
|||
) |
setBookmark | ( | $txt, | |
$level = 0 , |
|||
$y = -1 , |
|||
$page = '' , |
|||
$style = '' , |
|||
$color = array(0,0,0) , |
|||
$x = -1 , |
|||
$link = '' |
|||
) |
Adds a bookmark - alias for Bookmark().
$txt | (string) Bookmark description. |
$level | (int) Bookmark level (minimum value is 0). |
$y | (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;). |
$page | (int) Target page number (leave empty for current page). |
$style | (string) Font style: B = Bold, I = Italic, BI = Bold + Italic. |
$color | (array) RGB color array (values from 0 to 255). |
$x | (float) X position in user units of the bookmark on the selected page (default = -1 = current position;). |
$link | (mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name). |
Definiert in Zeile 12301 der Datei tcpdf.php.
Benutzt $page, $x, $y und Bookmark().
|
protected |
Set buffer content (always append data).
$data | (string) data |
Definiert in Zeile 20606 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string() und TCPDF_STATIC\getObjFilename().
Wird benutzt von _out().
setCellHeightRatio | ( | $h) |
setCellMargins | ( | $left = '' , |
|
$top = '' , |
|||
$right = '' , |
|||
$bottom = '' |
|||
) |
Set the internal Cell margins.
$left | (float) left margin |
$top | (float) top margin |
$right | (float) right margin |
$bottom | (float) bottom margin |
Definiert in Zeile 2669 der Datei tcpdf.php.
Wird benutzt von __construct() und MultiCell().
SetCellPadding | ( | $pad) |
Set the same internal Cell padding for top, right, bottom, left-
$pad | (float) internal padding. |
Definiert in Zeile 2614 der Datei tcpdf.php.
Wird benutzt von openHTMLTagHandler(), setFooter(), setHeader(), Write() und write1DBarcode().
setCellPaddings | ( | $left = '' , |
|
$top = '' , |
|||
$right = '' , |
|||
$bottom = '' |
|||
) |
Set the internal Cell paddings.
$left | (float) left padding |
$top | (float) top padding |
$right | (float) right padding |
$bottom | (float) bottom padding |
Definiert in Zeile 2633 der Datei tcpdf.php.
Wird benutzt von __construct().
setColor | ( | $type, | |
$col1 = 0 , |
|||
$col2 = -1 , |
|||
$col3 = -1 , |
|||
$col4 = -1 , |
|||
$ret = false , |
|||
$name = '' |
|||
) |
Defines the color used by the specified type ('draw', 'fill', 'text').
$type | (string) Type of object affected by this color: ('draw', 'fill', 'text'). |
$col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
$col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
$col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
$col4 | (float) KEY (BLACK) color for CMYK (0-100). |
$ret | (boolean) If true do not send the command. |
$name | (string) spot color name (if any) |
Definiert in Zeile 3879 der Datei tcpdf.php.
Benutzt $TextColor, _out(), AddSpotColor() und setSpotColor().
Wird benutzt von setColorArray(), SetDrawColor(), SetFillColor() und SetTextColor().
setColorArray | ( | $type, | |
$color, | |||
$ret = false |
|||
) |
Set the color array for the specified type ('draw', 'fill', 'text'). It can be expressed in RGB, CMYK or GRAY SCALE components. The method can be called before the first page is created and the value is retained from page to page.
$type | (string) Type of object affected by this color: ('draw', 'fill', 'text'). |
$color | (array) Array of colors (1=gray, 3=RGB, 4=CMYK or 5=spotcolor=CMYK+name values). |
$ret | (boolean) If true do not send the PDF command. |
Definiert in Zeile 3804 der Datei tcpdf.php.
Benutzt $k, $y und setColor().
Wird benutzt von SetDrawColorArray(), SetFillColorArray() und SetTextColorArray().
setColumnsArray | ( | $columns) |
SetCompression | ( | $compress = true ) |
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.
$compress | (boolean) Boolean indicating if compression must be enabled. |
Definiert in Zeile 2818 der Datei tcpdf.php.
Benutzt $compress.
Wird benutzt von __construct().
|
protected |
Set start-writing mark on selected page. Borders and fills are always created after content and inserted on the position marked by this method.
$page | (int) page number (default is the current page) |
Definiert in Zeile 3223 der Datei tcpdf.php.
Benutzt $page.
Wird benutzt von MultiCell() und setPageMark().
SetCreator | ( | $creator) |
Defines the creator of the document. This is typically the name of the application that generates the PDF.
$creator | (string) The name of the creator. |
Definiert in Zeile 2898 der Datei tcpdf.php.
Benutzt $creator.
SetDefaultMonospacedFont | ( | $font) |
setDefaultTableColumns | ( | $cols = 4 ) |
setDestination | ( | $name, | |
$y = -1 , |
|||
$page = '' , |
|||
$x = -1 |
|||
) |
Add a Named Destination. NOTE: destination names are unique, so only last entry will be saved.
$name | (string) Destination name. |
$y | (float) Y position in user units of the destiantion on the selected page (default = -1 = current position; 0 = page start;). |
$page | (int) Target page number (leave empty for current page). |
$x | (float) X position in user units of the destiantion on the selected page (default = -1 = current position;). |
Definiert in Zeile 12228 der Datei tcpdf.php.
Benutzt $h, $page, $w, $x, $y, TCPDF_STATIC\empty_string(), TCPDF_STATIC\encodeNameObject(), GetX(), GetY() und PageNo().
SetDisplayMode | ( | $zoom, | |
$layout = 'SinglePage' , |
|||
$mode = 'UseNone' |
|||
) |
Defines the way the document is to be displayed by the viewer.
$zoom | (mixed) The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use.
|
$layout | (string) The page layout. Possible values are:
|
$mode | (string) A name object specifying how the document should be displayed when opened:
|
Definiert in Zeile 2801 der Datei tcpdf.php.
Benutzt Error(), TCPDF_STATIC\getPageLayoutMode() und TCPDF_STATIC\getPageMode().
Wird benutzt von __construct().
setDocCreationTimestamp | ( | $time) |
Set the document creation timestamp
$time | (mixed) Document creation timestamp in seconds or date-time string. |
Definiert in Zeile 10157 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\getTimestamp().
SetDocInfoUnicode | ( | $unicode = true ) |
setDocModificationTimestamp | ( | $time) |
Set the document modification timestamp
$time | (mixed) Document modification timestamp in seconds or date-time string. |
Definiert in Zeile 10170 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\getTimestamp().
SetDrawColor | ( | $col1 = 0 , |
|
$col2 = -1 , |
|||
$col3 = -1 , |
|||
$col4 = -1 , |
|||
$ret = false , |
|||
$name = '' |
|||
) |
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.
$col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
$col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
$col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
$col4 | (float) KEY (BLACK) color for CMYK (0-100). |
$ret | (boolean) If true do not send the command. |
$name | (string) spot color name (if any) |
Definiert in Zeile 3969 der Datei tcpdf.php.
Benutzt setColor().
SetDrawColorArray | ( | $color, | |
$ret = false |
|||
) |
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB, CMYK or GRAY SCALE components. The method can be called before the first page is created and the value is retained from page to page.
$color | (array) Array of colors (1, 3 or 4 values). |
$ret | (boolean) If true do not send the PDF command. |
Definiert in Zeile 3835 der Datei tcpdf.php.
Benutzt setColorArray().
Wird benutzt von Cell(), SetLineStyle(), write1DBarcode(), write2DBarcode() und writeHTML().
SetDrawSpotColor | ( | $name, | |
$tint = 100 |
|||
) |
Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
$name | (string) Name of the spot color. |
$tint | (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
Definiert in Zeile 3765 der Datei tcpdf.php.
Benutzt setSpotColor().
setEqualColumns | ( | $numcols = 0 , |
|
$width = 0 , |
|||
$y = '' |
|||
) |
Set multiple columns of the same size
$numcols | (int) number of columns (set to zero to disable columns mode) |
$width | (int) column width |
$y | (int) column starting Y position (leave empty for current Y position) |
Definiert in Zeile 21658 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string().
Wird benutzt von Close().
|
protected |
Add an extgstate
$gs | (array) extgstate |
Definiert in Zeile 13785 der Datei tcpdf.php.
Benutzt _out().
Wird benutzt von setAlpha() und setOverprint().
setExtraXMP | ( | $xmp) |
Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag. IMPORTANT: This data is added as-is without controls, so you have to validate your data before using this method!
$xmp | (string) Custom XMP data. |
SetFillColor | ( | $col1 = 0 , |
|
$col2 = -1 , |
|||
$col3 = -1 , |
|||
$col4 = -1 , |
|||
$ret = false , |
|||
$name = '' |
|||
) |
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.
$col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
$col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
$col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
$col4 | (float) KEY (BLACK) color for CMYK (0-100). |
$ret | (boolean) If true do not send the command. |
$name | (string) Spot color name (if any). |
Definiert in Zeile 3986 der Datei tcpdf.php.
Benutzt setColor().
Wird benutzt von Button().
SetFillColorArray | ( | $color, | |
$ret = false |
|||
) |
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB, CMYK or GRAY SCALE components. The method can be called before the first page is created and the value is retained from page to page.
$color | (array) Array of colors (1, 3 or 4 values). |
$ret | (boolean) If true do not send the PDF command. |
Definiert in Zeile 3849 der Datei tcpdf.php.
Benutzt setColorArray().
Wird benutzt von Cell(), colorRegistrationBar(), Curve(), Ellipse(), Polycurve(), Polygon(), Rect(), registrationMark(), registrationMarkCMYK(), RoundedRectXY() und writeHTML().
SetFillSpotColor | ( | $name, | |
$tint = 100 |
|||
) |
Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).
$name | (string) Name of the spot color. |
$tint | (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
Definiert in Zeile 3777 der Datei tcpdf.php.
Benutzt setSpotColor().
SetFont | ( | $family, | |
$style = '' , |
|||
$size = null , |
|||
$fontfile = '' , |
|||
$subset = 'default' , |
|||
$out = true |
|||
) |
Sets the font used to print character strings. 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(). Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:
$family | (string) Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):
|
$style | (string) Font style. Possible values are (case insensitive):
|
$size | (float) Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12 |
$fontfile | (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces. |
$subset | (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font. |
$out | (boolean) if true output the font size command, otherwise only set the font properties. |
Definiert in Zeile 4446 der Datei tcpdf.php.
Benutzt $FontSizePt, AddFont(), getFontBuffer(), SetFontSize() und setFontSubBuffer().
Wird benutzt von __construct(), addHtmlLink(), Close(), GetArrStringWidth(), Header(), setFooter(), setHeader(), write1DBarcode() und writeHTML().
|
protected |
Set font buffer content.
$font | (string) font key |
$data | (array) font data |
Definiert in Zeile 20763 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\getObjFilename().
Wird benutzt von AddFont().
SetFontSize | ( | $size, | |
$out = true |
|||
) |
Defines the size of the current font.
$size | (float) The font size in points. |
$out | (boolean) if true output the font size command, otherwise only set the font properties. |
Definiert in Zeile 4474 der Datei tcpdf.php.
Wird benutzt von MultiCell() und SetFont().
setFontSpacing | ( | $spacing = 0 ) |
Set the amount to increase or decrease the space between characters in a text.
$spacing | (float) amount to increase or decrease the space between characters in a text (0 = default spacing) |
Definiert in Zeile 22437 der Datei tcpdf.php.
Wird benutzt von writeHTML().
setFontStretching | ( | $perc = 100 ) |
Set the percentage of character stretching.
$perc | (int) percentage of stretching (100 = no stretching) |
Definiert in Zeile 22415 der Datei tcpdf.php.
Wird benutzt von writeHTML().
|
protected |
Set font buffer content.
$font | (string) font key |
$key | (string) font sub-key |
$data | (array) font data |
Definiert in Zeile 20789 der Datei tcpdf.php.
Wird benutzt von _enddoc(), AddFont(), getCellCode() und SetFont().
setFontSubsetting | ( | $enable = true ) |
|
protected |
This method is used to render the page footer.
Definiert in Zeile 3544 der Datei tcpdf.php.
Benutzt $footer_margin, $lasth, $original_lMargin, $original_rMargin, $page, $thead, $theadMargins, _out(), _outRestoreGraphicsState(), _outSaveGraphicsState(), Footer(), getGraphicVars(), SetCellPadding(), SetFont(), setGraphicVars() und SetXY().
Wird benutzt von endPage().
setFooterData | ( | $tc = array(0,0,0) , |
|
$lc = array(0,0,0) |
|||
) |
setFooterFont | ( | $font) |
Set footer font.
$font | (array) Array describing the basic font parameters: (family, style, size). |
Definiert in Zeile 10339 der Datei tcpdf.php.
Wird benutzt von __construct().
setFooterMargin | ( | $fm = 10 ) |
setFormDefaultProp | ( | $prop = array() ) |
|
protected |
Set graphic variables.
$gvars | (array) array of graphic variablesto restore |
$extended | (boolean) if true restore extended graphic variables |
Definiert in Zeile 20484 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\empty_string().
Wird benutzt von Close(), setFooter(), setHeader(), setTableHeader(), startPage(), write1DBarcode(), write2DBarcode() und writeHTML().
|
protected |
This method is used to render the page header.
Definiert in Zeile 3503 der Datei tcpdf.php.
Benutzt $lasth, $newline, $original_lMargin, $original_rMargin, $thead, $theadMargins, _outRestoreGraphicsState(), _outSaveGraphicsState(), Header(), SetCellPadding(), SetFont(), setGraphicVars() und SetXY().
Wird benutzt von startPage().
setHeaderData | ( | $ln = '' , |
|
$lw = 0 , |
|||
$ht = '' , |
|||
$hs = '' , |
|||
$tc = array(0,0,0) , |
|||
$lc = array(0,0,0) |
|||
) |
Set header data.
$ln | (string) header image logo |
$lw | (string) header image logo width in mm |
$ht | (string) string to print as title on document header |
$hs | (string) string to print on document header |
$tc | (array) RGB array color for text. |
$lc | (array) RGB array color for line. |
setHeaderFont | ( | $font) |
Set header font.
$font | (array) Array describing the basic font parameters: (family, style, size). |
Definiert in Zeile 10319 der Datei tcpdf.php.
Wird benutzt von __construct().
setHeaderMargin | ( | $hm = 10 ) |
setHeaderTemplateAutoreset | ( | $val = true ) |
setHtmlLinksStyle | ( | $color = array(0,0,255) , |
|
$fontstyle = 'U' |
|||
) |
setHtmlVSpace | ( | $tagvs) |
Set the vertical spaces for HTML tags. The array must have the following structure (example): $tagvs = array('h1' => array(0 => array('h' => '', 'n' => 2), 1 => array('h' => 1.3, 'n' => 1))); The first array level contains the tag names, the second level contains 0 for opening tags or 1 for closing tags, the third level contains the vertical space unit (h) and the number spaces to add (n). If the h parameter is not specified, default values are used.
$tagvs | (array) array of tags and relative vertical spaces. |
|
protected |
Set image buffer content.
$image | (string) image key |
$data | (array) image data |
Definiert in Zeile 20702 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\getObjFilename().
Wird benutzt von Image().
setImageScale | ( | $scale) |
|
protected |
Set image buffer content for a specified sub-key.
$image | (string) image key |
$key | (string) image sub-key |
$data | (array) image data |
Definiert in Zeile 20727 der Datei tcpdf.php.
Wird benutzt von _putimages().
setJPEGQuality | ( | $quality) |
SetKeywords | ( | $keywords) |
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
$keywords | (string) The list of keywords. |
Definiert in Zeile 2887 der Datei tcpdf.php.
Benutzt $keywords.
setLanguageArray | ( | $language) |
setLastH | ( | $h) |
SetLeftMargin | ( | $margin) |
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.
$margin | (float) The margin. |
SetLineStyle | ( | $style, | |
$ret = false |
|||
) |
Set line style.
$style | (array) Line style. Array with keys among the following:
|
$ret | (boolean) if true do not send the command. |
Definiert in Zeile 11344 der Datei tcpdf.php.
Benutzt _out() und SetDrawColorArray().
Wird benutzt von cropMark(), Curve(), Ellipse(), Footer(), getCellBorder(), Header(), Line(), Polycurve(), Polygon(), Rect() und RoundedRectXY().
SetLineWidth | ( | $width) |
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.
$width | (float) The width. |
Definiert in Zeile 11301 der Datei tcpdf.php.
Benutzt _out().
Wird benutzt von openHTMLTagHandler().
SetLink | ( | $link, | |
$y = 0 , |
|||
$page = -1 |
|||
) |
Defines the page and position a link points to.
$link | (int) The link identifier returned by AddLink() |
$y | (float) Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page) |
$page | (int) Number of target page; -1 indicates the current page. This is the default value |
Definiert in Zeile 4712 der Datei tcpdf.php.
Wird benutzt von addHtmlLink() und openHTMLTagHandler().
setListIndentWidth | ( | $width) |
setLIsymbol | ( | $symbol = '!' ) |
Set the default bullet to be used as LI bullet symbol
$symbol | (string) character or string to be used (legal values are: '' = automatic, '!' = auto bullet, '#' = auto numbering, 'disc', 'disc', 'circle', 'square', '1', 'decimal', 'decimal-leading-zero', 'i', 'lower-roman', 'I', 'upper-roman', 'a', 'lower-alpha', 'lower-latin', 'A', 'upper-alpha', 'upper-latin', 'lower-greek', 'img|type|width|height|image.ext') |
SetMargins | ( | $left, | |
$top, | |||
$right = -1 , |
|||
$keepmargins = false |
|||
) |
Defines the left, top and right margins.
$left | (float) Left margin. |
$top | (float) Top margin. |
$right | (float) Right margin. Default value is the left one. |
$keepmargins | (boolean) if true overwrites the default page margins |
Definiert in Zeile 2548 der Datei tcpdf.php.
Benutzt $lMargin und $rMargin.
Wird benutzt von __construct().
setOpenCell | ( | $isopen) |
setOverprint | ( | $stroking = true , |
|
$nonstroking = '' , |
|||
$mode = 0 |
|||
) |
Set overprint mode for stroking (OP) and non-stroking (op) painting operations. (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
$stroking | (boolean) If true apply overprint for stroking operations. |
$nonstroking | (boolean) If true apply overprint for painting operations other than stroking. |
$mode | (integer) Overprint mode: (0 = each source colour component value replaces the value previously painted for the corresponding device colorant; 1 = a tint value of 0.0 for a source colour component shall leave the corresponding component of the previously painted colour unchanged). |
Definiert in Zeile 13827 der Datei tcpdf.php.
Benutzt addExtGState(), TCPDF_STATIC\empty_string() und setExtGState().
setPage | ( | $pnum, | |
$resetmargins = false |
|||
) |
Move pointer at the specified document page and update page dimensions.
$pnum | (int) page number (1 ... numpages) |
$resetmargins | (boolean) if true reset left, right, top margins and Y position. |
Definiert in Zeile 2982 der Datei tcpdf.php.
Benutzt $page, Error(), SetAutoPageBreak() und SetY().
Wird benutzt von lastPage(), MultiCell(), startPage() und writeHTML().
|
protected |
Set page boxes to be included on page descriptions.
$boxes | (array) Array of page boxes to set on document: ('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox'). |
Definiert in Zeile 7868 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\$pageboxes.
|
protected |
Set page buffer content.
$page | (int) page number |
$data | (string) page data |
$append | (boolean) if true append data, false replace. |
Definiert in Zeile 20658 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\getObjFilename().
Wird benutzt von _beginpage(), _out(), MultiCell() und writeHTML().
|
protected |
Change the format of the current page
$format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numners (width, height) or an array containing the following measures and options:
|
$orientation | (string) page orientation. Possible values are (case insensitive):
|
Definiert in Zeile 2091 der Datei tcpdf.php.
Benutzt $page, TCPDF_STATIC\getPageSizeFromFormat(), TCPDF_STATIC\setPageBoxes() und setPageOrientation().
Wird benutzt von __construct() und _beginpage().
setPageMark | ( | ) |
Set start-writing mark on current page stream used to put borders and fills. Borders and fills are always created after content and inserted on the position marked by this method. This function must be called after calling Image() function for a background image. Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.
Definiert in Zeile 3210 der Datei tcpdf.php.
Benutzt $page und setContentMark().
Wird benutzt von startPage().
setPageOrientation | ( | $orientation, | |
$autopagebreak = '' , |
|||
$bottommargin = '' |
|||
) |
Set page orientation.
$orientation | (string) page orientation. Possible values are (case insensitive):
|
$autopagebreak | (boolean) Boolean indicating if auto-page-break mode should be on or off. |
$bottommargin | (float) bottom margin of the page. |
Definiert in Zeile 2205 der Datei tcpdf.php.
Benutzt $AutoPageBreak, $bMargin, $CurOrientation, $fhPt, $fwPt, $h, $hPt, $k, $lMargin, $original_lMargin, $original_rMargin, $page, $rMargin, $tMargin, $w, $wPt, TCPDF_STATIC\empty_string(), SetAutoPageBreak(), TCPDF_STATIC\setPageBoxes() und TCPDF_STATIC\swapPageBoxCoordinates().
Wird benutzt von _beginpage(), setPageFormat() und setPageUnit().
setPageRegions | ( | $regions = array() ) |
Set no-write regions on page. A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment. You can set multiple regions for the same page.
$regions | (array) array of no-write regions. For each region you can define an array as follow: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right). Omit this parameter to remove all regions. |
setPageUnit | ( | $unit) |
Set the units of measure for the document.
$unit | (string) User measure unit. Possible values are:
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit. |
Definiert in Zeile 1999 der Datei tcpdf.php.
Benutzt $dpi, Error() und setPageOrientation().
Wird benutzt von __construct().
setPDFVersion | ( | $version = '1.7' ) |
Set the PDF version (check PDF reference for valid values).
$version | (string) PDF document version. |
Definiert in Zeile 13950 der Datei tcpdf.php.
Wird benutzt von __construct().
setPrintFooter | ( | $val = true ) |
setPrintHeader | ( | $val = true ) |
SetProtection | ( | $permissions = array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high') , |
|
$user_pass = '' , |
|||
$owner_pass = null , |
|||
$mode = 0 , |
|||
$pubkeys = null |
|||
) |
Set document protection Remark: the protection against modification is for people who have the full Acrobat product. If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access. Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.
$permissions | (Array) the set of permissions (specify the ones you want to block):
|
$user_pass | (String) user password. Empty by default. |
$owner_pass | (String) owner password. If not specified, a random value is used. |
$mode | (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit. |
$pubkeys | (String) array of recipients containing public-key certificates ('c') and permissions ('p'). For example: array(array('c' => 'file://../examples/data/cert/tcpdf.crt', 'p' => array('print'))) |
Definiert in Zeile 10864 der Datei tcpdf.php.
Benutzt _generateencryptionkey(), TCPDF_STATIC\convertHexStringToString(), Error(), TCPDF_STATIC\getRandomSeed() und TCPDF_STATIC\getUserPermissionCode().
setRasterizeVectorImages | ( | $mode) |
SetRightMargin | ( | $margin) |
Defines the right margin. The method can be called before creating the first page.
$margin | (float) The margin. |
setRTL | ( | $enable, | |
$resetx = true |
|||
) |
Enable or disable Right-To-Left language mode
$enable | (Boolean) if true enable Right-To-Left language mode. |
$resetx | (Boolean) if true reset the X position on direction change. |
Definiert in Zeile 2335 der Datei tcpdf.php.
Benutzt Ln().
setSignature | ( | $signing_cert = '' , |
|
$private_key = '' , |
|||
$private_key_password = '' , |
|||
$extracerts = '' , |
|||
$cert_type = 2 , |
|||
$info = array() |
|||
) |
Enable document signature (requires the OpenSSL Library). The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader. To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12 To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes
$signing_cert | (mixed) signing certificate (string or filename prefixed with 'file://') |
$private_key | (mixed) private key (string or filename prefixed with 'file://') |
$private_key_password | (string) password |
$extracerts | (string) specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used. |
$cert_type | (int) The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature. |
$info | (array) array of option information: Name, Location, Reason, ContactInfo. |
Definiert in Zeile 13421 der Datei tcpdf.php.
Wird benutzt von setUserRights().
setSignatureAppearance | ( | $x = 0 , |
|
$y = 0 , |
|||
$w = 0 , |
|||
$h = 0 , |
|||
$page = -1 , |
|||
$name = '' |
|||
) |
Set the digital signature appearance (a cliccable rectangle area to get signature properties)
$x | (float) Abscissa of the upper-left corner. |
$y | (float) Ordinate of the upper-left corner. |
$w | (float) Width of the signature area. |
$h | (float) Height of the signature area. |
$page | (int) option page number (if < 0 the current page is used). |
$name | (string) Name of the signature. |
Definiert in Zeile 13457 der Datei tcpdf.php.
Benutzt $h, $page, $w, $x, $y und getSignatureAppearanceArray().
setSpacesRE | ( | $re = '/[^\S\xa0]/' ) |
Set regular expression to detect withespaces or word separators. The pattern delimiter must be the forward-slash character "/". Some example patterns are:
Non-Unicode or missing PCRE unicode support: "/[^\S\xa0]/" Unicode and PCRE unicode support: "/[^\S\P{Z}\xa0]/u" Unicode and PCRE unicode support in Chinese mode: "/[^\S\P{Z}\P{Lo}\xa0]/u" if PCRE unicode support is turned ON ("\P" is the negate class of "\p"): "\p{Z}" or "\p{Separator}": any kind of Unicode whitespace or invisible separator. "\p{Lo}" or "\p{Other_Letter}": a Unicode letter or ideograph that does not have lowercase and uppercase variants. "\p{Lo}" is needed for Chinese characters because are packed next to each other without spaces in between.
$re | (string) regular expression (leave empty for default). |
Definiert in Zeile 2310 der Datei tcpdf.php.
Wird benutzt von __construct().
setSpotColor | ( | $type, | |
$name, | |||
$tint = 100 |
|||
) |
Set the spot color for the specified type ('draw', 'fill', 'text').
$type | (string) Type of object affected by this color: ('draw', 'fill', 'text'). |
$name | (string) Name of the spot color. |
$tint | (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
Definiert in Zeile 3719 der Datei tcpdf.php.
Benutzt $TextColor, $xobjid, _out(), Error() und TCPDF_COLORS\getSpotColor().
Wird benutzt von setColor(), SetDrawSpotColor(), SetFillSpotColor() und SetTextSpotColor().
setSRGBmode | ( | $mode = false ) |
setStartingPageNumber | ( | $num = 1 ) |
SetSubject | ( | $subject) |
Defines the subject of the document.
$subject | (string) The subject. |
Definiert in Zeile 2865 der Datei tcpdf.php.
Benutzt $subject.
|
protected |
Apply the requested SVG styles (*** TO BE COMPLETED ***)
$svgstyle | (array) array of SVG styles to apply |
$prevsvgstyle | (array) array of previous SVG style |
$x | (int) X origin of the bounding box |
$y | (int) Y origin of the bounding box |
$w | (int) width of the bounding box |
$h | (int) height of the bounding box |
$clip_function | (string) clip function |
$clip_params | (array) array of parameters for clipping function |
Definiert in Zeile 22995 der Datei tcpdf.php.
Benutzt TCPDF_COLORS\convertHTMLColorToDec().
|
protected |
This method is used to render the table header on new page (if any).
Definiert in Zeile 3609 der Datei tcpdf.php.
Benutzt $cell_padding, $lMargin, $page, $rMargin, $tMargin, $y, TCPDF_STATIC\empty_string(), getGraphicVars(), setGraphicVars() und writeHTML().
Wird benutzt von startPage().
setTempRTL | ( | $mode) |
Force temporary RTL language direction
$mode | (mixed) can be false, 'L' for LTR or 'R' for RTL |
Definiert in Zeile 2361 der Datei tcpdf.php.
Wird benutzt von openHTMLTagHandler().
SetTextColor | ( | $col1 = 0 , |
|
$col2 = -1 , |
|||
$col3 = -1 , |
|||
$col4 = -1 , |
|||
$ret = false , |
|||
$name = '' |
|||
) |
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.
$col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
$col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
$col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
$col4 | (float) KEY (BLACK) color for CMYK (0-100). |
$ret | (boolean) If true do not send the command. |
$name | (string) Spot color name (if any). |
Definiert in Zeile 4003 der Datei tcpdf.php.
Benutzt setColor().
SetTextColorArray | ( | $color, | |
$ret = false |
|||
) |
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.
$color | (array) Array of colors (1, 3 or 4 values). |
$ret | (boolean) If true do not send the PDF command. |
Definiert in Zeile 3862 der Datei tcpdf.php.
Benutzt setColorArray().
Wird benutzt von addHtmlLink(), Cell(), Footer(), Header(), write1DBarcode() und writeHTML().
setTextRenderingMode | ( | $stroke = 0 , |
|
$fill = true , |
|||
$clip = false |
|||
) |
Set Text rendering mode.
$stroke | (int) outline size in user units (0 = disable). |
$fill | (boolean) if true fills the text (default). |
$clip | (boolean) if true activate clipping mode |
Definiert in Zeile 21818 der Datei tcpdf.php.
Wird benutzt von Close(), Text() und writeHTML().
setTextShadow | ( | $params = array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal') ) |
Set parameters for drop shadow effect for text.
$params | (array) Array of parameters: enabled (boolean) set to true to enable shadow; depth_w (float) shadow width in user units; depth_h (float) shadow height in user units; color (array) shadow color or false to use the stroke color; opacity (float) Alpha value: real value from 0 (transparent) to 1 (opaque); blend_mode (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity. |
Definiert in Zeile 21873 der Datei tcpdf.php.
Wird benutzt von __construct().
SetTextSpotColor | ( | $name, | |
$tint = 100 |
|||
) |
Defines the spot color used for text.
$name | (string) Name of the spot color. |
$tint | (int) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
Definiert in Zeile 3789 der Datei tcpdf.php.
Benutzt setSpotColor().
SetTitle | ( | $title) |
Defines the title of the document.
$title | (string) The title. |
Definiert in Zeile 2854 der Datei tcpdf.php.
Benutzt $title.
SetTopMargin | ( | $margin) |
Defines the top margin. The method can be called before creating the first page.
$margin | (float) The margin. |
setUserRights | ( | $enable = true , |
|
$document = '/FullSave' , |
|||
$annots = '/Create/Delete/Modify/Copy/Import/Export' , |
|||
$form = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate' , |
|||
$signature = '/Modify' , |
|||
$ef = '/Create/Delete/Modify/Import' , |
|||
$formex = '' |
|||
) |
Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work. Check the PDF Reference 8.7.1 Transform Methods, Table 8.105 Entries in the UR transform parameters dictionary
$enable | (boolean) if true enable user's rights on PDF reader |
$document | (string) Names specifying additional document-wide usage rights for the document. The only defined value is "/FullSave", which permits a user to save the document along with modified form and/or annotation data. |
$annots | (string) Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations. |
$form | (string) Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate |
$signature | (string) Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field. |
$ef | (string) Names specifying additional usage rights for named embedded files in the document. Valid names are /Create/Delete/Modify/Import, which permit the user to perform the named operation on named embedded files Names specifying additional embedded-files-related usage rights for the document. |
$formex | (string) Names specifying additional form-field-related usage rights. The only valid name is BarcodePlaintext, which permits text form field data to be encoded as a plaintext two-dimensional barcode. |
Definiert in Zeile 13385 der Datei tcpdf.php.
Benutzt setSignature().
setViewerPreferences | ( | $preferences) |
Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print. (see Section 8.1 of PDF reference, "Viewer Preferences").
$preferences | (array) array of options. |
setVisibility | ( | $v) |
Set the visibility of the successive elements. This can be useful, for instance, to put a background image or color that will show on screen but won't print.
$v | (string) visibility mode. Legal values are: all, print, screen or view. |
Definiert in Zeile 13721 der Datei tcpdf.php.
Benutzt _out(), endLayer(), Error() und startLayer().
Wird benutzt von _endpage().
SetX | ( | $x, | |
$rtloff = false |
|||
) |
Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page (or left if language is RTL).
$x | (float) The value of the abscissa in user units. |
$rtloff | (boolean) if true always uses the page top-left corner as origin of axis. |
Definiert in Zeile 7412 der Datei tcpdf.php.
Wird benutzt von Footer(), Header(), MultiCell() und SetXY().
SetXY | ( | $x, | |
$y, | |||
$rtloff = false |
|||
) |
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.
$x | (float) The value of the abscissa. |
$y | (float) The value of the ordinate. |
$rtloff | (boolean) if true always uses the page top-left corner as origin of axis. |
Definiert in Zeile 7478 der Datei tcpdf.php.
Benutzt $x, $y, SetX() und SetY().
Wird benutzt von openHTMLTagHandler(), setFooter(), setHeader() und Text().
SetY | ( | $y, | |
$resetx = true , |
|||
$rtloff = false |
|||
) |
Moves the current abscissa back to the left margin and sets the ordinate. If the passed value is negative, it is relative to the bottom of the page.
$y | (float) The value of the ordinate in user units. |
$resetx | (bool) if true (default) reset the X position. |
$rtloff | (boolean) if true always uses the page top-left corner as origin of axis. |
Definiert in Zeile 7445 der Datei tcpdf.php.
Benutzt $h, $lMargin, $rMargin und $y.
Wird benutzt von Footer(), Header(), Image(), ImageEps(), MultiCell(), setPage(), SetXY(), startPage(), write1DBarcode() und write2DBarcode().
Skew | ( | $angle_x, | |
$angle_y, | |||
$x = '' , |
|||
$y = '' |
|||
) |
Skew.
$angle_x | (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right) |
$angle_y | (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) |
$x | (int) abscissa of the skewing center. default is current x position |
$y | (int) ordinate of the skewing center. default is current y position |
Definiert in Zeile 11238 der Datei tcpdf.php.
Benutzt $k, $x, $y, Error() und Transform().
Wird benutzt von SkewX() und SkewY().
SkewX | ( | $angle_x, | |
$x = '' , |
|||
$y = '' |
|||
) |
Skew horizontally.
$angle_x | (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right) |
$x | (int) abscissa of the skewing center. default is current x position |
$y | (int) ordinate of the skewing center. default is current y position |
Definiert in Zeile 11211 der Datei tcpdf.php.
SkewY | ( | $angle_y, | |
$x = '' , |
|||
$y = '' |
|||
) |
Skew vertically.
$angle_y | (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) |
$x | (int) abscissa of the skewing center. default is current x position |
$y | (int) ordinate of the skewing center. default is current y position |
Definiert in Zeile 11224 der Datei tcpdf.php.
|
protected |
Sort bookmarks for page and key.
Definiert in Zeile 12359 der Datei tcpdf.php.
Wird benutzt von _putbookmarks().
StarPolygon | ( | $x0, | |
$y0, | |||
$r, | |||
$nv, | |||
$ng, | |||
$angle = 0 , |
|||
$draw_circle = false , |
|||
$style = '' , |
|||
$line_style = array() , |
|||
$fill_color = array() , |
|||
$circle_style = '' , |
|||
$circle_outLine_style = array() , |
|||
$circle_fill_color = array() |
|||
) |
Draws a star polygon
$x0 | (float) Abscissa of center point. |
$y0 | (float) Ordinate of center point. |
$r | (float) Radius of inscribed circle. |
$nv | (integer) Number of vertices. |
$ng | (integer) Number of gap (if ($ng % $nv = 1) then is a regular polygon). |
$angle,: | (float) Angle oriented (anti-clockwise). Default value: 0. |
$draw_circle,: | (boolean) Draw inscribed circle or not. Default value is false. |
$style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
$line_style | (array) Line style of polygon sides. Array with keys among the following:
|
$fill_color | (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
$circle_style | (string) Style of rendering of inscribed circle (if draws). Possible values are:
|
$circle_outLine_style | (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array). |
$circle_fill_color | (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array). |
Definiert in Zeile 12032 der Datei tcpdf.php.
Benutzt Circle() und Polygon().
startLayer | ( | $name = '' , |
|
$print = true , |
|||
$view = true |
|||
) |
Start a new pdf layer.
$name | (string) Layer name (only a-z letters and numbers). Leave empty for automatic name. |
(boolean|null) Set to TRUE to print this layer, FALSE to not print and NULL to not set this option | |
$view | (boolean) Set to true to view this layer. |
Definiert in Zeile 13682 der Datei tcpdf.php.
Benutzt _out().
Wird benutzt von setVisibility().
startPage | ( | $orientation = '' , |
|
$format = '' , |
|||
$tocpage = false |
|||
) |
Starts a new page to the document. The page must be closed using the endPage() function. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
$orientation | (string) page orientation. Possible values are (case insensitive):
|
$format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
$tocpage | (boolean) if true the page is designated to contain the Table-Of-Content. |
Definiert in Zeile 3139 der Datei tcpdf.php.
Benutzt $dests, $links, $numpages, $outlines, $page, $tocpage, _beginpage(), getGraphicVars(), Open(), setGraphicVars(), setHeader(), setPage(), setPageMark(), setTableHeader(), SetY() und swapMargins().
Wird benutzt von AddPage().
startPageGroup | ( | $page = '' ) |
Create a new page group. NOTE: call this function before calling AddPage()
$page | (int) starting group page (leave empty for next page). |
Definiert in Zeile 13518 der Datei tcpdf.php.
Benutzt $newpagegroup und $page.
|
protected |
Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)
$parser | (resource) The first parameter, parser, is a reference to the XML parser calling the handler. |
$name | (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters. |
$attribs | (array) The third parameter, attribs, contains an associative array with the element's attributes (if any). The keys of this array are the attribute names, the values are the attribute values. Attribute names are case-folded on the same criteria as element names. Attribute values are not case-folded. The original order of the attributes can be retrieved by walking through attribs the normal way, using each(). The first key in the array was the first attribute, and so on. |
$ctm | (array) tranformation matrix for clipping mode (starting transformation matrix). |
Definiert in Zeile 23641 der Datei tcpdf.php.
Benutzt $_SERVER, TCPDF_IMAGES\$svginheritprop, TCPDF_COLORS\convertHTMLColorToDec(), TCPDF_STATIC\empty_string(), TCPDF_IMAGES\getImageFileType(), TCPDF_STATIC\getSVGTransformMatrix() und TCPDF_STATIC\getTransformationMatrixProduct().
startTemplate | ( | $w = 0 , |
|
$h = 0 , |
|||
$group = false |
|||
) |
Start a new XObject Template. An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked. Note: X,Y coordinates will be reset to 0,0.
$w | (int) Template width in user units (empty string or zero = page width less margins). |
$h | (int) Template height in user units (empty string or zero = page height less margins). |
$group | (mixed) Set transparency group. Can be a boolean value or an array specifying optional parameters: 'CS' (solour space name), 'I' (boolean flag to indicate isolated group) and 'K' (boolean flag to indicate knockout group). |
Definiert in Zeile 22188 der Datei tcpdf.php.
Wird benutzt von Button(), Header() und TextField().
startTransaction | ( | ) |
Stores a copy of the current TCPDF object used for undo operation.
Definiert in Zeile 21595 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\objclone().
Wird benutzt von writeHTML().
StartTransform | ( | ) |
Starts a 2D tranformation saving current graphic state. This function must be called before scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
Definiert in Zeile 10967 der Datei tcpdf.php.
Benutzt $page, $transfmatrix_key, $xobjid und _outSaveGraphicsState().
StopTransform | ( | ) |
Stops a 2D tranformation restoring previous graphic state. This function must be called after scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
Definiert in Zeile 10990 der Datei tcpdf.php.
Benutzt $transfmatrix_key und _outRestoreGraphicsState().
stringLeftTrim | ( | $str, | |
$replace = '' |
|||
) |
Left trim the input string
$str | (string) string to trim |
$replace | (string) string that replace spaces. |
Definiert in Zeile 22094 der Datei tcpdf.php.
Wird benutzt von writeHTML().
stringRightTrim | ( | $str, | |
$replace = '' |
|||
) |
Right trim the input string
$str | (string) string to trim |
$replace | (string) string that replace spaces. |
Definiert in Zeile 22107 der Datei tcpdf.php.
Wird benutzt von Write() und writeHTML().
stringTrim | ( | $str, | |
$replace = '' |
|||
) |
Trim the input string
$str | (string) string to trim |
$replace | (string) string that replace spaces. |
Definiert in Zeile 22120 der Datei tcpdf.php.
Wird benutzt von _putbookmarks(), getHtmlDomArray() und Write().
|
protected |
Draws an SVG path
$d | (string) attribute d of the path SVG element |
$style | (string) Style of rendering. Possible values are:
|
Definiert in Zeile 23279 der Datei tcpdf.php.
Benutzt TCPDF_STATIC\getPathPaintOperator() und TCPDF_STATIC\getVectorsAngle().
|
protected |
|
protected |
Swap the left and right margins.
$reverse | (boolean) if true swap left and right margins. |
Definiert in Zeile 20067 der Datei tcpdf.php.
Wird benutzt von startPage().
Text | ( | $x, | |
$y, | |||
$txt, | |||
$fstroke = false , |
|||
$fclip = false , |
|||
$ffill = true , |
|||
$border = 0 , |
|||
$ln = 0 , |
|||
$align = '' , |
|||
$fill = false , |
|||
$link = '' , |
|||
$stretch = 0 , |
|||
$ignore_min_height = false , |
|||
$calign = 'T' , |
|||
$valign = 'M' , |
|||
$rtloff = false |
|||
) |
Prints a text cell at the specified position. This method allows to place a string precisely on the page.
$x | (float) Abscissa of the cell origin |
$y | (float) Ordinate of the cell origin |
$txt | (string) String to print |
$fstroke | (int) outline size in user units (false = disable) |
$fclip | (boolean) if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation). |
$ffill | (boolean) if true fills the text |
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
$ln | (int) Indicates where the current position should go after the call. Possible values are:
|
$align | (string) Allows to center or align the text. Possible values are:
|
$fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
$link | (mixed) URL or identifier returned by AddLink(). |
$stretch | (int) font stretch mode:
|
$ignore_min_height | (boolean) if true ignore automatic minimum height value. |
$calign | (string) cell vertical alignment relative to the specified Y value. Possible values are:
|
$valign | (string) text vertical alignment inside the cell. Possible values are:
|
$rtloff | (boolean) if true uses the page top-left corner as origin of axis for $x and $y initial position. |
Definiert in Zeile 4900 der Datei tcpdf.php.
Benutzt $textrendermode, $textstrokewidth, $x, $y, Cell(), setTextRenderingMode() und SetXY().
TextField | ( | $name, | |
$w, | |||
$h, | |||
$prop = array() , |
|||
$opt = array() , |
|||
$x = '' , |
|||
$y = '' , |
|||
$js = false |
|||
) |
Creates a text field
$name | (string) field name |
$w | (float) Width of the rectangle |
$h | (float) Height of the rectangle |
$prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
$opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
$x | (float) Abscissa of the upper-left corner of the rectangle |
$y | (float) Ordinate of the upper-left corner of the rectangle |
$js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definiert in Zeile 12655 der Datei tcpdf.php.
Benutzt $h, $n, $w, $x, $y, _addfield(), Annotation(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), MultiCell() und startTemplate().
Wird benutzt von openHTMLTagHandler().
|
protected |
Apply graphic transformations.
$tm | (array) transformation matrix |
Definiert in Zeile 11269 der Datei tcpdf.php.
Benutzt $page, $transfmatrix_key, $xobjid und _out().
Wird benutzt von Rotate(), Scale(), Skew() und Translate().
Translate | ( | $t_x, | |
$t_y | |||
) |
Translate graphic object horizontally and vertically.
$t_x | (int) movement to the right |
$t_y | (int) movement to the bottom |
Definiert in Zeile 11159 der Datei tcpdf.php.
Benutzt $k und Transform().
Wird benutzt von TranslateX() und TranslateY().
TranslateX | ( | $t_x) |
Translate graphic object horizontally.
$t_x | (int) movement to the right (or left for RTL) |
Definiert in Zeile 11136 der Datei tcpdf.php.
Benutzt Translate().
TranslateY | ( | $t_y) |
Translate graphic object vertically.
$t_y | (int) movement to the bottom |
Definiert in Zeile 11147 der Datei tcpdf.php.
Benutzt Translate().
unhtmlentities | ( | $text_to_convert) |
Reverse function for htmlentities. Convert entities in UTF-8.
$text_to_convert | (string) Text to convert. |
Definiert in Zeile 10447 der Datei tcpdf.php.
Wird benutzt von _putannotsobjs(), _putbookmarks() und getHtmlDomArray().
unichr | ( | $c) |
Returns the unicode caracter specified by the value
$c | (int) UTF-8 value |
Definiert in Zeile 4153 der Datei tcpdf.php.
Benutzt TCPDF_FONTS\unichr().
Write | ( | $h, | |
$txt, | |||
$link = '' , |
|||
$fill = false , |
|||
$align = '' , |
|||
$ln = false , |
|||
$stretch = 0 , |
|||
$firstline = false , |
|||
$firstblock = false , |
|||
$maxh = 0 , |
|||
$wadj = 0 , |
|||
$margin = '' |
|||
) |
This method prints text from the current position.
$h | (float) Line height |
$txt | (string) String to print |
$link | (mixed) URL or identifier returned by AddLink() |
$fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
$align | (string) Allows to center or align the text. Possible values are:
|
$ln | (boolean) if true set cursor at the bottom of the line, otherwise set cursor at the top of the line. |
$stretch | (int) font stretch mode:
|
$firstline | (boolean) if true prints only the first line and return the remaining string. |
$firstblock | (boolean) if true the string is the starting of a line. |
$maxh | (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. |
$wadj | (float) first line width will be reduced by this amount (used in HTML mode). |
$margin | (array) margin array of the parent container |
Definiert in Zeile 6264 der Datei tcpdf.php.
Benutzt $cell_margin, $cell_padding, $h, $l, $lMargin, $page, $rMargin, TCPDF_FONT_DATA\$uni_RE_PATTERN_ARABIC, TCPDF_FONT_DATA\$uni_RE_PATTERN_RTL, $w, $x, AcceptPageBreak(), Cell(), checkPageRegions(), GetArrStringWidth(), getCellHeight(), GetCharWidth(), getRemainingWidth(), GetStringWidth(), inPageBody(), isRTLTextDir(), isUnicodeFont(), TCPDF_STATIC\pregSplit(), SetCellPadding(), stringRightTrim(), stringTrim(), TCPDF_FONTS\UniArrSubString(), TCPDF_FONTS\unichr(), TCPDF_FONTS\UTF8ArrayToUniArray(), TCPDF_FONTS\utf8Bidi() und TCPDF_FONTS\UTF8StringToArray().
Wird benutzt von addHtmlLink(), MultiCell() und writeHTML().
write1DBarcode | ( | $code, | |
$type, | |||
$x = '' , |
|||
$y = '' , |
|||
$w = '' , |
|||
$h = '' , |
|||
$xres = '' , |
|||
$style = '' , |
|||
$align = '' |
|||
) |
Print a Linear Barcode.
$code | (string) code to print |
$type | (string) type of barcode (see tcpdf_barcodes_1d.php for supported formats). |
$x | (int) x position in user units (empty string = current x position) |
$y | (int) y position in user units (empty string = current y position) |
$w | (int) width in user units (empty string = remaining page width) |
$h | (int) height in user units (empty string = remaining page height) |
$xres | (float) width of the smallest bar in user units (empty string = default value = 0.4mm) |
$style | (array) array of options:
|
$align | (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:
|
Definiert in Zeile 15154 der Datei tcpdf.php.
Benutzt $cell_padding, $h, $img_rb_x, $img_rb_y, $k, $lMargin, $rtl, $w, $x, $y, Cell(), checkPageRegions(), TCPDF_STATIC\empty_string(), Error(), fitBlock(), getCellHeight(), getGraphicVars(), GetStringWidth(), Rect(), SetCellPadding(), SetDrawColorArray(), SetFont(), setGraphicVars(), SetTextColorArray() und SetY().
Wird benutzt von Footer().
write2DBarcode | ( | $code, | |
$type, | |||
$x = '' , |
|||
$y = '' , |
|||
$w = '' , |
|||
$h = '' , |
|||
$style = '' , |
|||
$align = '' , |
|||
$distort = false |
|||
) |
Print 2D Barcode.
$code | (string) code to print |
$type | (string) type of barcode (see tcpdf_barcodes_2d.php for supported formats). |
$x | (int) x position in user units |
$y | (int) y position in user units |
$w | (int) width in user units |
$h | (int) height in user units |
$style | (array) array of options:
|
$align | (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:
|
$distort | (boolean) if true distort the barcode to fit width and height, otherwise preserve aspect ratio |
Definiert in Zeile 15473 der Datei tcpdf.php.
Benutzt $bMargin, $h, $img_rb_x, $img_rb_y, $lMargin, $rtl, $w, $x, $y, checkPageRegions(), TCPDF_STATIC\empty_string(), Error(), fitBlock(), getGraphicVars(), Rect(), SetDrawColorArray(), setGraphicVars() und SetY().
|
protected |
writeHTML | ( | $html, | |
$ln = true , |
|||
$fill = false , |
|||
$reseth = false , |
|||
$cell = false , |
|||
$align = '' |
|||
) |
Allows to preserve some HTML formatting (limited support).
IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting. Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul NOTE: all the HTML attributes must be enclosed in double-quote.
$html | (string) text to display |
$ln | (boolean) if true add a new line after text (default = true) |
$fill | (boolean) Indicates if the background must be painted (true) or transparent (false). |
$reseth | (boolean) if true reset the last cell height (default false). |
$cell | (boolean) if true add the current left (or right for RTL) padding to each Write (default false). |
$align | (string) Allows to center or align the text. Possible values are:
|
Definiert in Zeile 17049 der Datei tcpdf.php.
Benutzt $cell_height_ratio, $cell_margin, $cell_padding, $current_column, $customlistindent, $feps, $font_spacing, $font_stretching, $FontFamily, $FontSize, $FontSizePt, $FontStyle, $k, $lasth, $lispacer, $listcount, $listnum, $listordered, $lMargin, $newline, $numpages, $page, $rMargin, $rtl, $textindent, $textstrokewidth, $thead, $w, $wPt, $x, $xobjid, $y, addHtmlLink(), checkPageBreak(), closeHTMLTagHandler(), TCPDF_STATIC\empty_string(), Error(), getCellHeight(), getFontAscent(), getFontDescent(), getGraphicVars(), getHtmlDomArray(), getHTMLUnitToUnits(), getPageBuffer(), getSpaceString(), GetStringWidth(), inPageBody(), isRTLTextDir(), isUnicodeFont(), Ln(), MultiCell(), openHTMLTagHandler(), TCPDF_STATIC\pregSplit(), putHtmlListBullet(), resetLastH(), TCPDF_STATIC\revstrpos(), rollbackTransaction(), selectColumn(), SetDrawColorArray(), SetFillColorArray(), SetFont(), setFontSpacing(), setFontStretching(), setGraphicVars(), setPage(), setPageBuffer(), SetTextColorArray(), setTextRenderingMode(), startTransaction(), stringLeftTrim(), stringRightTrim() und Write().
Wird benutzt von MultiCell() und setTableHeader().
writeHTMLCell | ( | $w, | |
$h, | |||
$x, | |||
$y, | |||
$html = '' , |
|||
$border = 0 , |
|||
$ln = 0 , |
|||
$fill = false , |
|||
$reseth = true , |
|||
$align = '' , |
|||
$autopadding = true |
|||
) |
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.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting. IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting. Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul NOTE: all the HTML attributes must be enclosed in double-quote.
$w | (float) Cell width. If 0, the cell extends up to the right margin. |
$h | (float) Cell minimum height. The cell extends automatically if needed. |
$x | (float) upper-left corner X coordinate |
$y | (float) upper-left corner Y coordinate |
$html | (string) html text to print. Default value: empty string. |
$border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
$ln | (int) Indicates where the current position should go after the call. Possible values are:
|
$fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
$reseth | (boolean) if true reset the last cell height (default true). |
$align | (string) Allows to center or align the text. Possible values are:
|
$autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width. |
Definiert in Zeile 17032 der Datei tcpdf.php.
Benutzt $h, $w, $x, $y und MultiCell().
|
protected |
Alpha mode array. (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Definiert in Zeile 1788 der Datei tcpdf.php.
Wird benutzt von _outellipticalarc(), Cell(), getAlpha() und ImagePngAlpha().
|
protected |
|
protected |
|
protected |
Automatic page breaking.
Definiert in Zeile 446 der Datei tcpdf.php.
Wird benutzt von AcceptPageBreak(), getAutoPageBreak() und setPageOrientation().
|
protected |
Barcode to print on page footer (only if set).
Definiert in Zeile 619 der Datei tcpdf.php.
Wird benutzt von Footer() und getBarcode().
|
protected |
|
protected |
Page break margin.
Definiert in Zeile 274 der Datei tcpdf.php.
Wird benutzt von getBreakMargin(), MultiCell(), setPageOrientation() und write2DBarcode().
|
protected |
|
protected |
|
protected |
Buffer holding in-memory PDF.
Definiert in Zeile 166 der Datei tcpdf.php.
Wird benutzt von getPDFData().
|
protected |
|
protected |
|
protected |
|
protected |
Default cell height ratio.
Definiert in Zeile 924 der Datei tcpdf.php.
Wird benutzt von getCellHeight(), getCellHeightRatio(), getHtmlDomArray() und writeHTML().
|
protected |
Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
Definiert in Zeile 288 der Datei tcpdf.php.
Wird benutzt von Cell(), getCellCode(), getCellMargins(), getCSSMargin(), getHtmlDomArray(), MultiCell(), Write() und writeHTML().
|
protected |
Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
Definiert in Zeile 281 der Datei tcpdf.php.
Wird benutzt von adjustCellPadding(), Cell(), getCellCode(), getCellPaddings(), getCSSPadding(), getHtmlDomArray(), getNumLines(), getStringHeight(), MultiCell(), openHTMLTagHandler(), setTableHeader(), Write(), write1DBarcode() und writeHTML().
|
protected |
Boolean value true when page region check is active.
Definiert in Zeile 1554 der Datei tcpdf.php.
Wird benutzt von MultiCell().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Compression flag.
Definiert in Zeile 184 der Datei tcpdf.php.
Wird benutzt von _putimages(), _putpages(), _puttruetypeunicode() und SetCompression().
|
protected |
|
protected |
|
protected |
Current page orientation (P = Portrait, L = Landscape).
Definiert in Zeile 190 der Datei tcpdf.php.
Wird benutzt von _beginpage() und setPageOrientation().
|
protected |
Current column number.
Definiert in Zeile 1429 der Datei tcpdf.php.
Wird benutzt von MultiCell() und writeHTML().
|
protected |
Current page group number.
Definiert in Zeile 903 der Datei tcpdf.php.
Wird benutzt von _beginpage() und getGroupPageNo().
|
protected |
|
protected |
HTML PARSER: custom indent amount for lists. Negative value means disabled.
Definiert in Zeile 1106 der Datei tcpdf.php.
Wird benutzt von writeHTML().
|
protected |
Deafult Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. Annotation options can be directly specified using the 'aopt' entry.
Definiert in Zeile 1331 der Datei tcpdf.php.
Wird benutzt von getFormDefaultProp().
|
protected |
|
protected |
Default monospace font.
Definiert in Zeile 1226 der Datei tcpdf.php.
Wird benutzt von getHtmlDomArray().
|
protected |
|
protected |
A dictionary of names and corresponding destinations (Dests key on document Catalog).
Definiert in Zeile 1568 der Datei tcpdf.php.
Wird benutzt von getDestination() und startPage().
|
protected |
|
protected |
If true enables disk caching.
Definiert in Zeile 1191 der Datei tcpdf.php.
Wird benutzt von __construct().
|
protected |
Document creation date-time
Definiert in Zeile 1758 der Datei tcpdf.php.
Wird benutzt von __construct(), _datestring() und getDocCreationTimestamp().
|
protected |
Document modification date-time
Definiert in Zeile 1765 der Datei tcpdf.php.
Wird benutzt von getDocModificationTimestamp().
|
protected |
|
protected |
DPI (Dot Per Inch) Document Resolution (do not change).
Definiert in Zeile 882 der Datei tcpdf.php.
Wird benutzt von Image(), ImagePngAlpha() und setPageUnit().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Default encoding.
Definiert in Zeile 771 der Datei tcpdf.php.
Wird benutzt von __construct().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Epsilon value used for float calculations.
Definiert in Zeile 1092 der Datei tcpdf.php.
Wird benutzt von writeHTML().
|
protected |
Current foreground color.
Definiert in Zeile 716 der Datei tcpdf.php.
Wird benutzt von addHtmlLink(), Cell() und getHtmlDomArray().
|
protected |
Height of page format in points.
Definiert in Zeile 214 der Datei tcpdf.php.
Wird benutzt von setPageOrientation().
|
protected |
|
protected |
|
protected |
Increases or decreases the space between characters in a text by the specified amount (tracking).
Definiert in Zeile 1540 der Datei tcpdf.php.
Wird benutzt von getCellCode(), GetCharWidth(), getHtmlDomArray() und writeHTML().
|
protected |
Percentage of character stretching.
Definiert in Zeile 1533 der Datei tcpdf.php.
Wird benutzt von getCellCode(), getHtmlDomArray() und writeHTML().
|
protected |
|
protected |
Current font ascent (distance between font top and baseline).
Definiert in Zeile 379 der Datei tcpdf.php.
Wird benutzt von getCellCode().
|
protected |
Current font descent (distance between font bottom and baseline).
Definiert in Zeile 386 der Datei tcpdf.php.
Wird benutzt von getCellCode().
|
protected |
Current font family.
Definiert in Zeile 366 der Datei tcpdf.php.
Wird benutzt von AddFont(), GetArrStringWidth(), getFontFamily(), getHtmlDomArray(), isCharDefined(), replaceMissingChars() und writeHTML().
|
protected |
|
protected |
|
protected |
Current font size in user unit.
Definiert in Zeile 416 der Datei tcpdf.php.
Wird benutzt von getCellCode(), getFontSize() und writeHTML().
|
protected |
Current font size in points.
Definiert in Zeile 410 der Datei tcpdf.php.
Wird benutzt von _dolinethroughw(), _dooverlinew(), _dounderlinew(), GetArrStringWidth(), getFontSizePt(), getHtmlDomArray(), MultiCell(), SetFont() und writeHTML().
|
protected |
Current font style.
Definiert in Zeile 372 der Datei tcpdf.php.
Wird benutzt von addHtmlLink(), GetArrStringWidth(), getFontStyle(), getHtmlDomArray() und writeHTML().
|
protected |
Default font used on page footer.
Definiert in Zeile 607 der Datei tcpdf.php.
Wird benutzt von getFooterFont().
|
protected |
|
protected |
Minimum distance between footer and bottom page margin.
Definiert in Zeile 581 der Datei tcpdf.php.
Wird benutzt von getFooterMargin() und setFooter().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Current form action (used during XHTML rendering).
Definiert in Zeile 1345 der Datei tcpdf.php.
Wird benutzt von openHTMLTagHandler().
|
protected |
|
protected |
|
protected |
|
protected |
Width of page format in points.
Definiert in Zeile 208 der Datei tcpdf.php.
Wird benutzt von setPageOrientation().
|
protected |
|
protected |
|
protected |
Current height of page in user unit.
Definiert in Zeile 238 der Datei tcpdf.php.
Wird benutzt von _addfield(), _outRect(), _putAPXObject(), addEmptySignatureAppearance(), Annotation(), Bookmark(), Button(), Cell(), checkPageBreak(), Clip(), colorRegistrationBar(), CoonsPatchMesh(), cropMark(), fitBlock(), getCellBorder(), getCellCode(), getPageHeight(), getSignatureAppearanceArray(), Image(), ImageEps(), ImagePngAlpha(), LinearGradient(), Link(), ListBox(), Ln(), MultiCell(), openHTMLTagHandler(), RadialGradient(), Rect(), RoundedRect(), RoundedRectXY(), setCellHeightRatio(), setDestination(), setLastH(), setPageOrientation(), setSignatureAppearance(), SetY(), TextField(), Write(), write1DBarcode(), write2DBarcode() und writeHTMLCell().
|
protected |
Default font used on page header.
Definiert in Zeile 601 der Datei tcpdf.php.
Wird benutzt von getHeaderFont().
|
protected |
Color for header line (RGB array).
Definiert in Zeile 669 der Datei tcpdf.php.
Wird benutzt von getHeaderData().
|
protected |
|
protected |
Width of header image logo in user units.
Definiert in Zeile 643 der Datei tcpdf.php.
Wird benutzt von getHeaderData().
|
protected |
Minimum distance between header and top page margin.
Definiert in Zeile 575 der Datei tcpdf.php.
Wird benutzt von getHeaderMargin() und Header().
|
protected |
String to pring on page header after title.
Definiert in Zeile 655 der Datei tcpdf.php.
Wird benutzt von getHeaderData().
|
protected |
Color for header text (RGB array).
Definiert in Zeile 662 der Datei tcpdf.php.
Wird benutzt von getHeaderData().
|
protected |
Title to be printed on default page header.
Definiert in Zeile 649 der Datei tcpdf.php.
Wird benutzt von getHeaderData().
|
protected |
|
protected |
|
protected |
Current height of page in points.
Definiert in Zeile 226 der Datei tcpdf.php.
Wird benutzt von setPageOrientation().
|
protected |
|
protected |
Default color for html links.
Definiert in Zeile 1142 der Datei tcpdf.php.
Wird benutzt von getHtmlDomArray().
|
protected |
Default font style to add to html links.
Definiert in Zeile 1149 der Datei tcpdf.php.
Wird benutzt von getHtmlDomArray().
|
protected |
|
protected |
|
protected |
The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.
Definiert in Zeile 526 der Datei tcpdf.php.
Wird benutzt von getImageRBX(), Image(), ImageEps(), write1DBarcode() und write2DBarcode().
|
protected |
The right-bottom corner Y coordinate of last inserted image.
Definiert in Zeile 534 der Datei tcpdf.php.
Wird benutzt von getImageRBY(), Image(), ImageEps(), write1DBarcode() und write2DBarcode().
|
protected |
Adjusting factor to convert pixels to user units.
Definiert in Zeile 542 der Datei tcpdf.php.
Wird benutzt von getImageScale().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Boolean flag set to true when the input text is unicode (require unicode fonts).
Definiert in Zeile 550 der Datei tcpdf.php.
Wird benutzt von _putinfo() und _putXMP().
|
protected |
|
protected |
|
protected |
|
protected |
Scale factor (number of points in user unit).
Definiert in Zeile 202 der Datei tcpdf.php.
Wird benutzt von __construct(), _addfield(), _outellipticalarc(), _putannotsobjs(), _putcidfont0(), _putextgstates(), _putfonts(), _putpages(), _putresourcedict(), _putviewerpreferences(), _putxobjects(), AddSpotColor(), Annotation(), Button(), Close(), Footer(), getAllInternalPageNumberAliases(), getCellBorder(), getCellCode(), getCSSBorderWidth(), getScaleFactor(), getSignatureAppearanceArray(), Image(), ImageEps(), openHTMLTagHandler(), RadioButton(), replaceMissingChars(), Rotate(), Scale(), setColorArray(), SetFontSize(), setPageOrientation(), Skew(), Translate(), write1DBarcode() und writeHTML().
|
protected |
|
protected |
Language templates.
Definiert in Zeile 613 der Datei tcpdf.php.
Wird benutzt von _putannotsobjs(), _putbookmarks() und Write().
|
protected |
|
protected |
|
protected |
Height of last cell printed.
Definiert in Zeile 306 der Datei tcpdf.php.
Wird benutzt von getLastH(), getNumLines(), getStringHeight(), Ln(), setFooter(), setHeader() und writeHTML().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Line width in user unit.
Definiert in Zeile 312 der Datei tcpdf.php.
Wird benutzt von adjustCellPadding(), Arrow(), getCellBorder() und GetLineWidth().
|
protected |
|
protected |
Spacer string for LI tags.
Definiert in Zeile 764 der Datei tcpdf.php.
Wird benutzt von writeHTML().
|
protected |
HTML PARSER: array count list items on nested lists.
Definiert in Zeile 728 der Datei tcpdf.php.
Wird benutzt von writeHTML().
|
protected |
HTML PARSER: indent amount for lists.
Definiert in Zeile 740 der Datei tcpdf.php.
Wird benutzt von openHTMLTagHandler().
|
protected |
HTML PARSER: current list indententation level.
Definiert in Zeile 746 der Datei tcpdf.php.
Wird benutzt von openHTMLTagHandler().
|
protected |
HTML PARSER: current list nesting level.
Definiert in Zeile 734 der Datei tcpdf.php.
Wird benutzt von openHTMLTagHandler() und writeHTML().
|
protected |
HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
Definiert in Zeile 722 der Datei tcpdf.php.
Wird benutzt von writeHTML().
|
protected |
Symbol used for HTML unordered list items.
Definiert in Zeile 1057 der Datei tcpdf.php.
Wird benutzt von openHTMLTagHandler().
|
protected |
Left margin.
Definiert in Zeile 244 der Datei tcpdf.php.
Wird benutzt von __construct(), _beginpage(), AddPage(), fitBlock(), getCellCode(), getNumLines(), Image(), ImageEps(), MultiCell(), openHTMLTagHandler(), SetMargins(), setPageOrientation(), setTableHeader(), SetY(), Write(), write1DBarcode(), write2DBarcode() und writeHTML().
|
protected |
|
protected |
Current object number.
Definiert in Zeile 148 der Datei tcpdf.php.
Wird benutzt von _datastring(), _datestring(), _encrypt_data(), _enddoc(), _getannotsrefs(), _getobj(), _getrawstream(), _getstream(), _newobj(), _objectkey(), _putannotsobjs(), _putannotsrefs(), _putAPXObject(), _putbookmarks(), _putfonts(), _putpages(), _putshaders(), _putspotcolors(), _putstream(), _textstring(), addEmptySignatureAppearance(), addExtGState(), addJavascriptObject(), AddLink(), Button(), CoonsPatchMesh(), Gradient(), openHTMLTagHandler(), RadioButton(), setSignature() und TextField().
|
protected |
|
protected |
|
protected |
Boolean flag to indicate if a new line is created.
Definiert in Zeile 994 der Datei tcpdf.php.
Wird benutzt von setHeader() und writeHTML().
|
protected |
Array of page numbers were a new page group was started (the page numbers are the keys of the array).
Definiert in Zeile 889 der Datei tcpdf.php.
Wird benutzt von startPageGroup().
|
protected |
Number of colums.
Definiert in Zeile 1422 der Datei tcpdf.php.
Wird benutzt von MultiCell().
|
protected |
|
protected |
|
protected |
Counts the number of pages.
Definiert in Zeile 1156 der Datei tcpdf.php.
Wird benutzt von _putannotsobjs(), _putpages(), getNumPages(), startPage() und writeHTML().
|
protected |
|
protected |
|
protected |
|
protected |
Original left margin value.
Definiert in Zeile 588 der Datei tcpdf.php.
Wird benutzt von Header(), setFooter(), setHeader() und setPageOrientation().
|
protected |
Original right margin value.
Definiert in Zeile 595 der Datei tcpdf.php.
Wird benutzt von Header(), setFooter(), setHeader() und setPageOrientation().
|
protected |
|
protected |
Outlines for bookmark.
Definiert in Zeile 838 der Datei tcpdf.php.
Wird benutzt von startPage().
|
protected |
Overprint mode array. (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Definiert in Zeile 1780 der Datei tcpdf.php.
Wird benutzt von getOverprint().
|
protected |
Current page number.
Definiert in Zeile 142 der Datei tcpdf.php.
Wird benutzt von _beginpage(), _getobj(), _out(), addEmptySignatureAppearance(), addHtmlLink(), Annotation(), Bookmark(), checkPageBreak(), endPage(), getPage(), getPageDimensions(), getSignatureAppearanceArray(), MultiCell(), openHTMLTagHandler(), PageNo(), RadioButton(), replaceRightShiftPageNumAliases(), setBookmark(), setContentMark(), setDestination(), setFooter(), SetLink(), setPage(), setPageFormat(), setPageMark(), setPageOrientation(), setSignatureAppearance(), setTableHeader(), startPage(), startPageGroup(), StartTransform(), Transform(), Write() und writeHTML().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Threshold used to trigger page breaks.
Definiert in Zeile 452 der Datei tcpdf.php.
Wird benutzt von fitBlock().
|
protected |
|
protected |
Array containing page lengths in bytes.
Definiert in Zeile 1163 der Datei tcpdf.php.
Wird benutzt von _putpages().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Right margin.
Definiert in Zeile 250 der Datei tcpdf.php.
Wird benutzt von __construct(), _beginpage(), AddPage(), fitBlock(), getCellCode(), getCSSBorderMargin(), getCSSMargin(), getCSSPadding(), MultiCell(), openHTMLTagHandler(), SetMargins(), setPageOrientation(), setTableHeader(), SetY(), Write() und writeHTML().
|
protected |
Boolean flag to indicate if the document language is Right-To-Left.
Definiert in Zeile 785 der Datei tcpdf.php.
Wird benutzt von getRTL(), write1DBarcode(), write2DBarcode() und writeHTML().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Array of Spot colors.
Definiert in Zeile 1050 der Datei tcpdf.php.
Wird benutzt von colorRegistrationBar() und getAllSpotColors().
|
protected |
Store page number when startTransaction() is called.
|
protected |
Store Y position when startTransaction() is called.
|
protected |
|
protected |
Current stroke color.
Definiert in Zeile 1471 der Datei tcpdf.php.
Wird benutzt von Cell() und getHtmlDomArray().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Commands for text color.
Definiert in Zeile 434 der Datei tcpdf.php.
Wird benutzt von setColor() und setSpotColor().
|
protected |
Text indentation value (used for text-indent CSS attribute).
Definiert in Zeile 1387 der Datei tcpdf.php.
Wird benutzt von writeHTML().
|
protected |
Text rendering mode: 0 = Fill text; 1 = Stroke text; 2 = Fill, then stroke text; 3 = Neither fill nor stroke text (invisible); 4 = Fill text and add to path for clipping; 5 = Stroke text and add to path for clipping; 6 = Fill, then stroke text and add to path for clipping; 7 = Add text to path for clipping.
Definiert in Zeile 1457 der Datei tcpdf.php.
Wird benutzt von Text().
|
protected |
Text stroke width in doc units.
Definiert in Zeile 1464 der Datei tcpdf.php.
Wird benutzt von getHtmlDomArray(), Text() und writeHTML().
|
protected |
Table header content to be repeated on each new page.
Definiert in Zeile 1247 der Datei tcpdf.php.
Wird benutzt von getHtmlDomArray(), setFooter(), setHeader() und writeHTML().
|
protected |
Margins used for table header.
Definiert in Zeile 1254 der Datei tcpdf.php.
Wird benutzt von setFooter() und setHeader().
|
protected |
Document title.
Definiert in Zeile 488 der Datei tcpdf.php.
Wird benutzt von _putbookmarks() und SetTitle().
|
protected |
Top margin.
Definiert in Zeile 268 der Datei tcpdf.php.
Wird benutzt von _beginpage(), checkPageBreak(), fitBlock(), MultiCell(), setPageOrientation() und setTableHeader().
|
protected |
|
protected |
Boolean flag true when we are on TOC (Table Of Content) page.
Definiert in Zeile 1484 der Datei tcpdf.php.
Wird benutzt von AddPage(), endPage() und startPage().
|
protected |
|
protected |
Current key for transformation matrix.
Definiert in Zeile 1078 der Datei tcpdf.php.
Wird benutzt von StartTransform(), StopTransform() und Transform().
|
protected |
|
protected |
|
protected |
|
protected |
PDF viewer preferences.
Definiert in Zeile 931 der Datei tcpdf.php.
Wird benutzt von _putviewerpreferences().
|
protected |
Current width of page in user unit.
Definiert in Zeile 232 der Datei tcpdf.php.
Wird benutzt von _addfield(), _dolinethrough(), _dolinethroughw(), _dooverline(), _dooverlinew(), _dounderline(), _dounderlinew(), _outRect(), _putAPXObject(), addEmptySignatureAppearance(), Annotation(), Bookmark(), Button(), Cell(), Clip(), colorRegistrationBar(), CoonsPatchMesh(), cropMark(), fitBlock(), GetArrStringWidth(), getCellBorder(), getCellCode(), getFontBBox(), getNumLines(), getPageWidth(), getRawCharWidth(), getSignatureAppearanceArray(), getStringHeight(), Image(), ImageEps(), ImagePngAlpha(), LinearGradient(), Link(), ListBox(), MultiCell(), openHTMLTagHandler(), RadialGradient(), RadioButton(), Rect(), RoundedRect(), RoundedRectXY(), setDestination(), setPageOrientation(), setSignatureAppearance(), SetX(), TextField(), Write(), write1DBarcode(), write2DBarcode(), writeHTML() und writeHTMLCell().
|
protected |
Current width of page in points.
Definiert in Zeile 220 der Datei tcpdf.php.
Wird benutzt von setPageOrientation() und writeHTML().
|
protected |
Current horizontal position in user unit for cell positioning.
Definiert in Zeile 294 der Datei tcpdf.php.
Wird benutzt von _addfield(), _dolinethrough(), _dolinethroughw(), _dooverline(), _dooverlinew(), _dounderline(), _dounderlinew(), _outLine(), _outPoint(), _outRect(), addEmptySignatureAppearance(), Annotation(), Bookmark(), Button(), Cell(), checkPageBreak(), Clip(), colorRegistrationBar(), CoonsPatchMesh(), cropMark(), fitBlock(), GetAbsX(), getCellBorder(), getCellCode(), getNumLines(), getSignatureAppearanceArray(), GetX(), Header(), Image(), ImageEps(), ImagePngAlpha(), LinearGradient(), Link(), ListBox(), MirrorH(), MirrorL(), MirrorP(), MultiCell(), openHTMLTagHandler(), RadialGradient(), RadioButton(), Rect(), registrationMark(), registrationMarkCMYK(), Rotate(), RoundedRect(), RoundedRectXY(), Scale(), ScaleX(), ScaleXY(), ScaleY(), SetAbsX(), SetAbsXY(), setBookmark(), setDestination(), setSignatureAppearance(), SetX(), SetXY(), Skew(), SkewX(), SkewY(), Text(), TextField(), Write(), write1DBarcode(), write2DBarcode(), writeHTML() und writeHTMLCell().
|
protected |
|
protected |
Current XObject ID.
Definiert in Zeile 1526 der Datei tcpdf.php.
Wird benutzt von _out(), addExtGState(), AddFont(), Annotation(), CoonsPatchMesh(), Gradient(), Image(), MultiCell(), setSpotColor(), StartTransform(), Transform() und writeHTML().
|
protected |
Current vertical position in user unit for cell positioning.
Definiert in Zeile 300 der Datei tcpdf.php.
Wird benutzt von _addfield(), _dolinethrough(), _dolinethroughw(), _dooverline(), _dooverlinew(), _dounderline(), _dounderlinew(), _outLine(), _outPoint(), _outRect(), addEmptySignatureAppearance(), AddSpotColor(), Annotation(), Bookmark(), Button(), Cell(), checkPageBreak(), Clip(), colorRegistrationBar(), CoonsPatchMesh(), cropMark(), fitBlock(), Footer(), getCellBorder(), getCellCode(), getSignatureAppearanceArray(), GetY(), Header(), Image(), ImageEps(), ImagePngAlpha(), LinearGradient(), Link(), ListBox(), MirrorL(), MirrorP(), MirrorV(), MultiCell(), openHTMLTagHandler(), RadialGradient(), RadioButton(), Rect(), registrationMark(), registrationMarkCMYK(), Rotate(), RoundedRect(), RoundedRectXY(), Scale(), ScaleX(), ScaleXY(), ScaleY(), SetAbsXY(), SetAbsY(), setBookmark(), setColorArray(), setDestination(), SetLink(), setSignatureAppearance(), setTableHeader(), SetXY(), SetY(), Skew(), SkewX(), SkewY(), Text(), TextField(), write1DBarcode(), write2DBarcode(), writeHTML() und writeHTMLCell().