Class PDStandardAttributeObject
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
- All Implemented Interfaces:
COSObjectable
- Direct Known Subclasses:
PDLayoutAttributeObject
,PDListAttributeObject
,PDPrintFieldAttributeObject
,PDTableAttributeObject
A standard attribute object.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final float
An "unspecified" default float value. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.PDStandardAttributeObject
(COSDictionary dictionary) Creates a new standard attribute object with a given dictionary. -
Method Summary
Modifier and TypeMethodDescriptionprotected String[]
getArrayOfString
(String name) Gets an array of strings.protected PDGamma
Gets a colour.protected Object
getColorOrFourColors
(String name) Gets a single colour or four colours.protected int
getInteger
(String name, int defaultValue) Gets an integer.protected String
Gets a name value.protected String
Gets a name value.protected Object
getNameOrArrayOfName
(String name, String defaultValue) Gets a name value or array of name values.protected float
Gets a number value.protected float
Gets a number value.protected Object
getNumberOrArrayOfNumber
(String name, float defaultValue) Gets a number or an array of numbers.protected Object
getNumberOrName
(String name, String defaultValue) Gets a number or a name value.protected String
Gets a string attribute value.boolean
isSpecified
(String name) Is the attribute with the given name specified in this attribute object?protected void
setArrayOfName
(String name, String[] values) Sets an array of name values.protected void
setArrayOfNumber
(String name, float[] values) Sets an array of float numbers.protected void
setArrayOfString
(String name, String[] values) Sets an array of strings.protected void
Sets a colour.protected void
setFourColors
(String name, PDFourColours value) Sets four colours.protected void
setInteger
(String name, int value) Sets an integer.protected void
Sets a name value.protected void
Sets a float number.protected void
Sets an integer number.protected void
Sets a string attribute value.Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
arrayToString, arrayToString, create, getOwner, isEmpty, notifyChanged, potentiallyNotifyChanged, setOwner, setStructureElement, toString
Methods inherited from class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
equals, getCOSObject, hashCode
-
Field Details
-
UNSPECIFIED
protected static final float UNSPECIFIEDAn "unspecified" default float value.- See Also:
-
-
Constructor Details
-
PDStandardAttributeObject
public PDStandardAttributeObject()Default constructor. -
PDStandardAttributeObject
Creates a new standard attribute object with a given dictionary.- Parameters:
dictionary
- the dictionary
-
-
Method Details
-
isSpecified
Is the attribute with the given name specified in this attribute object?- Parameters:
name
- the attribute name- Returns:
true
if the attribute is specified,false
otherwise
-
getString
Gets a string attribute value.- Parameters:
name
- the attribute name- Returns:
- the string attribute value
-
setString
Sets a string attribute value.- Parameters:
name
- the attribute namevalue
- the string attribute value
-
getArrayOfString
Gets an array of strings.- Parameters:
name
- the attribute name- Returns:
- the array of strings
-
setArrayOfString
Sets an array of strings.- Parameters:
name
- the attribute namevalues
- the array of strings
-
getName
Gets a name value.- Parameters:
name
- the attribute name- Returns:
- the name value
-
getName
Gets a name value.- Parameters:
name
- the attribute namedefaultValue
- the default value- Returns:
- the name value
-
getNameOrArrayOfName
Gets a name value or array of name values.- Parameters:
name
- the attribute namedefaultValue
- the default value- Returns:
- a String or array of Strings
-
setName
Sets a name value.- Parameters:
name
- the attribute namevalue
- the name value
-
setArrayOfName
Sets an array of name values.- Parameters:
name
- the attribute namevalues
- the array of name values
-
getNumberOrName
Gets a number or a name value.- Parameters:
name
- the attribute namedefaultValue
- the default name- Returns:
- a Float or a String
-
getInteger
Gets an integer.- Parameters:
name
- the attribute namedefaultValue
- the default value- Returns:
- the integer
-
setInteger
Sets an integer.- Parameters:
name
- the attribute namevalue
- the integer
-
getNumber
Gets a number value.- Parameters:
name
- the attribute namedefaultValue
- the default value- Returns:
- the number value
-
getNumber
Gets a number value.- Parameters:
name
- the attribute name- Returns:
- the number value
-
getNumberOrArrayOfNumber
Gets a number or an array of numbers.- Parameters:
name
- the attribute namedefaultValue
- the default value- Returns:
- a Float or an array of floats
-
setNumber
Sets a float number.- Parameters:
name
- the attribute namevalue
- the float number
-
setNumber
Sets an integer number.- Parameters:
name
- the attribute namevalue
- the integer number
-
setArrayOfNumber
Sets an array of float numbers.- Parameters:
name
- the attribute namevalues
- the float numbers
-
getColor
Gets a colour.- Parameters:
name
- the attribute name- Returns:
- the colour
-
getColorOrFourColors
Gets a single colour or four colours.- Parameters:
name
- the attribute name- Returns:
- the single (
PDGamma
) or a (PDFourColours
)
-
setColor
Sets a colour.- Parameters:
name
- the attribute namevalue
- the colour
-
setFourColors
Sets four colours.- Parameters:
name
- the attribute namevalue
- the four colours
-