Foxit PDF SDK

Public 成员函数 | 静态 Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.pdf.objects.PDFStream类 参考
类 com.foxit.sdk.pdf.objects.PDFStream 继承关系图:

## Public 成员函数
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
FileReaderCallback | exportData (boolean is_raw_data) throws com.foxit.sdk.PDFException
| 导出流数据。 更多...
boolean | getData (boolean is_raw_data, long size, byte[] out_buffer) throws com.foxit.sdk.PDFException
| 获取流数据。 更多...
java.math.BigInteger | getDataSize (boolean is_raw_data) throws com.foxit.sdk.PDFException
| 获取流数据的大小，以字节为单位。 更多...
PDFDictionary | getDictionary () throws com.foxit.sdk.PDFException
| 获取与当前PDF流对象关联的PDF字典对象。 更多...
int | getStreamFilter () throws com.foxit.sdk.PDFException
| 获取流过滤器的类型，该类型指示在使用数据之前必须如何解码流数据。 更多...
void | importData (FileReaderCallback file_read, int stream_filter) throws com.foxit.sdk.PDFException
| 导入流数据。 更多...
void | setData (byte[] buffer) throws com.foxit.sdk.PDFException
| 设置流数据。 更多...
Public 成员函数 继承自 com.foxit.sdk.pdf.objects.PDFObject
PDFObject | cloneObject ()
| 克隆当前PDF对象并获取克隆的PDF对象。 更多...
PDFObject | deepCloneObject ()
| 克隆当前PDF对象并获取克隆的PDF对象。 更多...
PDFArray | getArray ()
| 获取当前PDF对象的PDF数组对象。 更多...
boolean | getBoolean () throws com.foxit.sdk.PDFException
| 获取当前PDF对象的布尔值。 更多...
DateTime | getDateTime () throws com.foxit.sdk.PDFException
| 获取当前PDF对象的日期时间值。 更多...
PDFDictionary | getDict ()
| 获取当前PDF对象的PDF字典对象。 更多...
PDFObject | getDirectObject ()
| 获取当前PDF对象的直接对象。 更多...
float | getFloat () throws com.foxit.sdk.PDFException
| 获取当前PDF对象的浮点数值。 更多...
int | getInteger () throws com.foxit.sdk.PDFException
| 获取当前PDF对象的整数值。 更多...
Matrix2D | getMatrix () throws com.foxit.sdk.PDFException
| 获取当前PDF对象的矩阵值。 更多...
String | getName () throws com.foxit.sdk.PDFException
| 获取当前PDF对象的名称值。 更多...
int | getObjNum ()
| 获取当前PDF对象的间接对象编号。 更多...
RectF | getRect () throws com.foxit.sdk.PDFException
| 获取当前PDF对象的矩形值。 更多...
PDFStream | getStream ()
| 获取当前PDF对象的PDF流对象。 更多...
byte[] | getString ()
| 获取当前PDF对象的字符串值。 更多...
int | getType ()
| 获取当前PDF对象的类型。 更多...
String | getWideString ()
| 获取当前PDF对象的宽字符串值。 更多...
boolean | isIdentical (PDFObject pdf_obj)
| 检查输入的PDF对象是否与当前PDF对象相同。 更多...
void | release ()
| 释放新创建的PDF对象或克隆PDF对象， 该对象与PDF文档或其他PDF对象无关且不会再使用。 更多...

## 静态 Public 成员函数
static PDFStream | create (PDFDictionary dictionary) throws com.foxit.sdk.PDFException
| 基于字典创建新的流对象。 更多...
静态 Public 成员函数 继承自 com.foxit.sdk.pdf.objects.PDFObject
static PDFObject | createFromBoolean (boolean boolean_value)
| 从布尔值创建PDF对象。 更多...
static PDFObject | createFromDateTime (DateTime date_time)
| 从日期时间创建PDF对象。 更多...
static PDFObject | createFromFloat (float float_value)
| 从浮点数创建PDF对象。 更多...
static PDFObject | createFromInteger (int integer_value)
| Create a PDF object from a integer number. 更多...
static PDFObject | createFromName (String name)
| 从表示名称的字符串创建PDF对象。 更多...
static PDFObject | createFromNameW (String name)
| 从表示名称的字符串创建PDF对象。 更多...
static PDFObject | createFromString (String string_value)
| 从字符串创建PDF对象。 更多...
static PDFObject | createFromString (String string_value, int length)
| 从字符串创建PDF对象。 更多...
static PDFObject | createReference (PDFDoc document, int object_number)
| 为间接对象创建引用。 更多...

## 静态 Public 属性
static final int | e_ASCII85Decode = 2
| 过滤器类型：ASCII85Decode，表示解码以ASCII base-85表示编码的数据， 重现原始二进制数据。
static final int | e_ASCIIHexDecode = 1
| 过滤器类型：ASCIIHexDecode，表示解码以ASCII十六进制表示编码的数据， 重现原始二进制数据。
static final int | e_CCITTFaxDecode = 6
| 过滤器类型：CCITTFaxDecode，表示解压使用CCITT传真标准编码的数据， 重现原始数据（通常是每像素为1比特的单色图像数据）。
static final int | e_Crypt = 10
| 过滤器类型：Crypt，表示解密由安全处理程序加密的数据， 重现加密前的原始数据。
static final int | e_DCTDecode = 8
| 过滤器类型：DCTDecode，表示解压使用基于JPEG标准的DCT（离散余弦变换） 技术编码的数据，重现接近原始数据的图像样本数据。
static final int | e_FlateDecode = 4
| 过滤器类型：FlateDecode，表示解压使用zlib/deflate压缩方法编码的数据， 重现原始文本或二进制数据。
static final int | e_JBIG2Decode = 7
| 过滤器类型：JBIG2Decode，表示解压使用JBIG2标准编码的数据， 重现原始单色（每像素为1比特）图像数据（或该数据的近似值）。
static final int | e_JPXDecode = 9
| 过滤器类型：JPXDecode，表示解压使用基于小波的 JPEG2000标准编码的数据，重现原始图像数据。
static final int | e_LZWDecode = 3
| 过滤器类型：LZWDecode，表示解压使用LZW(Lempel-Ziv-Welch) 自适应压缩方法编码的数据，重现原始文本或二进制数据。
static final int | e_NoneDecode = 0
| 无需解码流数据。
static final int | e_RunLengthDecode = 5
| 过滤器类型：RunLengthDecode，表示解压 使用面向字节的游程长度编码算法编码的数据， 重现原始文本或二进制数据（通常是单色图像数据， 或任何包含频繁长连续单个字节值的数据）。
static final int | e_Unknown = -1
| 未知过滤器类型。
静态 Public 属性 继承自 com.foxit.sdk.pdf.objects.PDFObject
static final int | e_Array = 5
| PDF数组对象。
static final int | e_Boolean = 1
| PDF布尔对象。
static final int | e_Dictionary = 6
| PDF字典对象。
static final int | e_InvalidType = 0
| 无效的PDF对象类型。
static final int | e_Name = 4
| PDF名称对象。
static final int | e_Null = 8
| PDF空对象。
static final int | e_Number = 2
| PDF数字对象。
static final int | e_Reference = 9
| PDF引用对象。
static final int | e_Stream = 7
| PDF流对象。
static final int | e_String = 3
| PDF字符串对象。

## 详细描述

PDF流对象由一个直接字典对象和流数据组成。 有关更多详细信息，请参阅<PDF Reference 1.7>中的第3.2.7节“流对象”。
类com.foxit.sdk.pdf.objects.PDFStream 派生自PDFObject ，并提供函数来创建新的PDF流对象以及 获取/设置流数据。

参见
  PDFObject

## 成员函数说明

## ◆ create()

static PDFStream com.foxit.sdk.pdf.objects.PDFStream.create | ( | PDFDictionary | dictionary | ) | throws com.foxit.sdk.PDFException
| static

基于字典创建新的流对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用， 请调用函数PDFObject.release 来释放该对象。

参数

  [in] | dictionary | 一个PDF字典对象： 如果为null，将基于 空的PDF字典创建PDF流对象。 如果不是null，在成功创建PDF流对象后， 请勿对此PDF字典对象调用PDFObject.release 。

返回
  一个新的PDFStream 对象。如果有任何错误，此函数将返回null。

## ◆ delete()

synchronized void com.foxit.sdk.pdf.objects.PDFStream.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

重载 com.foxit.sdk.pdf.objects.PDFObject .

## ◆ exportData()

FileReaderCallback com.foxit.sdk.pdf.objects.PDFStream.exportData | ( | boolean | is_raw_data | ) | throws com.foxit.sdk.PDFException

导出流数据。

此函数提供了一种高效的方式来获取流数据，尤其是对于大型流数据。

参数

  [in] | is_raw_data | 一个布尔值，指示是否获取原始数据： true表示获取原始数据，false表示 获取解码后的数据（原始数据）。

返回
  一个com.foxit.sdk.common.fxcrt.FileReaderCallback 对象，可用于读取流数据。 请记得使用返回的com.foxit.sdk.common.fxcrt.FileReaderCallback 对象的Release()回调函数 来释放此com.foxit.sdk.common.fxcrt.FileReaderCallback 对象，当不再使用它时。

注解
  如果当前流对象被释放或相关PDF文档被关闭， 请勿再使用返回的com.foxit.sdk.common.fxcrt.FileReaderCallback 对象；否则，将发生意外错误或崩溃。

## ◆ getData()

boolean com.foxit.sdk.pdf.objects.PDFStream.getData | ( | boolean | is_raw_data,
|  | long | size,
|  | byte[] | out_buffer
| ) |  | throws com.foxit.sdk.PDFException

获取流数据。

调用此函数时，用户应传递一个具有足够大小的内存块来检索数据。 建议用户调用函数PDFStream.getDataSize （使用相同的参数 is_raw_data）来获取预期大小，然后准备内存块，然后 调用此函数来获取数据。

参数

  [in] | is_raw_data | 一个布尔值，指示是否获取原始数据： true表示获取原始数据，false表示 获取解码后的数据（原始数据）。
  [in] | size | 参数out_buffer的大小，以字节为单位。 它应该等于或大于实际数据大小。
  [out] | out_buffer | 一个内存块（具有足够的大小）用作输出参数来接收流数据。 它不应为null。

返回
  true表示成功，而false表示失败。

## ◆ getDataSize()

java.math.BigInteger com.foxit.sdk.pdf.objects.PDFStream.getDataSize | ( | boolean | is_raw_data | ) | throws com.foxit.sdk.PDFException

获取流数据的大小，以字节为单位。

参数

  [in] | is_raw_data | 一个布尔值，指示是否获取原始数据： true表示获取原始数据，false表示 获取解码后的数据（原始数据）。

返回
  数据大小，以字节为单位。

## ◆ getDictionary()

PDFDictionary com.foxit.sdk.pdf.objects.PDFStream.getDictionary | ( |  | ) | throws com.foxit.sdk.PDFException

获取与当前PDF流对象关联的PDF字典对象。

返回
  流字典。 如果有任何错误，此函数将返回null。

## ◆ getStreamFilter()

int com.foxit.sdk.pdf.objects.PDFStream.getStreamFilter | ( |  | ) | throws com.foxit.sdk.PDFException

获取流过滤器的类型，该类型指示在使用数据之前必须如何解码流数据。

返回
  流过滤器的类型。请参考从com.foxit.sdk.pdf.objects.PDFStream.e_Unknown 开始的值， 此值将是这些值之一。

## ◆ importData()

void com.foxit.sdk.pdf.objects.PDFStream.importData | ( | FileReaderCallback | file_read,
|  | int | stream_filter
| ) |  | throws com.foxit.sdk.PDFException

导入流数据。

参数

  [in] | file_read | 一个由用户实现的com.foxit.sdk.common.fxcrt.FileReaderCallback 对象。Foxit PDF SDK将使用它来 读取流数据并设置到当前PDF流对象。用户应保持 此回调有效，直到相关的PDF文档关闭或当前流对象 因无用而被释放。
  [in] | stream_filter | 流过滤器的类型，指定如何解码通过参数file_read读取的数据。 请参考从com.foxit.sdk.pdf.objects.PDFStream.e_NoneDecode 开始的值，此值应是这些值之一，但 com.foxit.sdk.pdf.objects.PDFStream.e_Unknown 除外。

返回
  无。

## ◆ setData()

void com.foxit.sdk.pdf.objects.PDFStream.setData | ( | byte[] | buffer | ) | throws com.foxit.sdk.PDFException

设置流数据。

参数

  [in] | buffer | 一个内存块，表示要设置的新流数据。

返回
  无。