Class PDUserProperty
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
-
- org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
- All Implemented Interfaces:
COSObjectable
public class PDUserProperty extends PDDictionaryWrapper
A user property.
-
-
Field Summary
Fields Modifier and Type Field Description private PDUserAttributeObject
userAttributeObject
-
Constructor Summary
Constructors Constructor Description PDUserProperty(COSDictionary dictionary, PDUserAttributeObject userAttributeObject)
Creates a user property with a given dictionary.PDUserProperty(PDUserAttributeObject userAttributeObject)
Creates a new user property.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getFormattedValue()
Returns the string for the property value.java.lang.String
getName()
Returns the property name.COSBase
getValue()
Returns the property value.int
hashCode()
private boolean
isEntryChanged(java.lang.Object oldEntry, java.lang.Object newEntry)
Is the value changed?boolean
isHidden()
Shall the property be hidden?private void
potentiallyNotifyChanged(java.lang.Object oldEntry, java.lang.Object newEntry)
Notifies the user attribute object if the user property is changed.void
setFormattedValue(java.lang.String formattedValue)
Sets the string for the property value.void
setHidden(boolean hidden)
Specifies whether the property shall be hidden.void
setName(java.lang.String name)
Sets the property name.void
setValue(COSBase value)
Sets the property value.java.lang.String
toString()
-
Methods inherited from class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
getCOSObject
-
-
-
-
Field Detail
-
userAttributeObject
private final PDUserAttributeObject userAttributeObject
-
-
Constructor Detail
-
PDUserProperty
public PDUserProperty(PDUserAttributeObject userAttributeObject)
Creates a new user property.- Parameters:
userAttributeObject
- the user attribute object
-
PDUserProperty
public PDUserProperty(COSDictionary dictionary, PDUserAttributeObject userAttributeObject)
Creates a user property with a given dictionary.- Parameters:
dictionary
- the dictionaryuserAttributeObject
- the user attribute object
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns the property name.- Returns:
- the property name
-
setName
public void setName(java.lang.String name)
Sets the property name.- Parameters:
name
- the property name
-
getValue
public COSBase getValue()
Returns the property value.- Returns:
- the property value
-
setValue
public void setValue(COSBase value)
Sets the property value.- Parameters:
value
- the property value
-
getFormattedValue
public java.lang.String getFormattedValue()
Returns the string for the property value.- Returns:
- the string for the property value
-
setFormattedValue
public void setFormattedValue(java.lang.String formattedValue)
Sets the string for the property value.- Parameters:
formattedValue
- the string for the property value
-
isHidden
public boolean isHidden()
Shall the property be hidden?- Returns:
true
if the property shall be hidden,false
otherwise
-
setHidden
public void setHidden(boolean hidden)
Specifies whether the property shall be hidden.- Parameters:
hidden
-true
if the property shall be hidden,false
otherwise
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
potentiallyNotifyChanged
private void potentiallyNotifyChanged(java.lang.Object oldEntry, java.lang.Object newEntry)
Notifies the user attribute object if the user property is changed.- Parameters:
oldEntry
- old entrynewEntry
- new entry
-
isEntryChanged
private boolean isEntryChanged(java.lang.Object oldEntry, java.lang.Object newEntry)
Is the value changed?- Parameters:
oldEntry
- old entrynewEntry
- new entry- Returns:
true
if the entry is changed,false
otherwise
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classPDDictionaryWrapper
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classPDDictionaryWrapper
-
-