API Documentation

Zend/Pdf/Style.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Pdf  
Version
$Id: Style.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Style

Package: Zend\Pdf

Style object.

Style object doesn't directly correspond to any PDF file object. It's utility class, used as a container for style information. It's used by Zend_Pdf_Page class in draw operations.

Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprivate\Zend_Pdf_Color|null  $_color= ''

Line color.

Current color, used for lines and font outlines.

Details
Type
\Zend_Pdf_Colornull
Propertyprivate\Zend_Pdf_Color|null  $_fillColor= 'null'

Fill color.

Used to fill geometric shapes or text.

Default valuenullDetails
Type
\Zend_Pdf_Colornull
Propertyprivate\Zend_Pdf_Resource_Font  $_font= ''

Current font

Propertyprivatefloat  $_fontSize= ''

Font size

Details
Type
float
Propertyprivatearray  $_lineDashingPattern= ''

Array which describes line dashing pattern.

It's array of numeric: array($on_length, $off_length, $on_length, $off_length, ...)

Details
Type
array
Propertyprivatefloat  $_lineDashingPhase= ''

Line dashing phase

Details
Type
float
Propertyprivate\Zend_Pdf_Element_Numeric  $_lineWidth= ''

Line width.

Methods

methodpublic__construct( \Zend_Pdf_Style $anotherStyle = null ) : void

Create style.

Parameters
Name Type Description
$anotherStyle \Zend_Pdf_Style
methodpublicgetFillColor( ) : \Zend_Pdf_Color|null

Get fill color.

Returns
Type Description
\Zend_Pdf_Color|null
methodpublicgetFont( ) : \Zend_Pdf_Resource_Font

Get current font.

Returns
Type Description
\Zend_Pdf_Resource_Font $font
methodpublicgetFontSize( ) : float

Get current font size

Returns
Type Description
float $fontSize
methodpublicgetLineColor( ) : \Zend_Pdf_Color|null

Get line color.

Returns
Type Description
\Zend_Pdf_Color|null
methodpublicgetLineDashingPattern( ) : array

Get line dashing pattern

Returns
Type Description
array
methodpublicgetLineDashingPhase( ) : float

Get line dashing phase

Returns
Type Description
float
methodpublicgetLineWidth( ) : float

Get line width.

Returns
Type Description
float
methodpublicinstructions( ) : string

Dump style to a string, which can be directly inserted into content stream

Returns
Type Description
string
methodpublicsetFillColor( \Zend_Pdf_Color $color ) : void

Set fill color.

Parameters
Name Type Description
$color \Zend_Pdf_Color
methodpublicsetFont( \Zend_Pdf_Resource_Font $font, float $fontSize ) : void

Set current font.

Parameters
Name Type Description
$font \Zend_Pdf_Resource_Font
$fontSize float
methodpublicsetFontSize( float $fontSize ) : void

Modify current font size

Parameters
Name Type Description
$fontSize float
methodpublicsetLineColor( \Zend_Pdf_Color $color ) : void

Set line color.

Parameters
Name Type Description
$color \Zend_Pdf_Color
methodpublicsetLineDashingPattern( array $pattern, float $phase = 0 ) : void

Set line dashing pattern

Parameters
Name Type Description
$pattern array
$phase float
methodpublicsetLineWidth( float $width ) : void

Set line width.

Parameters
Name Type Description
$width float
Documentation was generated by DocBlox 0.15.1.