Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure

public Class PDUserAttributeObject

extends PDAttributeObject
Class Inheritance
Imports
java.util.ArrayList, .List, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName
A User attribute object.
Author
Johannes Koch

Field Summary

Modifier and TypeField and Description
public static final String
OWNER_USER_PROPERTIES

Attribute owner for user properties

Constructor Summary

AccessConstructor and Description
public
PDUserAttributeObject()

Default constructor

public
PDUserAttributeObject(COSDictionary
the dictionary
dictionary)

Constructor

Method Summary

Modifier and TypeMethod and Description
public void
addUserProperty(PDUserProperty
the user property
userProperty)

Adds a user property.

public List<PDUserProperty>

Returns:

the user properties
getOwnerUserProperties()

Returns the user properties.

public void
removeUserProperty(PDUserProperty
the user property
userProperty)

Removes a user property.

public void
setUserProperties(List<PDUserProperty>
the user properties
userProperties)

Sets the user properties.

public String
toString()

Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString.

Returns a string representation of the object.

public void
userPropertyChanged(PDUserProperty
the user property which might have be changed
userProperty)

Notify a possible change of user properties.

Inherited from org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject:
arrayToStringarrayToStringcreategetOwnerisEmptynotifyChangedpotentiallyNotifyChangedsetOwnersetStructureElement

Field Detail

OWNER_USER_PROPERTIESback to summary
public static final String OWNER_USER_PROPERTIES

Attribute owner for user properties

Constructor Detail

PDUserAttributeObjectback to summary
public PDUserAttributeObject()

Default constructor

PDUserAttributeObjectback to summary
public PDUserAttributeObject(COSDictionary dictionary)

Constructor

Parameters
dictionary:COSDictionary

the dictionary

Method Detail

addUserPropertyback to summary
public void addUserProperty(PDUserProperty userProperty)

Adds a user property.

Parameters
userProperty:PDUserProperty

the user property

getOwnerUserPropertiesback to summary
public List<PDUserProperty> getOwnerUserProperties()

Returns the user properties.

Returns:List<PDUserProperty>

the user properties

removeUserPropertyback to summary
public void removeUserProperty(PDUserProperty userProperty)

Removes a user property.

Parameters
userProperty:PDUserProperty

the user property

setUserPropertiesback to summary
public void setUserProperties(List<PDUserProperty> userProperties)

Sets the user properties.

Parameters
userProperties:List<PDUserProperty>

the user properties

toStringback to summary
public String toString()

Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
userPropertyChangedback to summary
public void userPropertyChanged(PDUserProperty userProperty)

Notify a possible change of user properties.

Parameters
userProperty:PDUserProperty

the user property which might have be changed