Class PDUserProperty
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
- All Implemented Interfaces:
COSObjectable
A user property.
- Version:
- $Revision: $
- Author:
- Johannes Koch
-
Constructor Summary
ConstructorsConstructorDescriptionPDUserProperty
(COSDictionary dictionary, PDUserAttributeObject userAttributeObject) Creates a user property with a given dictionary.PDUserProperty
(PDUserAttributeObject userAttributeObject) Creates a new user property. -
Method Summary
Modifier and TypeMethodDescriptionReturns the string for the property value.getName()
Returns the property name.getValue()
Returns the property value.boolean
isHidden()
Shall the property be hidden?void
setFormattedValue
(String formattedValue) Sets the string for the property value.void
setHidden
(boolean hidden) Specifies whether the property shall be hidden.void
Sets the property name.void
Sets the property value.toString()
Methods inherited from class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
equals, getCOSDictionary, getCOSObject, hashCode
-
Constructor Details
-
PDUserProperty
Creates a new user property.- Parameters:
userAttributeObject
- the user attribute object
-
PDUserProperty
Creates a user property with a given dictionary.- Parameters:
dictionary
- the dictionaryuserAttributeObject
- the user attribute object
-
-
Method Details
-
getName
Returns the property name.- Returns:
- the property name
-
setName
Sets the property name.- Parameters:
name
- the property name
-
getValue
Returns the property value.- Returns:
- the property value
-
setValue
Sets the property value.- Parameters:
value
- the property value
-
getFormattedValue
Returns the string for the property value.- Returns:
- the string for the property value
-
setFormattedValue
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
-