From a65382612afa93441df360b5095ffc57c85c9de8 Mon Sep 17 00:00:00 2001 From: fotis Date: Mon, 5 Feb 2001 22:36:54 +0000 Subject: removing design docs to the download dir git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@194022 13f79535-47bb-0310-9956-ffa450edef68 --- docs/design/contrib/layout/about.html | 1 - docs/design/contrib/layout/help-doc.html | 1 - docs/design/contrib/layout/index-all.html | 14 --- docs/design/contrib/layout/index.html | 7 -- docs/design/contrib/layout/model-tree/false.gif | Bin 85 -> 0 bytes docs/design/contrib/layout/model-tree/model.tree | 45 -------- docs/design/contrib/layout/model-tree/true.gif | Bin 82 -> 0 bytes docs/design/contrib/layout/model-tree/tv-class.gif | Bin 125 -> 0 bytes .../contrib/layout/model-tree/tv-interface.gif | Bin 338 -> 0 bytes .../layout/model-tree/tv-physical-package.gif | Bin 131 -> 0 bytes .../contrib/layout/model-tree/tv-pkg-diagram.gif | Bin 152 -> 0 bytes docs/design/contrib/layout/navigation.jar | Bin 19227 -> 0 bytes .../contrib/layout/org/apache/fop/layout/Area.html | 4 - .../org/apache/fop/layout/AreaContainer.html | 6 - .../layout/org/apache/fop/layout/AreaTree.html | 4 - .../layout/org/apache/fop/layout/BlockArea.html | 8 -- .../org/apache/fop/layout/BodyAreaContainer.html | 17 --- .../org/apache/fop/layout/BodyRegionArea.html | 4 - .../contrib/layout/org/apache/fop/layout/Box.html | 1 - .../layout/org/apache/fop/layout/ColumnArea.html | 8 -- .../layout/org/apache/fop/layout/DisplaySpace.html | 6 - .../org/apache/fop/layout/FontDescriptor.html | 1 - .../layout/org/apache/fop/layout/FontInfo.html | 1 - .../layout/org/apache/fop/layout/FontMetric.html | 3 - .../layout/org/apache/fop/layout/FontState.html | 1 - .../layout/org/apache/fop/layout/LineArea.html | 19 ---- .../layout/org/apache/fop/layout/LinkSet.html | 2 - .../org/apache/fop/layout/LinkedRectangle.html | 2 - .../contrib/layout/org/apache/fop/layout/Page.html | 2 - .../layout/org/apache/fop/layout/PageMaster.html | 1 - .../layout/org/apache/fop/layout/RegionArea.html | 1 - .../layout/org/apache/fop/layout/Space.html | 4 - .../layout/org/apache/fop/layout/SpanArea.html | 8 -- .../org/apache/fop/layout/class-use/Area.html | 1 - .../apache/fop/layout/class-use/AreaContainer.html | 1 - .../org/apache/fop/layout/class-use/AreaTree.html | 1 - .../org/apache/fop/layout/class-use/BlockArea.html | 1 - .../fop/layout/class-use/BodyAreaContainer.html | 1 - .../fop/layout/class-use/BodyRegionArea.html | 1 - .../org/apache/fop/layout/class-use/Box.html | 1 - .../apache/fop/layout/class-use/ColumnArea.html | 1 - .../apache/fop/layout/class-use/DisplaySpace.html | 1 - .../fop/layout/class-use/FontDescriptor.html | 1 - .../org/apache/fop/layout/class-use/FontInfo.html | 2 - .../apache/fop/layout/class-use/FontMetric.html | 1 - .../org/apache/fop/layout/class-use/FontState.html | 2 - .../org/apache/fop/layout/class-use/LineArea.html | 1 - .../org/apache/fop/layout/class-use/LinkSet.html | 1 - .../fop/layout/class-use/LinkedRectangle.html | 1 - .../org/apache/fop/layout/class-use/Page.html | 1 - .../apache/fop/layout/class-use/PageMaster.html | 1 - .../apache/fop/layout/class-use/RegionArea.html | 1 - .../org/apache/fop/layout/class-use/Space.html | 1 - .../org/apache/fop/layout/class-use/SpanArea.html | 1 - .../org/apache/fop/layout/doc-files/layout.cl.gif | Bin 118066 -> 0 bytes .../org/apache/fop/layout/doc-files/layout.cl.html | 41 ------- .../layout/org/apache/fop/layout/layout.cl.html | 3 - .../org/apache/fop/layout/package-frame.html | 7 -- .../org/apache/fop/layout/package-summary.html | 3 - .../layout/org/apache/fop/layout/package-tree.html | 1 - .../layout/org/apache/fop/layout/package-use.html | 3 - docs/design/contrib/layout/overview-frame.html | 4 - docs/design/contrib/layout/overview-summary.html | 1 - docs/design/contrib/layout/overview-tree.html | 1 - docs/design/contrib/layout/stylesheet.css | 28 ----- docs/design/contrib/pdf/help-doc.html | 1 - docs/design/contrib/pdf/index-all.html | 15 --- docs/design/contrib/pdf/index.html | 7 -- docs/design/contrib/pdf/model-tree/false.gif | Bin 85 -> 0 bytes docs/design/contrib/pdf/model-tree/model.tree | 73 ------------ docs/design/contrib/pdf/model-tree/true.gif | Bin 82 -> 0 bytes docs/design/contrib/pdf/model-tree/tv-class.gif | Bin 125 -> 0 bytes .../contrib/pdf/model-tree/tv-physical-package.gif | Bin 131 -> 0 bytes .../contrib/pdf/model-tree/tv-pkg-diagram.gif | Bin 152 -> 0 bytes docs/design/contrib/pdf/navigation.jar | Bin 19227 -> 0 bytes .../pdf/org/apache/fop/pdf/ASCII85Filter.html | 4 - .../pdf/org/apache/fop/pdf/ASCIIHexFilter.html | 4 - .../pdf/org/apache/fop/pdf/FlateFilter.html | 11 -- .../contrib/pdf/org/apache/fop/pdf/PDFAction.html | 15 --- .../pdf/org/apache/fop/pdf/PDFAnnotList.html | 7 -- .../contrib/pdf/org/apache/fop/pdf/PDFArray.html | 4 - .../contrib/pdf/org/apache/fop/pdf/PDFColor.html | 6 - .../pdf/org/apache/fop/pdf/PDFDocument.html | 118 -------------------- .../pdf/org/apache/fop/pdf/PDFEncoding.html | 13 --- .../pdf/org/apache/fop/pdf/PDFFileSpec.html | 4 - .../contrib/pdf/org/apache/fop/pdf/PDFFilter.html | 7 -- .../pdf/org/apache/fop/pdf/PDFFilterException.html | 8 -- .../contrib/pdf/org/apache/fop/pdf/PDFFont.html | 12 -- .../pdf/org/apache/fop/pdf/PDFFontDescriptor.html | 6 - .../pdf/org/apache/fop/pdf/PDFFontNonBase14.html | 7 -- .../pdf/org/apache/fop/pdf/PDFFontType1.html | 14 --- .../pdf/org/apache/fop/pdf/PDFFunction.html | 123 --------------------- .../contrib/pdf/org/apache/fop/pdf/PDFGoTo.html | 5 - .../pdf/org/apache/fop/pdf/PDFGoToRemote.html | 6 - .../contrib/pdf/org/apache/fop/pdf/PDFInfo.html | 4 - .../pdf/org/apache/fop/pdf/PDFInternalLink.html | 6 - .../contrib/pdf/org/apache/fop/pdf/PDFLink.html | 4 - .../contrib/pdf/org/apache/fop/pdf/PDFNumber.html | 1 - .../contrib/pdf/org/apache/fop/pdf/PDFObject.html | 5 - .../contrib/pdf/org/apache/fop/pdf/PDFPage.html | 9 -- .../contrib/pdf/org/apache/fop/pdf/PDFPages.html | 8 -- .../pdf/org/apache/fop/pdf/PDFPathPaint.html | 4 - .../contrib/pdf/org/apache/fop/pdf/PDFPattern.html | 20 ---- .../pdf/org/apache/fop/pdf/PDFRectangle.html | 3 - .../pdf/org/apache/fop/pdf/PDFResources.html | 7 -- .../contrib/pdf/org/apache/fop/pdf/PDFRoot.html | 4 - .../contrib/pdf/org/apache/fop/pdf/PDFShading.html | 59 ---------- .../contrib/pdf/org/apache/fop/pdf/PDFStream.html | 13 --- .../contrib/pdf/org/apache/fop/pdf/PDFUri.html | 6 - .../contrib/pdf/org/apache/fop/pdf/PDFXObject.html | 10 -- .../pdf/org/apache/fop/pdf/doc-files/pdf.cl.gif | Bin 132880 -> 0 bytes .../pdf/org/apache/fop/pdf/doc-files/pdf.cl.html | 41 ------- .../pdf/org/apache/fop/pdf/package-frame.html | 7 -- .../pdf/org/apache/fop/pdf/package-summary.html | 14 --- .../pdf/org/apache/fop/pdf/package-tree.html | 1 - .../pdf/org/apache/fop/pdf/package-use.html | 5 - .../contrib/pdf/org/apache/fop/pdf/pdf.cl.html | 7 -- docs/design/contrib/pdf/overview-frame.html | 4 - docs/design/contrib/pdf/overview-summary.html | 4 - docs/design/contrib/pdf/overview-tree.html | 1 - docs/design/contrib/pdf/stylesheet.css | 28 ----- 121 files changed, 1031 deletions(-) delete mode 100755 docs/design/contrib/layout/about.html delete mode 100755 docs/design/contrib/layout/help-doc.html delete mode 100755 docs/design/contrib/layout/index-all.html delete mode 100755 docs/design/contrib/layout/index.html delete mode 100755 docs/design/contrib/layout/model-tree/false.gif delete mode 100755 docs/design/contrib/layout/model-tree/model.tree delete mode 100755 docs/design/contrib/layout/model-tree/true.gif delete mode 100755 docs/design/contrib/layout/model-tree/tv-class.gif delete mode 100755 docs/design/contrib/layout/model-tree/tv-interface.gif delete mode 100755 docs/design/contrib/layout/model-tree/tv-physical-package.gif delete mode 100755 docs/design/contrib/layout/model-tree/tv-pkg-diagram.gif delete mode 100755 docs/design/contrib/layout/navigation.jar delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/Area.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/AreaContainer.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/AreaTree.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/BlockArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/BodyAreaContainer.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/BodyRegionArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/Box.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/ColumnArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/DisplaySpace.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/FontDescriptor.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/FontInfo.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/FontMetric.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/FontState.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/LineArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/LinkSet.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/LinkedRectangle.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/Page.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/PageMaster.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/RegionArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/Space.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/SpanArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/Area.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/AreaContainer.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/AreaTree.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/BlockArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/BodyAreaContainer.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/BodyRegionArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/Box.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/ColumnArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/DisplaySpace.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/FontDescriptor.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/FontInfo.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/FontMetric.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/FontState.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/LineArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/LinkSet.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/LinkedRectangle.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/Page.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/PageMaster.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/RegionArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/Space.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/class-use/SpanArea.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/doc-files/layout.cl.gif delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/doc-files/layout.cl.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/layout.cl.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/package-frame.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/package-summary.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/package-tree.html delete mode 100755 docs/design/contrib/layout/org/apache/fop/layout/package-use.html delete mode 100755 docs/design/contrib/layout/overview-frame.html delete mode 100755 docs/design/contrib/layout/overview-summary.html delete mode 100755 docs/design/contrib/layout/overview-tree.html delete mode 100755 docs/design/contrib/layout/stylesheet.css delete mode 100755 docs/design/contrib/pdf/help-doc.html delete mode 100755 docs/design/contrib/pdf/index-all.html delete mode 100755 docs/design/contrib/pdf/index.html delete mode 100755 docs/design/contrib/pdf/model-tree/false.gif delete mode 100755 docs/design/contrib/pdf/model-tree/model.tree delete mode 100755 docs/design/contrib/pdf/model-tree/true.gif delete mode 100755 docs/design/contrib/pdf/model-tree/tv-class.gif delete mode 100755 docs/design/contrib/pdf/model-tree/tv-physical-package.gif delete mode 100755 docs/design/contrib/pdf/model-tree/tv-pkg-diagram.gif delete mode 100755 docs/design/contrib/pdf/navigation.jar delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/ASCII85Filter.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/ASCIIHexFilter.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/FlateFilter.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFAction.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFAnnotList.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFArray.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFColor.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFDocument.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFEncoding.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFFileSpec.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilter.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilterException.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFFont.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontDescriptor.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontNonBase14.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontType1.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFFunction.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoTo.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoToRemote.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFInfo.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFInternalLink.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFLink.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFNumber.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFObject.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFPage.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFPages.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFPathPaint.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFPattern.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFRectangle.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFResources.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFRoot.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFShading.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFStream.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFUri.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/PDFXObject.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/doc-files/pdf.cl.gif delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/doc-files/pdf.cl.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/package-frame.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/package-summary.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/package-tree.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/package-use.html delete mode 100755 docs/design/contrib/pdf/org/apache/fop/pdf/pdf.cl.html delete mode 100755 docs/design/contrib/pdf/overview-frame.html delete mode 100755 docs/design/contrib/pdf/overview-summary.html delete mode 100755 docs/design/contrib/pdf/overview-tree.html delete mode 100755 docs/design/contrib/pdf/stylesheet.css (limited to 'docs') diff --git a/docs/design/contrib/layout/about.html b/docs/design/contrib/layout/about.html deleted file mode 100755 index 754926305..000000000 --- a/docs/design/contrib/layout/about.html +++ /dev/null @@ -1 +0,0 @@ -

Documentation for fop.tpr

Generated by Together® on Thu Jan 25 10:46:29 EST 2001 \ No newline at end of file diff --git a/docs/design/contrib/layout/help-doc.html b/docs/design/contrib/layout/help-doc.html deleted file mode 100755 index 8e318341f..000000000 --- a/docs/design/contrib/layout/help-doc.html +++ /dev/null @@ -1 +0,0 @@ -

How This API Document Is Organized

This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

Overview

The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

Package

Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

Class/Interface

Each class, interface, inner class and inner interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

Tree (Class Hierarchy)

There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

Deprecated API

The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

Index

The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

Prev/Next

These links take you to the next or previous class, interface, package, or related page.Resource not found: Help_Contents_FramesNoFrames.start
\ No newline at end of file diff --git a/docs/design/contrib/layout/index-all.html b/docs/design/contrib/layout/index-all.html deleted file mode 100755 index ed615f009..000000000 --- a/docs/design/contrib/layout/index-all.html +++ /dev/null @@ -1,14 +0,0 @@ -Index
A B C D E F G H I L M N O P R S T W

A

addAfter(org.apache.fop.layout.AreaContainer) - Method in class org.apache.fop.layout.Page
 
addAfter(org.apache.fop.layout.RegionArea) - Method in class org.apache.fop.layout.PageMaster
 
addBefore(org.apache.fop.layout.AreaContainer) - Method in class org.apache.fop.layout.Page
 
addBefore(org.apache.fop.layout.RegionArea) - Method in class org.apache.fop.layout.PageMaster
 
addBody(org.apache.fop.layout.BodyAreaContainer) - Method in class org.apache.fop.layout.Page
Ensure that page is set not only on B.A.C.
addBody(org.apache.fop.layout.BodyRegionArea) - Method in class org.apache.fop.layout.PageMaster
 
addCharacter(char,org.apache.fop.layout.LinkSet,boolean) - Method in class org.apache.fop.layout.LineArea
adds a single character to the line area tree
addCharacter(org.apache.fop.layout.FontState,float,float,float,int,org.apache.fop.layout.LinkSet,int,char,boolean) - Method in class org.apache.fop.layout.BlockArea
 
addChild(org.apache.fop.layout.Box) - Method in class org.apache.fop.layout.Area
 
addChildAtStart(org.apache.fop.layout.Box) - Method in class org.apache.fop.layout.Area
 
addDisplaySpace(int) - Method in class org.apache.fop.layout.Area
 
addEnd(org.apache.fop.layout.AreaContainer) - Method in class org.apache.fop.layout.Page
 
addEnd(org.apache.fop.layout.RegionArea) - Method in class org.apache.fop.layout.PageMaster
 
addFontProperties(java.lang.String,java.lang.String,java.lang.String,java.lang.String) - Method in class org.apache.fop.layout.FontInfo
 
addFootnote(org.apache.fop.fo.flow.FootnoteBody) - Method in class org.apache.fop.layout.BlockArea
 
addLeader(int,int,int,int,int,int,int,int) - Method in class org.apache.fop.layout.LineArea
adds a Leader; actually the method receives the leader properties -and creates a leader area or an inline area which is appended to -the children of the containing line area.
addLeader(org.apache.fop.layout.FontState,float,float,float,int,int,int,int,int,int,int,int) - Method in class org.apache.fop.layout.BlockArea
adds a leader to current line area of containing block area -the actual leader area is created in the line area
addLineArea(org.apache.fop.layout.LineArea) - Method in class org.apache.fop.layout.BlockArea
 
addLinkSet(org.apache.fop.layout.LinkSet) - Method in class org.apache.fop.layout.Page
 
addMetrics(java.lang.String,org.apache.fop.layout.FontMetric) - Method in class org.apache.fop.layout.FontInfo
 
addPage(org.apache.fop.layout.Page) - Method in class org.apache.fop.layout.AreaTree
 
addPageNumberCitation(java.lang.String,org.apache.fop.layout.LinkSet) - Method in class org.apache.fop.layout.LineArea
 
addPageNumberCitation(org.apache.fop.layout.FontState,float,float,float,int,org.apache.fop.layout.LinkSet,int,java.lang.String) - Method in class org.apache.fop.layout.BlockArea
 
addPending() - Method in class org.apache.fop.layout.LineArea
adds pending inline areas to the line area -normally done, when the line area is filled and -added as child to the parent block area
addPendingFootnote(org.apache.fop.fo.flow.FootnoteBody) - Method in class org.apache.fop.layout.Page
 
addRect(java.awt.Rectangle,org.apache.fop.layout.LineArea) - Method in class org.apache.fop.layout.LinkSet
 
addStart(org.apache.fop.layout.AreaContainer) - Method in class org.apache.fop.layout.Page
 
addStart(org.apache.fop.layout.RegionArea) - Method in class org.apache.fop.layout.PageMaster
 
addText(char[],int,int,org.apache.fop.layout.LinkSet,boolean) - Method in class org.apache.fop.layout.LineArea
adds text to line area
addText(org.apache.fop.layout.FontState,float,float,float,int,org.apache.fop.layout.LinkSet,int,char[],int,int,boolean) - Method in class org.apache.fop.layout.BlockArea
 
addToIDList(java.lang.String) - Method in class org.apache.fop.layout.Page
 
adjustFootnoteArea() - Method in class org.apache.fop.layout.BodyAreaContainer
 
align() - Method in class org.apache.fop.layout.LinkSet
 
align(int) - Method in class org.apache.fop.layout.LineArea
aligns line area
applyAreaContainerOffsets(org.apache.fop.layout.AreaContainer,org.apache.fop.layout.Area) - Method in class org.apache.fop.layout.LinkSet
 
Area - class org.apache.fop.layout.Area
 
Area(org.apache.fop.layout.FontState,int,int) - Constructor for class org.apache.fop.layout.Area
 
Area(org.apache.fop.layout.FontState) - Constructor for class org.apache.fop.layout.Area
 
AreaContainer - class org.apache.fop.layout.AreaContainer
 
AreaContainer(org.apache.fop.layout.FontState,int,int,int,int,int) - Constructor for class org.apache.fop.layout.AreaContainer
 
AreaTree - class org.apache.fop.layout.AreaTree
 

B

BlockArea - class org.apache.fop.layout.BlockArea
 
BlockArea(org.apache.fop.layout.FontState,int,int,int,int,int,int,int,int) - Constructor for class org.apache.fop.layout.BlockArea
 
BodyAreaContainer - class org.apache.fop.layout.BodyAreaContainer
 
BodyAreaContainer(org.apache.fop.layout.FontState,int,int,int,int,int,int,int) - Constructor for class org.apache.fop.layout.BodyAreaContainer
 
BodyRegionArea - class org.apache.fop.layout.BodyRegionArea
 
BodyRegionArea(int,int,int,int) - Constructor for class org.apache.fop.layout.BodyRegionArea
 
borderColorBottom - Variable in class org.apache.fop.layout.Area
 
borderColorLeft - Variable in class org.apache.fop.layout.Area
 
borderColorRight - Variable in class org.apache.fop.layout.Area
 
borderColorTop - Variable in class org.apache.fop.layout.Area
 
borderStyleBottom - Variable in class org.apache.fop.layout.Area
 
borderStyleLeft - Variable in class org.apache.fop.layout.Area
 
borderStyleRight - Variable in class org.apache.fop.layout.Area
 
borderStyleTop - Variable in class org.apache.fop.layout.Area
 
borderWidthBottom - Variable in class org.apache.fop.layout.Area
 
borderWidthLeft - Variable in class org.apache.fop.layout.Area
 
borderWidthRight - Variable in class org.apache.fop.layout.Area
 
borderWidthTop - Variable in class org.apache.fop.layout.Area
 
Box - class org.apache.fop.layout.Box
 

C

changeColor(float,float,float) - Method in class org.apache.fop.layout.LineArea
 
changeFont(org.apache.fop.layout.FontState) - Method in class org.apache.fop.layout.LineArea
 
changeHyphenation(java.lang.String,java.lang.String,int,char,int,int) - Method in class org.apache.fop.layout.LineArea
sets hyphenation related traits: language, country, hyphenate, hyphenation-character -and minimum number of character to remain one the previous line and to be on the -next line.
changeWhiteSpaceCollapse(int) - Method in class org.apache.fop.layout.LineArea
 
changeWrapOption(int) - Method in class org.apache.fop.layout.LineArea
 
ColumnArea - class org.apache.fop.layout.ColumnArea
 
ColumnArea(org.apache.fop.layout.FontState,int,int,int,int,int) - Constructor for class org.apache.fop.layout.ColumnArea
 
contentRectangleWidth - Variable in class org.apache.fop.layout.LinkSet
 

D

destination - Variable in class org.apache.fop.layout.LinkSet
the destination of the links
DisplaySpace - class org.apache.fop.layout.DisplaySpace
 
DisplaySpace(int) - Constructor for class org.apache.fop.layout.DisplaySpace
 

E

end() - Method in class org.apache.fop.layout.Area
 
end() - Method in class org.apache.fop.layout.BlockArea
 
end() - Method in class org.apache.fop.layout.ColumnArea
 
end() - Method in class org.apache.fop.layout.SpanArea
 
EXTERNAL - Static variable in class org.apache.fop.layout.LinkSet
 

F

FontDescriptor - interface org.apache.fop.layout.FontDescriptor
 
fontInfo - Variable in class org.apache.fop.layout.AreaTree
object containing information on available fonts, including -metrics
FontInfo - class org.apache.fop.layout.FontInfo
 
FontInfo() - Constructor for class org.apache.fop.layout.FontInfo
 
fontLookup(java.lang.String,java.lang.String,java.lang.String) - Method in class org.apache.fop.layout.FontInfo
 
FontMetric - interface org.apache.fop.layout.FontMetric
interface for font metric classes
fontName() - Method in interface org.apache.fop.layout.FontDescriptor
 
fonts - Variable in class org.apache.fop.layout.FontInfo
 
FontState - class org.apache.fop.layout.FontState
 
FontState(org.apache.fop.layout.FontInfo,java.lang.String,java.lang.String,java.lang.String,int,int) - Constructor for class org.apache.fop.layout.FontState
 
FontState(org.apache.fop.layout.FontInfo,java.lang.String,java.lang.String,java.lang.String,int) - Constructor for class org.apache.fop.layout.FontState
 

G

getAbsoluteHeight() - Method in class org.apache.fop.layout.Area
 
getAfter() - Method in class org.apache.fop.layout.Page
 
getAllocationWidth() - Method in class org.apache.fop.layout.Area
 
getArea() - Method in class org.apache.fop.layout.LinkSet
 
getAscender() - Method in class org.apache.fop.layout.FontState
 
getAscender() - Method in interface org.apache.fop.layout.FontDescriptor
 
getAscender(int) - Method in interface org.apache.fop.layout.FontMetric
 
getBackgroundColor() - Method in class org.apache.fop.layout.Area
 
getBackgroundColor() - Method in class org.apache.fop.layout.RegionArea
 
getBefore() - Method in class org.apache.fop.layout.Page
 
getBeforeFloatReferenceArea() - Method in class org.apache.fop.layout.BodyAreaContainer
 
getBody() - Method in class org.apache.fop.layout.Page
 
getCapHeight() - Method in class org.apache.fop.layout.FontState
 
getCapHeight() - Method in interface org.apache.fop.layout.FontDescriptor
 
getCapHeight(int) - Method in interface org.apache.fop.layout.FontMetric
 
getChildren() - Method in class org.apache.fop.layout.Area
 
getColumnCount() - Method in class org.apache.fop.layout.BodyRegionArea
 
getColumnCount() - Method in class org.apache.fop.layout.SpanArea
 
getColumnGap() - Method in class org.apache.fop.layout.BodyRegionArea
 
getColumnIndex() - Method in class org.apache.fop.layout.ColumnArea
 
getContentHeight() - Method in class org.apache.fop.layout.Area
 
getContentWidth() - Method in class org.apache.fop.layout.Area
 
getCurrentColumn() - Method in class org.apache.fop.layout.SpanArea
 
getCurrentColumnArea() - Method in class org.apache.fop.layout.BodyAreaContainer
 
getCurrentColumnArea() - Method in class org.apache.fop.layout.SpanArea
 
getCurrentYPosition() - Method in class org.apache.fop.layout.AreaContainer
 
getDescender() - Method in class org.apache.fop.layout.FontState
 
getDescender() - Method in interface org.apache.fop.layout.FontDescriptor
 
getDescender(int) - Method in interface org.apache.fop.layout.FontMetric
 
getDest() - Method in class org.apache.fop.layout.LinkSet
 
getEndIndent() - Method in class org.apache.fop.layout.BlockArea
 
getEndIndent() - Method in class org.apache.fop.layout.LineArea
 
getEndIndent() - Method in class org.apache.fop.layout.LinkSet
 
getFirstChar() - Method in interface org.apache.fop.layout.FontMetric
 
getFlags() - Method in interface org.apache.fop.layout.FontDescriptor
 
getFontBBox() - Method in interface org.apache.fop.layout.FontDescriptor
 
getFontFamily() - Method in class org.apache.fop.layout.FontState
 
getFontInfo() - Method in class org.apache.fop.layout.Area
 
getFontInfo() - Method in class org.apache.fop.layout.AreaTree
 
getFontInfo() - Method in class org.apache.fop.layout.FontState
 
getFontInfo() - Method in class org.apache.fop.layout.Page
 
getFontName() - Method in class org.apache.fop.layout.FontState
 
getFonts() - Method in class org.apache.fop.layout.FontInfo
 
getFontSize() - Method in class org.apache.fop.layout.FontState
 
getFontState() - Method in class org.apache.fop.layout.Area
 
getFontStyle() - Method in class org.apache.fop.layout.FontState
 
getFontVariant() - Method in class org.apache.fop.layout.FontState
 
getFontWeight() - Method in class org.apache.fop.layout.FontState
 
getFootnoteReferenceArea() - Method in class org.apache.fop.layout.BodyAreaContainer
 
getFootnoteState() - Method in class org.apache.fop.layout.BodyAreaContainer
 
getHalfLeading() - Method in class org.apache.fop.layout.BlockArea
 
getHeight() - Method in class org.apache.fop.layout.Area
 
getHeight() - Method in class org.apache.fop.layout.LineArea
 
getHeight() - Method in class org.apache.fop.layout.LinkedRectangle
 
getHeight() - Method in class org.apache.fop.layout.Page
 
getHeight() - Method in class org.apache.fop.layout.PageMaster
 
getIDList() - Method in class org.apache.fop.layout.Page
 
getIDReferences() - Method in class org.apache.fop.layout.Area
 
getIDReferences() - Method in class org.apache.fop.layout.AreaTree
 
getIDReferences() - Method in class org.apache.fop.layout.BodyAreaContainer
 
getItalicAngle() - Method in interface org.apache.fop.layout.FontDescriptor
 
getLastChar() - Method in interface org.apache.fop.layout.FontMetric
 
getLineArea() - Method in class org.apache.fop.layout.LinkedRectangle
 
getLinkSets() - Method in class org.apache.fop.layout.Page
 
getLinkType() - Method in class org.apache.fop.layout.LinkSet
 
getMainReferenceArea() - Method in class org.apache.fop.layout.BodyAreaContainer
 
getMaxContentHeight() - Method in class org.apache.fop.layout.SpanArea
 
getMaxHeight() - Method in class org.apache.fop.layout.Area
 
getMetricsFor(java.lang.String,java.lang.String,java.lang.String) - Method in class org.apache.fop.layout.FontInfo
 
getMetricsFor(java.lang.String) - Method in class org.apache.fop.layout.FontInfo
 
getNextArea(org.apache.fop.fo.FObj) - Method in class org.apache.fop.layout.BodyAreaContainer
 
getNumber() - Method in class org.apache.fop.layout.Page
 
getPaddingBottom() - Method in class org.apache.fop.layout.Area
 
getPaddingLeft() - Method in class org.apache.fop.layout.Area
 
getPaddingRight() - Method in class org.apache.fop.layout.Area
 
getPaddingTop() - Method in class org.apache.fop.layout.Area
 
getPage() - Method in class org.apache.fop.layout.Area
 
getPages() - Method in class org.apache.fop.layout.AreaTree
 
getParent() - Method in class org.apache.fop.layout.Area
 
getPendingAreas() - Method in class org.apache.fop.layout.LineArea
 
getPendingFootnotes() - Method in class org.apache.fop.layout.Page
 
getPendingWidth() - Method in class org.apache.fop.layout.LineArea
 
getPlacementOffset() - Method in class org.apache.fop.layout.LineArea
 
getPosition() - Method in class org.apache.fop.layout.AreaContainer
 
getPosition() - Method in class org.apache.fop.layout.BodyAreaContainer
 
getRectangle() - Method in class org.apache.fop.layout.LinkedRectangle
 
getRects() - Method in class org.apache.fop.layout.LinkSet
 
getRemainingHeight() - Method in class org.apache.fop.layout.BodyAreaContainer
Determine remaining height for new span area.
getSize() - Method in class org.apache.fop.layout.DisplaySpace
 
getStartIndent() - Method in class org.apache.fop.layout.BlockArea
 
getStartIndent() - Method in class org.apache.fop.layout.LineArea
 
getStartIndent() - Method in class org.apache.fop.layout.LinkSet
 
getStemV() - Method in interface org.apache.fop.layout.FontDescriptor
 
getTableCellXOffset() - Method in class org.apache.fop.layout.Area
 
getTotalContentHeight() - Method in class org.apache.fop.layout.SpanArea
 
getWidth() - Method in class org.apache.fop.layout.LinkedRectangle
 
getWidth() - Method in class org.apache.fop.layout.Page
 
getWidth() - Method in class org.apache.fop.layout.PageMaster
 
getWidths(int) - Method in interface org.apache.fop.layout.FontMetric
 
getX() - Method in class org.apache.fop.layout.LinkedRectangle
 
getXHeight() - Method in class org.apache.fop.layout.FontState
 
getXHeight(int) - Method in interface org.apache.fop.layout.FontMetric
 
getXPosition() - Method in class org.apache.fop.layout.AreaContainer
 
getXPosition() - Method in class org.apache.fop.layout.BodyAreaContainer
 
getY() - Method in class org.apache.fop.layout.LinkedRectangle
 
getYPosition() - Method in class org.apache.fop.layout.AreaContainer
 
getYPosition() - Method in class org.apache.fop.layout.BodyAreaContainer
 

H

hasLinks() - Method in class org.apache.fop.layout.Page
 

I

idReferences - Variable in class org.apache.fop.layout.AreaTree
 
increaseAbsoluteHeight(int) - Method in class org.apache.fop.layout.Area
 
increaseHeight(int) - Method in class org.apache.fop.layout.Area
 
incrementSpanIndex() - Method in class org.apache.fop.layout.ColumnArea
 
INTERNAL - Static variable in class org.apache.fop.layout.LinkSet
 
isBalanced() - Method in class org.apache.fop.layout.SpanArea
 
isBalancingRequired(org.apache.fop.fo.FObj) - Method in class org.apache.fop.layout.BodyAreaContainer
This almost does what getNewArea() does, without actually -returning an area.
isEmpty() - Method in class org.apache.fop.layout.LineArea
 
isLastColumn() - Method in class org.apache.fop.layout.BodyAreaContainer
Used in Flow when layout returns incomplete.
isLastColumn() - Method in class org.apache.fop.layout.SpanArea
 
isNewSpanArea() - Method in class org.apache.fop.layout.BodyAreaContainer
This variable is unset by getNextArea(), is set by addSpanArea(), -and may be set by resetSpanArea().

L

layout - Class Diagram in org.apache.fop.layout
 
LineArea - class org.apache.fop.layout.LineArea
 
LineArea(org.apache.fop.layout.FontState,int,int,int,int,int,org.apache.fop.layout.LineArea) - Constructor for class org.apache.fop.layout.LineArea
 
LinkedRectangle - class org.apache.fop.layout.LinkedRectangle
an object that stores a rectangle that is linked, and the LineArea -that it is logically associated with
LinkedRectangle(java.awt.Rectangle,org.apache.fop.layout.LineArea) - Constructor for class org.apache.fop.layout.LinkedRectangle
 
LinkedRectangle(org.apache.fop.layout.LinkedRectangle) - Constructor for class org.apache.fop.layout.LinkedRectangle
 
LinkSet - class org.apache.fop.layout.LinkSet
a set of rectangles on a page that are linked to a common -destination
LinkSet(java.lang.String,org.apache.fop.layout.Area,int) - Constructor for class org.apache.fop.layout.LinkSet
 

M

makeAreaContainer() - Method in class org.apache.fop.layout.RegionArea
 
makeBodyAreaContainer() - Method in class org.apache.fop.layout.BodyRegionArea
 
makePage(org.apache.fop.layout.AreaTree) - Method in class org.apache.fop.layout.PageMaster
 
mergeLinks() - Method in class org.apache.fop.layout.LinkSet
 

N

needsFootnoteAdjusting() - Method in class org.apache.fop.layout.BodyAreaContainer
 

O

org.apache.fop.layout - package org.apache.fop.layout
 

P

Page - class org.apache.fop.layout.Page
 
Page(org.apache.fop.layout.AreaTree,int,int) - Constructor for class org.apache.fop.layout.Page
 
pageList - Variable in class org.apache.fop.layout.AreaTree
 
PageMaster - class org.apache.fop.layout.PageMaster
 
PageMaster(int,int) - Constructor for class org.apache.fop.layout.PageMaster
 

R

rects - Variable in class org.apache.fop.layout.LinkSet
the set of rectangles
RegionArea - class org.apache.fop.layout.RegionArea
 
RegionArea(int,int,int,int) - Constructor for class org.apache.fop.layout.RegionArea
 
remove() - Method in class org.apache.fop.layout.Area
 
removeChild(org.apache.fop.layout.Area) - Method in class org.apache.fop.layout.Area
 
removeChild(org.apache.fop.layout.DisplaySpace) - Method in class org.apache.fop.layout.Area
 
render(org.apache.fop.render.Renderer) - Method in class org.apache.fop.layout.AreaContainer
 
render(org.apache.fop.render.Renderer) - Method in class org.apache.fop.layout.BlockArea
 
render(org.apache.fop.render.Renderer) - Method in class org.apache.fop.layout.BodyAreaContainer
 
render(org.apache.fop.render.Renderer) - Method in class org.apache.fop.layout.Box
 
render(org.apache.fop.render.Renderer) - Method in class org.apache.fop.layout.ColumnArea
 
render(org.apache.fop.render.Renderer) - Method in class org.apache.fop.layout.DisplaySpace
 
render(org.apache.fop.render.Renderer) - Method in class org.apache.fop.layout.LineArea
 
render(org.apache.fop.render.Renderer) - Method in class org.apache.fop.layout.Page
 
render(org.apache.fop.render.Renderer) - Method in class org.apache.fop.layout.SpanArea
 
resetSpanArea() - Method in class org.apache.fop.layout.BodyAreaContainer
This is where the balancing algorithm lives, or gets called.

S

setAbsoluteHeight(int) - Method in class org.apache.fop.layout.Area
 
setAllocationWidth(int) - Method in class org.apache.fop.layout.Area
 
setBackgroundColor(org.apache.fop.datatypes.ColorType) - Method in class org.apache.fop.layout.Area
 
setBackgroundColor(org.apache.fop.datatypes.ColorType) - Method in class org.apache.fop.layout.RegionArea
 
setBorderColor(org.apache.fop.datatypes.ColorType,org.apache.fop.datatypes.ColorType,org.apache.fop.datatypes.ColorType,org.apache.fop.datatypes.ColorType) - Method in class org.apache.fop.layout.Area
 
setBorderStyle(int,int,int,int) - Method in class org.apache.fop.layout.Area
 
setBorderWidth(int,int,int,int) - Method in class org.apache.fop.layout.Area
 
setColumnCount(int) - Method in class org.apache.fop.layout.BodyRegionArea
 
setColumnGap(int) - Method in class org.apache.fop.layout.BodyRegionArea
 
setColumnIndex(int) - Method in class org.apache.fop.layout.ColumnArea
 
setContentRectangleWidth(int) - Method in class org.apache.fop.layout.LinkSet
 
setCurrentColumn(int) - Method in class org.apache.fop.layout.SpanArea
 
setFontInfo(org.apache.fop.layout.FontInfo) - Method in class org.apache.fop.layout.AreaTree
 
setHeight(int) - Method in class org.apache.fop.layout.Area
 
setHeight(int) - Method in class org.apache.fop.layout.LinkedRectangle
 
setHyphenation(java.lang.String,java.lang.String,int,char,int,int) - Method in class org.apache.fop.layout.BlockArea
 
setIDReferences(org.apache.fop.datatypes.IDReferences) - Method in class org.apache.fop.layout.Area
 
setIDReferences(org.apache.fop.datatypes.IDReferences) - Method in class org.apache.fop.layout.BodyAreaContainer
 
setIndents(int,int) - Method in class org.apache.fop.layout.BlockArea
 
setIsBalanced() - Method in class org.apache.fop.layout.SpanArea
 
setLineArea() - Method in class org.apache.fop.layout.LinkedRectangle
 
setMaxHeight(int) - Method in class org.apache.fop.layout.Area
 
setNumber(int) - Method in class org.apache.fop.layout.Page
 
setPadding(int,int,int,int) - Method in class org.apache.fop.layout.Area
 
setPage(org.apache.fop.layout.Page) - Method in class org.apache.fop.layout.Area
 
setPage(org.apache.fop.layout.Page) - Method in class org.apache.fop.layout.SpanArea
 
setPendingAreas(java.util.Vector) - Method in class org.apache.fop.layout.LineArea
 
setPendingFootnotes(java.util.Vector) - Method in class org.apache.fop.layout.Page
 
setPendingWidth(int) - Method in class org.apache.fop.layout.LineArea
 
setRectangle(java.awt.Rectangle) - Method in class org.apache.fop.layout.LinkedRectangle
 
setTableCellXOffset(int) - Method in class org.apache.fop.layout.Area
 
setWidth(int) - Method in class org.apache.fop.layout.LinkedRectangle
 
setX(int) - Method in class org.apache.fop.layout.LinkedRectangle
 
setXOffset(int) - Method in class org.apache.fop.layout.LinkSet
 
setXPosition(int) - Method in class org.apache.fop.layout.AreaContainer
 
setXPosition(int) - Method in class org.apache.fop.layout.BodyAreaContainer
 
setY(int) - Method in class org.apache.fop.layout.LinkedRectangle
 
setYOffset(int) - Method in class org.apache.fop.layout.LinkSet
 
setYPosition(int) - Method in class org.apache.fop.layout.AreaContainer
 
setYPosition(int) - Method in class org.apache.fop.layout.BodyAreaContainer
 
Space - class org.apache.fop.layout.Space
 
spaceLeft() - Method in class org.apache.fop.layout.Area
 
spaceLeft() - Method in class org.apache.fop.layout.BlockArea
 
spaceLeft() - Method in class org.apache.fop.layout.ColumnArea
 
spaceLeft() - Method in class org.apache.fop.layout.SpanArea
 
SpanArea - class org.apache.fop.layout.SpanArea
 
SpanArea(org.apache.fop.layout.FontState,int,int,int,int,int,int) - Constructor for class org.apache.fop.layout.SpanArea
 
start() - Method in class org.apache.fop.layout.Area
 
start() - Method in class org.apache.fop.layout.BlockArea
 
start() - Method in class org.apache.fop.layout.ColumnArea
 
start() - Method in class org.apache.fop.layout.SpanArea
 

T

triplets - Variable in class org.apache.fop.layout.FontInfo
 

W

width(int,int) - Method in interface org.apache.fop.layout.FontMetric
return width (in 1/1000ths of point size) of character at -code point i
width(int) - Method in class org.apache.fop.layout.FontState
 
\ No newline at end of file diff --git a/docs/design/contrib/layout/index.html b/docs/design/contrib/layout/index.html deleted file mode 100755 index c214d84d0..000000000 --- a/docs/design/contrib/layout/index.html +++ /dev/null @@ -1,7 +0,0 @@ - - - - -<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.<BR>Link to <A HREF="overview-summary.html">Non-frame version.</A> \ No newline at end of file diff --git a/docs/design/contrib/layout/model-tree/false.gif b/docs/design/contrib/layout/model-tree/false.gif deleted file mode 100755 index 9941eeb0c..000000000 Binary files a/docs/design/contrib/layout/model-tree/false.gif and /dev/null differ diff --git a/docs/design/contrib/layout/model-tree/model.tree b/docs/design/contrib/layout/model-tree/model.tree deleted file mode 100755 index dbb009877..000000000 --- a/docs/design/contrib/layout/model-tree/model.tree +++ /dev/null @@ -1,45 +0,0 @@ -node2 > NAME = Area, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/Area.html->classFrame; -node3 > NAME = AreaContainer, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/AreaContainer.html->classFrame; -node4 > NAME = AreaTree, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/AreaTree.html->classFrame; -node5 > NAME = BlockArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/BlockArea.html->classFrame; -node6 > NAME = BodyAreaContainer, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/BodyAreaContainer.html->classFrame; -node7 > NAME = BodyRegionArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/BodyRegionArea.html->classFrame; -node8 > NAME = Box, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/Box.html->classFrame; -node9 > NAME = ColumnArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/ColumnArea.html->classFrame; -node10 > NAME = DisplaySpace, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/DisplaySpace.html->classFrame; -node11 > NAME = FontDescriptor, IMG = model-tree/tv-interface.gif, REF = org/apache/fop/layout/FontDescriptor.html->classFrame; -node12 > NAME = FontInfo, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/FontInfo.html->classFrame; -node13 > NAME = FontMetric, IMG = model-tree/tv-interface.gif, REF = org/apache/fop/layout/FontMetric.html->classFrame; -node14 > NAME = FontState, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/FontState.html->classFrame; -node15 > NAME = LineArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/LineArea.html->classFrame; -node16 > NAME = LinkedRectangle, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/LinkedRectangle.html->classFrame; -node17 > NAME = LinkSet, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/LinkSet.html->classFrame; -node18 > NAME = Page, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/Page.html->classFrame; -node19 > NAME = PageMaster, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/PageMaster.html->classFrame; -node20 > NAME = RegionArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/RegionArea.html->classFrame; -node21 > NAME = Space, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/Space.html->classFrame; -node22 > NAME = SpanArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/SpanArea.html->classFrame; -node1 > NAME = layout, IMG = model-tree/tv-physical-package.gif, REF = org/apache/fop/layout/layout.cl.html->classFrame, REF = org/apache/fop/layout/doc-files/layout.cl.html->imageFrame, CHILDS = node2:node3:node4:node5:node6:node7:node8:node9:node10:node11:node12:node13:node14:node15:node16:node17:node18:node19:node20:node21:node22; -node23 > NAME = Area, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/Area.html->classFrame; -node24 > NAME = AreaContainer, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/AreaContainer.html->classFrame; -node25 > NAME = AreaTree, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/AreaTree.html->classFrame; -node26 > NAME = BlockArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/BlockArea.html->classFrame; -node27 > NAME = BodyAreaContainer, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/BodyAreaContainer.html->classFrame; -node28 > NAME = BodyRegionArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/BodyRegionArea.html->classFrame; -node29 > NAME = Box, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/Box.html->classFrame; -node30 > NAME = ColumnArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/ColumnArea.html->classFrame; -node31 > NAME = DisplaySpace, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/DisplaySpace.html->classFrame; -node32 > NAME = FontInfo, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/FontInfo.html->classFrame; -node33 > NAME = FontState, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/FontState.html->classFrame; -node34 > NAME = LineArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/LineArea.html->classFrame; -node35 > NAME = LinkedRectangle, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/LinkedRectangle.html->classFrame; -node36 > NAME = LinkSet, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/LinkSet.html->classFrame; -node37 > NAME = Page, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/Page.html->classFrame; -node38 > NAME = PageMaster, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/PageMaster.html->classFrame; -node39 > NAME = RegionArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/RegionArea.html->classFrame; -node40 > NAME = Space, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/Space.html->classFrame; -node41 > NAME = SpanArea, IMG = model-tree/tv-class.gif, REF = org/apache/fop/layout/SpanArea.html->classFrame; -node42 > NAME = FontDescriptor, IMG = model-tree/tv-interface.gif, REF = org/apache/fop/layout/FontDescriptor.html->classFrame; -node43 > NAME = FontMetric, IMG = model-tree/tv-interface.gif, REF = org/apache/fop/layout/FontMetric.html->classFrame; -node0 > NAME = layout, IMG = model-tree/tv-pkg-diagram.gif, REF = org/apache/fop/layout/package-summary.html->classFrame, CHILDS = node1:node23:node24:node25:node26:node27:node28:node29:node30:node31:node32:node33:node34:node35:node36:node37:node38:node39:node40:node41:node42:node43; -ROOT > CHILDS = node0 \ No newline at end of file diff --git a/docs/design/contrib/layout/model-tree/true.gif b/docs/design/contrib/layout/model-tree/true.gif deleted file mode 100755 index 724083a6e..000000000 Binary files a/docs/design/contrib/layout/model-tree/true.gif and /dev/null differ diff --git a/docs/design/contrib/layout/model-tree/tv-class.gif b/docs/design/contrib/layout/model-tree/tv-class.gif deleted file mode 100755 index cb8efc68f..000000000 Binary files a/docs/design/contrib/layout/model-tree/tv-class.gif and /dev/null differ diff --git a/docs/design/contrib/layout/model-tree/tv-interface.gif b/docs/design/contrib/layout/model-tree/tv-interface.gif deleted file mode 100755 index b996aebe8..000000000 Binary files a/docs/design/contrib/layout/model-tree/tv-interface.gif and /dev/null differ diff --git a/docs/design/contrib/layout/model-tree/tv-physical-package.gif b/docs/design/contrib/layout/model-tree/tv-physical-package.gif deleted file mode 100755 index 927555f08..000000000 Binary files a/docs/design/contrib/layout/model-tree/tv-physical-package.gif and /dev/null differ diff --git a/docs/design/contrib/layout/model-tree/tv-pkg-diagram.gif b/docs/design/contrib/layout/model-tree/tv-pkg-diagram.gif deleted file mode 100755 index 649e05bca..000000000 Binary files a/docs/design/contrib/layout/model-tree/tv-pkg-diagram.gif and /dev/null differ diff --git a/docs/design/contrib/layout/navigation.jar b/docs/design/contrib/layout/navigation.jar deleted file mode 100755 index 80a885ea0..000000000 Binary files a/docs/design/contrib/layout/navigation.jar and /dev/null differ diff --git a/docs/design/contrib/layout/org/apache/fop/layout/Area.html b/docs/design/contrib/layout/org/apache/fop/layout/Area.html deleted file mode 100755 index 8cab5fc07..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/Area.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.layout
Class Area

org.apache.fop.layout.Box
-  |
-  +--org.apache.fop.layout.Area
-
Direct Known Subclasses:
AreaContainer, BlockArea, BodyAreaContainer, LineArea
public abstract class Area
extends Box

Field Summary
 ColorTypeborderColorBottom
           
 ColorTypeborderColorLeft
           
 ColorTypeborderColorRight
           
 ColorTypeborderColorTop
           
 intborderStyleBottom
           
 intborderStyleLeft
           
 intborderStyleRight
           
 intborderStyleTop
           
 intborderWidthBottom
           
 intborderWidthLeft
           
 intborderWidthRight
           
 intborderWidthTop
           

Constructor Summary
Area(FontState fontState)
           
Area(FontState fontState, int allocationWidth, int maxHeight)
           

Method Summary
 voidaddChild(Box child)
           
 voidaddChildAtStart(Box child)
           
 voidaddDisplaySpace(int size)
           
 voidend()
           
 intgetAbsoluteHeight()
           
 intgetAllocationWidth()
           
 ColorTypegetBackgroundColor()
           
 VectorgetChildren()
           
 intgetContentHeight()
           
 intgetContentWidth()
           
 FontInfogetFontInfo()
           
 FontStategetFontState()
           
 intgetHeight()
           
 IDReferencesgetIDReferences()
           
 intgetMaxHeight()
           
 intgetPaddingBottom()
           
 intgetPaddingLeft()
           
 intgetPaddingRight()
           
 intgetPaddingTop()
           
 PagegetPage()
           
 AreagetParent()
           
 intgetTableCellXOffset()
           
 voidincreaseAbsoluteHeight(int value)
           
 voidincreaseHeight(int amount)
           
 voidremove()
           
 voidremoveChild(Area area)
           
 voidremoveChild(DisplaySpace spacer)
           
 voidsetAbsoluteHeight(int value)
           
 voidsetAllocationWidth(int w)
           
 voidsetBackgroundColor(ColorType bgColor)
           
 voidsetBorderColor(ColorType top, ColorType left, ColorType bottom, ColorType right)
           
 voidsetBorderStyle(int top, int left, int bottom, int right)
           
 voidsetBorderWidth(int top, int left, int bottom, int right)
           
 voidsetHeight(int height)
           
 voidsetIDReferences(IDReferences idReferences)
           
 voidsetMaxHeight(int height)
           
 voidsetPadding(int top, int left, int bottom, int right)
           
 voidsetPage(Page page)
           
 voidsetTableCellXOffset(int offset)
           
 intspaceLeft()
           
 voidstart()
           

Methods inherited from class org.apache.fop.layout.Box
render

Field Detail

borderColorBottom

public ColorType borderColorBottom

borderColorLeft

public ColorType borderColorLeft

borderColorRight

public ColorType borderColorRight

borderColorTop

public ColorType borderColorTop

borderStyleBottom

public int borderStyleBottom

borderStyleLeft

public int borderStyleLeft

borderStyleRight

public int borderStyleRight

borderStyleTop

public int borderStyleTop

borderWidthBottom

public int borderWidthBottom

borderWidthLeft

public int borderWidthLeft

borderWidthRight

public int borderWidthRight

borderWidthTop

public int borderWidthTop
Constructor Detail

Area

public Area(FontState fontState)

Area

public Area(FontState fontState, int allocationWidth, int maxHeight)
Method Detail

addChild

public void addChild(Box child)

addChildAtStart

public void addChildAtStart(Box child)

addDisplaySpace

public void addDisplaySpace(int size)

end

public void end()

getAbsoluteHeight

public int getAbsoluteHeight()

getAllocationWidth

public int getAllocationWidth()

getBackgroundColor

public ColorType getBackgroundColor()

getChildren

public Vector getChildren()

getContentHeight

public int getContentHeight()

getContentWidth

public int getContentWidth()

getFontInfo

public FontInfo getFontInfo()

getFontState

public FontState getFontState()

getHeight

public int getHeight()

getIDReferences

public IDReferences getIDReferences()

getMaxHeight

public int getMaxHeight()

getPaddingBottom

public int getPaddingBottom()

getPaddingLeft

public int getPaddingLeft()

getPaddingRight

public int getPaddingRight()

getPaddingTop

public int getPaddingTop()

getPage

public Page getPage()

getParent

public Area getParent()

getTableCellXOffset

public int getTableCellXOffset()

increaseAbsoluteHeight

public void increaseAbsoluteHeight(int value)

increaseHeight

public void increaseHeight(int amount)

remove

public void remove()

removeChild

public void removeChild(Area area)

removeChild

public void removeChild(DisplaySpace spacer)

setAbsoluteHeight

public void setAbsoluteHeight(int value)

setAllocationWidth

public void setAllocationWidth(int w)

setBackgroundColor

public void setBackgroundColor(ColorType bgColor)

setBorderColor

public void setBorderColor(ColorType top, ColorType left, ColorType bottom, ColorType right)

setBorderStyle

public void setBorderStyle(int top, int left, int bottom, int right)

setBorderWidth

public void setBorderWidth(int top, int left, int bottom, int right)

setHeight

public void setHeight(int height)

setIDReferences

public void setIDReferences(IDReferences idReferences)

setMaxHeight

public void setMaxHeight(int height)

setPadding

public void setPadding(int top, int left, int bottom, int right)

setPage

public void setPage(Page page)

setTableCellXOffset

public void setTableCellXOffset(int offset)

spaceLeft

public int spaceLeft()

start

public void start()

Association Links

to Class org.apache.fop.layout.FontState

to Class java.util.Vector

to Class org.apache.fop.layout.Page

to Class org.apache.fop.datatypes.ColorType

to Class org.apache.fop.datatypes.IDReferences

to Class org.apache.fop.datatypes.ColorType

to Class org.apache.fop.datatypes.ColorType

to Class org.apache.fop.datatypes.ColorType

to Class org.apache.fop.datatypes.ColorType

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/AreaContainer.html b/docs/design/contrib/layout/org/apache/fop/layout/AreaContainer.html deleted file mode 100755 index db8464cf3..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/AreaContainer.html +++ /dev/null @@ -1,6 +0,0 @@ -

org.apache.fop.layout
Class AreaContainer

org.apache.fop.layout.Box
-  |
-  +--org.apache.fop.layout.Area
-        |
-        +--org.apache.fop.layout.AreaContainer
-
Direct Known Subclasses:
ColumnArea, SpanArea
public class AreaContainer
extends Area

Fields inherited from class org.apache.fop.layout.Area
borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderStyleBottom, borderStyleLeft, borderStyleRight, borderStyleTop, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop

Constructor Summary
AreaContainer(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int position)
           

Method Summary
 intgetCurrentYPosition()
           
 intgetPosition()
           
 intgetXPosition()
           
 intgetYPosition()
           
 voidrender(Renderer renderer)
           
 voidsetXPosition(int value)
           
 voidsetYPosition(int value)
           

Methods inherited from class org.apache.fop.layout.Area
addChild, addChildAtStart, addDisplaySpace, end, getAbsoluteHeight, getAllocationWidth, getBackgroundColor, getChildren, getContentHeight, getContentWidth, getFontInfo, getFontState, getHeight, getIDReferences, getMaxHeight, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPage, getParent, getTableCellXOffset, increaseAbsoluteHeight, increaseHeight, remove, removeChild, removeChild, setAbsoluteHeight, setAllocationWidth, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setHeight, setIDReferences, setMaxHeight, setPadding, setPage, setTableCellXOffset, spaceLeft, start

Constructor Detail

AreaContainer

public AreaContainer(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int position)
Method Detail

getCurrentYPosition

public int getCurrentYPosition()

getPosition

public int getPosition()

getXPosition

public int getXPosition()

getYPosition

public int getYPosition()

render

public void render(Renderer renderer)

setXPosition

public void setXPosition(int value)

setYPosition

public void setYPosition(int value)
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/AreaTree.html b/docs/design/contrib/layout/org/apache/fop/layout/AreaTree.html deleted file mode 100755 index 1039cf03a..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/AreaTree.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.layout
Class AreaTree

public class AreaTree

Field Summary
 (package private) FontInfofontInfo
          object containing information on available fonts, including -metrics
 (package private) IDReferencesidReferences
           
 (package private) VectorpageList
           

Method Summary
 voidaddPage(Page page)
           
 FontInfogetFontInfo()
           
 IDReferencesgetIDReferences()
           
 VectorgetPages()
           
 voidsetFontInfo(FontInfo fontInfo)
           

Field Detail

fontInfo

FontInfo fontInfo
object containing information on available fonts, including -metrics

idReferences

IDReferences idReferences

pageList

Vector pageList
Method Detail

addPage

public void addPage(Page page)

getFontInfo

public FontInfo getFontInfo()

getIDReferences

public IDReferences getIDReferences()

getPages

public Vector getPages()

setFontInfo

public void setFontInfo(FontInfo fontInfo)

Association Links

to Class org.apache.fop.layout.FontInfo

object containing information on available fonts, including -metrics

to Class java.util.Vector

to Class org.apache.fop.datatypes.IDReferences

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/BlockArea.html b/docs/design/contrib/layout/org/apache/fop/layout/BlockArea.html deleted file mode 100755 index 5bdeb15e6..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/BlockArea.html +++ /dev/null @@ -1,8 +0,0 @@ -

org.apache.fop.layout
Class BlockArea

org.apache.fop.layout.Box
-  |
-  +--org.apache.fop.layout.Area
-        |
-        +--org.apache.fop.layout.BlockArea
-
public class BlockArea
extends Area

Fields inherited from class org.apache.fop.layout.Area
borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderStyleBottom, borderStyleLeft, borderStyleRight, borderStyleTop, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop

Constructor Summary
BlockArea(FontState fontState, int allocationWidth, int maxHeight, int startIndent, int endIndent, int textIndent, int align, int alignLastLine, int lineHeight)
           

Method Summary
 voidaddCharacter(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, char data, boolean ul)
           
 voidaddFootnote(FootnoteBody fb)
           
 intaddLeader(FontState fontState, float red, float green, float blue, int leaderPattern, int leaderLengthMinimum, int leaderLengthOptimum, int leaderLengthMaximum, int ruleThickness, int ruleStyle, int leaderPatternWidth, int leaderAlignment)
          adds a leader to current line area of containing block area -the actual leader area is created in the line area
 voidaddLineArea(LineArea la)
           
 intaddPageNumberCitation(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, String refid)
           
 intaddText(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, char[] data, int start, int end, boolean ul)
           
 voidend()
           
 intgetEndIndent()
           
 intgetHalfLeading()
           
 intgetStartIndent()
           
 voidrender(Renderer renderer)
           
 voidsetHyphenation(String language, String country, int hyphenate, char hyphenationChar, int hyphenationPushCharacterCount, int hyphenationRemainCharacterCount)
           
 voidsetIndents(int startIndent, int endIndent)
           
 intspaceLeft()
           
 voidstart()
           

Methods inherited from class org.apache.fop.layout.Area
addChild, addChildAtStart, addDisplaySpace, getAbsoluteHeight, getAllocationWidth, getBackgroundColor, getChildren, getContentHeight, getContentWidth, getFontInfo, getFontState, getHeight, getIDReferences, getMaxHeight, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPage, getParent, getTableCellXOffset, increaseAbsoluteHeight, increaseHeight, remove, removeChild, removeChild, setAbsoluteHeight, setAllocationWidth, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setHeight, setIDReferences, setMaxHeight, setPadding, setPage, setTableCellXOffset

Constructor Detail

BlockArea

public BlockArea(FontState fontState, int allocationWidth, int maxHeight, int startIndent, int endIndent, int textIndent, int align, int alignLastLine, int lineHeight)
Method Detail

addCharacter

public void addCharacter(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, char data, boolean ul)

addFootnote

public void addFootnote(FootnoteBody fb)

addLeader

public int addLeader(FontState fontState, float red, float green, float blue, int leaderPattern, int leaderLengthMinimum, int leaderLengthOptimum, int leaderLengthMaximum, int ruleThickness, int ruleStyle, int leaderPatternWidth, int leaderAlignment)
adds a leader to current line area of containing block area -the actual leader area is created in the line area
Returns: int +1 for success and -1 for none

addLineArea

public void addLineArea(LineArea la)

addPageNumberCitation

public int addPageNumberCitation(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, String refid)

addText

public int addText(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, char[] data, int start, int end, boolean ul)

end

public void end()

getEndIndent

public int getEndIndent()

getHalfLeading

public int getHalfLeading()

getStartIndent

public int getStartIndent()

render

public void render(Renderer renderer)

setHyphenation

public void setHyphenation(String language, String country, int hyphenate, char hyphenationChar, int hyphenationPushCharacterCount, int hyphenationRemainCharacterCount)

setIndents

public void setIndents(int startIndent, int endIndent)

spaceLeft

public int spaceLeft()

start

public void start()

Association Links

to Class org.apache.fop.layout.LineArea

to Class org.apache.fop.layout.LinkSet

to Class java.lang.String

to Class java.lang.String

to Class java.util.Vector

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/BodyAreaContainer.html b/docs/design/contrib/layout/org/apache/fop/layout/BodyAreaContainer.html deleted file mode 100755 index 26094740b..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/BodyAreaContainer.html +++ /dev/null @@ -1,17 +0,0 @@ -

org.apache.fop.layout
Class BodyAreaContainer

org.apache.fop.layout.Box
-  |
-  +--org.apache.fop.layout.Area
-        |
-        +--org.apache.fop.layout.BodyAreaContainer
-
public class BodyAreaContainer
extends Area

Fields inherited from class org.apache.fop.layout.Area
borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderStyleBottom, borderStyleLeft, borderStyleRight, borderStyleTop, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop

Constructor Summary
BodyAreaContainer(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int position, int columnCount, int columnGap)
           

Method Summary
 voidadjustFootnoteArea()
           
 AreaContainergetBeforeFloatReferenceArea()
           
 AreaContainergetCurrentColumnArea()
           
 AreaContainergetFootnoteReferenceArea()
           
 intgetFootnoteState()
           
 IDReferencesgetIDReferences()
           
 AreaContainergetMainReferenceArea()
           
 AreaContainergetNextArea(FObj fo)
           
 intgetPosition()
           
 intgetRemainingHeight()
          Determine remaining height for new span area.
 intgetXPosition()
           
 intgetYPosition()
           
 booleanisBalancingRequired(FObj fo)
          This almost does what getNewArea() does, without actually -returning an area.
 booleanisLastColumn()
          Used in Flow when layout returns incomplete.
 booleanisNewSpanArea()
          This variable is unset by getNextArea(), is set by addSpanArea(), -and may be set by resetSpanArea().
 booleanneedsFootnoteAdjusting()
           
 voidrender(Renderer renderer)
           
 voidresetSpanArea()
          This is where the balancing algorithm lives, or gets called.
 voidsetIDReferences(IDReferences idReferences)
           
 voidsetXPosition(int value)
           
 voidsetYPosition(int value)
           

Methods inherited from class org.apache.fop.layout.Area
addChild, addChildAtStart, addDisplaySpace, end, getAbsoluteHeight, getAllocationWidth, getBackgroundColor, getChildren, getContentHeight, getContentWidth, getFontInfo, getFontState, getHeight, getMaxHeight, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPage, getParent, getTableCellXOffset, increaseAbsoluteHeight, increaseHeight, remove, removeChild, removeChild, setAbsoluteHeight, setAllocationWidth, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setHeight, setMaxHeight, setPadding, setPage, setTableCellXOffset, spaceLeft, start

Constructor Detail

BodyAreaContainer

public BodyAreaContainer(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int position, int columnCount, int columnGap)
Method Detail

adjustFootnoteArea

public void adjustFootnoteArea()

getBeforeFloatReferenceArea

public AreaContainer getBeforeFloatReferenceArea()

getCurrentColumnArea

public AreaContainer getCurrentColumnArea()

getFootnoteReferenceArea

public AreaContainer getFootnoteReferenceArea()

getFootnoteState

public int getFootnoteState()

getIDReferences

public IDReferences getIDReferences()

getMainReferenceArea

public AreaContainer getMainReferenceArea()

getNextArea

public AreaContainer getNextArea(FObj fo)
                           throws org.apache.fop.apps.FOPException

getPosition

public int getPosition()

getRemainingHeight

public int getRemainingHeight()
Determine remaining height for new span area. Needs to be -modified for footnote and before-float reference areas when -those are supported.
returns int The remaining available height in millipoints.

getXPosition

public int getXPosition()

getYPosition

public int getYPosition()

isBalancingRequired

public boolean isBalancingRequired(FObj fo)
This almost does what getNewArea() does, without actually -returning an area. These 2 methods can be reworked.
Parameters:
fo - The next formatting object
returns boolean True if we need to balance.

isLastColumn

public boolean isLastColumn()
Used in Flow when layout returns incomplete.
returns boolean Is this the last column in this span?

isNewSpanArea

public boolean isNewSpanArea()
This variable is unset by getNextArea(), is set by addSpanArea(), -and may be set by resetSpanArea().
returns boolean Is the span area new or not?

needsFootnoteAdjusting

public boolean needsFootnoteAdjusting()

render

public void render(Renderer renderer)

resetSpanArea

public void resetSpanArea()
This is where the balancing algorithm lives, or gets called. -Right now it's primitive: get the total content height in all -columns, divide by the column count, and add a heuristic -safety factor. -Then the previous (unbalanced) span area is removed, and a new -one added with the computed max height.

setIDReferences

public void setIDReferences(IDReferences idReferences)

setXPosition

public void setXPosition(int value)

setYPosition

public void setYPosition(int value)

Association Links

to Class org.apache.fop.layout.AreaContainer

to Class org.apache.fop.layout.AreaContainer

to Class org.apache.fop.layout.AreaContainer

to Class org.apache.fop.fo.FObj

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/BodyRegionArea.html b/docs/design/contrib/layout/org/apache/fop/layout/BodyRegionArea.html deleted file mode 100755 index 9c05a75f8..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/BodyRegionArea.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.layout
Class BodyRegionArea

org.apache.fop.layout.RegionArea
-  |
-  +--org.apache.fop.layout.BodyRegionArea
-
public class BodyRegionArea
extends RegionArea

Constructor Summary
BodyRegionArea(int xPosition, int yPosition, int width, int height)
           

Method Summary
 intgetColumnCount()
           
 intgetColumnGap()
           
 BodyAreaContainermakeBodyAreaContainer()
           
 voidsetColumnCount(int columnCount)
           
 voidsetColumnGap(int columnGap)
           

Methods inherited from class org.apache.fop.layout.RegionArea
getBackgroundColor, makeAreaContainer, setBackgroundColor

Constructor Detail

BodyRegionArea

public BodyRegionArea(int xPosition, int yPosition, int width, int height)
Method Detail

getColumnCount

public int getColumnCount()

getColumnGap

public int getColumnGap()

makeBodyAreaContainer

public BodyAreaContainer makeBodyAreaContainer()

setColumnCount

public void setColumnCount(int columnCount)

setColumnGap

public void setColumnGap(int columnGap)
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/Box.html b/docs/design/contrib/layout/org/apache/fop/layout/Box.html deleted file mode 100755 index 3fd9332d6..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/Box.html +++ /dev/null @@ -1 +0,0 @@ -

org.apache.fop.layout
Class Box

Direct Known Subclasses:
Area, Space
public abstract class Box

Method Summary
 abstract voidrender(Renderer renderer)
           

Method Detail

render

public abstract void render(Renderer renderer)

Association Links

to Class org.apache.fop.layout.Area

to Class org.apache.fop.layout.AreaTree

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/ColumnArea.html b/docs/design/contrib/layout/org/apache/fop/layout/ColumnArea.html deleted file mode 100755 index 59897d345..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/ColumnArea.html +++ /dev/null @@ -1,8 +0,0 @@ -

org.apache.fop.layout
Class ColumnArea

org.apache.fop.layout.Box
-  |
-  +--org.apache.fop.layout.Area
-        |
-        +--org.apache.fop.layout.AreaContainer
-              |
-              +--org.apache.fop.layout.ColumnArea
-
public class ColumnArea
extends AreaContainer

Fields inherited from class org.apache.fop.layout.Area
borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderStyleBottom, borderStyleLeft, borderStyleRight, borderStyleTop, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop

Constructor Summary
ColumnArea(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int columnCount)
           

Method Summary
 voidend()
           
 intgetColumnIndex()
           
 voidincrementSpanIndex()
           
 voidrender(Renderer renderer)
           
 voidsetColumnIndex(int columnIndex)
           
 intspaceLeft()
           
 voidstart()
           

Methods inherited from class org.apache.fop.layout.AreaContainer
getCurrentYPosition, getPosition, getXPosition, getYPosition, setXPosition, setYPosition

Methods inherited from class org.apache.fop.layout.Area
addChild, addChildAtStart, addDisplaySpace, getAbsoluteHeight, getAllocationWidth, getBackgroundColor, getChildren, getContentHeight, getContentWidth, getFontInfo, getFontState, getHeight, getIDReferences, getMaxHeight, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPage, getParent, getTableCellXOffset, increaseAbsoluteHeight, increaseHeight, remove, removeChild, removeChild, setAbsoluteHeight, setAllocationWidth, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setHeight, setIDReferences, setMaxHeight, setPadding, setPage, setTableCellXOffset

Constructor Detail

ColumnArea

public ColumnArea(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int columnCount)
Method Detail

end

public void end()

getColumnIndex

public int getColumnIndex()

incrementSpanIndex

public void incrementSpanIndex()

render

public void render(Renderer renderer)

setColumnIndex

public void setColumnIndex(int columnIndex)

spaceLeft

public int spaceLeft()

start

public void start()
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/DisplaySpace.html b/docs/design/contrib/layout/org/apache/fop/layout/DisplaySpace.html deleted file mode 100755 index 843f0a723..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/DisplaySpace.html +++ /dev/null @@ -1,6 +0,0 @@ -

org.apache.fop.layout
Class DisplaySpace

org.apache.fop.layout.Box
-  |
-  +--org.apache.fop.layout.Space
-        |
-        +--org.apache.fop.layout.DisplaySpace
-
public class DisplaySpace
extends Space

Constructor Summary
DisplaySpace(int size)
           

Method Summary
 intgetSize()
           
 voidrender(Renderer renderer)
           

Constructor Detail

DisplaySpace

public DisplaySpace(int size)
Method Detail

getSize

public int getSize()

render

public void render(Renderer renderer)
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/FontDescriptor.html b/docs/design/contrib/layout/org/apache/fop/layout/FontDescriptor.html deleted file mode 100755 index 919bee975..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/FontDescriptor.html +++ /dev/null @@ -1 +0,0 @@ -

org.apache.fop.layout
Interface FontDescriptor

public interface FontDescriptor

Method Summary
 StringfontName()
           
 intgetAscender()
           
 intgetCapHeight()
           
 intgetDescender()
           
 intgetFlags()
           
 int[]getFontBBox()
           
 intgetItalicAngle()
           
 intgetStemV()
           

Method Detail

fontName

public String fontName()

getAscender

public int getAscender()

getCapHeight

public int getCapHeight()

getDescender

public int getDescender()

getFlags

public int getFlags()

getFontBBox

public int[] getFontBBox()

getItalicAngle

public int getItalicAngle()

getStemV

public int getStemV()
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/FontInfo.html b/docs/design/contrib/layout/org/apache/fop/layout/FontInfo.html deleted file mode 100755 index c75f1fa64..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/FontInfo.html +++ /dev/null @@ -1 +0,0 @@ -

org.apache.fop.layout
Class FontInfo

public class FontInfo

Field Summary
 (package private) Hashtablefonts
           
 (package private) Hashtabletriplets
           

Constructor Summary
FontInfo()
           

Method Summary
 voidaddFontProperties(String name, String family, String style, String weight)
           
 voidaddMetrics(String name, FontMetric metrics)
           
 StringfontLookup(String family, String style, String weight)
           
 HashtablegetFonts()
           
 FontMetricgetMetricsFor(String fontName)
           
 FontMetricgetMetricsFor(String family, String style, String weight)
           

Field Detail

fonts

Hashtable fonts

triplets

Hashtable triplets
Constructor Detail

FontInfo

public FontInfo()
Method Detail

addFontProperties

public void addFontProperties(String name, String family, String style, String weight)

addMetrics

public void addMetrics(String name, FontMetric metrics)

fontLookup

public String fontLookup(String family, String style, String weight)
                   throws org.apache.fop.apps.FOPException

getFonts

public Hashtable getFonts()

getMetricsFor

public FontMetric getMetricsFor(String fontName)
                          throws org.apache.fop.apps.FOPException

getMetricsFor

public FontMetric getMetricsFor(String family, String style, String weight)
                          throws org.apache.fop.apps.FOPException

Association Links

to Class java.util.Hashtable

to Class java.util.Hashtable

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/FontMetric.html b/docs/design/contrib/layout/org/apache/fop/layout/FontMetric.html deleted file mode 100755 index c289f3528..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/FontMetric.html +++ /dev/null @@ -1,3 +0,0 @@ -

org.apache.fop.layout
Interface FontMetric

public interface FontMetric

interface for font metric classes

Method Summary
 intgetAscender(int size)
           
 intgetCapHeight(int size)
           
 intgetDescender(int size)
           
 intgetFirstChar()
           
 intgetLastChar()
           
 int[]getWidths(int size)
           
 intgetXHeight(int size)
           
 intwidth(int i, int size)
          return width (in 1/1000ths of point size) of character at -code point i

Method Detail

getAscender

public int getAscender(int size)

getCapHeight

public int getCapHeight(int size)

getDescender

public int getDescender(int size)

getFirstChar

public int getFirstChar()

getLastChar

public int getLastChar()

getWidths

public int[] getWidths(int size)

getXHeight

public int getXHeight(int size)

width

public int width(int i, int size)
return width (in 1/1000ths of point size) of character at -code point i
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/FontState.html b/docs/design/contrib/layout/org/apache/fop/layout/FontState.html deleted file mode 100755 index 228c6eb80..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/FontState.html +++ /dev/null @@ -1 +0,0 @@ -

org.apache.fop.layout
Class FontState

public class FontState

Constructor Summary
FontState(FontInfo fontInfo, String fontFamily, String fontStyle, String fontWeight, int fontSize)
           
FontState(FontInfo fontInfo, String fontFamily, String fontStyle, String fontWeight, int fontSize, int fontVariant)
           

Method Summary
 intgetAscender()
           
 intgetCapHeight()
           
 intgetDescender()
           
 StringgetFontFamily()
           
 FontInfogetFontInfo()
           
 StringgetFontName()
           
 intgetFontSize()
           
 StringgetFontStyle()
           
 intgetFontVariant()
           
 StringgetFontWeight()
           
 intgetXHeight()
           
 intwidth(int charnum)
           

Constructor Detail

FontState

public FontState(FontInfo fontInfo, String fontFamily, String fontStyle, String fontWeight, int fontSize)
            throws org.apache.fop.apps.FOPException

FontState

public FontState(FontInfo fontInfo, String fontFamily, String fontStyle, String fontWeight, int fontSize, int fontVariant)
            throws org.apache.fop.apps.FOPException
Method Detail

getAscender

public int getAscender()

getCapHeight

public int getCapHeight()

getDescender

public int getDescender()

getFontFamily

public String getFontFamily()

getFontInfo

public FontInfo getFontInfo()

getFontName

public String getFontName()

getFontSize

public int getFontSize()

getFontStyle

public String getFontStyle()

getFontVariant

public int getFontVariant()

getFontWeight

public String getFontWeight()

getXHeight

public int getXHeight()

width

public int width(int charnum)

Association Links

to Class org.apache.fop.layout.FontInfo

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class org.apache.fop.layout.FontMetric

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/LineArea.html b/docs/design/contrib/layout/org/apache/fop/layout/LineArea.html deleted file mode 100755 index e2bae4dd7..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/LineArea.html +++ /dev/null @@ -1,19 +0,0 @@ -

org.apache.fop.layout
Class LineArea

org.apache.fop.layout.Box
-  |
-  +--org.apache.fop.layout.Area
-        |
-        +--org.apache.fop.layout.LineArea
-
public class LineArea
extends Area

Fields inherited from class org.apache.fop.layout.Area
borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderStyleBottom, borderStyleLeft, borderStyleRight, borderStyleTop, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop

Constructor Summary
LineArea(FontState fontState, int lineHeight, int halfLeading, int allocationWidth, int startIndent, int endIndent, LineArea prevLineArea)
           

Method Summary
 intaddCharacter(char data, LinkSet ls, boolean ul)
          adds a single character to the line area tree
 voidaddLeader(int leaderPattern, int leaderLengthMinimum, int leaderLengthOptimum, int leaderLengthMaximum, int ruleStyle, int ruleThickness, int leaderPatternWidth, int leaderAlignment)
          adds a Leader; actually the method receives the leader properties -and creates a leader area or an inline area which is appended to -the children of the containing line area.
 intaddPageNumberCitation(String refid, LinkSet ls)
           
 voidaddPending()
          adds pending inline areas to the line area -normally done, when the line area is filled and -added as child to the parent block area
 intaddText(char[] odata, int start, int end, LinkSet ls, boolean ul)
          adds text to line area
 voidalign(int type)
          aligns line area
 voidchangeColor(float red, float green, float blue)
           
 voidchangeFont(FontState fontState)
           
 voidchangeHyphenation(String language, String country, int hyphenate, char hyphenationChar, int hyphenationPushCharacterCount, int hyphenationRemainCharacterCount)
          sets hyphenation related traits: language, country, hyphenate, hyphenation-character -and minimum number of character to remain one the previous line and to be on the -next line.
 voidchangeWhiteSpaceCollapse(int whiteSpaceCollapse)
           
 voidchangeWrapOption(int wrapOption)
           
 intgetEndIndent()
           
 intgetHeight()
           
 VectorgetPendingAreas()
           
 intgetPendingWidth()
           
 intgetPlacementOffset()
           
 intgetStartIndent()
           
 booleanisEmpty()
           
 voidrender(Renderer renderer)
           
 voidsetPendingAreas(Vector areas)
           
 voidsetPendingWidth(int width)
           

Methods inherited from class org.apache.fop.layout.Area
addChild, addChildAtStart, addDisplaySpace, end, getAbsoluteHeight, getAllocationWidth, getBackgroundColor, getChildren, getContentHeight, getContentWidth, getFontInfo, getFontState, getIDReferences, getMaxHeight, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPage, getParent, getTableCellXOffset, increaseAbsoluteHeight, increaseHeight, remove, removeChild, removeChild, setAbsoluteHeight, setAllocationWidth, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setHeight, setIDReferences, setMaxHeight, setPadding, setPage, setTableCellXOffset, spaceLeft, start

Constructor Detail

LineArea

public LineArea(FontState fontState, int lineHeight, int halfLeading, int allocationWidth, int startIndent, int endIndent, LineArea prevLineArea)
Method Detail

addCharacter

public int addCharacter(char data, LinkSet ls, boolean ul)
adds a single character to the line area tree

addLeader

public void addLeader(int leaderPattern, int leaderLengthMinimum, int leaderLengthOptimum, int leaderLengthMaximum, int ruleStyle, int ruleThickness, int leaderPatternWidth, int leaderAlignment)
adds a Leader; actually the method receives the leader properties -and creates a leader area or an inline area which is appended to -the children of the containing line area.
-leader pattern use-content is not implemented.

addPageNumberCitation

public int addPageNumberCitation(String refid, LinkSet ls)

addPending

public void addPending()
adds pending inline areas to the line area -normally done, when the line area is filled and -added as child to the parent block area

addText

public int addText(char[] odata, int start, int end, LinkSet ls, boolean ul)
adds text to line area
Returns: int character position

align

public void align(int type)
aligns line area

changeColor

public void changeColor(float red, float green, float blue)

changeFont

public void changeFont(FontState fontState)

changeHyphenation

public void changeHyphenation(String language, String country, int hyphenate, char hyphenationChar, int hyphenationPushCharacterCount, int hyphenationRemainCharacterCount)
sets hyphenation related traits: language, country, hyphenate, hyphenation-character -and minimum number of character to remain one the previous line and to be on the -next line.

changeWhiteSpaceCollapse

public void changeWhiteSpaceCollapse(int whiteSpaceCollapse)

changeWrapOption

public void changeWrapOption(int wrapOption)

getEndIndent

public int getEndIndent()

getHeight

public int getHeight()

getPendingAreas

public Vector getPendingAreas()

getPendingWidth

public int getPendingWidth()

getPlacementOffset

public int getPlacementOffset()

getStartIndent

public int getStartIndent()

isEmpty

public boolean isEmpty()

render

public void render(Renderer renderer)

setPendingAreas

public void setPendingAreas(Vector areas)

setPendingWidth

public void setPendingWidth(int width)

Association Links

to Class org.apache.fop.layout.FontState

to Class java.lang.String

to Class java.lang.String

to Class java.util.Vector

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/LinkSet.html b/docs/design/contrib/layout/org/apache/fop/layout/LinkSet.html deleted file mode 100755 index 58d851508..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/LinkSet.html +++ /dev/null @@ -1,2 +0,0 @@ -

org.apache.fop.layout
Class LinkSet

public class LinkSet

a set of rectangles on a page that are linked to a common -destination

Field Summary
 (package private) intcontentRectangleWidth
           
 (package private) Stringdestination
          the destination of the links
 final static intEXTERNAL
           
 final static intINTERNAL
           
 (package private) Vectorrects
          the set of rectangles

Constructor Summary
LinkSet(String destination, Area area, int linkType)
           

Method Summary
 voidaddRect(Rectangle r, LineArea lineArea)
           
 voidalign()
           
 voidapplyAreaContainerOffsets(AreaContainer ac, Area area)
           
 AreagetArea()
           
 StringgetDest()
           
 intgetEndIndent()
           
 intgetLinkType()
           
 VectorgetRects()
           
 intgetStartIndent()
           
 voidmergeLinks()
           
 voidsetContentRectangleWidth(int contentRectangleWidth)
           
 voidsetXOffset(int x)
           
 voidsetYOffset(int y)
           

Field Detail

contentRectangleWidth

int contentRectangleWidth

destination

String destination
the destination of the links

EXTERNAL

public final static int EXTERNAL

INTERNAL

public final static int INTERNAL

rects

Vector rects
the set of rectangles
Constructor Detail

LinkSet

public LinkSet(String destination, Area area, int linkType)
Method Detail

addRect

public void addRect(Rectangle r, LineArea lineArea)

align

public void align()

applyAreaContainerOffsets

public void applyAreaContainerOffsets(AreaContainer ac, Area area)

getArea

public Area getArea()

getDest

public String getDest()

getEndIndent

public int getEndIndent()

getLinkType

public int getLinkType()

getRects

public Vector getRects()

getStartIndent

public int getStartIndent()

mergeLinks

public void mergeLinks()

setContentRectangleWidth

public void setContentRectangleWidth(int contentRectangleWidth)

setXOffset

public void setXOffset(int x)

setYOffset

public void setYOffset(int y)

Association Links

to Class java.lang.String

the destination of the links

to Class java.util.Vector

the set of rectangles

to Class org.apache.fop.layout.Area

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/LinkedRectangle.html b/docs/design/contrib/layout/org/apache/fop/layout/LinkedRectangle.html deleted file mode 100755 index 22958d7cc..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/LinkedRectangle.html +++ /dev/null @@ -1,2 +0,0 @@ -

org.apache.fop.layout
Class LinkedRectangle

public class LinkedRectangle

an object that stores a rectangle that is linked, and the LineArea -that it is logically associated with

Constructor Summary
LinkedRectangle(Rectangle link, LineArea lineArea)
           
LinkedRectangle(LinkedRectangle lr)
           

Method Summary
 intgetHeight()
           
 LineAreagetLineArea()
           
 RectanglegetRectangle()
           
 intgetWidth()
           
 intgetX()
           
 intgetY()
           
 voidsetHeight(int height)
           
 voidsetLineArea()
           
 voidsetRectangle(Rectangle link)
           
 voidsetWidth(int width)
           
 voidsetX(int x)
           
 voidsetY(int y)
           

Constructor Detail

LinkedRectangle

public LinkedRectangle(Rectangle link, LineArea lineArea)

LinkedRectangle

public LinkedRectangle(LinkedRectangle lr)
Method Detail

getHeight

public int getHeight()

getLineArea

public LineArea getLineArea()

getRectangle

public Rectangle getRectangle()

getWidth

public int getWidth()

getX

public int getX()

getY

public int getY()

setHeight

public void setHeight(int height)

setLineArea

public void setLineArea()

setRectangle

public void setRectangle(Rectangle link)

setWidth

public void setWidth(int width)

setX

public void setX(int x)

setY

public void setY(int y)

Association Links

to Class java.awt.Rectangle

the linked Rectangle

to Class org.apache.fop.layout.LineArea

the associated LineArea
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/Page.html b/docs/design/contrib/layout/org/apache/fop/layout/Page.html deleted file mode 100755 index 088f73dc4..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/Page.html +++ /dev/null @@ -1,2 +0,0 @@ -

org.apache.fop.layout
Class Page

public class Page

Constructor Summary
 (package private) Page(AreaTree areaTree, int height, int width)
           

Method Summary
 (package private) voidaddAfter(AreaContainer area)
           
 (package private) voidaddBefore(AreaContainer area)
           
 voidaddBody(BodyAreaContainer area)
          Ensure that page is set not only on B.A.C.
 (package private) voidaddEnd(AreaContainer area)
           
 voidaddLinkSet(LinkSet linkSet)
           
 voidaddPendingFootnote(FootnoteBody fb)
           
 (package private) voidaddStart(AreaContainer area)
           
 voidaddToIDList(String id)
           
 AreaContainergetAfter()
           
 AreaContainergetBefore()
           
 BodyAreaContainergetBody()
           
 FontInfogetFontInfo()
           
 intgetHeight()
           
 VectorgetIDList()
           
 VectorgetLinkSets()
           
 intgetNumber()
           
 VectorgetPendingFootnotes()
           
 intgetWidth()
           
 booleanhasLinks()
           
 voidrender(Renderer renderer)
           
 voidsetNumber(int number)
           
 voidsetPendingFootnotes(Vector v)
           

Constructor Detail

Page

Page(AreaTree areaTree, int height, int width)
Method Detail

addAfter

void addAfter(AreaContainer area)

addBefore

void addBefore(AreaContainer area)

addBody

public void addBody(BodyAreaContainer area)
Ensure that page is set not only on B.A.C. but also on the -three top-level reference areas.
Parameters:
area - The region-body area container (special)

addEnd

void addEnd(AreaContainer area)

addLinkSet

public void addLinkSet(LinkSet linkSet)

addPendingFootnote

public void addPendingFootnote(FootnoteBody fb)

addStart

void addStart(AreaContainer area)

addToIDList

public void addToIDList(String id)

getAfter

public AreaContainer getAfter()

getBefore

public AreaContainer getBefore()

getBody

public BodyAreaContainer getBody()

getFontInfo

public FontInfo getFontInfo()

getHeight

public int getHeight()

getIDList

public Vector getIDList()

getLinkSets

public Vector getLinkSets()

getNumber

public int getNumber()

getPendingFootnotes

public Vector getPendingFootnotes()

getWidth

public int getWidth()

hasLinks

public boolean hasLinks()

render

public void render(Renderer renderer)

setNumber

public void setNumber(int number)

setPendingFootnotes

public void setPendingFootnotes(Vector v)

Association Links

to Class org.apache.fop.layout.BodyAreaContainer

to Class org.apache.fop.layout.AreaContainer

to Class org.apache.fop.layout.AreaContainer

to Class org.apache.fop.layout.AreaContainer

to Class org.apache.fop.layout.AreaContainer

to Class org.apache.fop.layout.AreaTree

to Class java.util.Vector

to Class java.util.Vector

to Class java.util.Vector

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/PageMaster.html b/docs/design/contrib/layout/org/apache/fop/layout/PageMaster.html deleted file mode 100755 index 07c91ea1a..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/PageMaster.html +++ /dev/null @@ -1 +0,0 @@ -

org.apache.fop.layout
Class PageMaster

public class PageMaster

Constructor Summary
PageMaster(int pageWidth, int pageHeight)
           

Method Summary
 voidaddAfter(RegionArea region)
           
 voidaddBefore(RegionArea region)
           
 voidaddBody(BodyRegionArea region)
           
 voidaddEnd(RegionArea region)
           
 voidaddStart(RegionArea region)
           
 intgetHeight()
           
 intgetWidth()
           
 PagemakePage(AreaTree areaTree)
           

Constructor Detail

PageMaster

public PageMaster(int pageWidth, int pageHeight)
Method Detail

addAfter

public void addAfter(RegionArea region)

addBefore

public void addBefore(RegionArea region)

addBody

public void addBody(BodyRegionArea region)

addEnd

public void addEnd(RegionArea region)

addStart

public void addStart(RegionArea region)

getHeight

public int getHeight()

getWidth

public int getWidth()

makePage

public Page makePage(AreaTree areaTree)

Association Links

to Class org.apache.fop.layout.BodyRegionArea

to Class org.apache.fop.layout.RegionArea

to Class org.apache.fop.layout.RegionArea

to Class org.apache.fop.layout.RegionArea

to Class org.apache.fop.layout.RegionArea

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/RegionArea.html b/docs/design/contrib/layout/org/apache/fop/layout/RegionArea.html deleted file mode 100755 index 8fdf3f409..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/RegionArea.html +++ /dev/null @@ -1 +0,0 @@ -

org.apache.fop.layout
Class RegionArea

Direct Known Subclasses:
BodyRegionArea
public class RegionArea

Constructor Summary
RegionArea(int xPosition, int yPosition, int width, int height)
           

Method Summary
 ColorTypegetBackgroundColor()
           
 AreaContainermakeAreaContainer()
           
 voidsetBackgroundColor(ColorType bgColor)
           

Constructor Detail

RegionArea

public RegionArea(int xPosition, int yPosition, int width, int height)
Method Detail

getBackgroundColor

public ColorType getBackgroundColor()

makeAreaContainer

public AreaContainer makeAreaContainer()

setBackgroundColor

public void setBackgroundColor(ColorType bgColor)

Association Links

to Class org.apache.fop.datatypes.ColorType

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/Space.html b/docs/design/contrib/layout/org/apache/fop/layout/Space.html deleted file mode 100755 index a97356e72..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/Space.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.layout
Class Space

org.apache.fop.layout.Box
-  |
-  +--org.apache.fop.layout.Space
-
Direct Known Subclasses:
DisplaySpace
public abstract class Space
extends Box

Methods inherited from class org.apache.fop.layout.Box
render

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/SpanArea.html b/docs/design/contrib/layout/org/apache/fop/layout/SpanArea.html deleted file mode 100755 index ecac35421..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/SpanArea.html +++ /dev/null @@ -1,8 +0,0 @@ -

org.apache.fop.layout
Class SpanArea

org.apache.fop.layout.Box
-  |
-  +--org.apache.fop.layout.Area
-        |
-        +--org.apache.fop.layout.AreaContainer
-              |
-              +--org.apache.fop.layout.SpanArea
-
public class SpanArea
extends AreaContainer

Fields inherited from class org.apache.fop.layout.Area
borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderStyleBottom, borderStyleLeft, borderStyleRight, borderStyleTop, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop

Constructor Summary
SpanArea(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int columnCount, int columnGap)
           

Method Summary
 voidend()
           
 intgetColumnCount()
           
 intgetCurrentColumn()
           
 AreaContainergetCurrentColumnArea()
           
 intgetMaxContentHeight()
           
 intgetTotalContentHeight()
           
 booleanisBalanced()
           
 booleanisLastColumn()
           
 voidrender(Renderer renderer)
           
 voidsetCurrentColumn(int currentColumn)
           
 voidsetIsBalanced()
           
 voidsetPage(Page page)
           
 intspaceLeft()
           
 voidstart()
           

Methods inherited from class org.apache.fop.layout.AreaContainer
getCurrentYPosition, getPosition, getXPosition, getYPosition, setXPosition, setYPosition

Methods inherited from class org.apache.fop.layout.Area
addChild, addChildAtStart, addDisplaySpace, getAbsoluteHeight, getAllocationWidth, getBackgroundColor, getChildren, getContentHeight, getContentWidth, getFontInfo, getFontState, getHeight, getIDReferences, getMaxHeight, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPage, getParent, getTableCellXOffset, increaseAbsoluteHeight, increaseHeight, remove, removeChild, removeChild, setAbsoluteHeight, setAllocationWidth, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setHeight, setIDReferences, setMaxHeight, setPadding, setTableCellXOffset

Constructor Detail

SpanArea

public SpanArea(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int columnCount, int columnGap)
Method Detail

end

public void end()

getColumnCount

public int getColumnCount()

getCurrentColumn

public int getCurrentColumn()

getCurrentColumnArea

public AreaContainer getCurrentColumnArea()

getMaxContentHeight

public int getMaxContentHeight()

getTotalContentHeight

public int getTotalContentHeight()

isBalanced

public boolean isBalanced()

isLastColumn

public boolean isLastColumn()

render

public void render(Renderer renderer)

setCurrentColumn

public void setCurrentColumn(int currentColumn)

setIsBalanced

public void setIsBalanced()

setPage

public void setPage(Page page)

spaceLeft

public int spaceLeft()

start

public void start()
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/Area.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/Area.html deleted file mode 100755 index e1d06aabd..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/Area.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.Area

Packages that use Area
org.apache.fop.layout 

Uses of Area in org.apache.fop.layout
 

Subclasses of Area in org.apache.fop.layout
class AreaContainer
          
class BlockArea
          
class BodyAreaContainer
          
class LineArea
          
 

Constructors in org.apache.fop.layout with parameters of type Area
LinkSet.LinkSet(String destination, Area area, int linkType)
          
 

Methods in org.apache.fop.layout that return Area
AreaArea.getParent()
          
AreaLinkSet.getArea()
          
 

Methods in org.apache.fop.layout with parameters of type Area
voidArea.removeChild(Area area)
          
voidLinkSet.applyAreaContainerOffsets(AreaContainer ac, Area area)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/AreaContainer.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/AreaContainer.html deleted file mode 100755 index 2855a7d56..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/AreaContainer.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.AreaContainer

Packages that use AreaContainer
org.apache.fop.layout 

Uses of AreaContainer in org.apache.fop.layout
 

Subclasses of AreaContainer in org.apache.fop.layout
class ColumnArea
          
class SpanArea
          
 

Methods in org.apache.fop.layout that return AreaContainer
AreaContainerBodyAreaContainer.getBeforeFloatReferenceArea()
          
AreaContainerBodyAreaContainer.getCurrentColumnArea()
          
AreaContainerBodyAreaContainer.getFootnoteReferenceArea()
          
AreaContainerBodyAreaContainer.getMainReferenceArea()
          
AreaContainerBodyAreaContainer.getNextArea(FObj fo)
          
AreaContainerPage.getAfter()
          
AreaContainerPage.getBefore()
          
AreaContainerRegionArea.makeAreaContainer()
          
AreaContainerSpanArea.getCurrentColumnArea()
          
 

Methods in org.apache.fop.layout with parameters of type AreaContainer
voidLinkSet.applyAreaContainerOffsets(AreaContainer ac, Area area)
          
(package private) voidPage.addAfter(AreaContainer area)
          
(package private) voidPage.addBefore(AreaContainer area)
          
(package private) voidPage.addEnd(AreaContainer area)
          
(package private) voidPage.addStart(AreaContainer area)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/AreaTree.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/AreaTree.html deleted file mode 100755 index 74cd14997..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/AreaTree.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.AreaTree

Packages that use AreaTree
org.apache.fop.layout 

Uses of AreaTree in org.apache.fop.layout
 

Constructors in org.apache.fop.layout with parameters of type AreaTree
Page.Page(AreaTree areaTree, int height, int width)
          
 

Methods in org.apache.fop.layout with parameters of type AreaTree
PagePageMaster.makePage(AreaTree areaTree)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/BlockArea.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/BlockArea.html deleted file mode 100755 index fc47245c2..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/BlockArea.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.BlockArea

No usage of org.apache.fop.layout.BlockArea
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/BodyAreaContainer.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/BodyAreaContainer.html deleted file mode 100755 index 012ac4c59..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/BodyAreaContainer.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.BodyAreaContainer

Packages that use BodyAreaContainer
org.apache.fop.layout 

Uses of BodyAreaContainer in org.apache.fop.layout
 

Methods in org.apache.fop.layout that return BodyAreaContainer
BodyAreaContainerBodyRegionArea.makeBodyAreaContainer()
          
BodyAreaContainerPage.getBody()
          
 

Methods in org.apache.fop.layout with parameters of type BodyAreaContainer
voidPage.addBody(BodyAreaContainer area)
          Ensure that page is set not only on B.A.C.
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/BodyRegionArea.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/BodyRegionArea.html deleted file mode 100755 index a4d8a8ff2..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/BodyRegionArea.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.BodyRegionArea

Packages that use BodyRegionArea
org.apache.fop.layout 

Uses of BodyRegionArea in org.apache.fop.layout
 

Methods in org.apache.fop.layout with parameters of type BodyRegionArea
voidPageMaster.addBody(BodyRegionArea region)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/Box.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/Box.html deleted file mode 100755 index d14ac6d9a..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/Box.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.Box

Packages that use Box
org.apache.fop.layout 

Uses of Box in org.apache.fop.layout
 

Subclasses of Box in org.apache.fop.layout
class Area
          
class Space
          
 

Methods in org.apache.fop.layout with parameters of type Box
voidArea.addChild(Box child)
          
voidArea.addChildAtStart(Box child)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/ColumnArea.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/ColumnArea.html deleted file mode 100755 index fd1655f17..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/ColumnArea.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.ColumnArea

No usage of org.apache.fop.layout.ColumnArea
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/DisplaySpace.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/DisplaySpace.html deleted file mode 100755 index 788bb400f..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/DisplaySpace.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.DisplaySpace

Packages that use DisplaySpace
org.apache.fop.layout 

Uses of DisplaySpace in org.apache.fop.layout
 

Methods in org.apache.fop.layout with parameters of type DisplaySpace
voidArea.removeChild(DisplaySpace spacer)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontDescriptor.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontDescriptor.html deleted file mode 100755 index b5878e70e..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontDescriptor.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.FontDescriptor

No usage of org.apache.fop.layout.FontDescriptor
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontInfo.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontInfo.html deleted file mode 100755 index 1122c1c51..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontInfo.html +++ /dev/null @@ -1,2 +0,0 @@ -

Uses of Class
org.apache.fop.layout.FontInfo

Packages that use FontInfo
org.apache.fop.layout 

Uses of FontInfo in org.apache.fop.layout
 

Fields in org.apache.fop.layout declared as FontInfo
(package private) FontInfoAreaTree.fontInfo
          object containing information on available fonts, including -metrics
 

Constructors in org.apache.fop.layout with parameters of type FontInfo
FontState.FontState(FontInfo fontInfo, String fontFamily, String fontStyle, String fontWeight, int fontSize, int fontVariant)
          
FontState.FontState(FontInfo fontInfo, String fontFamily, String fontStyle, String fontWeight, int fontSize)
          
 

Methods in org.apache.fop.layout that return FontInfo
FontInfoArea.getFontInfo()
          
FontInfoAreaTree.getFontInfo()
          
FontInfoFontState.getFontInfo()
          
FontInfoPage.getFontInfo()
          
 

Methods in org.apache.fop.layout with parameters of type FontInfo
voidAreaTree.setFontInfo(FontInfo fontInfo)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontMetric.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontMetric.html deleted file mode 100755 index c2e67b3de..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontMetric.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.FontMetric

Packages that use FontMetric
org.apache.fop.layout 

Uses of FontMetric in org.apache.fop.layout
 

Methods in org.apache.fop.layout that return FontMetric
FontMetricFontInfo.getMetricsFor(String family, String style, String weight)
          
FontMetricFontInfo.getMetricsFor(String fontName)
          
 

Methods in org.apache.fop.layout with parameters of type FontMetric
voidFontInfo.addMetrics(String name, FontMetric metrics)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontState.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontState.html deleted file mode 100755 index af2aaf0c4..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/FontState.html +++ /dev/null @@ -1,2 +0,0 @@ -

Uses of Class
org.apache.fop.layout.FontState

Packages that use FontState
org.apache.fop.layout 

Uses of FontState in org.apache.fop.layout
 

Constructors in org.apache.fop.layout with parameters of type FontState
Area.Area(FontState fontState, int allocationWidth, int maxHeight)
          
Area.Area(FontState fontState)
          
AreaContainer.AreaContainer(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int position)
          
BlockArea.BlockArea(FontState fontState, int allocationWidth, int maxHeight, int startIndent, int endIndent, int textIndent, int align, int alignLastLine, int lineHeight)
          
BodyAreaContainer.BodyAreaContainer(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int position, int columnCount, int columnGap)
          
ColumnArea.ColumnArea(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int columnCount)
          
LineArea.LineArea(FontState fontState, int lineHeight, int halfLeading, int allocationWidth, int startIndent, int endIndent, LineArea prevLineArea)
          
SpanArea.SpanArea(FontState fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int columnCount, int columnGap)
          
 

Methods in org.apache.fop.layout that return FontState
FontStateArea.getFontState()
          
 

Methods in org.apache.fop.layout with parameters of type FontState
voidBlockArea.addCharacter(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, char data, boolean ul)
          
intBlockArea.addLeader(FontState fontState, float red, float green, float blue, int leaderPattern, int leaderLengthMinimum, int leaderLengthOptimum, int leaderLengthMaximum, int ruleThickness, int ruleStyle, int leaderPatternWidth, int leaderAlignment)
          adds a leader to current line area of containing block area -the actual leader area is created in the line area
intBlockArea.addPageNumberCitation(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, String refid)
          
intBlockArea.addText(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, char[] data, int start, int end, boolean ul)
          
voidLineArea.changeFont(FontState fontState)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/LineArea.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/LineArea.html deleted file mode 100755 index 5e1649044..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/LineArea.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.LineArea

Packages that use LineArea
org.apache.fop.layout 

Uses of LineArea in org.apache.fop.layout
 

Constructors in org.apache.fop.layout with parameters of type LineArea
LineArea.LineArea(FontState fontState, int lineHeight, int halfLeading, int allocationWidth, int startIndent, int endIndent, LineArea prevLineArea)
          
LinkedRectangle.LinkedRectangle(Rectangle link, LineArea lineArea)
          
 

Methods in org.apache.fop.layout that return LineArea
LineAreaLinkedRectangle.getLineArea()
          
 

Methods in org.apache.fop.layout with parameters of type LineArea
voidBlockArea.addLineArea(LineArea la)
          
voidLinkSet.addRect(Rectangle r, LineArea lineArea)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/LinkSet.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/LinkSet.html deleted file mode 100755 index fe1594234..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/LinkSet.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.LinkSet

Packages that use LinkSet
org.apache.fop.layout 

Uses of LinkSet in org.apache.fop.layout
 

Methods in org.apache.fop.layout with parameters of type LinkSet
voidBlockArea.addCharacter(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, char data, boolean ul)
          
intBlockArea.addPageNumberCitation(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, String refid)
          
intBlockArea.addText(FontState fontState, float red, float green, float blue, int wrapOption, LinkSet ls, int whiteSpaceCollapse, char[] data, int start, int end, boolean ul)
          
intLineArea.addCharacter(char data, LinkSet ls, boolean ul)
          adds a single character to the line area tree
intLineArea.addPageNumberCitation(String refid, LinkSet ls)
          
intLineArea.addText(char[] odata, int start, int end, LinkSet ls, boolean ul)
          adds text to line area
voidPage.addLinkSet(LinkSet linkSet)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/LinkedRectangle.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/LinkedRectangle.html deleted file mode 100755 index 6c81aaa93..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/LinkedRectangle.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.LinkedRectangle

Packages that use LinkedRectangle
org.apache.fop.layout 

Uses of LinkedRectangle in org.apache.fop.layout
 

Constructors in org.apache.fop.layout with parameters of type LinkedRectangle
LinkedRectangle.LinkedRectangle(LinkedRectangle lr)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/Page.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/Page.html deleted file mode 100755 index 08907076c..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/Page.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.Page

Packages that use Page
org.apache.fop.layout 

Uses of Page in org.apache.fop.layout
 

Methods in org.apache.fop.layout that return Page
PageArea.getPage()
          
PagePageMaster.makePage(AreaTree areaTree)
          
 

Methods in org.apache.fop.layout with parameters of type Page
voidArea.setPage(Page page)
          
voidAreaTree.addPage(Page page)
          
voidSpanArea.setPage(Page page)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/PageMaster.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/PageMaster.html deleted file mode 100755 index ce1ef7aa0..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/PageMaster.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.PageMaster

No usage of org.apache.fop.layout.PageMaster
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/RegionArea.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/RegionArea.html deleted file mode 100755 index 44ab6b3ea..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/RegionArea.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.RegionArea

Packages that use RegionArea
org.apache.fop.layout 

Uses of RegionArea in org.apache.fop.layout
 

Subclasses of RegionArea in org.apache.fop.layout
class BodyRegionArea
          
 

Methods in org.apache.fop.layout with parameters of type RegionArea
voidPageMaster.addAfter(RegionArea region)
          
voidPageMaster.addBefore(RegionArea region)
          
voidPageMaster.addEnd(RegionArea region)
          
voidPageMaster.addStart(RegionArea region)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/Space.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/Space.html deleted file mode 100755 index 99b1eb141..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/Space.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.Space

Packages that use Space
org.apache.fop.layout 

Uses of Space in org.apache.fop.layout
 

Subclasses of Space in org.apache.fop.layout
class DisplaySpace
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/class-use/SpanArea.html b/docs/design/contrib/layout/org/apache/fop/layout/class-use/SpanArea.html deleted file mode 100755 index d8fd7aa56..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/class-use/SpanArea.html +++ /dev/null @@ -1 +0,0 @@ -

Uses of Class
org.apache.fop.layout.SpanArea

No usage of org.apache.fop.layout.SpanArea
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/doc-files/layout.cl.gif b/docs/design/contrib/layout/org/apache/fop/layout/doc-files/layout.cl.gif deleted file mode 100755 index 0b356b759..000000000 Binary files a/docs/design/contrib/layout/org/apache/fop/layout/doc-files/layout.cl.gif and /dev/null differ diff --git a/docs/design/contrib/layout/org/apache/fop/layout/doc-files/layout.cl.html b/docs/design/contrib/layout/org/apache/fop/layout/doc-files/layout.cl.html deleted file mode 100755 index 5c336f511..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/doc-files/layout.cl.html +++ /dev/null @@ -1,41 +0,0 @@ - - - \ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/layout.cl.html b/docs/design/contrib/layout/org/apache/fop/layout/layout.cl.html deleted file mode 100755 index 7dabd740d..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/layout.cl.html +++ /dev/null @@ -1,3 +0,0 @@ -

org.apache.fop.layout
Class Diagram layout

Class Summary
Area 
AreaContainer 
AreaTree 
BlockArea 
BodyAreaContainer 
BodyRegionArea 
Box 
ColumnArea 
DisplaySpace 
FontDescriptor 
FontInfo 
FontMetricinterface for font metric classes
FontState 
LineArea 
LinkedRectanglean object that stores a rectangle that is linked, and the LineArea -that it is logically associated with
LinkSeta set of rectangles on a page that are linked to a common -destination
Page 
PageMaster 
RegionArea 
Space 
SpanArea 
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/package-frame.html b/docs/design/contrib/layout/org/apache/fop/layout/package-frame.html deleted file mode 100755 index 1aa7968c2..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/package-frame.html +++ /dev/null @@ -1,7 +0,0 @@ -Package org.apache.fop.layout -org.apache.fop.layout
Class Diagrams 
layout
Interfaces 
FontDescriptor
FontMetric
Classes 
Area
AreaContainer
AreaTree
BlockArea
BodyAreaContainer
BodyRegionArea
Box
ColumnArea
DisplaySpace
FontInfo
FontState
LineArea
LinkedRectangle
LinkSet
Page
PageMaster
RegionArea
Space
SpanArea
\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/package-summary.html b/docs/design/contrib/layout/org/apache/fop/layout/package-summary.html deleted file mode 100755 index f168659d3..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/package-summary.html +++ /dev/null @@ -1,3 +0,0 @@ -Package org.apache.fop.layout

Package org.apache.fop.layout

Class Diagram Summary
layout 
 

Interface Summary
FontDescriptor 
FontMetricinterface for font metric classes
 

Class Summary
Area 
AreaContainer 
AreaTree 
BlockArea 
BodyAreaContainer 
BodyRegionArea 
Box 
ColumnArea 
DisplaySpace 
FontInfo 
FontState 
LineArea 
LinkedRectanglean object that stores a rectangle that is linked, and the LineArea -that it is logically associated with
LinkSeta set of rectangles on a page that are linked to a common -destination
Page 
PageMaster 
RegionArea 
Space 
SpanArea 
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/package-tree.html b/docs/design/contrib/layout/org/apache/fop/layout/package-tree.html deleted file mode 100755 index 2cc4e4ccc..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/package-tree.html +++ /dev/null @@ -1 +0,0 @@ -org.apache.fop.layout Class Hierarchy

Hierarchy For Package org.apache.fop.layout

Package Hierarchies:
All Packages

Class Hierarchy

Interface Hierarchy

\ No newline at end of file diff --git a/docs/design/contrib/layout/org/apache/fop/layout/package-use.html b/docs/design/contrib/layout/org/apache/fop/layout/package-use.html deleted file mode 100755 index f4a9bfa03..000000000 --- a/docs/design/contrib/layout/org/apache/fop/layout/package-use.html +++ /dev/null @@ -1,3 +0,0 @@ -

Uses of Package
org.apache.fop.layout

Packages that use org.apache.fop.layout
org.apache.fop.layout 

Classes in org.apache.fop.layout used by org.apache.fop.layout
Area
          
AreaContainer
          
AreaTree
          
BlockArea
          
BodyAreaContainer
          
BodyRegionArea
          
ColumnArea
          
DisplaySpace
          
FontInfo
          
FontState
          
LineArea
          
LinkedRectangle
          an object that stores a rectangle that is linked, and the LineArea -that it is logically associated with
LinkSet
          a set of rectangles on a page that are linked to a common -destination
Page
          
PageMaster
          
RegionArea
          
Space
          
SpanArea
          
 

\ No newline at end of file diff --git a/docs/design/contrib/layout/overview-frame.html b/docs/design/contrib/layout/overview-frame.html deleted file mode 100755 index 884b07e9a..000000000 --- a/docs/design/contrib/layout/overview-frame.html +++ /dev/null @@ -1,4 +0,0 @@ -Overview - - - \ No newline at end of file diff --git a/docs/design/contrib/layout/overview-summary.html b/docs/design/contrib/layout/overview-summary.html deleted file mode 100755 index 3264f40fd..000000000 --- a/docs/design/contrib/layout/overview-summary.html +++ /dev/null @@ -1 +0,0 @@ -Overview
Packages
org.apache.fop.layout 
\ No newline at end of file diff --git a/docs/design/contrib/layout/overview-tree.html b/docs/design/contrib/layout/overview-tree.html deleted file mode 100755 index a19160835..000000000 --- a/docs/design/contrib/layout/overview-tree.html +++ /dev/null @@ -1 +0,0 @@ -Class Hierarchy

Hierarchy For All Packages

Package Hierarchies:
org.apache.fop.layout

Class Hierarchy

Interface Hierarchy

\ No newline at end of file diff --git a/docs/design/contrib/layout/stylesheet.css b/docs/design/contrib/layout/stylesheet.css deleted file mode 100755 index e6d825496..000000000 --- a/docs/design/contrib/layout/stylesheet.css +++ /dev/null @@ -1,28 +0,0 @@ -/* Javadoc style sheet */ - -/* Define colors, fonts and other style attributes here to override the defaults */ - -/* Page background color */ -body { background-color: #FFFFFF } - -/* Table colors */ -#TableHeadingColor { background: #CCCCFF } /* Dark mauve */ -#TableSubHeadingColor { background: #EEEEFF } /* Light mauve */ -#TableRowColor { background: #FFFFFF } /* White */ - -/* Font used in left-hand frame lists */ -#FrameTitleFont { font-size: normal; font-family: normal } -#FrameHeadingFont { font-size: normal; font-family: normal } -#FrameItemFont { font-size: normal; font-family: normal } - -/* Example of smaller, sans-serif font in frames */ -/* #FrameItemFont { font-size: 10pt; font-family: Helvetica, Arial, sans-serif } */ - -/* Navigation bar fonts and colors */ -#NavBarCell1 { background-color:#EEEEFF;}/* Light mauve */ -#NavBarCell1Rev { background-color:#00008B;}/* Dark Blue */ -#NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;} -#NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;} - -#NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} -#NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} \ No newline at end of file diff --git a/docs/design/contrib/pdf/help-doc.html b/docs/design/contrib/pdf/help-doc.html deleted file mode 100755 index 6013d2acd..000000000 --- a/docs/design/contrib/pdf/help-doc.html +++ /dev/null @@ -1 +0,0 @@ -

How This API Document Is Organized

This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

Overview

The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

Package

Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

Class/Interface

Each class, interface, inner class and inner interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

Tree (Class Hierarchy)

There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

Deprecated API

The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

Index

The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

Prev/Next

These links take you to the next or previous class, interface, package, or related page.Resource not found: Help_Contents_FramesNoFrames.start
\ No newline at end of file diff --git a/docs/design/contrib/pdf/index-all.html b/docs/design/contrib/pdf/index-all.html deleted file mode 100755 index 0e7f74a23..000000000 --- a/docs/design/contrib/pdf/index-all.html +++ /dev/null @@ -1,15 +0,0 @@ -Index
A B C D E F G I M O P R S T U W X Y

A

action - Variable in class org.apache.fop.pdf.PDFLink
 
add(java.lang.String) - Method in class org.apache.fop.pdf.PDFStream
append data to the stream
addDifferences(int,java.util.Vector) - Method in class org.apache.fop.pdf.PDFEncoding
add differences to the encoding
addFilter(java.lang.String) - Method in class org.apache.fop.pdf.PDFStream
 
addFilter(org.apache.fop.pdf.PDFFilter) - Method in class org.apache.fop.pdf.PDFStream
Add a filter for compression of the stream.
addFont(org.apache.fop.pdf.PDFFont) - Method in class org.apache.fop.pdf.PDFResources
add font object to resources list.
addImage(org.apache.fop.image.FopImage) - Method in class org.apache.fop.pdf.PDFDocument
 
addImageArray(int[],int,int) - Method in class org.apache.fop.pdf.PDFStream
append an array of xRGB pixels, ASCII Hex Encoding it first
addLink(org.apache.fop.pdf.PDFLink) - Method in class org.apache.fop.pdf.PDFAnnotList
add an /Annot object of /Subtype /Link.
addPage(org.apache.fop.pdf.PDFPage) - Method in class org.apache.fop.pdf.PDFPages
add a /Page object.
addPage(org.apache.fop.pdf.PDFPage) - Method in class org.apache.fop.pdf.PDFRoot
add a /Page object to the root /Pages object
addPattern(org.apache.fop.pdf.PDFPattern) - Method in class org.apache.fop.pdf.PDFResources
 
addShading(org.apache.fop.pdf.PDFShading) - Method in class org.apache.fop.pdf.PDFPage
 
addShading(org.apache.fop.pdf.PDFShading) - Method in class org.apache.fop.pdf.PDFResources
 
ASCII85Filter - class org.apache.fop.pdf.ASCII85Filter
 
ASCIIHexFilter - class org.apache.fop.pdf.ASCIIHexFilter
 

B

black() - Method in class org.apache.fop.pdf.PDFColor
 
blue() - Method in class org.apache.fop.pdf.PDFColor
 
blue255() - Method in class org.apache.fop.pdf.PDFColor
 
brx - Variable in class org.apache.fop.pdf.PDFLink
 
bry - Variable in class org.apache.fop.pdf.PDFLink
 

C

color - Variable in class org.apache.fop.pdf.PDFLink
 
createFont(int,java.lang.String,byte,java.lang.String,java.lang.Object,int,int,org.apache.fop.pdf.PDFArray,org.apache.fop.pdf.PDFFontDescriptor) - Static method in class org.apache.fop.pdf.PDFFont
factory method with the extended parameters -for Type1, MMType1 and TrueType
createFont(int,java.lang.String,byte,java.lang.String,java.lang.Object) - Static method in class org.apache.fop.pdf.PDFFont
factory method with the basic parameters
createGradient(boolean,org.apache.fop.datatypes.ColorSpace,java.util.Vector,java.util.Vector,java.util.Vector) - Method in class org.apache.fop.pdf.PDFDocument
 
cyan() - Method in class org.apache.fop.pdf.PDFColor
 

D

doubleOut(double) - Method in class org.apache.fop.pdf.PDFNumber
 
doubleOut(java.lang.Double) - Method in class org.apache.fop.pdf.PDFNumber
 

E

encode(byte[]) - Method in class org.apache.fop.pdf.ASCII85Filter
 
encode(byte[]) - Method in class org.apache.fop.pdf.ASCIIHexFilter
 
encode(byte[]) - Method in class org.apache.fop.pdf.FlateFilter
Encode the given data and return it.
encode(byte[]) - Method in class org.apache.fop.pdf.PDFFilter
encode the given data with the filter

F

FlateFilter - class org.apache.fop.pdf.FlateFilter
A filter to deflate a stream.
fopimage - Variable in class org.apache.fop.pdf.PDFXObject
 

G

getAction() - Method in class org.apache.fop.pdf.PDFAction
represent the action to call -this method should be implemented to return the action which gets -called by the Link Object.
getAction() - Method in class org.apache.fop.pdf.PDFGoToRemote
return the action string which will reference this object
getAction() - Method in class org.apache.fop.pdf.PDFInternalLink
returns the action ncecessary for an internal link
getAction() - Method in class org.apache.fop.pdf.PDFUri
returns the action ncecessary for a uri
getAnnotList() - Method in class org.apache.fop.pdf.PDFPage
get this page's annotation list
getBitsPerComponent() - Method in class org.apache.fop.pdf.FlateFilter
 
getColors() - Method in class org.apache.fop.pdf.FlateFilter
 
getColorSpace() - Method in class org.apache.fop.pdf.PDFDocument
 
getColorSpace() - Method in class org.apache.fop.pdf.PDFPathPaint
 
getColorSpaceOut(boolean) - Method in class org.apache.fop.pdf.PDFColor
 
getColorSpaceOut(boolean) - Method in class org.apache.fop.pdf.PDFPathPaint
 
getColorSpaceOut(boolean) - Method in class org.apache.fop.pdf.PDFPattern
 
getColumns() - Method in class org.apache.fop.pdf.FlateFilter
 
getCount() - Method in class org.apache.fop.pdf.PDFAnnotList
get the count of /Annot objects
getCount() - Method in class org.apache.fop.pdf.PDFPages
get the count of /Page objects
getData() - Method in class org.apache.fop.pdf.PDFStream
 
getDataLength() - Method in class org.apache.fop.pdf.PDFStream
 
getDecodeParms() - Method in class org.apache.fop.pdf.ASCII85Filter
 
getDecodeParms() - Method in class org.apache.fop.pdf.ASCIIHexFilter
 
getDecodeParms() - Method in class org.apache.fop.pdf.FlateFilter
 
getDecodeParms() - Method in class org.apache.fop.pdf.PDFFilter
return a parameter dictionary for this filter, or null
getName() - Method in class org.apache.fop.pdf.ASCII85Filter
 
getName() - Method in class org.apache.fop.pdf.ASCIIHexFilter
 
getName() - Method in class org.apache.fop.pdf.FlateFilter
 
getName() - Method in class org.apache.fop.pdf.PDFFilter
return a PDF string representation of the filter, e.g.
getName() - Method in class org.apache.fop.pdf.PDFFont
get the internal name used for this font
getName() - Method in class org.apache.fop.pdf.PDFPattern
Get the name of the pattern
getName() - Method in class org.apache.fop.pdf.PDFShading
 
getNumber() - Method in class org.apache.fop.pdf.PDFObject
 
getPredictor() - Method in class org.apache.fop.pdf.FlateFilter
 
getResources() - Method in class org.apache.fop.pdf.PDFDocument
get the /Resources object for the document
getVector() - Method in class org.apache.fop.pdf.PDFColor
 
getXNumber() - Method in class org.apache.fop.pdf.PDFXObject
 
goToReference - Variable in class org.apache.fop.pdf.PDFInternalLink
 
green() - Method in class org.apache.fop.pdf.PDFColor
 
green255() - Method in class org.apache.fop.pdf.PDFColor
 

I

incrementCount() - Method in class org.apache.fop.pdf.PDFPages
increment the count of /Page objects
isApplied() - Method in class org.apache.fop.pdf.PDFFilter
 

M

MacExpertEncoding - Static variable in class org.apache.fop.pdf.PDFEncoding
the name for the standard encoding scheme
MacRomanEncoding - Static variable in class org.apache.fop.pdf.PDFEncoding
the name for the standard encoding scheme
magenta() - Method in class org.apache.fop.pdf.PDFColor
 
makeAnnotList() - Method in class org.apache.fop.pdf.PDFDocument
make an annotation list object
makeArray(int[]) - Method in class org.apache.fop.pdf.PDFDocument
make an Array object (ex.
makeEncoding(java.lang.String) - Method in class org.apache.fop.pdf.PDFDocument
make a /Encoding object
makeFont(java.lang.String,java.lang.String,java.lang.String,org.apache.fop.layout.FontMetric,org.apache.fop.layout.FontDescriptor) - Method in class org.apache.fop.pdf.PDFDocument
make a Type1 /Font object
makeFontDescriptor(org.apache.fop.layout.FontDescriptor) - Method in class org.apache.fop.pdf.PDFDocument
make a /FontDescriptor object for a CID font
makeFunction(int,int,java.util.Vector,java.util.Vector,java.lang.StringBuffer) - Method in class org.apache.fop.pdf.PDFDocument
make a postscript calculator function
makeFunction(int,java.util.Vector,java.util.Vector,java.util.Vector,int,int,java.util.Vector,java.util.Vector,java.lang.StringBuffer,java.util.Vector) - Method in class org.apache.fop.pdf.PDFDocument
Make a Type 0 sampled function
makeFunction(int,java.util.Vector,java.util.Vector,java.util.Vector,java.util.Vector,double) - Method in class org.apache.fop.pdf.PDFDocument
make a type Exponential interpolation function -(for shading usually)
makeFunction(int,java.util.Vector,java.util.Vector,java.util.Vector,java.util.Vector,java.util.Vector) - Method in class org.apache.fop.pdf.PDFDocument
Make a Type 3 Stitching function
makeLink(java.awt.Rectangle,java.lang.String,int) - Method in class org.apache.fop.pdf.PDFDocument
make a link object
makePage(org.apache.fop.pdf.PDFResources,org.apache.fop.pdf.PDFStream,int,int,org.apache.fop.layout.Page) - Method in class org.apache.fop.pdf.PDFDocument
make a /Page object
makePattern(int,org.apache.fop.pdf.PDFResources,int,int,java.util.Vector,double,double,java.util.Vector,java.util.Vector,java.lang.StringBuffer) - Method in class org.apache.fop.pdf.PDFDocument
Make a tiling pattern
makePattern(int,org.apache.fop.pdf.PDFShading,java.util.Vector,java.lang.StringBuffer,java.util.Vector) - Method in class org.apache.fop.pdf.PDFDocument
Make a smooth shading pattern
makeShading(int,org.apache.fop.datatypes.ColorSpace,java.util.Vector,java.util.Vector,boolean,int,int,int,java.util.Vector,org.apache.fop.pdf.PDFFunction) - Method in class org.apache.fop.pdf.PDFDocument
Make a free-form gouraud shaded triangle mesh, coons patch mesh, or tensor patch mesh -shading object
makeShading(int,org.apache.fop.datatypes.ColorSpace,java.util.Vector,java.util.Vector,boolean,int,int,java.util.Vector,int,org.apache.fop.pdf.PDFFunction) - Method in class org.apache.fop.pdf.PDFDocument
make a Lattice-Form Gouraud mesh shading object
makeShading(int,org.apache.fop.datatypes.ColorSpace,java.util.Vector,java.util.Vector,boolean,java.util.Vector,java.util.Vector,org.apache.fop.pdf.PDFFunction,java.util.Vector) - Method in class org.apache.fop.pdf.PDFDocument
Make an axial or radial shading object.
makeShading(int,org.apache.fop.datatypes.ColorSpace,java.util.Vector,java.util.Vector,boolean,java.util.Vector,java.util.Vector,org.apache.fop.pdf.PDFFunction) - Method in class org.apache.fop.pdf.PDFDocument
make a function based shading object
makeStream() - Method in class org.apache.fop.pdf.PDFDocument
make a stream object
MMTYPE1 - Static variable in class org.apache.fop.pdf.PDFFont
font subtype to be used as parameter to createFont()

O

org.apache.fop.pdf - package org.apache.fop.pdf
 
output(java.io.OutputStream) - Method in class org.apache.fop.pdf.PDFDocument
write the entire document out

P

pdf - Class Diagram in org.apache.fop.pdf
 
PDFAction - class org.apache.fop.pdf.PDFAction
class representing an action object.
PDFAction() - Constructor for class org.apache.fop.pdf.PDFAction
empty constructor for PDFAction.
PDFAction(int) - Constructor for class org.apache.fop.pdf.PDFAction
create an Action object.
PDFAnnotList - class org.apache.fop.pdf.PDFAnnotList
class representing an object which is a list of annotations.
PDFAnnotList(int) - Constructor for class org.apache.fop.pdf.PDFAnnotList
create a /Annots object.
PDFArray - class org.apache.fop.pdf.PDFArray
class representing an array object
PDFArray(int,int[]) - Constructor for class org.apache.fop.pdf.PDFArray
create the array object
PDFColor - class org.apache.fop.pdf.PDFColor
 
PDFColor(double,double,double,double) - Constructor for class org.apache.fop.pdf.PDFColor
 
PDFColor(double,double,double) - Constructor for class org.apache.fop.pdf.PDFColor
 
PDFColor(int,int,int) - Constructor for class org.apache.fop.pdf.PDFColor
 
PDFColor(org.apache.fop.datatypes.ColorType) - Constructor for class org.apache.fop.pdf.PDFColor
 
PDFDocument - class org.apache.fop.pdf.PDFDocument
class representing a PDF document.
PDFDocument() - Constructor for class org.apache.fop.pdf.PDFDocument
creates an empty PDF document
PDFEncoding - class org.apache.fop.pdf.PDFEncoding
class representing an /Encoding object.
PDFEncoding(int,java.lang.String) - Constructor for class org.apache.fop.pdf.PDFEncoding
create the /Encoding object
PDFFileSpec - class org.apache.fop.pdf.PDFFileSpec
class representing a /FileSpec object.
PDFFileSpec(int,java.lang.String) - Constructor for class org.apache.fop.pdf.PDFFileSpec
create a /FileSpec object.
PDFFilter - class org.apache.fop.pdf.PDFFilter
 
PDFFilterException - class org.apache.fop.pdf.PDFFilterException
 
PDFFilterException() - Constructor for class org.apache.fop.pdf.PDFFilterException
 
PDFFilterException(java.lang.String) - Constructor for class org.apache.fop.pdf.PDFFilterException
 
PDFFont - class org.apache.fop.pdf.PDFFont
class representing a /Font object.
PDFFont(int,java.lang.String,byte,java.lang.String,java.lang.Object) - Constructor for class org.apache.fop.pdf.PDFFont
create the /Font object
PDFFontDescriptor - class org.apache.fop.pdf.PDFFontDescriptor
class representing a font descriptor.
PDFFontDescriptor(int,java.lang.String,int,int,int,int,org.apache.fop.pdf.PDFRectangle,int,int) - Constructor for class org.apache.fop.pdf.PDFFontDescriptor
create the /FontDescriptor object
PDFFontNonBase14 - class org.apache.fop.pdf.PDFFontNonBase14
A common ancestor for Type1, TrueType, MMType1 and Type3 fonts -(all except base 14 fonts).
PDFFontNonBase14(int,java.lang.String,byte,java.lang.String,java.lang.Object) - Constructor for class org.apache.fop.pdf.PDFFontNonBase14
create the /Font object
PDFFontType1 - class org.apache.fop.pdf.PDFFontType1
class representing a Type1 or MMType1 font (not necessary for the base 14).
PDFFontType1(int,java.lang.String,byte,java.lang.String,java.lang.Object) - Constructor for class org.apache.fop.pdf.PDFFontType1
create the /Font object
PDFFunction - class org.apache.fop.pdf.PDFFunction
class representing a PDF Function.
PDFFunction(int,int,java.util.Vector,java.util.Vector,java.lang.StringBuffer) - Constructor for class org.apache.fop.pdf.PDFFunction
create an complete Function object of Type 4, a postscript calculator function.
PDFFunction(int,int,java.util.Vector,java.util.Vector,java.util.Vector,int,int,java.util.Vector,java.util.Vector,java.lang.StringBuffer,java.util.Vector) - Constructor for class org.apache.fop.pdf.PDFFunction
create an complete Function object of Type 0, A Sampled function.
PDFFunction(int,int,java.util.Vector,java.util.Vector,java.util.Vector,java.util.Vector,double) - Constructor for class org.apache.fop.pdf.PDFFunction
create an complete Function object of Type 2, an Exponential Interpolation function.
PDFFunction(int,int,java.util.Vector,java.util.Vector,java.util.Vector,java.util.Vector,java.util.Vector) - Constructor for class org.apache.fop.pdf.PDFFunction
create an complete Function object of Type 3, a Stitching function.
PDFGoTo - class org.apache.fop.pdf.PDFGoTo
class representing a /GoTo object.
PDFGoTo(int,java.lang.String) - Constructor for class org.apache.fop.pdf.PDFGoTo
create a /GoTo object.
PDFGoToRemote - class org.apache.fop.pdf.PDFGoToRemote
class representing a /GoToR object.
PDFGoToRemote(int,org.apache.fop.pdf.PDFFileSpec) - Constructor for class org.apache.fop.pdf.PDFGoToRemote
create an GoToR object.
PDFInfo - class org.apache.fop.pdf.PDFInfo
class representing an /Info object
PDFInfo(int) - Constructor for class org.apache.fop.pdf.PDFInfo
create an Info object
PDFInternalLink - class org.apache.fop.pdf.PDFInternalLink
class used to create a PDF internal link
PDFInternalLink(java.lang.String) - Constructor for class org.apache.fop.pdf.PDFInternalLink
create an internal link instance.
PDFLink - class org.apache.fop.pdf.PDFLink
class representing an /Annot object of /Subtype /Link
PDFLink(int,java.awt.Rectangle) - Constructor for class org.apache.fop.pdf.PDFLink
create objects associated with a link annotation (GoToR)
PDFNumber - class org.apache.fop.pdf.PDFNumber
 
PDFNumber() - Constructor for class org.apache.fop.pdf.PDFNumber
 
PDFObject - class org.apache.fop.pdf.PDFObject
generic PDF object.
PDFObject() - Constructor for class org.apache.fop.pdf.PDFObject
 
PDFObject(int) - Constructor for class org.apache.fop.pdf.PDFObject
create an empty object
PDFPage - class org.apache.fop.pdf.PDFPage
class representing a /Page object.
PDFPage(int,org.apache.fop.pdf.PDFResources,org.apache.fop.pdf.PDFStream,int,int) - Constructor for class org.apache.fop.pdf.PDFPage
create a /Page object
PDFPages - class org.apache.fop.pdf.PDFPages
class representing a /Pages object.
PDFPages(int) - Constructor for class org.apache.fop.pdf.PDFPages
create a /Pages object.
PDFPathPaint - class org.apache.fop.pdf.PDFPathPaint
 
PDFPathPaint() - Constructor for class org.apache.fop.pdf.PDFPathPaint
 
PDFPathPaint(int) - Constructor for class org.apache.fop.pdf.PDFPathPaint
 
PDFPattern - class org.apache.fop.pdf.PDFPattern
class representing a PDF Function.
PDFPattern(int,java.lang.String,int,org.apache.fop.pdf.PDFShading,java.util.Vector,java.lang.StringBuffer,java.util.Vector) - Constructor for class org.apache.fop.pdf.PDFPattern
Create a type 2 pattern (smooth shading)
PDFPattern(int,java.lang.String,org.apache.fop.pdf.PDFResources,int,int,int,java.util.Vector,double,double,java.util.Vector,java.util.Vector,java.lang.StringBuffer) - Constructor for class org.apache.fop.pdf.PDFPattern
Create a tiling pattern (type 1).
PDFRectangle - class org.apache.fop.pdf.PDFRectangle
class representing a rectangle - -Rectangles are specified on page 183 of the PDF 1.3 spec.
PDFRectangle(int,int,int,int) - Constructor for class org.apache.fop.pdf.PDFRectangle
create a rectangle giving the four separate values
PDFRectangle(int[]) - Constructor for class org.apache.fop.pdf.PDFRectangle
create a rectangle giving an array of four values
PDFResources - class org.apache.fop.pdf.PDFResources
class representing a /Resources object.
PDFResources(int) - Constructor for class org.apache.fop.pdf.PDFResources
create a /Resources object.
PDFRoot - class org.apache.fop.pdf.PDFRoot
class representing a Root (/Catalog) object
PDFRoot(int) - Constructor for class org.apache.fop.pdf.PDFRoot
create a Root (/Catalog) object
PDFShading - class org.apache.fop.pdf.PDFShading
class representing a PDF Smooth Shading object.
PDFShading(int,java.lang.String,int,org.apache.fop.datatypes.ColorSpace,java.util.Vector,java.util.Vector,boolean,int,int,int,java.util.Vector,org.apache.fop.pdf.PDFFunction) - Constructor for class org.apache.fop.pdf.PDFShading
Constructor for Type 4,6, or 7
PDFShading(int,java.lang.String,int,org.apache.fop.datatypes.ColorSpace,java.util.Vector,java.util.Vector,boolean,int,int,java.util.Vector,int,org.apache.fop.pdf.PDFFunction) - Constructor for class org.apache.fop.pdf.PDFShading
Constructor for type 5
PDFShading(int,java.lang.String,int,org.apache.fop.datatypes.ColorSpace,java.util.Vector,java.util.Vector,boolean,java.util.Vector,java.util.Vector,org.apache.fop.pdf.PDFFunction,java.util.Vector) - Constructor for class org.apache.fop.pdf.PDFShading
Constructor for Type 2 and 3
PDFShading(int,java.lang.String,int,org.apache.fop.datatypes.ColorSpace,java.util.Vector,java.util.Vector,boolean,java.util.Vector,java.util.Vector,org.apache.fop.pdf.PDFFunction) - Constructor for class org.apache.fop.pdf.PDFShading
Constructor for type function based shading
PDFStream - class org.apache.fop.pdf.PDFStream
class representing a PDF stream.
PDFStream(int) - Constructor for class org.apache.fop.pdf.PDFStream
create an empty stream object
PDFUri - class org.apache.fop.pdf.PDFUri
class used to create a PDF Uri link
PDFUri(java.lang.String) - Constructor for class org.apache.fop.pdf.PDFUri
create a Uri instance.
PDFXObject - class org.apache.fop.pdf.PDFXObject
PDF XObject - -A derivative of the PDF Object, is a PDF Stream that has not only a -dictionary but a stream of image data.
PDFXObject(int,int,org.apache.fop.image.FopImage) - Constructor for class org.apache.fop.pdf.PDFXObject
create an Xobject with the given number and name and load the -image in the object
PREDICTION_NONE - Static variable in class org.apache.fop.pdf.FlateFilter
 
PREDICTION_PNG_AVG - Static variable in class org.apache.fop.pdf.FlateFilter
 
PREDICTION_PNG_NONE - Static variable in class org.apache.fop.pdf.FlateFilter
 
PREDICTION_PNG_OPT - Static variable in class org.apache.fop.pdf.FlateFilter
 
PREDICTION_PNG_PAETH - Static variable in class org.apache.fop.pdf.FlateFilter
 
PREDICTION_PNG_SUB - Static variable in class org.apache.fop.pdf.FlateFilter
 
PREDICTION_PNG_UP - Static variable in class org.apache.fop.pdf.FlateFilter
 
PREDICTION_TIFF2 - Static variable in class org.apache.fop.pdf.FlateFilter
 

R

red() - Method in class org.apache.fop.pdf.PDFColor
 
red255() - Method in class org.apache.fop.pdf.PDFColor
 
referencePDF() - Method in class org.apache.fop.pdf.PDFObject
the PDF representation of a reference to this object

S

setAction(org.apache.fop.pdf.PDFAction) - Method in class org.apache.fop.pdf.PDFLink
 
setAnnotList(org.apache.fop.pdf.PDFAnnotList) - Method in class org.apache.fop.pdf.PDFPage
set this page's annotation list
setApplied(boolean) - Method in class org.apache.fop.pdf.PDFFilter
Set the applied attribute to the given value.
setBitsPerComponent(int) - Method in class org.apache.fop.pdf.FlateFilter
 
setColors(int) - Method in class org.apache.fop.pdf.FlateFilter
 
setColorSpace(int) - Method in class org.apache.fop.pdf.PDFColor
 
setColorSpace(int) - Method in class org.apache.fop.pdf.PDFDocument
 
setColorSpace(int) - Method in class org.apache.fop.pdf.PDFPathPaint
 
setColumns(int) - Method in class org.apache.fop.pdf.FlateFilter
 
setData(byte[]) - Method in class org.apache.fop.pdf.PDFStream
 
setDescriptor(org.apache.fop.pdf.PDFFontDescriptor) - Method in class org.apache.fop.pdf.PDFFontNonBase14
set the font descriptor (unused for the Type3 fonts)
setFontFile(byte,org.apache.fop.pdf.PDFStream) - Method in class org.apache.fop.pdf.PDFFontDescriptor
set the optional font file stream
setIDReferences(org.apache.fop.datatypes.IDReferences) - Method in class org.apache.fop.pdf.PDFDocument
 
setMetrics(int,int,int,int,int,int) - Method in class org.apache.fop.pdf.PDFFontDescriptor
set the optional metrics
setPageReference(java.lang.String) - Method in class org.apache.fop.pdf.PDFGoTo
Sets page reference after object has been created
setParent(org.apache.fop.pdf.PDFPages) - Method in class org.apache.fop.pdf.PDFPage
set this page's parent
setPredictor(int) - Method in class org.apache.fop.pdf.FlateFilter
 
setProducer(java.lang.String) - Method in class org.apache.fop.pdf.PDFDocument
set the producer of the document
setProducer(java.lang.String) - Method in class org.apache.fop.pdf.PDFInfo
set the producer string
setRootPages(org.apache.fop.pdf.PDFPages) - Method in class org.apache.fop.pdf.PDFRoot
set the root /Pages object
setWidthMetrics(int,int,org.apache.fop.pdf.PDFArray) - Method in class org.apache.fop.pdf.PDFFontNonBase14
set the width metrics for the font
setXObjects(java.util.Vector) - Method in class org.apache.fop.pdf.PDFResources
 
setXPosition(int) - Method in class org.apache.fop.pdf.PDFGoTo
Sets the x Position to jump to
setYPosition(int) - Method in class org.apache.fop.pdf.PDFGoTo
Sets the Y position to jump to

T

toPDF() - Method in class org.apache.fop.pdf.PDFAction
represent the object in PDF -this method should be implemented to return the PDF which is to be -generated by the Action object
toPDF() - Method in class org.apache.fop.pdf.PDFAnnotList
represent the object in PDF
toPDF() - Method in class org.apache.fop.pdf.PDFArray
produce the PDF representation for the object
toPDF() - Method in class org.apache.fop.pdf.PDFColor
 
toPDF() - Method in class org.apache.fop.pdf.PDFEncoding
produce the PDF representation for the object
toPDF() - Method in class org.apache.fop.pdf.PDFFileSpec
represent the object in PDF
toPDF() - Method in class org.apache.fop.pdf.PDFFont
produce the PDF representation for the object
toPDF() - Method in class org.apache.fop.pdf.PDFFontDescriptor
produce the PDF representation for the object
toPDF() - Method in class org.apache.fop.pdf.PDFFunction
represent as PDF.
toPDF() - Method in class org.apache.fop.pdf.PDFGoTo
represent the object in PDF
toPDF() - Method in class org.apache.fop.pdf.PDFGoToRemote
represent the object in PDF
toPDF() - Method in class org.apache.fop.pdf.PDFInfo
produce the PDF representation of the object
toPDF() - Method in class org.apache.fop.pdf.PDFInternalLink
there is nothing to return for the toPDF method, as it should not be called
toPDF() - Method in class org.apache.fop.pdf.PDFLink
produce the PDF representation of the object
toPDF() - Method in class org.apache.fop.pdf.PDFObject
represent object as PDF
toPDF() - Method in class org.apache.fop.pdf.PDFPage
represent this object as PDF
toPDF() - Method in class org.apache.fop.pdf.PDFPages
represent the object in PDF
toPDF() - Method in class org.apache.fop.pdf.PDFPattern
represent as PDF.
toPDF() - Method in class org.apache.fop.pdf.PDFRectangle
produce the PDF representation for the object
toPDF() - Method in class org.apache.fop.pdf.PDFResources
represent the object in PDF
toPDF() - Method in class org.apache.fop.pdf.PDFRoot
represent the object as PDF
toPDF() - Method in class org.apache.fop.pdf.PDFShading
represent as PDF.
toPDF() - Method in class org.apache.fop.pdf.PDFStream
represent as PDF.
toPDF() - Method in class org.apache.fop.pdf.PDFUri
there is nothing to return for the toPDF method, as it should not be called
toPDF() - Method in class org.apache.fop.pdf.PDFXObject
 
TRUETYPE - Static variable in class org.apache.fop.pdf.PDFFont
font subtype to be used as parameter to createFont()
TYPE0 - Static variable in class org.apache.fop.pdf.PDFFont
font subtype to be used as parameter to createFont()
TYPE1 - Static variable in class org.apache.fop.pdf.PDFFont
font subtype to be used as parameter to createFont()
TYPE3 - Static variable in class org.apache.fop.pdf.PDFFont
font subtype to be used as parameter to createFont()

U

ulx - Variable in class org.apache.fop.pdf.PDFLink
 
uly - Variable in class org.apache.fop.pdf.PDFLink
 
uri - Variable in class org.apache.fop.pdf.PDFUri
 

W

WinAnsiEncoding - Static variable in class org.apache.fop.pdf.PDFEncoding
the name for the standard encoding scheme

X

Xnum - Variable in class org.apache.fop.pdf.PDFXObject
 

Y

yellow() - Method in class org.apache.fop.pdf.PDFColor
 
\ No newline at end of file diff --git a/docs/design/contrib/pdf/index.html b/docs/design/contrib/pdf/index.html deleted file mode 100755 index 1d97ba8d3..000000000 --- a/docs/design/contrib/pdf/index.html +++ /dev/null @@ -1,7 +0,0 @@ - - - - -<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.<BR>Link to <A HREF="overview-summary.html">Non-frame version.</A> \ No newline at end of file diff --git a/docs/design/contrib/pdf/model-tree/false.gif b/docs/design/contrib/pdf/model-tree/false.gif deleted file mode 100755 index 9941eeb0c..000000000 Binary files a/docs/design/contrib/pdf/model-tree/false.gif and /dev/null differ diff --git a/docs/design/contrib/pdf/model-tree/model.tree b/docs/design/contrib/pdf/model-tree/model.tree deleted file mode 100755 index 99fe2407a..000000000 --- a/docs/design/contrib/pdf/model-tree/model.tree +++ /dev/null @@ -1,73 +0,0 @@ -node2 > NAME = ASCII85Filter, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/ASCII85Filter.html->classFrame; -node3 > NAME = ASCIIHexFilter, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/ASCIIHexFilter.html->classFrame; -node4 > NAME = FlateFilter, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/FlateFilter.html->classFrame; -node5 > NAME = PDFAction, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFAction.html->classFrame; -node6 > NAME = PDFAnnotList, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFAnnotList.html->classFrame; -node7 > NAME = PDFArray, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFArray.html->classFrame; -node8 > NAME = PDFColor, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFColor.html->classFrame; -node9 > NAME = PDFDocument, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFDocument.html->classFrame; -node10 > NAME = PDFEncoding, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFEncoding.html->classFrame; -node11 > NAME = PDFFileSpec, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFileSpec.html->classFrame; -node12 > NAME = PDFFilter, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFilter.html->classFrame; -node13 > NAME = PDFFilterException, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFilterException.html->classFrame; -node14 > NAME = PDFFont, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFont.html->classFrame; -node15 > NAME = PDFFontDescriptor, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFontDescriptor.html->classFrame; -node16 > NAME = PDFFontNonBase14, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFontNonBase14.html->classFrame; -node17 > NAME = PDFFontType1, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFontType1.html->classFrame; -node18 > NAME = PDFFunction, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFunction.html->classFrame; -node19 > NAME = PDFGoTo, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFGoTo.html->classFrame; -node20 > NAME = PDFGoToRemote, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFGoToRemote.html->classFrame; -node21 > NAME = PDFInfo, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFInfo.html->classFrame; -node22 > NAME = PDFInternalLink, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFInternalLink.html->classFrame; -node23 > NAME = PDFLink, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFLink.html->classFrame; -node24 > NAME = PDFNumber, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFNumber.html->classFrame; -node25 > NAME = PDFObject, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFObject.html->classFrame; -node26 > NAME = PDFPage, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFPage.html->classFrame; -node27 > NAME = PDFPages, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFPages.html->classFrame; -node28 > NAME = PDFPathPaint, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFPathPaint.html->classFrame; -node29 > NAME = PDFPattern, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFPattern.html->classFrame; -node30 > NAME = PDFRectangle, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFRectangle.html->classFrame; -node31 > NAME = PDFResources, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFResources.html->classFrame; -node32 > NAME = PDFRoot, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFRoot.html->classFrame; -node33 > NAME = PDFShading, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFShading.html->classFrame; -node34 > NAME = PDFStream, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFStream.html->classFrame; -node35 > NAME = PDFUri, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFUri.html->classFrame; -node36 > NAME = PDFXObject, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFXObject.html->classFrame; -node1 > NAME = pdf, IMG = model-tree/tv-physical-package.gif, REF = org/apache/fop/pdf/pdf.cl.html->classFrame, REF = org/apache/fop/pdf/doc-files/pdf.cl.html->imageFrame, CHILDS = node2:node3:node4:node5:node6:node7:node8:node9:node10:node11:node12:node13:node14:node15:node16:node17:node18:node19:node20:node21:node22:node23:node24:node25:node26:node27:node28:node29:node30:node31:node32:node33:node34:node35:node36; -node37 > NAME = ASCII85Filter, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/ASCII85Filter.html->classFrame; -node38 > NAME = ASCIIHexFilter, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/ASCIIHexFilter.html->classFrame; -node39 > NAME = FlateFilter, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/FlateFilter.html->classFrame; -node40 > NAME = PDFAction, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFAction.html->classFrame; -node41 > NAME = PDFAnnotList, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFAnnotList.html->classFrame; -node42 > NAME = PDFArray, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFArray.html->classFrame; -node43 > NAME = PDFColor, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFColor.html->classFrame; -node44 > NAME = PDFDocument, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFDocument.html->classFrame; -node45 > NAME = PDFEncoding, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFEncoding.html->classFrame; -node46 > NAME = PDFFileSpec, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFileSpec.html->classFrame; -node47 > NAME = PDFFilter, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFilter.html->classFrame; -node48 > NAME = PDFFilterException, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFilterException.html->classFrame; -node49 > NAME = PDFFont, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFont.html->classFrame; -node50 > NAME = PDFFontDescriptor, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFontDescriptor.html->classFrame; -node51 > NAME = PDFFontNonBase14, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFontNonBase14.html->classFrame; -node52 > NAME = PDFFontType1, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFontType1.html->classFrame; -node53 > NAME = PDFFunction, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFFunction.html->classFrame; -node54 > NAME = PDFGoTo, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFGoTo.html->classFrame; -node55 > NAME = PDFGoToRemote, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFGoToRemote.html->classFrame; -node56 > NAME = PDFInfo, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFInfo.html->classFrame; -node57 > NAME = PDFInternalLink, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFInternalLink.html->classFrame; -node58 > NAME = PDFLink, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFLink.html->classFrame; -node59 > NAME = PDFNumber, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFNumber.html->classFrame; -node60 > NAME = PDFObject, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFObject.html->classFrame; -node61 > NAME = PDFPage, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFPage.html->classFrame; -node62 > NAME = PDFPages, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFPages.html->classFrame; -node63 > NAME = PDFPathPaint, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFPathPaint.html->classFrame; -node64 > NAME = PDFPattern, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFPattern.html->classFrame; -node65 > NAME = PDFRectangle, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFRectangle.html->classFrame; -node66 > NAME = PDFResources, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFResources.html->classFrame; -node67 > NAME = PDFRoot, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFRoot.html->classFrame; -node68 > NAME = PDFShading, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFShading.html->classFrame; -node69 > NAME = PDFStream, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFStream.html->classFrame; -node70 > NAME = PDFUri, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFUri.html->classFrame; -node71 > NAME = PDFXObject, IMG = model-tree/tv-class.gif, REF = org/apache/fop/pdf/PDFXObject.html->classFrame; -node0 > NAME = pdf, IMG = model-tree/tv-pkg-diagram.gif, REF = org/apache/fop/pdf/package-summary.html->classFrame, CHILDS = node1:node37:node38:node39:node40:node41:node42:node43:node44:node45:node46:node47:node48:node49:node50:node51:node52:node53:node54:node55:node56:node57:node58:node59:node60:node61:node62:node63:node64:node65:node66:node67:node68:node69:node70:node71; -ROOT > CHILDS = node0 \ No newline at end of file diff --git a/docs/design/contrib/pdf/model-tree/true.gif b/docs/design/contrib/pdf/model-tree/true.gif deleted file mode 100755 index 724083a6e..000000000 Binary files a/docs/design/contrib/pdf/model-tree/true.gif and /dev/null differ diff --git a/docs/design/contrib/pdf/model-tree/tv-class.gif b/docs/design/contrib/pdf/model-tree/tv-class.gif deleted file mode 100755 index cb8efc68f..000000000 Binary files a/docs/design/contrib/pdf/model-tree/tv-class.gif and /dev/null differ diff --git a/docs/design/contrib/pdf/model-tree/tv-physical-package.gif b/docs/design/contrib/pdf/model-tree/tv-physical-package.gif deleted file mode 100755 index 927555f08..000000000 Binary files a/docs/design/contrib/pdf/model-tree/tv-physical-package.gif and /dev/null differ diff --git a/docs/design/contrib/pdf/model-tree/tv-pkg-diagram.gif b/docs/design/contrib/pdf/model-tree/tv-pkg-diagram.gif deleted file mode 100755 index 649e05bca..000000000 Binary files a/docs/design/contrib/pdf/model-tree/tv-pkg-diagram.gif and /dev/null differ diff --git a/docs/design/contrib/pdf/navigation.jar b/docs/design/contrib/pdf/navigation.jar deleted file mode 100755 index 80a885ea0..000000000 Binary files a/docs/design/contrib/pdf/navigation.jar and /dev/null differ diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/ASCII85Filter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/ASCII85Filter.html deleted file mode 100755 index 5472cdeb9..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/ASCII85Filter.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.pdf
Class ASCII85Filter

org.apache.fop.pdf.PDFFilter
-  |
-  +--org.apache.fop.pdf.ASCII85Filter
-
public class ASCII85Filter
extends PDFFilter

Method Summary
 byte[]encode(byte[] data)
           
 StringgetDecodeParms()
           
 StringgetName()
           

Methods inherited from class org.apache.fop.pdf.PDFFilter
isApplied, setApplied

Method Detail

encode

public byte[] encode(byte[] data)

getDecodeParms

public String getDecodeParms()

getName

public String getName()

Association Links

to Class java.lang.String

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/ASCIIHexFilter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/ASCIIHexFilter.html deleted file mode 100755 index 2a0050dbf..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/ASCIIHexFilter.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.pdf
Class ASCIIHexFilter

org.apache.fop.pdf.PDFFilter
-  |
-  +--org.apache.fop.pdf.ASCIIHexFilter
-
public class ASCIIHexFilter
extends PDFFilter

Method Summary
 byte[]encode(byte[] data)
           
 StringgetDecodeParms()
           
 StringgetName()
           

Methods inherited from class org.apache.fop.pdf.PDFFilter
isApplied, setApplied

Method Detail

encode

public byte[] encode(byte[] data)

getDecodeParms

public String getDecodeParms()

getName

public String getName()

Association Links

to Class java.lang.String

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/FlateFilter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/FlateFilter.html deleted file mode 100755 index 5e3523d34..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/FlateFilter.html +++ /dev/null @@ -1,11 +0,0 @@ -

org.apache.fop.pdf
Class FlateFilter

org.apache.fop.pdf.PDFFilter
-  |
-  +--org.apache.fop.pdf.FlateFilter
-
public class FlateFilter
extends PDFFilter

A filter to deflate a stream. Note that the attributes for -prediction, colors, bitsPerComponent, and columns are not supported -when this filter is used to handle the data compression. They are -only valid for externally encoded data such as that from a graphics -file.

Field Summary
 final static intPREDICTION_NONE
           
 final static intPREDICTION_PNG_AVG
           
 final static intPREDICTION_PNG_NONE
           
 final static intPREDICTION_PNG_OPT
           
 final static intPREDICTION_PNG_PAETH
           
 final static intPREDICTION_PNG_SUB
           
 final static intPREDICTION_PNG_UP
           
 final static intPREDICTION_TIFF2
           

Method Summary
 byte[]encode(byte[] data)
          Encode the given data and return it.
 intgetBitsPerComponent()
           
 intgetColors()
           
 intgetColumns()
           
 StringgetDecodeParms()
           
 StringgetName()
           
 intgetPredictor()
           
 voidsetBitsPerComponent(int bits)
           
 voidsetColors(int colors)
           
 voidsetColumns(int columns)
           
 voidsetPredictor(int predictor)
           

Methods inherited from class org.apache.fop.pdf.PDFFilter
isApplied, setApplied

Field Detail

PREDICTION_NONE

public final static int PREDICTION_NONE

PREDICTION_PNG_AVG

public final static int PREDICTION_PNG_AVG

PREDICTION_PNG_NONE

public final static int PREDICTION_PNG_NONE

PREDICTION_PNG_OPT

public final static int PREDICTION_PNG_OPT

PREDICTION_PNG_PAETH

public final static int PREDICTION_PNG_PAETH

PREDICTION_PNG_SUB

public final static int PREDICTION_PNG_SUB

PREDICTION_PNG_UP

public final static int PREDICTION_PNG_UP

PREDICTION_TIFF2

public final static int PREDICTION_TIFF2
Method Detail

encode

public byte[] encode(byte[] data)
Encode the given data and return it. Note: a side effect of -this method is that it resets the prediction to the default -because these attributes are not supported. So the DecodeParms -should be retrieved after calling this method.

getBitsPerComponent

public int getBitsPerComponent()

getColors

public int getColors()

getColumns

public int getColumns()

getDecodeParms

public String getDecodeParms()

getName

public String getName()

getPredictor

public int getPredictor()

setBitsPerComponent

public void setBitsPerComponent(int bits)
                          throws PDFFilterException

setColors

public void setColors(int colors)
                throws PDFFilterException

setColumns

public void setColumns(int columns)
                 throws PDFFilterException

setPredictor

public void setPredictor(int predictor)
                   throws PDFFilterException
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAction.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAction.html deleted file mode 100755 index 50b84e5dc..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAction.html +++ /dev/null @@ -1,15 +0,0 @@ -

org.apache.fop.pdf
Class PDFAction

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFAction
-
Direct Known Subclasses:
PDFGoToRemote, PDFInternalLink, PDFUri
public abstract class PDFAction
extends PDFObject

class representing an action object.

Constructor Summary
PDFAction(int number)
          create an Action object.
PDFAction()
          empty constructor for PDFAction.

Method Summary
 abstract StringgetAction()
          represent the action to call -this method should be implemented to return the action which gets -called by the Link Object.
 abstract byte[]toPDF()
          represent the object in PDF -this method should be implemented to return the PDF which is to be -generated by the Action object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFAction

public PDFAction(int number)
create an Action object. -this constructor is used for passing on the object number to the PDFObject
Parameters:
number - the object's number

PDFAction

public PDFAction()
empty constructor for PDFAction. -this constructor is used when there is no additional object being created
Method Detail

getAction

public abstract String getAction()
represent the action to call -this method should be implemented to return the action which gets -called by the Link Object. This could be a reference to another object -or the specific destination of the link
Returns: the action to place next to /A within a Link

toPDF

public abstract byte[] toPDF()
represent the object in PDF -this method should be implemented to return the PDF which is to be -generated by the Action object
Returns: the PDF string
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAnnotList.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAnnotList.html deleted file mode 100755 index bdc92951b..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAnnotList.html +++ /dev/null @@ -1,7 +0,0 @@ -

org.apache.fop.pdf
Class PDFAnnotList

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFAnnotList
-
public class PDFAnnotList
extends PDFObject

class representing an object which is a list of annotations. - -This PDF object is a list of references to /Annot objects. So far we -are dealing only with links.

Constructor Summary
PDFAnnotList(int number)
          create a /Annots object.

Method Summary
 voidaddLink(PDFLink link)
          add an /Annot object of /Subtype /Link.
 intgetCount()
          get the count of /Annot objects
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFAnnotList

public PDFAnnotList(int number)
create a /Annots object.
Parameters:
number - the object's number
Method Detail

addLink

public void addLink(PDFLink link)
add an /Annot object of /Subtype /Link.
Parameters:
link - the PDFLink to add.

getCount

public int getCount()
get the count of /Annot objects
Returns: the number of links

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class java.util.Vector

the /Annot objects
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFArray.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFArray.html deleted file mode 100755 index a838e8ca9..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFArray.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.pdf
Class PDFArray

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFArray
-
public class PDFArray
extends PDFObject

class representing an array object

Constructor Summary
PDFArray(int number, int[] values)
          create the array object

Method Summary
 byte[]toPDF()
          produce the PDF representation for the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFArray

public PDFArray(int number, int[] values)
create the array object
Parameters:
number - the object's number
values - the actual array wrapped by this object
Method Detail

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFColor.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFColor.html deleted file mode 100755 index 88658ba8e..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFColor.html +++ /dev/null @@ -1,6 +0,0 @@ -

org.apache.fop.pdf
Class PDFColor

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFPathPaint
-        |
-        +--org.apache.fop.pdf.PDFColor
-
public class PDFColor
extends PDFPathPaint

Constructor Summary
PDFColor(org.apache.fop.datatypes.ColorType theColor)
           
PDFColor(double theRed, double theGreen, double theBlue)
           
PDFColor(int theRed, int theGreen, int theBlue)
           
PDFColor(double theCyan, double theMagenta, double theYellow, double theBlack)
           

Method Summary
 doubleblack()
           
 doubleblue()
           
 intblue255()
           
 doublecyan()
           
 StringgetColorSpaceOut(boolean fillNotStroke)
           
 VectorgetVector()
           
 doublegreen()
           
 intgreen255()
           
 doublemagenta()
           
 doublered()
           
 intred255()
           
 voidsetColorSpace(int theColorSpace)
           
 (package private) byte[]toPDF()
           
 doubleyellow()
           

Methods inherited from class org.apache.fop.pdf.PDFPathPaint
getColorSpace

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFColor

public PDFColor(org.apache.fop.datatypes.ColorType theColor)

PDFColor

public PDFColor(double theRed, double theGreen, double theBlue)

PDFColor

public PDFColor(int theRed, int theGreen, int theBlue)

PDFColor

public PDFColor(double theCyan, double theMagenta, double theYellow, double theBlack)
Method Detail

black

public double black()

blue

public double blue()

blue255

public int blue255()

cyan

public double cyan()

getColorSpaceOut

public String getColorSpaceOut(boolean fillNotStroke)

getVector

public Vector getVector()

green

public double green()

green255

public int green255()

magenta

public double magenta()

red

public double red()

red255

public int red255()

setColorSpace

public void setColorSpace(int theColorSpace)

toPDF

byte[] toPDF()

yellow

public double yellow()

Association Links

to Class org.apache.fop.pdf.PDFNumber

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFDocument.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFDocument.html deleted file mode 100755 index 866a4c57b..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFDocument.html +++ /dev/null @@ -1,118 +0,0 @@ -

org.apache.fop.pdf
Class PDFDocument

public class PDFDocument

class representing a PDF document. - -The document is built up by calling various methods and then finally -output to given filehandle using output method. - -A PDF document consists of a series of numbered objects preceded by a -header and followed by an xref table and trailer. The xref table -allows for quick access to objects by listing their character -positions within the document. For this reason the PDF document must -keep track of the character position of each object. The document -also keeps direct track of the /Root, /Info and /Resources objects.

Constructor Summary
PDFDocument()
          creates an empty PDF document

Method Summary
 intaddImage(FopImage img)
           
 PDFPatterncreateGradient(boolean radial, ColorSpace theColorspace, Vector theColors, Vector theBounds, Vector theCoords)
           
 intgetColorSpace()
           
 PDFResourcesgetResources()
          get the /Resources object for the document
 PDFAnnotListmakeAnnotList()
          make an annotation list object
 PDFArraymakeArray(int[] values)
          make an Array object (ex.
 PDFEncodingmakeEncoding(String encodingName)
          make a /Encoding object
 PDFFontmakeFont(String fontname, String basefont, String encoding, FontMetric metrics, FontDescriptor descriptor)
          make a Type1 /Font object
 PDFFontDescriptormakeFontDescriptor(FontDescriptor desc)
          make a /FontDescriptor object for a CID font
 PDFFunctionmakeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)
          Make a Type 0 sampled function
 PDFFunctionmakeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)
          make a type Exponential interpolation function -(for shading usually)
 PDFFunctionmakeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)
          Make a Type 3 Stitching function
 PDFFunctionmakeFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)
          make a postscript calculator function
 PDFLinkmakeLink(Rectangle rect, String destination, int linkType)
          make a link object
 PDFPagemakePage(PDFResources resources, PDFStream contents, int pagewidth, int pageheight, Page currentPage)
          make a /Page object
 PDFPatternmakePattern(int thePatternType, PDFResources theResources, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
          Make a tiling pattern
 PDFPatternmakePattern(int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
          Make a smooth shading pattern
 PDFShadingmakeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
          make a function based shading object
 PDFShadingmakeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
          Make an axial or radial shading object.
 PDFShadingmakeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
          Make a free-form gouraud shaded triangle mesh, coons patch mesh, or tensor patch mesh -shading object
 PDFShadingmakeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
          make a Lattice-Form Gouraud mesh shading object
 PDFStreammakeStream()
          make a stream object
 voidoutput(OutputStream stream)
          write the entire document out
 voidsetColorSpace(int theColorspace)
           
 voidsetIDReferences(IDReferences idReferences)
           
 voidsetProducer(String producer)
          set the producer of the document

Constructor Detail

PDFDocument

public PDFDocument()
creates an empty PDF document
Method Detail

addImage

public int addImage(FopImage img)

createGradient

public PDFPattern createGradient(boolean radial, ColorSpace theColorspace, Vector theColors, Vector theBounds, Vector theCoords)

getColorSpace

public int getColorSpace()

getResources

public PDFResources getResources()
get the /Resources object for the document
Returns: the /Resources object

makeAnnotList

public PDFAnnotList makeAnnotList()
make an annotation list object
Returns: the annotation list object created

makeArray

public PDFArray makeArray(int[] values)
make an Array object (ex. Widths array for a font)

makeEncoding

public PDFEncoding makeEncoding(String encodingName)
make a /Encoding object
Parameters:
encodingName - character encoding scheme name
Returns: the created /Encoding object

makeFont

public PDFFont makeFont(String fontname, String basefont, String encoding, FontMetric metrics, FontDescriptor descriptor)
make a Type1 /Font object
Parameters:
fontname - internal name to use for this font (eg "F1")
basefont - name of the base font (eg "Helvetica")
encoding - character encoding scheme used by the font
metrics - additional information about the font
descriptor - additional information about the font
Returns: the created /Font object

makeFontDescriptor

public PDFFontDescriptor makeFontDescriptor(FontDescriptor desc)
make a /FontDescriptor object for a CID font

makeFunction

public PDFFunction makeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)
Make a Type 0 sampled function
Parameters:
theDomain - Vector objects of Double objects. -This is the domain of the function. -See page 264 of the PDF 1.3 Spec.
theRange - Vector objects of Double objects. -This is the Range of the function. -See page 264 of the PDF 1.3 Spec.
theSize - A Vector object of Integer objects. -This is the number of samples in each input dimension. -I can't imagine there being more or less than two input dimensions, -so maybe this should be an array of length 2. - -See page 265 of the PDF 1.3 Spec.
theBitsPerSample - An int specifying the number of bits user to represent each sample value. -Limited to 1,2,4,8,12,16,24 or 32. -See page 265 of the 1.3 PDF Spec.
theOrder - The order of interpolation between samples. Default is 1 (one). Limited -to 1 (one) or 3, which means linear or cubic-spline interpolation. - -This attribute is optional. - -See page 265 in the PDF 1.3 spec.
theEncode - Vector objects of Double objects. -This is the linear mapping of input values intop the domain -of the function's sample table. Default is hard to represent in -ascii, but basically [0 (Size0 1) 0 (Size1 1)...]. -This attribute is optional. - -See page 265 in the PDF 1.3 spec.
theDecode - Vector objects of Double objects. -This is a linear mapping of sample values into the range. -The default is just the range. - -This attribute is optional. -Read about it on page 265 of the PDF 1.3 spec.
theFunctionDataStream - The sample values that specify the function are provided in a stream. - -This is optional, but is almost always used. - -Page 265 of the PDF 1.3 spec has more.
theFilter - This is a vector of String objects which are the various filters that -have are to be applied to the stream to make sense of it. Order matters, -so watch out. - -This is not documented in the Function section of the PDF 1.3 spec, -it was deduced from samples that this is sometimes used, even if we may never -use it in FOP. It is added for completeness sake.
theNumber - The object number of this PDF object.
theFunctionType - This is the type of function (0,2,3, or 4). -It should be 0 as this is the constructor for sampled functions.

makeFunction

public PDFFunction makeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)
make a type Exponential interpolation function -(for shading usually)
Parameters:
theDomain - Vector objects of Double objects. -This is the domain of the function. -See page 264 of the PDF 1.3 Spec.
theRange - Vector of Doubles that is the Range of the function. -See page 264 of the PDF 1.3 Spec.
theCZero - This is a vector of Double objects which defines the function result -when x=0. - -This attribute is optional. -It's described on page 268 of the PDF 1.3 spec.
theCOne - This is a vector of Double objects which defines the function result -when x=1. - -This attribute is optional. -It's described on page 268 of the PDF 1.3 spec.
theInterpolationExponentN - This is the inerpolation exponent. - -This attribute is required. -PDF Spec page 268
theFunctionType - The type of the function, which should be 2.

makeFunction

public PDFFunction makeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)
Make a Type 3 Stitching function
Parameters:
theDomain - Vector objects of Double objects. -This is the domain of the function. -See page 264 of the PDF 1.3 Spec.
theRange - Vector objects of Double objects. -This is the Range of the function. -See page 264 of the PDF 1.3 Spec.
theFunctions - A Vector of the PDFFunction objects that the stitching function stitches. - -This attributed is required. -It is described on page 269 of the PDF spec.
theBounds - This is a vector of Doubles representing the numbers that, -in conjunction with Domain define the intervals to which each function from -the 'functions' object applies. It must be in order of increasing magnitude, -and each must be within Domain. - -It basically sets how much of the gradient each function handles. - -This attributed is required. -It's described on page 269 of the PDF 1.3 spec.
theEncode - Vector objects of Double objects. -This is the linear mapping of input values intop the domain -of the function's sample table. Default is hard to represent in -ascii, but basically [0 (Size0 1) 0 (Size1 1)...]. -This attribute is required. - -See page 270 in the PDF 1.3 spec.
theFunctionType - This is the function type. It should be 3, -for a stitching function.

makeFunction

public PDFFunction makeFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)
make a postscript calculator function
Parameters:
theNumber
theFunctionType
theDomain
theRange
theFunctionDataStream

makeLink

public PDFLink makeLink(Rectangle rect, String destination, int linkType)
make a link object
Parameters:
rect - the clickable rectangle
destination - the destination file
linkType - the link type
Returns: the PDFLink object created

makePage

public PDFPage makePage(PDFResources resources, PDFStream contents, int pagewidth, int pageheight, Page currentPage)
make a /Page object
Parameters:
resources - resources object to use
contents - stream object with content
pagewidth - width of the page in points
pageheight - height of the page in points
Returns: the created /Page object

makePattern

public PDFPattern makePattern(int thePatternType, PDFResources theResources, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
Make a tiling pattern
Parameters:
thePatternType - the type of pattern, which is 1 for tiling.
theResources - the resources associated with this pattern
thePaintType - 1 or 2, colored or uncolored.
theTilingType - 1, 2, or 3, constant spacing, no distortion, or faster tiling
theBBox - Vector of Doubles: The pattern cell bounding box
theXStep - horizontal spacing
theYStep - vertical spacing
theMatrix - Optional Vector of Doubles transformation matrix
theXUID - Optional vector of Integers that uniquely identify the pattern
thePatternDataStream - The stream of pattern data to be tiled.

makePattern

public PDFPattern makePattern(int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
Make a smooth shading pattern
Parameters:
thePatternType - the type of the pattern, which is 2, smooth shading
theShading - the PDF Shading object that comprises this pattern
theXUID - optional:the extended unique Identifier if used.
theExtGState - optional: the extended graphics state, if used.
theMatrix - Optional:Vector of Doubles that specify the matrix.

makeShading

public PDFShading makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
make a function based shading object
Parameters:
theShadingType - The type of shading object, which should be 1 for function -based shading.
theColorSpace - The colorspace is 'DeviceRGB' or something similar.
theBackground - An array of color components appropriate to the -colorspace key specifying a single color value. -This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle -in the coordinate space that is current at the -time of shading is imaged. Temporary clipping -boundary.
theAntiAlias - Whether or not to anti-alias.
theDomain - Optional vector of Doubles specifying the domain.
theMatrix - Vector of Doubles specifying the matrix. -If it's a pattern, then the matrix maps it to pattern space. -If it's a shading, then it maps it to current user space. -It's optional, the default is the identity matrix
theFunction - The PDF Function that maps an (x,y) location to a color

makeShading

public PDFShading makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
Make an axial or radial shading object.
Parameters:
theShadingType - 2 or 3 for axial or radial shading
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the -colorspace key specifying a single color value. -This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle -in the coordinate space that is current at the -time of shading is imaged. Temporary clipping -boundary.
theAntiAlias - Default is false
theCoords - Vector of four (type 2) or 6 (type 3) Double
theDomain - Vector of Doubles specifying the domain
theFunction - the Stitching (PDFfunction type 3) function, even if it's stitching a single function
theExtend - Vector of Booleans of whether to extend teh start and end colors past the start and end points -The default is [false, false]

makeShading

public PDFShading makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
Make a free-form gouraud shaded triangle mesh, coons patch mesh, or tensor patch mesh -shading object
Parameters:
theShadingType - 4, 6, or 7 depending on whether it's -Free-form gouraud-shaded triangle meshes, coons patch meshes, -or tensor product patch meshes, respectively.
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the -colorspace key specifying a single color value. -This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle -in the coordinate space that is current at the -time of shading is imaged. Temporary clipping -boundary.
theAntiAlias - Default is false
theBitsPerCoordinate - 1,2,4,8,12,16,24 or 32.
theBitsPerComponent - 1,2,4,8,12, and 16
theBitsPerFlag - 2,4,8.
theDecode - Vector of Doubles see PDF 1.3 spec pages 303 to 312.
theFunction - the PDFFunction

makeShading

public PDFShading makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
make a Lattice-Form Gouraud mesh shading object
Parameters:
theShadingType - 5 for lattice-Form Gouraud shaded-triangle mesh -without spaces. "Shading1" or "Sh1" are good examples.
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the -colorspace key specifying a single color value. -This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle -in the coordinate space that is current at the -time of shading is imaged. Temporary clipping -boundary.
theAntiAlias - Default is false
theBitsPerCoordinate - 1,2,4,8,12,16, 24, or 32
theBitsPerComponent - 1,2,4,8,12,24,32
theDecode - Vector of Doubles. See page 305 in PDF 1.3 spec.
theVerticesPerRow - number of vertices in each "row" of the lattice.
theFunction - The PDFFunction that's mapped on to this shape

makeStream

public PDFStream makeStream()
make a stream object
Returns: the stream object created

output

public void output(OutputStream stream)
             throws java.io.IOException
write the entire document out
Parameters:
writer - the OutputStream to output the document to

setColorSpace

public void setColorSpace(int theColorspace)

setIDReferences

public void setIDReferences(IDReferences idReferences)

setProducer

public void setProducer(String producer)
set the producer of the document
Parameters:
producer - string indicating application producing the PDF

Association Links

to Class java.lang.String

the version of PDF supported

to Class java.util.Vector

the character position of each object

to Class java.util.Vector

the objects themselves

to Class org.apache.fop.pdf.PDFRoot

the /Root object

to Class org.apache.fop.pdf.PDFInfo

the /Info object

to Class org.apache.fop.pdf.PDFResources

the /Resources object

to Class org.apache.fop.datatypes.IDReferences

the documents idReferences

to Class org.apache.fop.datatypes.ColorSpace

the colorspace (0=RGB, 1=CMYK) *

to Class java.util.Vector

the XObjects

to Class java.util.Hashtable

the XObjects Map. -Should be modified (works only for image subtype)
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFEncoding.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFEncoding.html deleted file mode 100755 index c394b20a3..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFEncoding.html +++ /dev/null @@ -1,13 +0,0 @@ -

org.apache.fop.pdf
Class PDFEncoding

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFEncoding
-
public class PDFEncoding
extends PDFObject

class representing an /Encoding object. - -A small object expressing the base encoding name and -the differences from the base encoding. - -The three base encodings are given by their name. - -Encodings are specified on page 213 and onwards of the PDF 1.3 spec.

Field Summary
 final static StringMacExpertEncoding
          the name for the standard encoding scheme
 final static StringMacRomanEncoding
          the name for the standard encoding scheme
 final static StringWinAnsiEncoding
          the name for the standard encoding scheme

Constructor Summary
PDFEncoding(int number, String basename)
          create the /Encoding object

Method Summary
 voidaddDifferences(int code, Vector sequence)
          add differences to the encoding
 byte[]toPDF()
          produce the PDF representation for the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

MacExpertEncoding

public final static String MacExpertEncoding
the name for the standard encoding scheme

MacRomanEncoding

public final static String MacRomanEncoding
the name for the standard encoding scheme

WinAnsiEncoding

public final static String WinAnsiEncoding
the name for the standard encoding scheme
Constructor Detail

PDFEncoding

public PDFEncoding(int number, String basename)
create the /Encoding object
Parameters:
number - the object's number
basename - the name of the character encoding schema
Method Detail

addDifferences

public void addDifferences(int code, Vector sequence)
add differences to the encoding
Parameters:
code - the first index of the sequence to be changed
sequence - the sequence of glyph names (as String)

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF

Association Links

to Class java.lang.String

the name for the standard encoding scheme

to Class java.lang.String

the name for the standard encoding scheme

to Class java.lang.String

the name for the standard encoding scheme

to Class java.lang.String

the name for the base encoding. -One of the three base encoding scheme names or -the default font's base encoding if null.

to Class java.util.Hashtable

the differences from the base encoding
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFileSpec.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFileSpec.html deleted file mode 100755 index 479ae060a..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFileSpec.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.pdf
Class PDFFileSpec

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFFileSpec
-
public class PDFFileSpec
extends PDFObject

class representing a /FileSpec object.

Constructor Summary
PDFFileSpec(int number, String filename)
          create a /FileSpec object.

Method Summary
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFileSpec

public PDFFileSpec(int number, String filename)
create a /FileSpec object.
Parameters:
number - the object's number
filename - the filename represented by this object
Method Detail

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class java.lang.String

the filename
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilter.html deleted file mode 100755 index 1f3c11b8a..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilter.html +++ /dev/null @@ -1,7 +0,0 @@ -

org.apache.fop.pdf
Class PDFFilter

Direct Known Subclasses:
ASCII85Filter, ASCIIHexFilter, FlateFilter
public abstract class PDFFilter

Method Summary
 abstract byte[]encode(byte[] data)
          encode the given data with the filter
 abstract StringgetDecodeParms()
          return a parameter dictionary for this filter, or null
 abstract StringgetName()
          return a PDF string representation of the filter, e.g.
 booleanisApplied()
           
 voidsetApplied(boolean b)
          Set the applied attribute to the given value.

Method Detail

encode

public abstract byte[] encode(byte[] data)
encode the given data with the filter

getDecodeParms

public abstract String getDecodeParms()
return a parameter dictionary for this filter, or null

getName

public abstract String getName()
return a PDF string representation of the filter, e.g. /FlateDecode

isApplied

public boolean isApplied()

setApplied

public void setApplied(boolean b)
Set the applied attribute to the given value. This attribute is -used to determine if this filter is just a placeholder for the -decodeparms and dictionary entries, or if the filter needs to -actually encode the data. For example if the raw data is copied -out of an image file in it's compressed format, then this -should be set to true and the filter options should be set to -those which the raw data was encoded with.
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilterException.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilterException.html deleted file mode 100755 index 6fb6d9306..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilterException.html +++ /dev/null @@ -1,8 +0,0 @@ -

org.apache.fop.pdf
Class PDFFilterException

java.lang.Object
-  |
-  +--java.lang.Throwable
-        |
-        +--java.lang.Exception
-              |
-              +--org.apache.fop.pdf.PDFFilterException
-
public class PDFFilterException
extends Exception

Constructor Summary
PDFFilterException()
           
PDFFilterException(String message)
           

Methods inherited from class java.lang.Throwable
getMessage, getLocalizedMessage, toString, printStackTrace, printStackTrace, printStackTrace, fillInStackTrace

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

Constructor Detail

PDFFilterException

public PDFFilterException()

PDFFilterException

public PDFFilterException(String message)
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFont.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFont.html deleted file mode 100755 index c07d29aa6..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFont.html +++ /dev/null @@ -1,12 +0,0 @@ -

org.apache.fop.pdf
Class PDFFont

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFFont
-
Direct Known Subclasses:
PDFFontNonBase14
public class PDFFont
extends PDFObject

class representing a /Font object. - -A more complete object expressing the base font name and encoding of a -font along with an internal name for the font used within -streams of content. - -Fonts are specified on page 198 and onwards of the PDF 1.3 spec.

Field Summary
 final static byteMMTYPE1
          font subtype to be used as parameter to createFont()
 final static byteTRUETYPE
          font subtype to be used as parameter to createFont()
 final static byteTYPE0
          font subtype to be used as parameter to createFont()
 final static byteTYPE1
          font subtype to be used as parameter to createFont()
 final static byteTYPE3
          font subtype to be used as parameter to createFont()

Constructor Summary
PDFFont(int number, String fontname, byte subtype, String basefont, Object encoding)
          create the /Font object

Method Summary
 static PDFFontcreateFont(int number, String fontname, byte subtype, String basefont, Object encoding)
          factory method with the basic parameters
 static PDFFontcreateFont(int number, String fontname, byte subtype, String basefont, Object encoding, int firstChar, int lastChar, PDFArray widths, PDFFontDescriptor descriptor)
          factory method with the extended parameters -for Type1, MMType1 and TrueType
 StringgetName()
          get the internal name used for this font
 byte[]toPDF()
          produce the PDF representation for the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

MMTYPE1

public final static byte MMTYPE1
font subtype to be used as parameter to createFont()

TRUETYPE

public final static byte TRUETYPE
font subtype to be used as parameter to createFont()

TYPE0

public final static byte TYPE0
font subtype to be used as parameter to createFont()

TYPE1

public final static byte TYPE1
font subtype to be used as parameter to createFont()

TYPE3

public final static byte TYPE3
font subtype to be used as parameter to createFont()
Constructor Detail

PDFFont

public PDFFont(int number, String fontname, byte subtype, String basefont, Object encoding)
create the /Font object
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype
basefont - the base font name
encoding - the character encoding schema used by the font
mapping - the Unicode mapping mechanism
Method Detail

createFont

public static PDFFont createFont(int number, String fontname, byte subtype, String basefont, Object encoding)
factory method with the basic parameters
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype
basefont - the base font name
encoding - the character encoding schema used by the font

createFont

public static PDFFont createFont(int number, String fontname, byte subtype, String basefont, Object encoding, int firstChar, int lastChar, PDFArray widths, PDFFontDescriptor descriptor)
factory method with the extended parameters -for Type1, MMType1 and TrueType
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype
basefont - the base font name
encoding - the character encoding schema used by the font
firstChar - the first character code in the font
lastChar - the last character code in the font
widths - an array of size (lastChar - firstChar +1)
descriptor - the descriptor for other font's metrics

getName

public String getName()
get the internal name used for this font
Returns: the internal name

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF

Association Links

to Class java.lang.String

font subtype names as output in the PDF

to Class java.lang.String

the internal name for the font (eg "F1")

to Class java.lang.String

the base font name (eg "Helvetica")
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontDescriptor.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontDescriptor.html deleted file mode 100755 index 427a0bbac..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontDescriptor.html +++ /dev/null @@ -1,6 +0,0 @@ -

org.apache.fop.pdf
Class PDFFontDescriptor

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFFontDescriptor
-
public class PDFFontDescriptor
extends PDFObject

class representing a font descriptor. - -Font descriptors are specified on page 222 and onwards of the PDF 1.3 spec.

Constructor Summary
PDFFontDescriptor(int number, String basefont, int ascent, int descent, int capHeight, int flags, PDFRectangle fontBBox, int italicAngle, int stemV)
          create the /FontDescriptor object

Method Summary
 voidsetFontFile(byte subtype, PDFStream fontfile)
          set the optional font file stream
 voidsetMetrics(int avgWidth, int maxWidth, int missingWidth, int leading, int stemH, int xHeight)
          set the optional metrics
 byte[]toPDF()
          produce the PDF representation for the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFontDescriptor

public PDFFontDescriptor(int number, String basefont, int ascent, int descent, int capHeight, int flags, PDFRectangle fontBBox, int italicAngle, int stemV)
create the /FontDescriptor object
Parameters:
number - the object's number
ascent - the maximum height above the baseline
descent - the maximum depth below the baseline
capHeight - height of the capital letters
flags - various characteristics of the font
fontBBox - the bounding box for the described font
basefont - the base font name
italicAngle - the angle of the vertical dominant strokes
stemV - the width of the dominant vertical stems of glyphs
Method Detail

setFontFile

public void setFontFile(byte subtype, PDFStream fontfile)
set the optional font file stream
Parameters:
subtype - the font type defined in the font stream
fontfile - the stream containing an embedded font

setMetrics

public void setMetrics(int avgWidth, int maxWidth, int missingWidth, int leading, int stemH, int xHeight)
set the optional metrics

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF

Association Links

to Class org.apache.fop.pdf.PDFRectangle

to Class java.lang.String

to Class org.apache.fop.pdf.PDFStream

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontNonBase14.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontNonBase14.html deleted file mode 100755 index 4313afd0e..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontNonBase14.html +++ /dev/null @@ -1,7 +0,0 @@ -

org.apache.fop.pdf
Class PDFFontNonBase14

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFFont
-        |
-        +--org.apache.fop.pdf.PDFFontNonBase14
-
Direct Known Subclasses:
PDFFontType1
public abstract class PDFFontNonBase14
extends PDFFont

A common ancestor for Type1, TrueType, MMType1 and Type3 fonts -(all except base 14 fonts).

Fields inherited from class org.apache.fop.pdf.PDFFont
MMTYPE1, TRUETYPE, TYPE0, TYPE1, TYPE3

Constructor Summary
PDFFontNonBase14(int number, String fontname, byte subtype, String basefont, Object encoding)
          create the /Font object

Method Summary
 voidsetDescriptor(PDFFontDescriptor descriptor)
          set the font descriptor (unused for the Type3 fonts)
 voidsetWidthMetrics(int firstChar, int lastChar, PDFArray widths)
          set the width metrics for the font

Methods inherited from class org.apache.fop.pdf.PDFFont
createFont, createFont, getName, toPDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFontNonBase14

public PDFFontNonBase14(int number, String fontname, byte subtype, String basefont, Object encoding)
create the /Font object
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype
basefont - the base font name
encoding - the character encoding schema used by the font
mapping - the Unicode mapping mechanism
Method Detail

setDescriptor

public void setDescriptor(PDFFontDescriptor descriptor)
set the font descriptor (unused for the Type3 fonts)
Parameters:
descriptor - the descriptor for other font's metrics

setWidthMetrics

public void setWidthMetrics(int firstChar, int lastChar, PDFArray widths)
set the width metrics for the font
Parameters:
firstChar - the first character code in the font
lastChar - the last character code in the font
widths - an array of size (lastChar - firstChar +1)

Association Links

to Class org.apache.fop.pdf.PDFArray

widths of characters from firstChar to lastChar

to Class org.apache.fop.pdf.PDFFontDescriptor

descriptor of font metrics
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontType1.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontType1.html deleted file mode 100755 index 2a0e5f9f0..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontType1.html +++ /dev/null @@ -1,14 +0,0 @@ -

org.apache.fop.pdf
Class PDFFontType1

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFFont
-        |
-        +--org.apache.fop.pdf.PDFFontNonBase14
-              |
-              +--org.apache.fop.pdf.PDFFontType1
-
public class PDFFontType1
extends PDFFontNonBase14

class representing a Type1 or MMType1 font (not necessary for the base 14). - -Type1 fonts are specified on page 201 and onwards of the PDF 1.3 spec. -MMType1 fonts are specified on page 205 and onwards of the PDF 1.3 spec. - -In fact everything already done in the superclass. -Must only define the not default constructor.

Fields inherited from class org.apache.fop.pdf.PDFFont
MMTYPE1, TRUETYPE, TYPE0, TYPE1, TYPE3

Constructor Summary
PDFFontType1(int number, String fontname, byte subtype, String basefont, Object encoding)
          create the /Font object

Methods inherited from class org.apache.fop.pdf.PDFFontNonBase14
setDescriptor, setWidthMetrics

Methods inherited from class org.apache.fop.pdf.PDFFont
createFont, createFont, getName, toPDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFontType1

public PDFFontType1(int number, String fontname, byte subtype, String basefont, Object encoding)
create the /Font object
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype (PDFFont.TYPE1 or PDFFont.MMTYPE1)
basefont - the base font name
encoding - the character encoding schema used by the font
mapping - the Unicode mapping mechanism
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFunction.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFunction.html deleted file mode 100755 index 144aea14c..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFunction.html +++ /dev/null @@ -1,123 +0,0 @@ -

org.apache.fop.pdf
Class PDFFunction

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFFunction
-
public class PDFFunction
extends PDFObject

class representing a PDF Function. - -PDF Functions represent parameterized mathematical formulas and sampled representations with -arbitrary resolution. Functions are used in two areas: device-dependent -rasterization information for halftoning and transfer -functions, and color specification for smooth shading (a PDF 1.3 feature). - -All PDF Functions have a FunctionType (0,2,3, or 4), a Domain, and a Range.

Constructor Summary
PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)
          create an complete Function object of Type 0, A Sampled function.
PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)
          create an complete Function object of Type 2, an Exponential Interpolation function.
PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)
          create an complete Function object of Type 3, a Stitching function.
PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)
          create an complete Function object of Type 4, a postscript calculator function.

Method Summary
 byte[]toPDF()
          represent as PDF.

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFunction

public PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)
create an complete Function object of Type 0, A Sampled function. - -Use null for an optional object parameter if you choose not to use it. -For optional int parameters, pass the default.
Parameters:
theDomain - Vector objects of Double objects. -This is the domain of the function. -See page 264 of the PDF 1.3 Spec.
theRange - Vector objects of Double objects. -This is the Range of the function. -See page 264 of the PDF 1.3 Spec.
theSize - A Vector object of Integer objects. -This is the number of samples in each input dimension. -I can't imagine there being more or less than two input dimensions, -so maybe this should be an array of length 2. - -See page 265 of the PDF 1.3 Spec.
theBitsPerSample - An int specifying the number of bits user to represent each sample value. -Limited to 1,2,4,8,12,16,24 or 32. -See page 265 of the 1.3 PDF Spec.
theOrder - The order of interpolation between samples. Default is 1 (one). Limited -to 1 (one) or 3, which means linear or cubic-spline interpolation. - -This attribute is optional. - -See page 265 in the PDF 1.3 spec.
theEncode - Vector objects of Double objects. -This is the linear mapping of input values intop the domain -of the function's sample table. Default is hard to represent in -ascii, but basically [0 (Size0 1) 0 (Size1 1)...]. -This attribute is optional. - -See page 265 in the PDF 1.3 spec.
theDecode - Vector objects of Double objects. -This is a linear mapping of sample values into the range. -The default is just the range. - -This attribute is optional. -Read about it on page 265 of the PDF 1.3 spec.
theFunctionDataStream - The sample values that specify the function are provided in a stream. - -This is optional, but is almost always used. - -Page 265 of the PDF 1.3 spec has more.
theFilter - This is a vector of String objects which are the various filters that -have are to be applied to the stream to make sense of it. Order matters, -so watch out. - -This is not documented in the Function section of the PDF 1.3 spec, -it was deduced from samples that this is sometimes used, even if we may never -use it in FOP. It is added for completeness sake.
theNumber - The object number of this PDF object.
theFunctionType - This is the type of function (0,2,3, or 4). -It should be 0 as this is the constructor for sampled functions.

PDFFunction

public PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)
create an complete Function object of Type 2, an Exponential Interpolation function. - -Use null for an optional object parameter if you choose not to use it. -For optional int parameters, pass the default.
Parameters:
theNumber - the object's number
theDomain - Vector objects of Double objects. -This is the domain of the function. -See page 264 of the PDF 1.3 Spec.
theRange - Vector of Doubles that is the Range of the function. -See page 264 of the PDF 1.3 Spec.
theCZero - This is a vector of Double objects which defines the function result -when x=0. - -This attribute is optional. -It's described on page 268 of the PDF 1.3 spec.
theCOne - This is a vector of Double objects which defines the function result -when x=1. - -This attribute is optional. -It's described on page 268 of the PDF 1.3 spec.
theInterpolationExponentN - This is the inerpolation exponent. - -This attribute is required. -PDF Spec page 268
theFunctionType - The type of the function, which should be 2.

PDFFunction

public PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)
create an complete Function object of Type 3, a Stitching function. - -Use null for an optional object parameter if you choose not to use it. -For optional int parameters, pass the default.
Parameters:
theNumber - the object's number
theDomain - Vector objects of Double objects. -This is the domain of the function. -See page 264 of the PDF 1.3 Spec.
theRange - Vector objects of Double objects. -This is the Range of the function. -See page 264 of the PDF 1.3 Spec.
theFunctions - A Vector of the PDFFunction objects that the stitching function stitches. - -This attributed is required. -It is described on page 269 of the PDF spec.
theBounds - This is a vector of Doubles representing the numbers that, -in conjunction with Domain define the intervals to which each function from -the 'functions' object applies. It must be in order of increasing magnitude, -and each must be within Domain. - -It basically sets how much of the gradient each function handles. - -This attributed is required. -It's described on page 269 of the PDF 1.3 spec.
theEncode - Vector objects of Double objects. -This is the linear mapping of input values intop the domain -of the function's sample table. Default is hard to represent in -ascii, but basically [0 (Size0 1) 0 (Size1 1)...]. -This attribute is required. - -See page 270 in the PDF 1.3 spec.
theFunctionType - This is the function type. It should be 3, -for a stitching function.

PDFFunction

public PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)
create an complete Function object of Type 4, a postscript calculator function. - -Use null for an optional object parameter if you choose not to use it. -For optional int parameters, pass the default.
Parameters:
theDomain - Vector object of Double objects. -This is the domain of the function. -See page 264 of the PDF 1.3 Spec.
theRange - Vector object of Double objects. -This is the Range of the function. -See page 264 of the PDF 1.3 Spec.
theFunctionDataStream - This is a stream of arithmetic, boolean, and stack operators and boolean constants. -I end up enclosing it in the '{' and '}' braces for you, so don't do it -yourself. - -This attribute is required. -It's described on page 269 of the PDF 1.3 spec.
theNumber - The object number of this PDF object.
theFunctionType - The type of function which should be 4, as this is -a Postscript calculator function
Method Detail

toPDF

public byte[] toPDF()
represent as PDF. Whatever the FunctionType is, the correct -representation spits out. The sets of required and optional -attributes are different for each type, but if a required -attribute's object was constructed as null, then no error -is raised. Instead, the malformed PDF that was requested -by the construction is dutifully output. -This policy should be reviewed.
Returns: the PDF string.

Association Links

to Class java.util.Vector

Required: 2 * m Array of Double numbers which are possible inputs to the function

to Class java.util.Vector

Required: 2 * n Array of Double numbers which are possible outputs to the function

to Class java.util.Vector

Required: Array containing the Integer size of the Domain and Range, respectively. -Note: This is really more like two seperate integers, sizeDomain, and sizeRange, -but since they're expressed as an array in PDF, my implementation reflects that.

to Class java.util.Vector

Optional for Type 0: A 2 * m array of Doubles which provides a linear mapping of input values to the domain. - -Required for Type 3: A 2 * k array of Doubles that, taken in pairs, map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function. -Should be two values per function, usually (0,1), as in [0 1 0 1] for 2 functions.

to Class java.util.Vector

Optinoal for Type 0: A 2 * n array of Doubles which provides a linear mapping of sample values to the range. Defaults to Range.

to Class java.lang.StringBuffer

Required For Type 4: Postscript Calculator function composed of arithmetic, boolean, and stack operators + boolean constants

to Class java.util.Vector

Required (?) For Type 0: A vector of Strings for the various filters to be used to decode the stream. -These are how the string is compressed. Flate, LZW, etc.

to Class java.util.Vector

Required For Type 2: An Array of n Doubles defining the function result when x=0. Default is [0].

to Class java.util.Vector

Required For Type 2: An Array of n Doubles defining the function result when x=1. Default is [1].

to Class java.util.Vector

Required for Type 3: An vector of PDFFunctions which form an array of k single input functions making up the stitching function.

to Class java.util.Vector

Optional for Type 3: An array of (k-1) Doubles that, in combination with Domain, define the intervals to which each function from the Functions array apply. Bounds elements must be in order of increasing magnitude, and each value must be within the value of Domain. -k is the number of functions. -If you pass null, it will output (1/k) in an array of k-1 elements. -This makes each function responsible for an equal amount of the stitching function. -It makes the gradient even.

to Class org.apache.fop.pdf.PDFNumber

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoTo.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoTo.html deleted file mode 100755 index ffb39a8f4..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoTo.html +++ /dev/null @@ -1,5 +0,0 @@ -

org.apache.fop.pdf
Class PDFGoTo

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFGoTo
-
public class PDFGoTo
extends PDFObject

class representing a /GoTo object.

Constructor Summary
PDFGoTo(int number, String pageReference)
          create a /GoTo object.

Method Summary
 voidsetPageReference(String pageReference)
          Sets page reference after object has been created
 voidsetXPosition(int xPosition)
          Sets the x Position to jump to
 voidsetYPosition(int yPosition)
          Sets the Y position to jump to
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFGoTo

public PDFGoTo(int number, String pageReference)
create a /GoTo object.
Parameters:
number - the object's number
pageReference - the pageReference represented by this object
Method Detail

setPageReference

public void setPageReference(String pageReference)
Sets page reference after object has been created
Parameters:
pageReference -the - new page reference to use

setXPosition

public void setXPosition(int xPosition)
Sets the x Position to jump to
Parameters:
xPosition - x position

setYPosition

public void setYPosition(int yPosition)
Sets the Y position to jump to
Parameters:
yPosition - y position

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class java.lang.String

the pageReference
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoToRemote.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoToRemote.html deleted file mode 100755 index 264bc2d8e..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoToRemote.html +++ /dev/null @@ -1,6 +0,0 @@ -

org.apache.fop.pdf
Class PDFGoToRemote

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFAction
-        |
-        +--org.apache.fop.pdf.PDFGoToRemote
-
public class PDFGoToRemote
extends PDFAction

class representing a /GoToR object.

Constructor Summary
PDFGoToRemote(int number, PDFFileSpec pdfFileSpec)
          create an GoToR object.

Method Summary
 StringgetAction()
          return the action string which will reference this object
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFGoToRemote

public PDFGoToRemote(int number, PDFFileSpec pdfFileSpec)
create an GoToR object.
Parameters:
number - the object's number
fileSpec - the fileSpec associated with the action
Method Detail

getAction

public String getAction()
return the action string which will reference this object
Returns: the action String

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class org.apache.fop.pdf.PDFFileSpec

the file specification
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInfo.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInfo.html deleted file mode 100755 index 5372526b7..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInfo.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.pdf
Class PDFInfo

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFInfo
-
public class PDFInfo
extends PDFObject

class representing an /Info object

Constructor Summary
PDFInfo(int number)
          create an Info object

Method Summary
 voidsetProducer(String producer)
          set the producer string
 byte[]toPDF()
          produce the PDF representation of the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFInfo

public PDFInfo(int number)
create an Info object
Parameters:
number - the object's number
Method Detail

setProducer

public void setProducer(String producer)
set the producer string
Parameters:
producer - the producer string

toPDF

public byte[] toPDF()
produce the PDF representation of the object
Returns: the PDF

Association Links

to Class java.lang.String

the application producing the PDF
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInternalLink.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInternalLink.html deleted file mode 100755 index 6abb2756d..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInternalLink.html +++ /dev/null @@ -1,6 +0,0 @@ -

org.apache.fop.pdf
Class PDFInternalLink

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFAction
-        |
-        +--org.apache.fop.pdf.PDFInternalLink
-
public class PDFInternalLink
extends PDFAction

class used to create a PDF internal link

Field Summary
 (package private) StringgoToReference
           

Constructor Summary
PDFInternalLink(String goToReference)
          create an internal link instance.

Method Summary
 StringgetAction()
          returns the action ncecessary for an internal link
 byte[]toPDF()
          there is nothing to return for the toPDF method, as it should not be called

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

goToReference

String goToReference
Constructor Detail

PDFInternalLink

public PDFInternalLink(String goToReference)
create an internal link instance.
Parameters:
goToReference - the GoTo Reference to which the link should point
Method Detail

getAction

public String getAction()
returns the action ncecessary for an internal link
Returns: the action to place next to /A within a Link

toPDF

public byte[] toPDF()
there is nothing to return for the toPDF method, as it should not be called
Returns: an empty string

Association Links

to Class java.lang.String

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFLink.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFLink.html deleted file mode 100755 index 232ba4db4..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFLink.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.pdf
Class PDFLink

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFLink
-
public class PDFLink
extends PDFObject

class representing an /Annot object of /Subtype /Link

Field Summary
 (package private) PDFActionaction
           
 (package private) floatbrx
           
 (package private) floatbry
           
 (package private) Stringcolor
           
 (package private) floatulx
           
 (package private) floatuly
           

Constructor Summary
PDFLink(int number, Rectangle r)
          create objects associated with a link annotation (GoToR)

Method Summary
 voidsetAction(PDFAction action)
           
 byte[]toPDF()
          produce the PDF representation of the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

action

PDFAction action

brx

float brx

bry

float bry

color

String color

ulx

float ulx

uly

float uly
Constructor Detail

PDFLink

public PDFLink(int number, Rectangle r)
create objects associated with a link annotation (GoToR)
Parameters:
number - the object's number
producer - the application producing the PDF
Method Detail

setAction

public void setAction(PDFAction action)

toPDF

public byte[] toPDF()
produce the PDF representation of the object
Returns: the PDF

Association Links

to Class java.lang.String

to Class org.apache.fop.pdf.PDFAction

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFNumber.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFNumber.html deleted file mode 100755 index ed9511d0c..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFNumber.html +++ /dev/null @@ -1 +0,0 @@ -

org.apache.fop.pdf
Class PDFNumber

public class PDFNumber

Constructor Summary
PDFNumber()
           

Method Summary
 StringdoubleOut(Double doubleDown)
           
 StringdoubleOut(double doubleDown)
           

Constructor Detail

PDFNumber

public PDFNumber()
Method Detail

doubleOut

public String doubleOut(Double doubleDown)

doubleOut

public String doubleOut(double doubleDown)
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFObject.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFObject.html deleted file mode 100755 index 217e9e986..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFObject.html +++ /dev/null @@ -1,5 +0,0 @@ -

org.apache.fop.pdf
Class PDFObject

Direct Known Subclasses:
PDFAction, PDFAnnotList, PDFArray, PDFEncoding, PDFFileSpec, PDFFont, PDFFontDescriptor, PDFFunction, PDFGoTo, PDFInfo, PDFLink, PDFPage, PDFPages, PDFPathPaint, PDFResources, PDFRoot, PDFShading, PDFStream, PDFXObject
public abstract class PDFObject

generic PDF object. - -A PDF Document is essentially a collection of these objects. A PDF -Object has a number and a generation (although the generation will always -be 0 in new documents).

Constructor Summary
PDFObject(int number)
          create an empty object
PDFObject()
           

Method Summary
 intgetNumber()
           
 StringreferencePDF()
          the PDF representation of a reference to this object
 (package private) abstract byte[]toPDF()
          represent object as PDF

Constructor Detail

PDFObject

public PDFObject(int number)
create an empty object
Parameters:
number - the object's number

PDFObject

public PDFObject()
Method Detail

getNumber

public int getNumber()
Returns: the PDF Object number

referencePDF

public String referencePDF()
the PDF representation of a reference to this object
Returns: the reference string

toPDF

abstract byte[] toPDF()
represent object as PDF
Returns: PDF string
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPage.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPage.html deleted file mode 100755 index f6d060941..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPage.html +++ /dev/null @@ -1,9 +0,0 @@ -

org.apache.fop.pdf
Class PDFPage

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFPage
-
public class PDFPage
extends PDFObject

class representing a /Page object. - -There is one of these for every page in a PDF document. The object -specifies the dimensions of the page and references a /Resources -object, a contents stream and the page's parent in the page -hierarchy.

Constructor Summary
PDFPage(int number, PDFResources resources, PDFStream contents, int pagewidth, int pageheight)
          create a /Page object

Method Summary
 voidaddShading(PDFShading shading)
           
 PDFAnnotListgetAnnotList()
          get this page's annotation list
 voidsetAnnotList(PDFAnnotList annotList)
          set this page's annotation list
 voidsetParent(PDFPages parent)
          set this page's parent
 byte[]toPDF()
          represent this object as PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFPage

public PDFPage(int number, PDFResources resources, PDFStream contents, int pagewidth, int pageheight)
create a /Page object
Parameters:
number - the object's number
resources - the /Resources object
contents - the content stream
pagewidth - the page's width in points
pageheight - the page's height in points
Method Detail

addShading

public void addShading(PDFShading shading)

getAnnotList

public PDFAnnotList getAnnotList()
get this page's annotation list
Returns: annotList a PDFAnnotList list of annotations

setAnnotList

public void setAnnotList(PDFAnnotList annotList)
set this page's annotation list
Parameters:
annotList - a PDFAnnotList list of annotations

setParent

public void setParent(PDFPages parent)
set this page's parent
Parameters:
parent - the /Pages object that is this page's parent

toPDF

public byte[] toPDF()
represent this object as PDF
Returns: the PDF string

Association Links

to Class org.apache.fop.pdf.PDFPages

the page's parent, a /Pages object

to Class org.apache.fop.pdf.PDFResources

the page's /Resource object

to Class org.apache.fop.pdf.PDFStream

the contents stream

to Class org.apache.fop.pdf.PDFAnnotList

the list of annotation objects for this page
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPages.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPages.html deleted file mode 100755 index c3d3f302b..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPages.html +++ /dev/null @@ -1,8 +0,0 @@ -

org.apache.fop.pdf
Class PDFPages

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFPages
-
public class PDFPages
extends PDFObject

class representing a /Pages object. - -A /Pages object is an ordered collection of pages (/Page objects) -(Actually, /Pages can contain further /Pages as well but this -implementation doesn't allow this)

Constructor Summary
PDFPages(int number)
          create a /Pages object.

Method Summary
 voidaddPage(PDFPage page)
          add a /Page object.
 intgetCount()
          get the count of /Page objects
 voidincrementCount()
          increment the count of /Page objects
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFPages

public PDFPages(int number)
create a /Pages object.
Parameters:
number - the object's number
Method Detail

addPage

public void addPage(PDFPage page)
add a /Page object.
Parameters:
page - the PDFPage to add.

getCount

public int getCount()
get the count of /Page objects
Returns: the number of pages

incrementCount

public void incrementCount()
increment the count of /Page objects

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class java.util.Vector

the /Page objects
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPathPaint.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPathPaint.html deleted file mode 100755 index 6482f23e6..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPathPaint.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.pdf
Class PDFPathPaint

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFPathPaint
-
Direct Known Subclasses:
PDFColor, PDFPattern
public abstract class PDFPathPaint
extends PDFObject

Constructor Summary
PDFPathPaint(int theNumber)
           
PDFPathPaint()
           

Method Summary
 intgetColorSpace()
           
 StringgetColorSpaceOut(boolean fillNotStroke)
           
 voidsetColorSpace(int theColorSpace)
           

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF, toPDF

Constructor Detail

PDFPathPaint

public PDFPathPaint(int theNumber)

PDFPathPaint

public PDFPathPaint()
Method Detail

getColorSpace

public int getColorSpace()

getColorSpaceOut

public String getColorSpaceOut(boolean fillNotStroke)

setColorSpace

public void setColorSpace(int theColorSpace)

Association Links

to Class org.apache.fop.datatypes.ColorSpace

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPattern.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPattern.html deleted file mode 100755 index cfa54aadd..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPattern.html +++ /dev/null @@ -1,20 +0,0 @@ -

org.apache.fop.pdf
Class PDFPattern

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFPathPaint
-        |
-        +--org.apache.fop.pdf.PDFPattern
-
public class PDFPattern
extends PDFPathPaint

class representing a PDF Function. - -PDF Functions represent parameterized mathematical formulas and sampled representations with -arbitrary resolution. Functions are used in two areas: device-dependent -rasterization information for halftoning and transfer -functions, and color specification for smooth shading (a PDF 1.3 feature). - -All PDF Functions have a FunctionType (0,2,3, or 4), a Domain, and a Range.

Constructor Summary
PDFPattern(int theNumber, String thePatternName, PDFResources theResources, int thePatternType, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
          Create a tiling pattern (type 1).
PDFPattern(int theNumber, String thePatternName, int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
          Create a type 2 pattern (smooth shading)

Method Summary
 StringgetColorSpaceOut(boolean fillNotStroke)
           
 StringgetName()
          Get the name of the pattern
 byte[]toPDF()
          represent as PDF.

Methods inherited from class org.apache.fop.pdf.PDFPathPaint
getColorSpace, setColorSpace

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFPattern

public PDFPattern(int theNumber, String thePatternName, PDFResources theResources, int thePatternType, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
Create a tiling pattern (type 1).
Parameters:
theNumber - The object number of this PDF Object
thePatternName - The name of the pattern such as "Pa1" or "Pattern1"
theResources - the resources associated with this pattern
thePatternType - the type of pattern, which is 1 for tiling.
thePaintType - 1 or 2, colored or uncolored.
theTilingType - 1, 2, or 3, constant spacing, no distortion, or faster tiling
theBBox - Vector of Doubles: The pattern cell bounding box
theXStep - horizontal spacing
theYStep - vertical spacing
theMatrix - Optional Vector of Doubles transformation matrix
theXUID - Optional vector of Integers that uniquely identify the pattern
thePatternDataStream - The stream of pattern data to be tiled.

PDFPattern

public PDFPattern(int theNumber, String thePatternName, int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
Create a type 2 pattern (smooth shading)
Parameters:
theNumber - the object number of this PDF object
thePatternName - the name of the pattern
thePatternType - the type of the pattern, which is 2, smooth shading
theShading - the PDF Shading object that comprises this pattern
theXUID - optional:the extended unique Identifier if used.
theExtGState - optional: the extended graphics state, if used.
theMatrix - Optional:Vector of Doubles that specify the matrix.
Method Detail

getColorSpaceOut

public String getColorSpaceOut(boolean fillNotStroke)

getName

public String getName()
Get the name of the pattern
Returns: String representing the name of the pattern.

toPDF

public byte[] toPDF()
represent as PDF. Whatever the FunctionType is, the correct -representation spits out. The sets of required and optional -attributes are different for each type, but if a required -attribute's object was constructed as null, then no error -is raised. Instead, the malformed PDF that was requested -by the construction is dutifully output. -This policy should be reviewed.
Returns: the PDF string.

Association Links

to Class org.apache.fop.pdf.PDFNumber

to Class org.apache.fop.pdf.PDFResources

The resources associated with this pattern

to Class java.lang.String

The name of the pattern such as "Pa1" or "Pattern1"

to Class java.util.Vector

Vector of Doubles representing the Bounding box rectangle

to Class org.apache.fop.pdf.PDFShading

The Shading object comprising the Type 2 pattern

to Class java.util.Vector

Vector of Integers represetning the Extended unique Identifier

to Class java.lang.StringBuffer

String representing the extended Graphics state. -Probably will never be used like this.

to Class java.util.Vector

Vector of Doubles representing the Transformation matrix.

to Class java.lang.StringBuffer

The stream of a pattern
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRectangle.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRectangle.html deleted file mode 100755 index 50c588053..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRectangle.html +++ /dev/null @@ -1,3 +0,0 @@ -

org.apache.fop.pdf
Class PDFRectangle

public class PDFRectangle

class representing a rectangle - -Rectangles are specified on page 183 of the PDF 1.3 spec.

Constructor Summary
PDFRectangle(int llx, int lly, int urx, int ury)
          create a rectangle giving the four separate values
PDFRectangle(int[] array)
          create a rectangle giving an array of four values

Method Summary
 byte[]toPDF()
          produce the PDF representation for the object

Constructor Detail

PDFRectangle

public PDFRectangle(int llx, int lly, int urx, int ury)
create a rectangle giving the four separate values
Parameters:
llx - lower left x coordinate
lly - lower left y coordinate
urx - upper right x coordinate
ury - upper right y coordinate

PDFRectangle

public PDFRectangle(int[] array)
create a rectangle giving an array of four values
Parameters:
array - values in the order llx, lly, urx, ury
Method Detail

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFResources.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFResources.html deleted file mode 100755 index 7b902d080..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFResources.html +++ /dev/null @@ -1,7 +0,0 @@ -

org.apache.fop.pdf
Class PDFResources

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFResources
-
public class PDFResources
extends PDFObject

class representing a /Resources object. - -/Resources object contain a list of references to the fonts for the -document

Constructor Summary
PDFResources(int number)
          create a /Resources object.

Method Summary
 voidaddFont(PDFFont font)
          add font object to resources list.
 voidaddPattern(PDFPattern thePattern)
           
 voidaddShading(PDFShading theShading)
           
 voidsetXObjects(Vector xObjects)
           
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFResources

public PDFResources(int number)
create a /Resources object.
Parameters:
number - the object's number
Method Detail

addFont

public void addFont(PDFFont font)
add font object to resources list.
Parameters:
font - the PDFFont to add

addPattern

public void addPattern(PDFPattern thePattern)

addShading

public void addShading(PDFShading theShading)

setXObjects

public void setXObjects(Vector xObjects)

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF

Association Links

to Class java.util.Hashtable

/Font objects keyed by their internal name

to Class java.util.Vector

to Class java.util.Vector

to Class java.util.Vector

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRoot.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRoot.html deleted file mode 100755 index ae89d19a3..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRoot.html +++ /dev/null @@ -1,4 +0,0 @@ -

org.apache.fop.pdf
Class PDFRoot

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFRoot
-
public class PDFRoot
extends PDFObject

class representing a Root (/Catalog) object

Constructor Summary
PDFRoot(int number)
          create a Root (/Catalog) object

Method Summary
 voidaddPage(PDFPage page)
          add a /Page object to the root /Pages object
 voidsetRootPages(PDFPages pages)
          set the root /Pages object
 byte[]toPDF()
          represent the object as PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFRoot

public PDFRoot(int number)
create a Root (/Catalog) object
Parameters:
number - the object's number
Method Detail

addPage

public void addPage(PDFPage page)
add a /Page object to the root /Pages object
Parameters:
page - the /Page object to add

setRootPages

public void setRootPages(PDFPages pages)
set the root /Pages object
Parameters:
pages - the /Pages object to set as root

toPDF

public byte[] toPDF()
represent the object as PDF
Returns: the PDF string

Association Links

to Class org.apache.fop.pdf.PDFPages

the /Pages object that is root of the Pages hierarchy
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFShading.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFShading.html deleted file mode 100755 index ce9f3e955..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFShading.html +++ /dev/null @@ -1,59 +0,0 @@ -

org.apache.fop.pdf
Class PDFShading

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFShading
-
public class PDFShading
extends PDFObject

class representing a PDF Smooth Shading object. - -PDF Functions represent parameterized mathematical formulas and sampled representations with -arbitrary resolution. Functions are used in two areas: device-dependent -rasterization information for halftoning and transfer -functions, and color specification for smooth shading (a PDF 1.3 feature). - -All PDF Functions have a shadingType (0,2,3, or 4), a Domain, and a Range.

Constructor Summary
PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
          Constructor for type function based shading
PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
          Constructor for Type 2 and 3
PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
          Constructor for Type 4,6, or 7
PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
          Constructor for type 5

Method Summary
 StringgetName()
           
 byte[]toPDF()
          represent as PDF.

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFShading

public PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
Constructor for type function based shading
Parameters:
theNumber - The object number of this PDF object
theShadingName - The name of the shading pattern. Can be anything -without spaces. "Shading1" or "Sh1" are good examples.
theShadingType - The type of shading object, which should be 1 for function -based shading.
theColorSpace - The colorspace is 'DeviceRGB' or something similar.
theBackground - An array of color components appropriate to the -colorspace key specifying a single color value. -This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle -in the coordinate space that is current at the -time of shading is imaged. Temporary clipping -boundary.
theAntiAlias - Whether or not to anti-alias.
theDomain - Optional vector of Doubles specifying the domain.
theMatrix - Vector of Doubles specifying the matrix. -If it's a pattern, then the matrix maps it to pattern space. -If it's a shading, then it maps it to current user space. -It's optional, the default is the identity matrix
theFunction - The PDF Function that maps an (x,y) location to a color

PDFShading

public PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
Constructor for Type 2 and 3
Parameters:
theNumber - The object number of this PDF object.
theShadingName - The name of the shading pattern. Can be anything -without spaces. "Shading1" or "Sh1" are good examples.
theShadingType - 2 or 3 for axial or radial shading
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the -colorspace key specifying a single color value. -This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle -in the coordinate space that is current at the -time of shading is imaged. Temporary clipping -boundary.
theAntiAlias - Default is false
theCoords - Vector of four (type 2) or 6 (type 3) Double
theDomain - Vector of Doubles specifying the domain
theFunction - the Stitching (PDFfunction type 3) function, even if it's stitching a single function
theExtend - Vector of Booleans of whether to extend teh start and end colors past the start and end points -The default is [false, false]

PDFShading

public PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
Constructor for Type 4,6, or 7
Parameters:
theNumber - The object number of this PDF object.
theShadingType - 4, 6, or 7 depending on whether it's -Free-form gouraud-shaded triangle meshes, coons patch meshes, -or tensor product patch meshes, respectively.
theShadingName - The name of the shading pattern. Can be anything -without spaces. "Shading1" or "Sh1" are good examples.
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the -colorspace key specifying a single color value. -This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle -in the coordinate space that is current at the -time of shading is imaged. Temporary clipping -boundary.
theAntiAlias - Default is false
theBitsPerCoordinate - 1,2,4,8,12,16,24 or 32.
theBitsPerComponent - 1,2,4,8,12, and 16
theBitsPerFlag - 2,4,8.
theDecode - Vector of Doubles see PDF 1.3 spec pages 303 to 312.
theFunction - the PDFFunction

PDFShading

public PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
Constructor for type 5
Parameters:
theShadingType - 5 for lattice-Form Gouraud shaded-triangle mesh
theShadingName - The name of the shading pattern. Can be anything -without spaces. "Shading1" or "Sh1" are good examples.
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the -colorspace key specifying a single color value. -This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle -in the coordinate space that is current at the -time of shading is imaged. Temporary clipping -boundary.
theAntiAlias - Default is false
theBitsPerCoordinate - 1,2,4,8,12,16, 24, or 32
theBitsPerComponent - 1,2,4,8,12,24,32
theDecode - Vector of Doubles. See page 305 in PDF 1.3 spec.
theVerticesPerRow - number of vertices in each "row" of the lattice.
theFunction - The PDFFunction that's mapped on to this shape
theNumber - the object number of this PDF object.
Method Detail

getName

public String getName()

toPDF

public byte[] toPDF()
represent as PDF. Whatever the shadingType is, the correct -representation spits out. The sets of required and optional -attributes are different for each type, but if a required -attribute's object was constructed as null, then no error -is raised. Instead, the malformed PDF that was requested -by the construction is dutifully output. -This policy should be reviewed.
Returns: the PDF string.

Association Links

to Class java.lang.String

The name of the Shading e.g. "Shading1"

to Class org.apache.fop.datatypes.ColorSpace

A ColorSpace representing the colorspace. "DeviceRGB" is an example.

to Class java.util.Vector

The background color. Since shading is opaque, -this is very rarely used.

to Class java.util.Vector

Optional: A Vector specifying the clipping rectangle

to Class java.util.Vector

Optional for Type 1: Array of four numbers, xmin, xmax, ymin, ymax. Default is [0 1 0 1] -Optional for Type 2: An array of two numbers between which the blend varies between start and end points. Default is 0, 1. -Optional for Type 3: An array of two numbers between which the blend varies between start and end points. Default is 0, 1.

to Class java.util.Vector

Optional for Type 1: A transformation matrix

to Class org.apache.fop.pdf.PDFFunction

Required for Type 1, 2, and 3: -The object of the color mapping function (usually type 2 or 3). -Optional for Type 4,5,6, and 7: When it's nearly the same thing.

to Class java.util.Vector

Required for Type 2: An Array of four numbers specifying the starting and ending coordinate pairs -Required for Type 3: An Array of six numbers [x0,y0,r0,x1,y1,r1] specifying the centers and radii of -the starting and ending circles.

to Class java.util.Vector

Required for Type 2+3: An Array of two boolean values specifying whether to extend the -start and end colors past the start and end points, -respectively. Default is false, false.

to Class java.util.Vector

Required for Type 4,5,6, and 7: Array of Doubles which specifies how to decode coordinate and color component values. -Each type has a differing number of decode array members, so check the spec. -Page 303 in PDF Spec 1.3

to Class org.apache.fop.pdf.PDFNumber

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFStream.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFStream.html deleted file mode 100755 index 9d3577f1f..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFStream.html +++ /dev/null @@ -1,13 +0,0 @@ -

org.apache.fop.pdf
Class PDFStream

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFStream
-
public class PDFStream
extends PDFObject

class representing a PDF stream. - -A derivative of the PDF Object, a PDF Stream has not only a dictionary -but a stream of PDF commands. The stream of commands is where the real -work is done, the dictionary just provides information like the stream -length.

Constructor Summary
PDFStream(int number)
          create an empty stream object

Method Summary
 voidadd(String s)
          append data to the stream
 voidaddFilter(PDFFilter filter)
          Add a filter for compression of the stream.
 voidaddFilter(String filterType)
           
 voidaddImageArray(int[] pixels, int width, int height)
          append an array of xRGB pixels, ASCII Hex Encoding it first
 byte[]getData()
           
 intgetDataLength()
           
 voidsetData(byte[] data)
           
 byte[]toPDF()
          represent as PDF.

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFStream

public PDFStream(int number)
create an empty stream object
Parameters:
number - the object's number
Method Detail

add

public void add(String s)
append data to the stream
Parameters:
s - the string of PDF to add

addFilter

public void addFilter(PDFFilter filter)
Add a filter for compression of the stream. Filters are -applied in the order they are added. This should always be a -new instance of the particular filter of choice. The applied -flag in the filter is marked true after it has been applied to the -data.

addFilter

public void addFilter(String filterType)

addImageArray

public void addImageArray(int[] pixels, int width, int height)
append an array of xRGB pixels, ASCII Hex Encoding it first
Parameters:
pixels - the area of pixels
width - the width of the image in pixels
height - the height of the image in pixels

getData

public byte[] getData()

getDataLength

public int getDataLength()

setData

public void setData(byte[] data)
              throws java.io.IOException

toPDF

public byte[] toPDF()
represent as PDF.
Returns: the PDF string.

Association Links

to Class java.io.ByteArrayOutputStream

the stream of PDF commands

to Class java.util.Vector

the filters that should be applied
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFUri.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFUri.html deleted file mode 100755 index 951ae2060..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFUri.html +++ /dev/null @@ -1,6 +0,0 @@ -

org.apache.fop.pdf
Class PDFUri

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFAction
-        |
-        +--org.apache.fop.pdf.PDFUri
-
public class PDFUri
extends PDFAction

class used to create a PDF Uri link

Field Summary
 (package private) Stringuri
           

Constructor Summary
PDFUri(String uri)
          create a Uri instance.

Method Summary
 StringgetAction()
          returns the action ncecessary for a uri
 byte[]toPDF()
          there is nothing to return for the toPDF method, as it should not be called

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

uri

String uri
Constructor Detail

PDFUri

public PDFUri(String uri)
create a Uri instance.
Parameters:
uri - the uri to which the link should point
Method Detail

getAction

public String getAction()
returns the action ncecessary for a uri
Returns: the action to place next to /A within a Link

toPDF

public byte[] toPDF()
there is nothing to return for the toPDF method, as it should not be called
Returns: an empty string

Association Links

to Class java.lang.String

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFXObject.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFXObject.html deleted file mode 100755 index 40cf0a644..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFXObject.html +++ /dev/null @@ -1,10 +0,0 @@ -

org.apache.fop.pdf
Class PDFXObject

org.apache.fop.pdf.PDFObject
-  |
-  +--org.apache.fop.pdf.PDFXObject
-
public class PDFXObject
extends PDFObject

PDF XObject - -A derivative of the PDF Object, is a PDF Stream that has not only a -dictionary but a stream of image data. -the dictionary just provides information like the stream length

Field Summary
 (package private) FopImagefopimage
           
 (package private) intXnum
           

Constructor Summary
PDFXObject(int number, int Xnumber, FopImage img)
          create an Xobject with the given number and name and load the -image in the object

Method Summary
 intgetXNumber()
           
 (package private) byte[]toPDF()
           

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

fopimage

FopImage fopimage

Xnum

int Xnum
Constructor Detail

PDFXObject

public PDFXObject(int number, int Xnumber, FopImage img)
create an Xobject with the given number and name and load the -image in the object
Method Detail

getXNumber

public int getXNumber()
Returns: the PDF XObject number

toPDF

byte[] toPDF()

Association Links

to Class org.apache.fop.image.FopImage

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/doc-files/pdf.cl.gif b/docs/design/contrib/pdf/org/apache/fop/pdf/doc-files/pdf.cl.gif deleted file mode 100755 index b0bc139e1..000000000 Binary files a/docs/design/contrib/pdf/org/apache/fop/pdf/doc-files/pdf.cl.gif and /dev/null differ diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/doc-files/pdf.cl.html b/docs/design/contrib/pdf/org/apache/fop/pdf/doc-files/pdf.cl.html deleted file mode 100755 index df5b8a0e9..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/doc-files/pdf.cl.html +++ /dev/null @@ -1,41 +0,0 @@ - - - \ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/package-frame.html b/docs/design/contrib/pdf/org/apache/fop/pdf/package-frame.html deleted file mode 100755 index b82138c5a..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/package-frame.html +++ /dev/null @@ -1,7 +0,0 @@ -Package org.apache.fop.pdf -org.apache.fop.pdf
Class Diagrams 
pdf
Classes 
ASCII85Filter
ASCIIHexFilter
FlateFilter
PDFAction
PDFAnnotList
PDFArray
PDFColor
PDFDocument
PDFEncoding
PDFFileSpec
PDFFilter
PDFFilterException
PDFFont
PDFFontDescriptor
PDFFontNonBase14
PDFFontType1
PDFFunction
PDFGoTo
PDFGoToRemote
PDFInfo
PDFInternalLink
PDFLink
PDFNumber
PDFObject
PDFPage
PDFPages
PDFPathPaint
PDFPattern
PDFRectangle
PDFResources
PDFRoot
PDFShading
PDFStream
PDFUri
PDFXObject
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/package-summary.html b/docs/design/contrib/pdf/org/apache/fop/pdf/package-summary.html deleted file mode 100755 index c60d043cb..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/package-summary.html +++ /dev/null @@ -1,14 +0,0 @@ -Package org.apache.fop.pdf

Package org.apache.fop.pdf

-Classes for handling the low-level creation of PDF documents -These classes were developed for FOP, but could be used by other -applications wishing to produce PDF.

See
          Description

Class Diagram Summary
pdf 
 

Class Summary
ASCII85Filter 
ASCIIHexFilter 
FlateFilterA filter to deflate a stream.
PDFActionclass representing an action object.
PDFAnnotListclass representing an object which is a list of annotations.
PDFArrayclass representing an array object
PDFColor 
PDFDocumentclass representing a PDF document.
PDFEncodingclass representing an /Encoding object.
PDFFileSpecclass representing a /FileSpec object.
PDFFilter 
PDFFilterException 
PDFFontclass representing a /Font object.
PDFFontDescriptorclass representing a font descriptor.
PDFFontNonBase14A common ancestor for Type1, TrueType, MMType1 and Type3 fonts -(all except base 14 fonts).
PDFFontType1class representing a Type1 or MMType1 font (not necessary for the base 14).
PDFFunctionclass representing a PDF Function.
PDFGoToclass representing a /GoTo object.
PDFGoToRemoteclass representing a /GoToR object.
PDFInfoclass representing an /Info object
PDFInternalLinkclass used to create a PDF internal link
PDFLinkclass representing an /Annot object of /Subtype /Link
PDFNumber 
PDFObjectgeneric PDF object.
PDFPageclass representing a /Page object.
PDFPagesclass representing a /Pages object.
PDFPathPaint 
PDFPatternclass representing a PDF Function.
PDFRectangleclass representing a rectangle - -Rectangles are specified on page 183 of the PDF 1.3 spec.
PDFResourcesclass representing a /Resources object.
PDFRootclass representing a Root (/Catalog) object
PDFShadingclass representing a PDF Smooth Shading object.
PDFStreamclass representing a PDF stream.
PDFUriclass used to create a PDF Uri link
PDFXObjectPDF XObject - -A derivative of the PDF Object, is a PDF Stream that has not only a -dictionary but a stream of image data.
 

Package org.apache.fop.pdf Description

-

Classes for handling the low-level creation of PDF documents

-

These classes were developed for FOP, but could be used by other -applications wishing to produce PDF.

-
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/package-tree.html b/docs/design/contrib/pdf/org/apache/fop/pdf/package-tree.html deleted file mode 100755 index ef6926290..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/package-tree.html +++ /dev/null @@ -1 +0,0 @@ -org.apache.fop.pdf Class Hierarchy

Hierarchy For Package org.apache.fop.pdf

Package Hierarchies:
All Packages

Class Hierarchy

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/package-use.html b/docs/design/contrib/pdf/org/apache/fop/pdf/package-use.html deleted file mode 100755 index 1cb3d510c..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/package-use.html +++ /dev/null @@ -1,5 +0,0 @@ -

Uses of Package
org.apache.fop.pdf

Packages that use org.apache.fop.pdf
org.apache.fop.pdf 

Classes in org.apache.fop.pdf used by org.apache.fop.pdf
ASCII85Filter
          
ASCIIHexFilter
          
FlateFilter
          A filter to deflate a stream.
PDFAction
          class representing an action object.
PDFAnnotList
          class representing an object which is a list of annotations.
PDFArray
          class representing an array object
PDFColor
          
PDFDocument
          class representing a PDF document.
PDFEncoding
          class representing an /Encoding object.
PDFFileSpec
          class representing a /FileSpec object.
PDFFont
          class representing a /Font object.
PDFFontDescriptor
          class representing a font descriptor.
PDFFontNonBase14
          A common ancestor for Type1, TrueType, MMType1 and Type3 fonts -(all except base 14 fonts).
PDFFontType1
          class representing a Type1 or MMType1 font (not necessary for the base 14).
PDFFunction
          class representing a PDF Function.
PDFGoTo
          class representing a /GoTo object.
PDFGoToRemote
          class representing a /GoToR object.
PDFInfo
          class representing an /Info object
PDFInternalLink
          class used to create a PDF internal link
PDFLink
          class representing an /Annot object of /Subtype /Link
PDFPage
          class representing a /Page object.
PDFPages
          class representing a /Pages object.
PDFPathPaint
          
PDFPattern
          class representing a PDF Function.
PDFResources
          class representing a /Resources object.
PDFRoot
          class representing a Root (/Catalog) object
PDFShading
          class representing a PDF Smooth Shading object.
PDFStream
          class representing a PDF stream.
PDFUri
          class used to create a PDF Uri link
PDFXObject
          PDF XObject - -A derivative of the PDF Object, is a PDF Stream that has not only a -dictionary but a stream of image data.
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/pdf.cl.html b/docs/design/contrib/pdf/org/apache/fop/pdf/pdf.cl.html deleted file mode 100755 index 6ac6fc023..000000000 --- a/docs/design/contrib/pdf/org/apache/fop/pdf/pdf.cl.html +++ /dev/null @@ -1,7 +0,0 @@ -

org.apache.fop.pdf
Class Diagram pdf

Class Summary
ASCII85Filter 
ASCIIHexFilter 
FlateFilterA filter to deflate a stream.
PDFActionclass representing an action object.
PDFAnnotListclass representing an object which is a list of annotations.
PDFArrayclass representing an array object
PDFColor 
PDFDocumentclass representing a PDF document.
PDFEncodingclass representing an /Encoding object.
PDFFileSpecclass representing a /FileSpec object.
PDFFilter 
PDFFilterException 
PDFFontclass representing a /Font object.
PDFFontDescriptorclass representing a font descriptor.
PDFFontNonBase14A common ancestor for Type1, TrueType, MMType1 and Type3 fonts -(all except base 14 fonts).
PDFFontType1class representing a Type1 or MMType1 font (not necessary for the base 14).
PDFFunctionclass representing a PDF Function.
PDFGoToclass representing a /GoTo object.
PDFGoToRemoteclass representing a /GoToR object.
PDFInfoclass representing an /Info object
PDFInternalLinkclass used to create a PDF internal link
PDFLinkclass representing an /Annot object of /Subtype /Link
PDFNumber 
PDFObjectgeneric PDF object.
PDFPageclass representing a /Page object.
PDFPagesclass representing a /Pages object.
PDFPathPaint 
PDFPatternclass representing a PDF Function.
PDFRectangleclass representing a rectangle - -Rectangles are specified on page 183 of the PDF 1.3 spec.
PDFResourcesclass representing a /Resources object.
PDFRootclass representing a Root (/Catalog) object
PDFShadingclass representing a PDF Smooth Shading object.
PDFStreamclass representing a PDF stream.
PDFUriclass used to create a PDF Uri link
PDFXObjectPDF XObject - -A derivative of the PDF Object, is a PDF Stream that has not only a -dictionary but a stream of image data.
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/overview-frame.html b/docs/design/contrib/pdf/overview-frame.html deleted file mode 100755 index ef1a08b96..000000000 --- a/docs/design/contrib/pdf/overview-frame.html +++ /dev/null @@ -1,4 +0,0 @@ -Overview - - - \ No newline at end of file diff --git a/docs/design/contrib/pdf/overview-summary.html b/docs/design/contrib/pdf/overview-summary.html deleted file mode 100755 index 389f4f618..000000000 --- a/docs/design/contrib/pdf/overview-summary.html +++ /dev/null @@ -1,4 +0,0 @@ -Overview
Packages
org.apache.fop.pdf -Classes for handling the low-level creation of PDF documents -These classes were developed for FOP, but could be used by other -applications wishing to produce PDF.
\ No newline at end of file diff --git a/docs/design/contrib/pdf/overview-tree.html b/docs/design/contrib/pdf/overview-tree.html deleted file mode 100755 index 794961455..000000000 --- a/docs/design/contrib/pdf/overview-tree.html +++ /dev/null @@ -1 +0,0 @@ -Class Hierarchy

Hierarchy For All Packages

Package Hierarchies:
org.apache.fop.pdf

Class Hierarchy

\ No newline at end of file diff --git a/docs/design/contrib/pdf/stylesheet.css b/docs/design/contrib/pdf/stylesheet.css deleted file mode 100755 index e6d825496..000000000 --- a/docs/design/contrib/pdf/stylesheet.css +++ /dev/null @@ -1,28 +0,0 @@ -/* Javadoc style sheet */ - -/* Define colors, fonts and other style attributes here to override the defaults */ - -/* Page background color */ -body { background-color: #FFFFFF } - -/* Table colors */ -#TableHeadingColor { background: #CCCCFF } /* Dark mauve */ -#TableSubHeadingColor { background: #EEEEFF } /* Light mauve */ -#TableRowColor { background: #FFFFFF } /* White */ - -/* Font used in left-hand frame lists */ -#FrameTitleFont { font-size: normal; font-family: normal } -#FrameHeadingFont { font-size: normal; font-family: normal } -#FrameItemFont { font-size: normal; font-family: normal } - -/* Example of smaller, sans-serif font in frames */ -/* #FrameItemFont { font-size: 10pt; font-family: Helvetica, Arial, sans-serif } */ - -/* Navigation bar fonts and colors */ -#NavBarCell1 { background-color:#EEEEFF;}/* Light mauve */ -#NavBarCell1Rev { background-color:#00008B;}/* Dark Blue */ -#NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;} -#NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;} - -#NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} -#NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} \ No newline at end of file -- cgit v1.2.3