Class PDUserAttributeObject
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
-
- org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
-
- org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
-
- All Implemented Interfaces:
COSObjectable
public class PDUserAttributeObject extends PDAttributeObject
A User attribute object.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
OWNER_USER_PROPERTIES
Attribute owner for user properties
-
Constructor Summary
Constructors Constructor Description PDUserAttributeObject()
Default constructorPDUserAttributeObject(COSDictionary dictionary)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addUserProperty(PDUserProperty userProperty)
Adds a user property.java.util.List<PDUserProperty>
getOwnerUserProperties()
Returns the user properties.void
removeUserProperty(PDUserProperty userProperty)
Removes a user property.void
setUserProperties(java.util.List<PDUserProperty> userProperties)
Sets the user properties.java.lang.String
toString()
void
userPropertyChanged(PDUserProperty userProperty)
-
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 Detail
-
OWNER_USER_PROPERTIES
public static final java.lang.String OWNER_USER_PROPERTIES
Attribute owner for user properties- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PDUserAttributeObject
public PDUserAttributeObject()
Default constructor
-
PDUserAttributeObject
public PDUserAttributeObject(COSDictionary dictionary)
- Parameters:
dictionary
- the dictionary
-
-
Method Detail
-
getOwnerUserProperties
public java.util.List<PDUserProperty> getOwnerUserProperties()
Returns the user properties.- Returns:
- the user properties
-
setUserProperties
public void setUserProperties(java.util.List<PDUserProperty> userProperties)
Sets the user properties.- Parameters:
userProperties
- the user properties
-
addUserProperty
public void addUserProperty(PDUserProperty userProperty)
Adds a user property.- Parameters:
userProperty
- the user property
-
removeUserProperty
public void removeUserProperty(PDUserProperty userProperty)
Removes a user property.- Parameters:
userProperty
- the user property
-
userPropertyChanged
public void userPropertyChanged(PDUserProperty userProperty)
- Parameters:
userProperty
- the changed user property.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classPDAttributeObject
-
-