| Home >> All >> org >> apache >> fop |
Page 1 2
| • | org.apache.fop.pdf.* (52) | • | org.apache.fop.render.* (48) | ||
| • | org.apache.fop.tools.* (11) | • | org.apache.fop.viewer.* (12) |
Package Samples:
• org.apache.fop.render.mif.fonts: Classes for rendering the Area Tree to MIF (Maker Interchange Format, used by Adobe FrameMaker).
• org.apache.fop.render.pdf.fonts: Classes for rendering the Area Tree to PDF.
• org.apache.fop.render.xml: generic renderer interface
• org.apache.fop.viewer
• org.apache.fop.pdf
• org.apache.fop.render.pdf
• org.apache.fop.render.txt
• org.apache.fop.render.mif
• org.apache.fop.render.ps
• org.apache.fop.render.pcl
• org.apache.fop.render.awt
• org.apache.fop.render.svg
• org.apache.fop.render
• org.apache.fop.tools.xslt
• org.apache.fop.tools.anttasks
• org.apache.fop.tools
Classes:
• TernaryTree: Ternary Search Tree A ternary search tree is a hibrid between a binary tree and a digital search tree (trie). Keys are limited to strings. A data value of type char is stored in each leaf node. It can be used as an index (or pointer) to the data. Branches that only contain one key are compressed to one node by storing a pointer to the trailer substring of the key. This class is intended to serve as base class or helper class to implement Dictionary collections or the like. Ternary trees have some nice properties as the following: the tree can be traversed in sorted order, partial matches (wildcard) ...
• PageNumberCitation: 6.6.11 fo:page-number-citation Common Usage: The fo:page-number-citation is used to reference the page-number for the page containing the first normal area returned by the cited formatting object. NOTE: It may be used to provide the page-numbers in the table of contents, cross-references, and index entries. Areas: The fo:page-number-citation formatting object generates and returns a single normal inline-area. Constraints: The cited page-number is the number of the page containing, as a descendant, the first normal area returned by the formatting object with an id trait matching the ref-id trait ...
• MessageHandler: The class MessageHandler contains the static methods log and error which should be used for any end user information instead of System.out.print() or System.err.print(). The class defines several output methods: writing to the screen (default), logging to a file, creating message events and repressing all output. If you don't want to change the default behaviour, you should be happy with MessageHandler.log(message) and MessageHandler.error(message) The class MessageHandler also supports the setting of an id. If set every message has as a prefix an identifying string. That way Fop probably can also ...
• Driver: Primary class that drives overall FOP process. The simplest way to use this is to instantiate it with the InputSource and OutputStream, then set the renderer desired, and calling run(); Here is an example use of Driver which outputs PDF: Driver driver = new Driver(new InputSource (args[0]), new FileOutputStream(args[1])); driver.setRenderer(RENDER_PDF); driver.run(); If neccessary, calling classes can call into the lower level methods to setup and render. Methods can be called to set the Renderer to use, the (possibly multiple) ElementMapping(s) to use and the OutputStream to use to output the ...
• 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. Modified by Mark Lillywhite, mark-fop@inomial.com. ...
• Character: this class represents the flow object 'fo:character'. Its use is defined by the spec: "The fo:character flow object represents a character that is mapped to a glyph for presentation. It is an atomic unit to the formatter. When the result tree is interpreted as a tree of formatting objects, a character in the result tree is treated as if it were an empty element of type fo:character with a character attribute equal to the Unicode representation of the character. The semantics of an "auto" value for character properties, which is typically their initial value, are based on the Unicode codepoint. ...
• Fop: Wrapper for Fop which allows it to be accessed from within an Ant task. Accepts the inputs: fofile -> formatting objects file to be transformed format -> MIME type of the format to generate ex. "application/pdf" outfile -> output filename baseDir -> directory to work from userconfig -> file with user configuration (same as the "-c" command line option) messagelevel -> (error | warn | info | verbose | debug) level to output non-error messages logFiles -> Controls whether the names of the files that are processed are logged or not
• PDFPage: 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. Modified by Mark Lillywhite, mark-fop@inomial.com. The Parent object was being referred to by reference, but all that we ever used from the Parent was it's PDF object ID, and according to the memory profile this was causing OOM issues. So, we store only the object ID of the parent, rather than the parent itself.
• TableColLength: A table-column width specification, possibly including some number of proportional "column-units". The absolute size of a column-unit depends on the fixed and proportional sizes of all columns in the table, and on the overall size of the table. It can't be calculated until all columns have been specified and until the actual width of the table is known. Since this can be specified as a percent of its parent containing width, the calculation is done during layout. NOTE: this is only supposed to be allowed if table-layout=fixed.
• Hyphen: This class represents a hyphen. A 'full' hyphen is made of 3 parts: the pre-break text, post-break text and no-break. If no line-break is generated at this position, the no-break text is used, otherwise, pre-break and post-break are used. Typically, pre-break is equal to the hyphen character and the others are empty. However, this general scheme allows support for cases in some languages where words change spelling if they're split across lines, like german's 'backen' which hyphenates 'bak-ken'. BTW, this comes from TeX.
• PDFRenderer: Renderer that renders areas to PDF. Modified by Mark Lillywhite, mark-fop@inomial.com to use the new Renderer interface. The PDF renderer is by far the trickiest renderer and the best supported by FOP. It also required some reworking in the way that Pages, Catalogs and the Root object were written to the stream. The output document should now still be a 100% compatible PDF document, but the order of the document writing is significantly different. See also the changes to PDFPage, PDFPages and PDFRoot.
• IDReferences: IDReferences contains a map of IDs and the objects to which they refer. It also contains a list of references to IDs which have yet to be encountered. Modified by Mark Lillywhite mark-fop@inomial.com. Added getInvalidElements() so that StreamRenderer can tell what hasn't been determined yet. Modified by lmckenzi@ca.ibm.com Sometimes IDs are created, but not validated. This code fixes the incorrect complaint that the ID already exists which prevents basic-links from working (sometimes).
• Numeric: Represents a "numeric" value as defined by the XSL FO Specification. This consists of one or more kinds of value specifications, from absolute numbers (units power of 0) to lengths (unit power of 1), relative lengths (ems), percentage lengths. A Numeric can be constructed from other Property types representing Numbers or Length-type values. Numeric provides methods to return Number and Length values based on its current value. It supports basic arithmetic operations involving Numerics.
• AWTFontMetrics: This is a FontMetrics to be used for AWT rendering. It instanciates a font, depening on famil and style values. The java.awt.FontMetrics for this font is then created to be used for the actual measurement. Since layout is word by word and since it is expected that two subsequent words often share the same style, the Font and FontMetrics is buffered and only changed if needed. Since FontState and FontInfo multiply all factors by size, we assume a "standard" font of FONT_SIZE.
• MessageListener: For situations, where the messages Fop directs to the user have to be handled in some special way, the interface MessageListener and the class MessageEvent are provided. Embedding Fop into a graphical user interface could be such a scenario. Any MessageListener listens for MessageEvents, which contain the user message and also the message type information (progress information or error warning). The class DefaultMessageListener shows an trivial implementation of MessageListener.
• PrintStarter: This class prints a xsl-fo dokument without interaction. At the moment java has not the possibility to configure the printer and it's options without interaction (30.03.2000). This class allows to print a set of pages (from-to), even/odd pages and many copies. - Print from page xxx: property name - start, value int - Print to page xxx: property name - end, value int - Print even/odd pages: property name - even, value boolean - Print xxx copies: property name - copies, value int
• TestConverter: TestConverter is used to process a set of tests specified in a testsuite. This class retrieves the data in the testsuite and uses FOP to convert the xml and xsl file into either an xml representation of the area tree or a pdf document. The area tree can be used for automatic comparisons between different versions of FOP or the pdf can be view for manual checking and pdf rendering. Modified by Mark Lillywhite mark-fop@inomial.com to use the new Driver interface.
• ConfigurationReader: Entry class for reading configuration from file and creating a configuration class. Example of typical use: ConfigurationReader reader = new ConfigurationReader ("config.xml","standard"); try { reader.start(); } catch (org.apache.fop.apps.FOPException error) { reader.dumpError(error); } Once the configuration has been setup, the information can be accessed with the methods of StandardConfiguration.
• PDFShading: 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.
• FOTreeBuilder: SAX Handler that builds the formatting object tree. Modified by Mark Lillywhite mark-fop@inomial.com. Now uses StreamRenderer to automagically render the document as soon as it receives a page-sequence end-tag. Also, calls methods to set up and shut down the renderer at the beginning and end of the FO document. Finally, supresses adding the PageSequence object to the Root, since it is parsed immediately.
• PDFPattern: 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.
• PDFFunction: 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.
• StreamRenderer: This class acts as a bridge between the XML:FO parser and the formatting/rendering classes. It will queue PageSequences up until all the IDs required by them are satisfied, at which time it will render the pages. StreamRenderer is created by Driver and called from FOTreeBuilder when a PageSequence is created, and AreaTree when a Page is formatted.
• PrintRenderer: Abstract base class of "Print" type renderers. Modified by Mark Lillywhite mark-fop@inomial.com. Removed the render(AreaTree, OutputStream) method, and added no-op concrete implementation of startRenderer() and stopRenderer(). The method render(Page, OutputStream) is not mentioned in this class but it is inherited from the Renderer interface.
• LoadableProperties: Erweitert Hashtable um die Methode load. Die Zeilen der Textdatei, die mit # oder ! anfangen sind Kommentarzeilen. Eine gültige Zeile ist entweder eine Kommentarzeile oder eine Zeile mit dem Gleichheitszeichen "in der Mitte". Die Klasse LoadableProperties lässt im Gegensatz zu der Klasse Properties die Schlüsselwerte mit Leerzeichen zu.
| Home | Contact Us | Privacy Policy | Terms of Service |