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_BorderEffect Class representing annotations border effect dictionary

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

See PDF 32000-1:2008 - 12.5.4 Border Styles

Class hierarchy

Summary

Methods

Properties

Constants

Constants

CLOUDY

public const string SetaPDF_Core_Document_Page_Annotation_BorderEffect::CLOUDY = 'C'

Border effect

NONE

public const string SetaPDF_Core_Document_Page_Annotation_BorderEffect::NONE = 'S'

Border effect


Properties

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Page_Annotation_BorderEffect::$_dictionary

The dictionary


Methods

__construct()

public SetaPDF_Core_Document_Page_Annotation_BorderEffect::__construct ()

The constructor.

Parameters
$dictionary : SetaPDF_Core_Type_Dictionary
 

getDictionary()

public SetaPDF_Core_Document_Page_Annotation_BorderEffect::getDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the dictionary of it.

getIntensity()

public SetaPDF_Core_Document_Page_Annotation_BorderEffect::getIntensity (
void
): int|float

Get the intensity of the effect.

Exceptions

Throws SetaPDF_Core_Type_Exception

getName()

public SetaPDF_Core_Document_Page_Annotation_BorderEffect::getName (
void
): string

Get the border effect name.

setIntensity()

public SetaPDF_Core_Document_Page_Annotation_BorderEffect::setIntensity (
null|int|float $intensity
): SetaPDF_Core_Document_Page_Annotation_BorderEffect

Set the border width.

Parameters
$intensity : null|int|float
 

setName()

public SetaPDF_Core_Document_Page_Annotation_BorderEffect::setName (
null|string $name
): SetaPDF_Core_Document_Page_Annotation_BorderEffect

Set the border effect name.

Parameters
$name : null|string
 

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