Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.pdfbox.util
Class PDFStreamEngine

    java.lang.Object
      org.pdfbox.util.PDFStreamEngine

Direct Known Subclasses:
  PageDrawer, PDFTextStripper, Type3StreamParser

public class PDFStreamEngine
extends Object

This class will run through a PDF content stream and execute certain operations and provide a callback interface for clients that want to do things with the stream. See the PDFTextStripper class for an example of how to use this class.

Version:
  $Revision: 1.23 $
Author:
  Ben Litchfield (ben@benlitchfield.com)

Constructor Summary
`PDFStreamEngine()` Constructor.
`PDFStreamEngine(Properties properties)` Constructor with engine properties.

Method Summary
`Map` | `getColorSpaces()`
`Map` | `getFonts()`
`Stack` | `getGraphicsStack()`
`PDGraphicsState` | `getGraphicsState()`
`Map` | `getGraphicsStates()`
`PDResources` | `getResources()`
`Matrix` | `getTextLineMatrix()`
`Matrix` | `getTextMatrix()`
`protected void` | `processOperator(PDFOperator operator, List arguments)` This is used to handle an operation.
`void` | `processOperator(String operator, List arguments)` This is used to handle an operation.
`void` | `processStream(PDPage aPage, PDResources resources, COSStream cosStream)` This will process the contents of the stream.
`void` | `processSubStream(PDPage aPage, PDResources resources, COSStream cosStream)` Process a sub stream of the current stream.
`void` | `setColorSpaces(Map value)`
`void` | `setFonts(Map value)`
`void` | `setGraphicsStack(Stack value)`
`void` | `setGraphicsState(PDGraphicsState value)`
`void` | `setGraphicsStates(Map value)`
`void` | `setTextLineMatrix(Matrix value)`
`void` | `setTextMatrix(Matrix value)`
`protected void` | `showCharacter(TextPosition text)` A method provided as an event interface to allow a subclass to perform some specific functionality when a character needs to be displayed.
`void` | `showString(byte[] string)` You should override this method if you want to perform an action when a string is being shown.

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

Constructor Detail

### PDFStreamEngine

    public PDFStreamEngine()

  Constructor.

### PDFStreamEngine

    public PDFStreamEngine(Properties properties)
                    throws IOException

  Constructor with engine properties. The property keys are all PDF operators, the values are class names used to execute those operators.

Parameters:
  `properties` - The engine properties.
Throws:
  `IOException` - If there is an error setting the engine properties.

Method Detail

### processStream

    public void processStream(PDPage aPage,
                              PDResources resources,
                              COSStream cosStream)
                       throws IOException

  This will process the contents of the stream.

  Parameters:
    `aPage` - The page.
    `resources` - The location to retrieve resources.
    `cosStream` - the Stream to execute.
  Throws:
    `IOException` - if there is an error accessing the stream.

### processSubStream

    public void processSubStream(PDPage aPage,
                                 PDResources resources,
                                 COSStream cosStream)
                          throws IOException

  Process a sub stream of the current stream.

  Parameters:
    `aPage` - The page used for drawing.
    `resources` - The resources used when processing the stream.
    `cosStream` - The stream to process.
  Throws:
    `IOException` - If there is an exception while processing the stream.

### showCharacter

    protected void showCharacter(TextPosition text)

  A method provided as an event interface to allow a subclass to perform some specific functionality when a character needs to be displayed.

  Parameters:
    `text` - The character to be displayed.

### showString

    public void showString(byte[] string)
                    throws IOException

  You should override this method if you want to perform an action when a string is being shown.

  Parameters:
    `string` - The string to display.
  Throws:
    `IOException` - If there is an error showing the string

### processOperator

    protected void processOperator(PDFOperator operator,
                                   List arguments)
                            throws IOException

  This is used to handle an operation.

  Parameters:
    `operator` - The operation to perform.
    `arguments` - The list of arguments.
  Throws:
    `IOException` - If there is an error processing the operation.

### processOperator

    public void processOperator(String operator,
                                List arguments)
                         throws IOException

  This is used to handle an operation.

  Parameters:
    `operator` - The operation to perform.
    `arguments` - The list of arguments.
  Throws:
    `IOException` - If there is an error processing the operation.

### getColorSpaces

    public Map getColorSpaces()

  Returns:
    Returns the colorSpaces.

### setColorSpaces

    public void setColorSpaces(Map value)

  Parameters:
    `value` - The colorSpaces to set.

### getFonts

    public Map getFonts()

  Returns:
    Returns the fonts.

### setFonts

    public void setFonts(Map value)

  Parameters:
    `value` - The fonts to set.

### getGraphicsStack

    public Stack getGraphicsStack()

  Returns:
    Returns the graphicsStack.

### setGraphicsStack

    public void setGraphicsStack(Stack value)

  Parameters:
    `value` - The graphicsStack to set.

### getGraphicsState

    public PDGraphicsState getGraphicsState()

  Returns:
    Returns the graphicsState.

### setGraphicsState

    public void setGraphicsState(PDGraphicsState value)

  Parameters:
    `value` - The graphicsState to set.

### getGraphicsStates

    public Map getGraphicsStates()

  Returns:
    Returns the graphicsStates.

### setGraphicsStates

    public void setGraphicsStates(Map value)

  Parameters:
    `value` - The graphicsStates to set.

### getTextLineMatrix

    public Matrix getTextLineMatrix()

  Returns:
    Returns the textLineMatrix.

### setTextLineMatrix

    public void setTextLineMatrix(Matrix value)

  Parameters:
    `value` - The textLineMatrix to set.

### getTextMatrix

    public Matrix getTextMatrix()

  Returns:
    Returns the textMatrix.

### setTextMatrix

    public void setTextMatrix(Matrix value)

  Parameters:
    `value` - The textMatrix to set.

### getResources

    public PDResources getResources()

  Returns:
    Returns the resources.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD