class final Core · roukmoute/pdf 0.6.1
PDF\Specification\Dictionary\AnnotationDictionaryTable164\BorderEntryTable 164, /Border; PDF type: array; Optional.Inheritance and contracts
Parent : PDF\Specification\SchemaEntry
Definition in the specification
Table 164 · Entries common to all annotation dictionaries
ISO 32000-1:2008, §12.5.2 · PDF page 392 ↗
/Border array
(Optional) An array specifying the characteristics of the annotation’s border, which shall be drawn as a rounded rectangle. (PDF 1.0) The array consists of three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units. If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn. (PDF 1.1) The array may have a fourth element, an optional dash array defining a pattern of dashes and gaps that shall be used in drawing the border. The dash array shall be specified in the same format as in the line dash pattern parameter of the graphics state (see 8.4.3.6, “Line Dash Pattern”). EXAMPLE A Border value of [ 0 0 1 [ 3 2 ] ] specifies a border 1 unit wide, with square corners, drawn with 3-unit dashes alternating with 2-unit gaps. NOTE (PDF 1.2) The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry. That entry specifies a border style dictionary that has more settings than the array specified for the Border entry. If an annotation dictionary includes the BS entry, then the Border entry is ignored. Default value: [ 0 0 1 ].
Qualifier: Optional
Conditional descriptions remain traceable. A definition alone does not implement a codec, a signature or every format mechanism. Read the coverage.
Construction
__construct()
public function __construct(PDF\Syntax\Object\ArrayType|PDF\Syntax\Object\IndirectReference $value)Inherited methods
3 methods from parents and contracts
definition()
public function definition(): PDF\Specification\EntryDefinitionkey()
public function key(): PDF\Syntax\Object\NameTypevalue()
public function value(): PDF\Syntax\FileStructure\BasicTypeProperties
| Declaration | Origin and documentation |
|---|---|
public readonly PDF\Syntax\Object\NameType $key | PDF\Syntax\Object\DictionaryObject\Entry |
public readonly PDF\Syntax\FileStructure\BasicType $value | PDF\Syntax\Object\DictionaryObject\Entry |
Constants
| Name | PHP value | Origin |
|---|---|---|
KEY | | PDF\Specification\Dictionary\AnnotationDictionaryTable164\BorderEntry |
TABLE | | PDF\Specification\Dictionary\AnnotationDictionaryTable164\BorderEntry |
VARIABLE | | PDF\Specification\SchemaEntry |