Apache PDFBox 2.0.0-SNAPSHOT API

Return-Path: X-Original-To: apmail-pdfbox-commits-archive@www.apache.org Delivered-To: apmail-pdfbox-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 1915F190E8 for ; Sat, 19 Mar 2016 08:49:26 +0000 (UTC) Received: (qmail 36465 invoked by uid 500); 19 Mar 2016 08:49:25 -0000 Delivered-To: apmail-pdfbox-commits-archive@pdfbox.apache.org Received: (qmail 36432 invoked by uid 500); 19 Mar 2016 08:49:25 -0000 Mailing-List: contact commits-help@pdfbox.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@pdfbox.apache.org Delivered-To: mailing list commits@pdfbox.apache.org Received: (qmail 35629 invoked by uid 99); 19 Mar 2016 08:49:25 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 19 Mar 2016 08:49:25 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 10E97DFF96; Sat, 19 Mar 2016 08:49:25 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: msahyoun@apache.org To: commits@pdfbox.apache.org Date: Sat, 19 Mar 2016 08:50:07 -0000 Message-Id: <950884f3e02a47238af6b38403b78999@git.apache.org> In-Reply-To: <975f94204b8b4b34bb7622ddea6786f2@git.apache.org> References: <975f94204b8b4b34bb7622ddea6786f2@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [45/51] [partial] pdfbox-docs git commit: PDFBOX-3030: remove 2.0.0-SNAPSHOT javadoc http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/55fb5ae9/content/docs/2.0.0-SNAPSHOT/javadocs/index.html ---------------------------------------------------------------------- diff --git a/content/docs/2.0.0-SNAPSHOT/javadocs/index.html b/content/docs/2.0.0-SNAPSHOT/javadocs/index.html deleted file mode 100644 index f40118b..0000000 --- a/content/docs/2.0.0-SNAPSHOT/javadocs/index.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - -Apache PDFBox 2.0.0-SNAPSHOT API - - - - - - - - - -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<h2>Frame Alert</h2> -<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> - - - http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/55fb5ae9/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/PDContentStream.html ---------------------------------------------------------------------- diff --git a/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/PDContentStream.html b/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/PDContentStream.html deleted file mode 100644 index 2e61115..0000000 --- a/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/PDContentStream.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - -PDContentStream (Apache PDFBox 2.0.0-SNAPSHOT API) - - - - - - -

-

-

-

Prev Class
Next Class

-

Frames
No Frames

-

All Classes

-

- -

-

-

Summary:
Nested |
Field |
Constr |
Method

-

Detail:
Field |
Constr |
Method

-

- - - -

-

-

-
-
All Known Implementing Classes:
-
PDAppearanceStream, PDFormXObject, PDPage, PDTilingPattern, PDTransparencyGroup, PDType3CharProc
-
-
-
-
```
public interface PDContentStream
```
-
A content stream.
-
Author:
-
John Hewson
-

-

-

-

- -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - -

Methods
Modifier and Type	Method and Description
`PDRectangle`	`getBBox()` - Returns the bounding box of the contents. -
`InputStream`	`getContents()` - Returns this stream's content, if any. -
`Matrix`	`getMatrix()` - Returns the matrix which transforms from the stream's space to user space. -
`PDResources`	`getResources()` - Returns this stream's resources, if any. -

-

-

-

-

-

- -
- - - -
  Method Detail
  - - - -
  - -
    getContents
    -
```
InputStream getContents()
-                        throws IOException
```
    -
    Returns this stream's content, if any.
    -
    Returns:
    An InputStream or null.
    -
    Throws:
    -
    IOException - If the stream could not be read
    -
  - - - -
  - -
    getResources
    -
```
PDResources getResources()
```
    -
    Returns this stream's resources, if any.
    -
  - - - -
  - -
    getBBox
    -
```
PDRectangle getBBox()
```
    -
    Returns the bounding box of the contents.
    -
  - - - -
  - -
    getMatrix
    -
```
Matrix getMatrix()
```
    -
    Returns the matrix which transforms from the stream's space to user space.
    -
  -
-

-

-

- - -

-

-

-

Prev Class
Next Class

-

Frames
No Frames

-

All Classes

-

- -

-

-

Summary:
Nested |
Field |
Constr |
Method

-

Detail:
Field |
Constr |
Method

-

- -

Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.

- - http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/55fb5ae9/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/PDFGraphicsStreamEngine.html ---------------------------------------------------------------------- diff --git a/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/PDFGraphicsStreamEngine.html b/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/PDFGraphicsStreamEngine.html deleted file mode 100644 index 488d6d5..0000000 --- a/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/PDFGraphicsStreamEngine.html +++ /dev/null @@ -1,557 +0,0 @@ - - - - - -PDFGraphicsStreamEngine (Apache PDFBox 2.0.0-SNAPSHOT API) - - - - - - -

-

-

-

Prev Class
Next Class

-

Frames
No Frames

-

All Classes

-

- -

-

-

Summary:
Nested |
Field |
Constr |
Method

-

Detail:
Field |
Constr |
Method

-

- - - -

-

java.lang.Object
-
- org.apache.pdfbox.contentstream.PDFStreamEngine
- -
  - org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
  -
-

-

-

-
-
Direct Known Subclasses:
-
PageDrawer
-
-
-
-
```
public abstract class PDFGraphicsStreamEngine
-extends PDFStreamEngine
```
-
PDFStreamEngine subclass for advanced processing of graphics. - This class should be subclasses by end users looking to hook into graphics operations.
-
Author:
-
John Hewson
-

-

-

-

- -

- - -
Constructor Summary
- - - - - - - - - - -
Constructors
Modifier Constructor and Description
protected PDFGraphicsStreamEngine(PDPage page) -
Constructor.
-
-

- -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Methods
Modifier and Type	Method and Description
`abstract void`	`appendRectangle(Point2D p0, - Point2D p1, - Point2D p2, - Point2D p3)` - Append a rectangle to the current path. -
`abstract void`	`clip(int windingRule)` - Modify the current clipping path by intersecting it with the current path. -
`abstract void`	`closePath()` - Closes the current path. -
`abstract void`	`curveTo(float x1, - float y1, - float x2, - float y2, - float x3, - float y3)` - Draws a curve from the current point to (x3,y3) using (x1,y1) and (x2,y2) as control points. -
`abstract void`	`drawImage(PDImage pdImage)` - Draw the image. -
`abstract void`	`endPath()` - Ends the current path without filling or stroking it. -
`abstract void`	`fillAndStrokePath(int windingRule)` - Fills and then strokes the path. -
`abstract void`	`fillPath(int windingRule)` - Fill the path. -
`abstract Point2D`	`getCurrentPoint()` - Returns the current point of the current path. -
`protected PDPage`	`getPage()` - Returns the page. -
`abstract void`	`lineTo(float x, - float y)` - Draws a line from the current point to (x,y). -
`abstract void`	`moveTo(float x, - float y)` - Starts a new path at (x,y). -
`abstract void`	`shadingFill(COSName shadingName)` - Fill with Shading. -
`abstract void`	`strokePath()` - Stroke the path. -

-

- - -
Methods inherited from class org.apache.pdfbox.contentstream.PDFStreamEngine
-addOperator, applyTextAdjustment, beginText, endText, getAppearance, getCurrentPage, getGraphicsStackSize, getGraphicsState, getInitialMatrix, getResources, getTextLineMatrix, getTextMatrix, operatorException, processAnnotation, processChildStream, processOperator, processOperator, processPage, processSoftMask, processTilingPattern, processTilingPattern, processTransparencyGroup, processType3Stream, registerOperatorProc essor, restoreGraphicsStack, restoreGraphicsState, saveGraphicsStack, saveGraphicsState, setLineDashPattern, setTextLineMatrix, setTextMatrix, showAnnotation, showFontGlyph, showForm, showGlyph, showText, showTextString, showTextStrings, showTransparencyGroup, showType3Glyph, transformedPoint, transformWidth, unsupportedOperator

-

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

-

-

-

-

-

- -
- - - -
  Constructor Detail
  - - - -
  - -
    PDFGraphicsStreamEngine
    -
```
protected PDFGraphicsStreamEngine(PDPage page)
```
    -
    Constructor.
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    getPage
    -
```
protected final PDPage getPage()
```
    -
    Returns the page.
    -
  - - - -
  - -
    appendRectangle
    -
```
public abstract void appendRectangle(Point2D p0,
-                   Point2D p1,
-                   Point2D p2,
-                   Point2D p3)
-                              throws IOException
```
    -
    Append a rectangle to the current path.
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    drawImage
    -
```
public abstract void drawImage(PDImage pdImage)
-                        throws IOException
```
    -
    Draw the image.
    -
    Parameters:
    pdImage - The image to draw.
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    clip
    -
```
public abstract void clip(int windingRule)
-                   throws IOException
```
    -
    Modify the current clipping path by intersecting it with the current path. - The clipping path will not be updated until the succeeding painting operator is called.
    -
    Parameters:
    windingRule - The winding rule which will be used for clipping.
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    moveTo
    -
```
public abstract void moveTo(float x,
-          float y)
-                     throws IOException
```
    -
    Starts a new path at (x,y).
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    lineTo
    -
```
public abstract void lineTo(float x,
-          float y)
-                     throws IOException
```
    -
    Draws a line from the current point to (x,y).
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    curveTo
    -
```
public abstract void curveTo(float x1,
-           float y1,
-           float x2,
-           float y2,
-           float x3,
-           float y3)
-                      throws IOException
```
    -
    Draws a curve from the current point to (x3,y3) using (x1,y1) and (x2,y2) as control points.
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    getCurrentPoint
    -
```
public abstract Point2D getCurrentPoint()
-                                 throws IOException
```
    -
    Returns the current point of the current path.
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    closePath
    -
```
public abstract void closePath()
-                        throws IOException
```
    -
    Closes the current path.
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    endPath
    -
```
public abstract void endPath()
-                      throws IOException
```
    -
    Ends the current path without filling or stroking it. The clipping path is updated here.
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    strokePath
    -
```
public abstract void strokePath()
-                         throws IOException
```
    -
    Stroke the path.
    -
    Throws:
    -
    IOException - If there is an IO error while stroking the path.
    -
  - - - -
  - -
    fillPath
    -
```
public abstract void fillPath(int windingRule)
-                       throws IOException
```
    -
    Fill the path.
    -
    Parameters:
    windingRule - The winding rule this path will use.
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    fillAndStrokePath
    -
```
public abstract void fillAndStrokePath(int windingRule)
-                                throws IOException
```
    -
    Fills and then strokes the path.
    -
    Parameters:
    windingRule - The winding rule this path will use.
    -
    Throws:
    -
    IOException
    -
  - - - -
  - -
    shadingFill
    -
```
public abstract void shadingFill(COSName shadingName)
-                          throws IOException
```
    -
    Fill with Shading.
    -
    Parameters:
    shadingName - The name of the Shading Dictionary to use for this fill instruction.
    -
    Throws:
    -
    IOException
    -
  -
-

-

-

- - -

-

-

-

Prev Class
Next Class

-

Frames
No Frames

-

All Classes

-

- -

-

-

Summary:
Nested |
Field |
Constr |
Method

-

Detail:
Field |
Constr |
Method

-

- -

Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.

- -