Class Annotations.WidgetFlags
Annotations.WidgetFlags
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Annotations.WidgetFlags(options)
An object that describes flags on a Widget, or other PDF objects.
|
| Method Attributes | Method Name and Description |
|---|---|
|
clear()
Clear the flags.
|
|
|
get(flag)
Determine if the given flag is set.
|
|
|
set(options, shouldSet)
Set flags to true or false.
|
|
|
toArray()
Return an array of all set flags.
|
Class Detail
Annotations.WidgetFlags(options)
An object that describes flags on a Widget, or other PDF objects.
- Parameters:
- {?{mask: string[]}} options
- Define the set of supported flags.
Method Detail
clear()
Clear the flags.
{boolean}
get(flag)
Determine if the given flag is set.
- Parameters:
- {string} flag
- The name of the flag to check
- Returns:
- {boolean} Whether the flag is set
set(options, shouldSet)
Set flags to true or false.
If options is an array of strings, set the flags with those names to true.
If options is a number or array of numbers, set the flags from the corresponding numbers to true. (deprecated, relies on a limited interpretation of numbers as bitfields)
If options is a string, set that flag to shouldSet.
- Parameters:
- {(string[]|number[]|string|number)} options
- One of the possible input types to determine which flags to set
- {?boolean} shouldSet
- If options is a string, whether to set or unset the flag
{string[]}
toArray()
Return an array of all set flags.
- Returns:
- {string[]} An array of all set flags.