Package org.apache.pdfbox.pdmodel.common
Class PDNamedTextStream
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDNamedTextStream
- All Implemented Interfaces:
DualCOSObjectable
A named text stream is a combination of a name and a PDTextStream object. This
is used in name trees.
- Version:
- $Revision: 1.3 $
- Author:
- Ben Litchfield
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionConvert this standard java object to a COS object.getName()
The name of the named text stream.Convert this standard java object to a COS object.This will get the stream.void
This will set the name of the named text stream.void
setStream
(PDTextStream str) This will set the stream.
-
Constructor Details
-
PDNamedTextStream
public PDNamedTextStream()Constructor. -
PDNamedTextStream
Constructor.- Parameters:
name
- The name of the stream.str
- The stream.
-
-
Method Details
-
getName
The name of the named text stream.- Returns:
- The stream name.
-
setName
This will set the name of the named text stream.- Parameters:
name
- The name of the named text stream.
-
getStream
This will get the stream.- Returns:
- The stream associated with this name.
-
setStream
This will set the stream.- Parameters:
str
- The stream associated with this name.
-
getFirstCOSObject
Convert this standard java object to a COS object.- Specified by:
getFirstCOSObject
in interfaceDualCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getSecondCOSObject
Convert this standard java object to a COS object.- Specified by:
getSecondCOSObject
in interfaceDualCOSObjectable
- Returns:
- The cos object that matches this Java object.
-