Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
            1. AdditionalActions
            2. Annotation
            3. AppearanceCharacteristics
            4. BorderEffect
            5. BorderStyle
            6. CaretAnnotation
            7. CircleAnnotation
            8. FileAttachmentAnnotation
            9. Flags
            10. FreeTextAnnotation
            11. HighlightAnnotation
            12. InkAnnotation
            13. LineAnnotation
            14. LineEndingStyle
            15. LinkAnnotation
            16. MarkupAnnotation
            17. PolyLineAnnotation
            18. PolygonAnnotation
            19. PopupAnnotation
            20. QuadPointsTrait
            21. ScreenAnnotation
            22. SquareAnnotation
            23. SquigglyAnnotation
            24. StampAnnotation
            25. StrikeOutAnnotation
            26. TextAnnotation
            27. TextMarkupAnnotation
            28. UnderlineAnnotation
            29. Widget
            30. WidgetAnnotation

setasign\SetaPDF2\Core\Document\Page\Annotation

BorderEffect Class representing annotations border effect dictionary

File: /SetaPDF v2/Core/Document/Page/Annotation/BorderEffect.php
Old class name (alias): \SetaPDF_Core_Document_Page_Annotation_BorderEffect

See PDF 32000-1:2008 - 12.5.4 Border Styles

Class hierarchy

Summary

Methods

Properties

Constants

Constants

CLOUDY

public const string BorderEffect::CLOUDY = 'C'

Border effect

NONE

public const string BorderEffect::NONE = 'S'

Border effect


Properties

$_dictionary

protected \SetaPDF_Core_Type_Dictionary BorderEffect::$_dictionary

The dictionary


Methods

__construct()

public BorderEffect::__construct ()

The constructor.

Parameters
$dictionary : \SetaPDF_Core_Type_Dictionary
 

getDictionary()

public BorderEffect::getDictionary (
void
): \SetaPDF_Core_Type_Dictionary

Get the dictionary of it.

getIntensity()

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

Get the intensity of the effect.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getName()

public BorderEffect::getName (
void
): string

Get the border effect name.

setIntensity()

public BorderEffect::setIntensity (
null|int|float $intensity
): self

Set the border width.

Parameters
$intensity : null|int|float
 

setName()

public BorderEffect::setName (
?string $name
): self

Set the border effect name.

Parameters
$name : ?string
 

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