SetaPDF_Core_Document_Page_Annotation_BorderStyle Class representing annotations border style dictionary

File: /SetaPDF/Core/Document/Page/Annotation/BorderStyle.php

See PDF 32000-1:2008 - 12.5.4 Border Styles

Class hierarchy

Summary

Constants

BEVELED

DASHED

INSET

SOLID

UNDERLINE


Properties


Methods

__construct()

public SetaPDF_Core_Document_Page_Annotation_BorderStyle::__construct ( SetaPDF_Core_Document_Page_Annotation $annotation )

The constructor.

Parameters
$annotation : SetaPDF_Core_Document_Page_Annotation
 

cleanUp()

public void SetaPDF_Core_Document_Page_Annotation_BorderStyle::cleanUp ( void )

Release memory/cycled references.

getDashPattern()

public array|null SetaPDF_Core_Document_Page_Annotation_BorderStyle::getDashPattern ( void )

Get the dash pattern.

getDictionary()

public SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Page_Annotation_BorderStyle::getDictionary ( [ boolean $create = false ] )

Get the dictionary of it.

Parameters
$create : boolean

Defines whether the dictionary should be created if it doesn't exists

getStyle()

public string SetaPDF_Core_Document_Page_Annotation_BorderStyle::getStyle ( void )

Get the border style.

getWidth()

public int|float SetaPDF_Core_Document_Page_Annotation_BorderStyle::getWidth ( void )

Get the border width.

setDashPattern()

public self SetaPDF_Core_Document_Page_Annotation_BorderStyle::setDashPattern ( array|SetaPDF_Core_Type_Array $pattern )

Set the dash pattern.

Parameters
$pattern : array|SetaPDF_Core_Type_Array
 

setStyle()

public self SetaPDF_Core_Document_Page_Annotation_BorderStyle::setStyle ( null|string $style )

Set the border style.

Parameters
$style : null|string
 

setWidth()

public self SetaPDF_Core_Document_Page_Annotation_BorderStyle::setWidth ( null|int|float $width )

Set the border width.

Parameters
$width : null|int|float