Class PDListAttributeObject
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
- All Implemented Interfaces:
COSObjectable
A List attribute object.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final String
static final String
ListNumbering: Circle: Open circular bulletstatic final String
ListNumbering: Decimal: Decimal arabic numerals (1–9, 10–99, …)static final String
ListNumbering: Disc: Solid circular bulletstatic final String
ListNumbering: LowerAlpha: Lowercase letters (a, b, c, …)static final String
ListNumbering: LowerRoman: Lowercase roman numerals (i, ii, iii, iv, …)static final String
ListNumbering: None: No autonumbering; Lbl elements (if present) contain arbitrary text not subject to any numbering schemestatic final String
ListNumbering: Square: Solid square bulletstatic final String
ListNumbering: UpperAlpha: Uppercase letters (A, B, C, …)static final String
ListNumbering: UpperRoman: Uppercase roman numerals (I, II, III, IV, …)static final String
standard attribute owner: ListFields inherited from class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
UNSPECIFIED
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.PDListAttributeObject
(COSDictionary dictionary) Creates a new List attribute object with a given dictionary. -
Method Summary
Modifier and TypeMethodDescriptionGets the list numbering (ListNumbering).void
setListNumbering
(String listNumbering) Sets the list numbering (ListNumbering).toString()
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
getArrayOfString, getColor, getColorOrFourColors, getInteger, getName, getName, getNameOrArrayOfName, getNumber, getNumber, getNumberOrArrayOfNumber, getNumberOrName, getString, isSpecified, setArrayOfName, setArrayOfNumber, setArrayOfString, setColor, setFourColors, setInteger, setName, setNumber, setNumber, setString
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
arrayToString, arrayToString, create, getOwner, isEmpty, notifyChanged, potentiallyNotifyChanged, setOwner, setStructureElement
Methods inherited from class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
equals, getCOSObject, hashCode
-
Field Details
-
OWNER_LIST
standard attribute owner: List- See Also:
-
LIST_NUMBERING
- See Also:
-
LIST_NUMBERING_CIRCLE
ListNumbering: Circle: Open circular bullet- See Also:
-
LIST_NUMBERING_DECIMAL
ListNumbering: Decimal: Decimal arabic numerals (1–9, 10–99, …)- See Also:
-
LIST_NUMBERING_DISC
ListNumbering: Disc: Solid circular bullet- See Also:
-
LIST_NUMBERING_LOWER_ALPHA
ListNumbering: LowerAlpha: Lowercase letters (a, b, c, …)- See Also:
-
LIST_NUMBERING_LOWER_ROMAN
ListNumbering: LowerRoman: Lowercase roman numerals (i, ii, iii, iv, …)- See Also:
-
LIST_NUMBERING_NONE
ListNumbering: None: No autonumbering; Lbl elements (if present) contain arbitrary text not subject to any numbering scheme- See Also:
-
LIST_NUMBERING_SQUARE
ListNumbering: Square: Solid square bullet- See Also:
-
LIST_NUMBERING_UPPER_ALPHA
ListNumbering: UpperAlpha: Uppercase letters (A, B, C, …)- See Also:
-
LIST_NUMBERING_UPPER_ROMAN
ListNumbering: UpperRoman: Uppercase roman numerals (I, II, III, IV, …)- See Also:
-
-
Constructor Details
-
PDListAttributeObject
public PDListAttributeObject()Default constructor. -
PDListAttributeObject
Creates a new List attribute object with a given dictionary.- Parameters:
dictionary
- the dictionary
-
-
Method Details
-
getListNumbering
Gets the list numbering (ListNumbering). The default value isLIST_NUMBERING_NONE
.- Returns:
- the list numbering
-
setListNumbering
Sets the list numbering (ListNumbering). The value shall be one of the following:- Parameters:
listNumbering
- the list numbering
-
toString
- Overrides:
toString
in classPDAttributeObject
-