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

public abstract Class PDAttributeObject

extends PDDictionaryWrapper
Class Inheritance
Known Direct Subclasses
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject, org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject, org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Imports
java.util.StringJoiner, org.apache.pdfbox.cos.COSBase, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper, org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject, .PDLayoutAttributeObject, .PDListAttributeObject, .PDPrintFieldAttributeObject, .PDTableAttributeObject
An attribute object.
Author
Johannes Koch

Field Summary

Modifier and TypeField and Description
private PDStructureElement
structureElement

Constructor Summary

AccessConstructor and Description
public
PDAttributeObject()

Default constructor.

public
PDAttributeObject(COSDictionary
the dictionary
dictionary)

Creates a new attribute object with a given dictionary.

Method Summary

Modifier and TypeMethod and Description
protected static String

Returns:

the String representation
arrayToString(Object[]
the Object array
array)

Creates a String representation of an Object array.

protected static String

Returns:

the String representation
arrayToString(float[]
the float array
array)

Creates a String representation of a float array.

public static PDAttributeObject

Returns:

the attribute object
create(COSDictionary
the dictionary
dictionary)

Creates an attribute object.

public String

Returns:

the owner of the attributes
getOwner()

Returns the owner of the attributes.

private PDStructureElement

Returns:

the structure element
getStructureElement()

Gets the structure element.

public boolean

Returns:

true if the attribute object is empty, false otherwise
isEmpty()

Detects whether there are no properties in the attribute object.

private boolean

Returns:

true if the value is changed, false otherwise
isValueChanged(COSBase
old value
oldValue, COSBase
new value
newValue)

Is the value changed?

protected void
notifyChanged()

Notifies the attribute object change listeners about a change in this attribute object.

protected void
potentiallyNotifyChanged(COSBase
old value
oldBase, COSBase
new value
newBase)

Notifies the attribute object change listeners if the attribute is changed.

protected void
setOwner(String
the owner of the attributes
owner)

Sets the owner of the attributes.

protected void
setStructureElement(PDStructureElement
the structure element
structureElement)

Sets the structure element.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper:
equalsgetCOSObjecthashCode

Field Detail

structureElementback to summary
private PDStructureElement structureElement

Constructor Detail

PDAttributeObjectback to summary
public PDAttributeObject()

Default constructor.

PDAttributeObjectback to summary
public PDAttributeObject(COSDictionary dictionary)

Creates a new attribute object with a given dictionary.

Parameters
dictionary:COSDictionary

the dictionary

Method Detail

arrayToStringback to summary
protected static String arrayToString(Object[] array)

Creates a String representation of an Object array.

Parameters
array:Object[]

the Object array

Returns:String

the String representation

arrayToStringback to summary
protected static String arrayToString(float[] array)

Creates a String representation of a float array.

Parameters
array:float[]

the float array

Returns:String

the String representation

createback to summary
public static PDAttributeObject create(COSDictionary dictionary)

Creates an attribute object.

Parameters
dictionary:COSDictionary

the dictionary

Returns:PDAttributeObject

the attribute object

getOwnerback to summary
public String getOwner()

Returns the owner of the attributes.

Returns:String

the owner of the attributes

getStructureElementback to summary
private PDStructureElement getStructureElement()

Gets the structure element.

Returns:PDStructureElement

the structure element

isEmptyback to summary
public boolean isEmpty()

Detects whether there are no properties in the attribute object.

Returns:boolean

true if the attribute object is empty, false otherwise

isValueChangedback to summary
private boolean isValueChanged(COSBase oldValue, COSBase newValue)

Is the value changed?

Parameters
oldValue:COSBase

old value

newValue:COSBase

new value

Returns:boolean

true if the value is changed, false otherwise

notifyChangedback to summary
protected void notifyChanged()

Notifies the attribute object change listeners about a change in this attribute object.

potentiallyNotifyChangedback to summary
protected void potentiallyNotifyChanged(COSBase oldBase, COSBase newBase)

Notifies the attribute object change listeners if the attribute is changed.

Parameters
oldBase:COSBase

old value

newBase:COSBase

new value

setOwnerback to summary
protected void setOwner(String owner)

Sets the owner of the attributes.

Parameters
owner:String

the owner of the attributes

setStructureElementback to summary
protected void setStructureElement(PDStructureElement structureElement)

Sets the structure element.

Parameters
structureElement:PDStructureElement

the structure element

toStringback to summary
public String toString()

Overrides java.lang.Object.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