PdfObject (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.objects.raw.PdfObject

Direct Known Subclasses:

CollectionObject, ColorSpaceObject, CompressedObject, DecodeParmsObject, EncryptionObject, ExtGStateObject, FontObject, FormObject, FunctionObject, GroupingObject, InfoObject, LinearizedObject, MCObject, MetadataObject, NamesObject, NavigatorObject, OCObject, OutlineObject, PageLabelObject, PageObject, ResourcesObject, ShadingObject, SoundObject, StreamObject, XObject
```
public class PdfObject
extends Object
```
holds actual data for PDF file to process

Field Summary

Fields
Modifier and Type	Field and Description
`protected PdfObject`	`Collection`
`protected int`	`colorspace`
`protected PdfObject`	`ColorSpace`
`static int`	`DECODED` states
`protected PdfObject`	`DecodeParms`
`protected PdfObject`	`Encoding`
`protected PdfObject`	`Function`
`protected int`	`generalType`
`protected boolean`	`hasStream`
`protected boolean`	`includeParent`
`protected boolean`	`isDataExternal`
`protected boolean`	`isFullyResolved`
`protected boolean`	`isSymbol`
`protected boolean`	`isZapfDingbats`
`protected boolean`	`maybeIndirect`
`protected int`	`pageNumber`
`protected PdfObject`	`Params`
`protected int`	`parentType`
`protected String`	`ref`
`protected PdfObject`	`Resources`
`protected PdfObject`	`Shading`
`protected PdfObject`	`SMask`
`byte[]`	`stream`
`protected int`	`subtype`
`protected int`	`type`
`static int`	`UNDECODED_DIRECT`
`static int`	`UNDECODED_REF`

Constructor Summary

Constructors
Modifier Constructor and Description

protected PdfObject()

PdfObject(int type)

PdfObject(int intRef, int gen)

PdfObject(String ref)

Constructors
Modifier	Constructor and Description
`protected`	`PdfObject()`
	`PdfObject(int type)`
	`PdfObject(int intRef, int gen)`
	`PdfObject(String ref)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`decompressStreamWhenRead()`
`protected static boolean[]`	`deepCopy(boolean[] input)`
`protected static byte[][]`	`deepCopy(byte[][] input)`
`protected static double[]`	`deepCopy(double[] input)`
`protected static float[]`	`deepCopy(float[] input)`
`protected static int[]`	`deepCopy(int[] input)`
`PdfObject`	`duplicate()`
`boolean`	`getBoolean(int id)`
`boolean[]`	`getBooleanArray(int id)`
`byte[][]`	`getByteArray(int id)`
`String`	`getCachedStreamFile(PdfFileReader objReader)`
`String`	`getCacheName(PdfFileReader objReader)` name of file with cached data on disk or null
`Shape`	`getClip()`
`byte[]`	`getConvertedData()`
`byte[]`	`getDecodedStream()`
`PdfObject`	`getDictionary(int id)`
`double[]`	`getDoubleArray(int id)`
`float[]`	`getFloatArray(int id)`
`float`	`getFloatNumber(int id)`
`String`	`getGeneralStringValue()`
`int`	`getGeneralType(int id)`
`int`	`getID()`
`static int`	`getId(int keyStart, int keyLength, byte[] raw)`
`int`	`getInt(int id)`
`int[]`	`getIntArray(int id)`
`byte[][]`	`getKeyArray(int id)`
`PdfKeyPairsIterator`	`getKeyPairsIterator()`
`PdfArrayIterator`	`getMixedArray(int id)`
`String`	`getName(int id)`
`int`	`getNameAsConstant(int id)`
`Object[]`	`getObjectArray(int id)`
`String`	`getObjectRefAsString()`
`int`	`getObjectRefGeneration()`
`int`	`getObjectRefID()`
`int`	`getObjectType()`
`int`	`getPageNumber()`
`int`	`getParameterConstant(int key)`
`int`	`getParentID()` only used internally for some forms - please do not use
`int`	`getPDFkeyInt()`
`byte[]`	`getRawName(int id)`
`int`	`getRawObjectType()`
`int`	`getStatus()`
`byte[][]`	`getStringArray(int id)`
`String`	`getStringKey(int id)`
`String`	`getStringValue(int id, int mode)`
`byte[]`	`getStringValueAsByte(int id)`
`String`	`getTextStreamValue(int id)`
`byte[]`	`getTextStreamValueAsByte(int id)`
`byte[]`	`getUnresolvedData()`
`boolean`	`hasStream()` flag set for embedded data
`boolean`	`ignoreRecursion()` do not cascade down whole tree
`void`	`ignoreRecursion(boolean ignoreRecursion)` do not cascade down whole tree
`boolean`	`ignoreStream()`
`void`	`ignoreStream(boolean ignoreStream)`
`boolean`	`isCached()`
`boolean`	`isCompressedStream()`
`boolean`	`isDataExternal()`
`void`	`isDataExternal(boolean isDataExternal)`
`boolean`	`isFullyResolved()`
`boolean`	`isInCompressedStream()`
`boolean`	`maybeIndirect()`
`void`	`maybeIndirect(boolean b)`
`void`	`moveCacheValues(PdfObject pdfObject)` move across and reset in pdfObject
`void`	`setBoolean(int id, boolean value)`
`void`	`setBooleanArray(int id, boolean[] value)`
`void`	`setCache(PdfFileReader objReader)`
`void`	`setClip(Shape clip)`
`void`	`setCompressedStream(boolean isCompressedStream)`
`int`	`setConstant(int pdfKeyType, int id)` common values shared between types
`int`	`setConstant(int pdfKeyType, int keyStart, int keyLength, byte[] raw)`
`void`	`setConvertedData(byte[] convertedData)`
`void`	`setDecodedStream(byte[] stream)`
`void`	`setDictionary(int id, PdfObject value)`
`void`	`setDictionaryPairs(byte[][] keys, byte[][] values)`
`void`	`setDoubleArray(int id, double[] value)`
`void`	`setFloatArray(int id, float[] value)`
`void`	`setFloatNumber(int id, float value)`
`void`	`setFullyResolved(boolean isFullyResolved)`
`void`	`setGeneralStringValue(String generalTypeAsString)`
`void`	`setID(int id)`
`void`	`setInCompressedStream(boolean isInCompressedStream)`
`void`	`setIntArray(int id, int[] value)`
`protected void`	`setInternalReference()` set this PdfObject up as an internal object and define its reference
`void`	`setIntNumber(int id, int value)`
`void`	`setKeyArray(int id, byte[][] keyValues)`
`void`	`setMixedArray(int id, byte[][] value)`
`void`	`setName(int id, byte[] value)`
`void`	`setObjectArray(int id, Object[] objectValues)`
`void`	`setPageNumber(int number)` set the page number for this form
`void`	`setRef(int intRef, int gen)`
`void`	`setRef(String ref)`
`void`	`setStatus(int status)`
`void`	`setStream(byte[] stream)`
`void`	`setStreamMayBeCorrupt(boolean streamMayBeCorrupt)`
`void`	`setStringArray(int id, byte[][] keyValues)`
`void`	`setStringKey(int id, byte[] value)`
`void`	`setTextStreamValue(int id, byte[] value)`
`void`	`setTextStreamValue(int id2, String value)`
`void`	`setUnresolvedData(byte[] unresolvedData, int PDFkeyInt)`
`boolean`	`streamMayBeCorrupt()`
`String`	`toString(float[] floatArray, boolean appendPageNumber)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

maybeIndirect
```
protected boolean maybeIndirect
```

isFullyResolved
```
protected boolean isFullyResolved
```

isDataExternal
```
protected boolean isDataExternal
```

DECODED
```
public static final int DECODED
```
states

See Also:

Constant Field Values

UNDECODED_REF
```
public static final int UNDECODED_REF
```
See Also:

Constant Field Values

UNDECODED_DIRECT
```
public static final int UNDECODED_DIRECT
```
See Also:

Constant Field Values

pageNumber
```
protected int pageNumber
```

colorspace
```
protected int colorspace
```

subtype
```
protected int subtype
```

type
```
protected int type
```

Collection
```
protected PdfObject Collection
```

ColorSpace
```
protected PdfObject ColorSpace
```

DecodeParms
```
protected PdfObject DecodeParms
```

Encoding
```
protected PdfObject Encoding
```

Function
```
protected PdfObject Function
```

Params
```
protected PdfObject Params
```

Resources
```
protected PdfObject Resources
```

Shading
```
protected PdfObject Shading
```

SMask
```
protected PdfObject SMask
```

isZapfDingbats
```
protected boolean isZapfDingbats
```

isSymbol
```
protected boolean isSymbol
```

generalType
```
protected int generalType
```

includeParent
```
protected boolean includeParent
```

ref
```
protected String ref
```

hasStream
```
protected boolean hasStream
```

stream
```
public byte[] stream
```

parentType
```
protected int parentType
```

Constructor Detail

PdfObject
```
protected PdfObject()
```

PdfObject

public PdfObject(int intRef,
                 int gen)

PdfObject
```
public PdfObject(String ref)
```

PdfObject
```
public PdfObject(int type)
```

Method Detail

setInternalReference
```
protected void setInternalReference()
```
set this PdfObject up as an internal object and define its reference

setRef

public void setRef(int intRef,
                   int gen)

getCacheName
```
public String getCacheName(PdfFileReader objReader)
```
name of file with cached data on disk or null

Parameters:

objReader - Initializes a PdfFileReader object

Returns:

The name of the cache

setRef
```
public void setRef(String ref)
```

deepCopy

protected static boolean[] deepCopy(boolean[] input)

getStatus
```
public int getStatus()
```

getUnresolvedData
```
public byte[] getUnresolvedData()
```

getPDFkeyInt
```
public int getPDFkeyInt()
```

setUnresolvedData

public void setUnresolvedData(byte[] unresolvedData,
                              int PDFkeyInt)

setStatus
```
public void setStatus(int status)
```

deepCopy

protected static float[] deepCopy(float[] input)

deepCopy

protected static double[] deepCopy(double[] input)

deepCopy

protected static int[] deepCopy(int[] input)

deepCopy

protected static byte[][] deepCopy(byte[][] input)

getDictionary

public PdfObject getDictionary(int id)

getGeneralType
```
public int getGeneralType(int id)
```

getGeneralStringValue
```
public String getGeneralStringValue()
```

setGeneralStringValue

public void setGeneralStringValue(String generalTypeAsString)

setIntNumber

public void setIntNumber(int id,
                         int value)

setFloatNumber

public void setFloatNumber(int id,
                           float value)

getInt
```
public int getInt(int id)
```

getFloatNumber
```
public float getFloatNumber(int id)
```

getBoolean
```
public boolean getBoolean(int id)
```

setBoolean

public void setBoolean(int id,
                       boolean value)

setDictionary

public void setDictionary(int id,
                          PdfObject value)

setID
```
public void setID(int id)
```

getID
```
public int getID()
```

getParentID
```
public int getParentID()
```
only used internally for some forms - please do not use

Returns:

hasStream
```
public boolean hasStream()
```
flag set for embedded data

getParameterConstant

public int getParameterConstant(int key)

setConstant

public int setConstant(int pdfKeyType,
                       int keyStart,
                       int keyLength,
                       byte[] raw)

getId

public static int getId(int keyStart,
                        int keyLength,
                        byte[] raw)

setConstant
```
public int setConstant(int pdfKeyType,
                       int id)
```
common values shared between types

Parameters:

pdfKeyType -

id - The id to set

Returns:

the value of PDF

getFloatArray
```
public float[] getFloatArray(int id)
```

getKeyArray
```
public byte[][] getKeyArray(int id)
```

getDoubleArray

public double[] getDoubleArray(int id)

getBooleanArray

public boolean[] getBooleanArray(int id)

getIntArray
```
public int[] getIntArray(int id)
```

setFloatArray

public void setFloatArray(int id,
                          float[] value)

setIntArray

public void setIntArray(int id,
                        int[] value)

setBooleanArray

public void setBooleanArray(int id,
                            boolean[] value)

setDoubleArray

public void setDoubleArray(int id,
                           double[] value)

setMixedArray

public void setMixedArray(int id,
                          byte[][] value)

getStringValue

public String getStringValue(int id,
                             int mode)

getNameAsConstant
```
public int getNameAsConstant(int id)
```

getName
```
public String getName(int id)
```

getRawName
```
public byte[] getRawName(int id)
```

getStringKey
```
public String getStringKey(int id)
```

getTextStreamValue

public String getTextStreamValue(int id)

setName

public void setName(int id,
                    byte[] value)

setStringKey

public void setStringKey(int id,
                         byte[] value)

setTextStreamValue

public void setTextStreamValue(int id,
                               byte[] value)

getDecodedStream
```
public byte[] getDecodedStream()
```

setStream
```
public void setStream(byte[] stream)
```

setDecodedStream

public void setDecodedStream(byte[] stream)

getObjectRefAsString
```
public String getObjectRefAsString()
```

getObjectRefID
```
public int getObjectRefID()
```

getObjectRefGeneration
```
public int getObjectRefGeneration()
```

getMixedArray

public PdfArrayIterator getMixedArray(int id)

setDictionaryPairs

public void setDictionaryPairs(byte[][] keys,
                               byte[][] values)

getKeyPairsIterator

public PdfKeyPairsIterator getKeyPairsIterator()

setKeyArray

public void setKeyArray(int id,
                        byte[][] keyValues)

setStringArray

public void setStringArray(int id,
                           byte[][] keyValues)

getStringArray

public byte[][] getStringArray(int id)

getObjectArray

public Object[] getObjectArray(int id)

setObjectArray

public void setObjectArray(int id,
                           Object[] objectValues)

duplicate
```
public PdfObject duplicate()
```

decompressStreamWhenRead

public boolean decompressStreamWhenRead()

getObjectType
```
public int getObjectType()
```

getRawObjectType
```
public int getRawObjectType()
```

getStringValueAsByte

public byte[] getStringValueAsByte(int id)

isCompressedStream
```
public boolean isCompressedStream()
```

setCompressedStream

public void setCompressedStream(boolean isCompressedStream)

ignoreRecursion
```
public boolean ignoreRecursion()
```
do not cascade down whole tree

ignoreRecursion

public void ignoreRecursion(boolean ignoreRecursion)

do not cascade down whole tree

getTextStreamValueAsByte

public byte[] getTextStreamValueAsByte(int id)

getByteArray
```
public byte[][] getByteArray(int id)
```

setTextStreamValue

public void setTextStreamValue(int id2,
                               String value)

toString

public String toString(float[] floatArray,
                       boolean appendPageNumber)

getPageNumber
```
public int getPageNumber()
```
Returns:

the page this field is associated to

setPageNumber
```
public void setPageNumber(int number)
```
set the page number for this form

setCache

public void setCache(PdfFileReader objReader)

isCached
```
public boolean isCached()
```

getCachedStreamFile

public String getCachedStreamFile(PdfFileReader objReader)

setInCompressedStream

public void setInCompressedStream(boolean isInCompressedStream)

isInCompressedStream
```
public boolean isInCompressedStream()
```

maybeIndirect
```
public void maybeIndirect(boolean b)
```

maybeIndirect
```
public boolean maybeIndirect()
```

isFullyResolved
```
public boolean isFullyResolved()
```

setFullyResolved

public void setFullyResolved(boolean isFullyResolved)

isDataExternal
```
public boolean isDataExternal()
```

isDataExternal

public void isDataExternal(boolean isDataExternal)

ignoreStream
```
public boolean ignoreStream()
```

ignoreStream

public void ignoreStream(boolean ignoreStream)

setStreamMayBeCorrupt

public void setStreamMayBeCorrupt(boolean streamMayBeCorrupt)

streamMayBeCorrupt
```
public boolean streamMayBeCorrupt()
```

moveCacheValues
```
public void moveCacheValues(PdfObject pdfObject)
```
move across and reset in pdfObject

Parameters:

pdfObject -

setClip
```
public void setClip(Shape clip)
```

getClip
```
public Shape getClip()
```

getConvertedData
```
public byte[] getConvertedData()
```

setConvertedData

public void setConvertedData(byte[] convertedData)

Class PdfObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

maybeIndirect

isFullyResolved

isDataExternal

DECODED

UNDECODED_REF

UNDECODED_DIRECT

pageNumber

colorspace

subtype

type

Collection

ColorSpace

DecodeParms

Encoding

Function

Params

Resources

Shading

SMask

isZapfDingbats

isSymbol

generalType

includeParent

ref

hasStream

stream

parentType

Constructor Detail

PdfObject

PdfObject

PdfObject

PdfObject

Method Detail

setInternalReference

setRef

getCacheName

setRef

deepCopy

getStatus

getUnresolvedData

getPDFkeyInt

setUnresolvedData

setStatus

deepCopy

deepCopy

deepCopy

deepCopy

getDictionary

getGeneralType

getGeneralStringValue

setGeneralStringValue

setIntNumber

setFloatNumber

getInt

getFloatNumber

getBoolean

setBoolean

setDictionary

setID

getID

getParentID

hasStream

getParameterConstant

setConstant

getId

setConstant

getFloatArray

getKeyArray

getDoubleArray

getBooleanArray

getIntArray

setFloatArray

setIntArray

setBooleanArray