Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
          2. Annotation
            1. Widget
            2. Widget
            3. AdditionalActions
            4. AppearanceCharacteristics
            5. BorderEffect
            6. BorderStyle
            7. Caret
            8. Circle
            9. FileAttachment
            10. Flags
            11. FreeText
            12. Highlight
            13. Ink
            14. Line
            15. LineEndingStyle
            16. Link
            17. Markup
            18. PolyLine
            19. Polygon
            20. Popup
            21. QuadPointsTrait
            22. Screen
            23. Square
            24. Squiggly
            25. Stamp
            26. StrikeOut
            27. Text
            28. TextMarkup
            29. Underline

SetaPDF_Core_Document_Page_Annotation_BorderStyle Class representing annotations border style dictionary

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

See PDF 32000-1:2008 - 12.5.4 Border Styles

Class hierarchy

Summary

Methods

Properties

Constants

Constants

BEVELED

public const string SetaPDF_Core_Document_Page_Annotation_BorderStyle::BEVELED = 'B'

Border style

DASHED

public const string SetaPDF_Core_Document_Page_Annotation_BorderStyle::DASHED = 'D'

Border style

INSET

public const string SetaPDF_Core_Document_Page_Annotation_BorderStyle::INSET = 'I'

Border style

SOLID

public const string SetaPDF_Core_Document_Page_Annotation_BorderStyle::SOLID = 'S'

Border style

UNDERLINE

public const string SetaPDF_Core_Document_Page_Annotation_BorderStyle::UNDERLINE = 'U'

Border style


Properties

$_annotation

protected SetaPDF_Core_Document_Page_Annotation SetaPDF_Core_Document_Page_Annotation_BorderStyle::$_annotation

The dictionary


Methods

__construct()

public SetaPDF_Core_Document_Page_Annotation_BorderStyle::__construct ()

The constructor.

Parameters
$annotation : SetaPDF_Core_Document_Page_Annotation
 

cleanUp()

public SetaPDF_Core_Document_Page_Annotation_BorderStyle::cleanUp (
void
): void

Release memory/cycled references.

getDashPattern()

public SetaPDF_Core_Document_Page_Annotation_BorderStyle::getDashPattern (
void
): array|null

Get the dash pattern.

Exceptions

Throws SetaPDF_Core_Type_Exception

getDictionary()

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

Get the dictionary of it.

Parameters
$create : boolean

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

getStyle()

public SetaPDF_Core_Document_Page_Annotation_BorderStyle::getStyle (
void
): string

Get the border style.

Exceptions

Throws SetaPDF_Core_Type_Exception

getWidth()

public SetaPDF_Core_Document_Page_Annotation_BorderStyle::getWidth (
void
): int|float

Get the border width.

Exceptions

Throws SetaPDF_Core_Type_Exception

setDashPattern()

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

Set the dash pattern.

Parameters
$pattern : array|SetaPDF_Core_Type_Array
 

setStyle()

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

Set the border style.

Parameters
$style : null|string
 

setWidth()

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

Set the border width.

Parameters
$width : null|int|float
 

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)