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

AppearanceCharacteristics Class representing annotations appearance characteristics

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

See PDF 32000-1:2008 - 12.5.6.19 Widget Annotations

Class hierarchy

Summary

Methods

Properties

Properties

$_dictionary

protected \setasign\SetaPDF2\Core\Type\PdfDictionary AppearanceCharacteristics::$_dictionary

The dictionary

$_indirectReference

protected \setasign\SetaPDF2\Core\Type\IndirectObjectInterface AppearanceCharacteristics::$_indirectReference

Methods

__construct()

public AppearanceCharacteristics::__construct ()

The constructor.

Parameters
$objectOrDictionary : \setasign\SetaPDF2\Core\Type\AbstractType
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getBackgroundColor()

public AppearanceCharacteristics::getBackgroundColor (
void
): ?\setasign\SetaPDF2\Core\DataStructure\Color\AbstractColor

Get the background color.

getBorderColor()

public AppearanceCharacteristics::getBorderColor (
void
): ?\setasign\SetaPDF2\Core\DataStructure\Color\AbstractColor

Get the border color.

getDictionary()

public AppearanceCharacteristics::getDictionary (
void
): \setasign\SetaPDF2\Core\Type\PdfDictionary

Get the dictionary of it.

getRotation()

public AppearanceCharacteristics::getRotation (
void
): int|float

Get the rotation value.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setBackgroundColor()

public AppearanceCharacteristics::setBackgroundColor (
null|array|int|float|\setasign\SetaPDF2\Core\DataStructure\Color\AbstractColor $backgroundColor
): self

Set the background color.

Parameters
$backgroundColor : null|array|int|float|\setasign\SetaPDF2\Core\DataStructure\Color\AbstractColor
 

setBorderColor()

public AppearanceCharacteristics::setBorderColor (): self

Set the border color.

Parameters
$borderColor : null|array|int|float|\setasign\SetaPDF2\Core\DataStructure\Color\AbstractColor
 

setRotation()

public AppearanceCharacteristics::setRotation (
null|int|float $rotation
): self

Set the rotation value.

Parameters
$rotation : null|int|float
 

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