Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org.jfree.report.modules.output.pageable » base » [javadoc | source]
org.jfree.report.modules.output.pageable.base
public interface: OutputTarget [javadoc | source]

All Implemented Interfaces:
    LayoutSupport

All Known Implementing Classes:
    G2OutputTarget, DummyOutputTarget, AbstractOutputTarget, PDFOutputTarget, PlainTextOutputTarget

An interface that defines the methods that must be supported by a report output target. JFreeReport currently implements three targets: one for Graphics2D (screen and printer), one for Acrobat PDF files and an other target for PlainText output.
Field Summary
public static final  String TITLE    Literal text for the 'title' property name. 
public static final  String AUTHOR    Literal text for the 'author' property name. 
Method from org.jfree.report.modules.output.pageable.base.OutputTarget Summary:
beginPage,   close,   configure,   createDummyWriter,   drawDrawable,   drawImage,   drawShape,   drawString,   endPage,   fillShape,   getFont,   getLogicalPage,   getOperationBounds,   getPaint,   getProperty,   getProperty,   getStroke,   isOpen,   open,   setFont,   setOperationBounds,   setPaint,   setProperty,   setStroke
Method from org.jfree.report.modules.output.pageable.base.OutputTarget Detail:
 public  void beginPage(PhysicalPage page)
    Signals that a page is being started. Stores the state of the target to make it possible to restore the complete output target.
 public  void close()
    Closes the target.
 public  void configure(ReportConfiguration config)
    Configures the output target.
 public OutputTarget createDummyWriter()
    Creates an output target that mimics a real output target, but produces no output. This is used by the reporting engine when it makes its first pass through the report, calculating page boundaries etc. The second pass will use a real output target.
 public  void drawDrawable(DrawableContainer drawable)
    Draws a drawable relative to the current position.
 public  void drawImage(ImageReference image) throws OutputTargetException
    Draws a image relative to the specified coordinates.
 public  void drawShape(Shape shape)
    Draws a shape relative to the current position.
 public  void drawString(String text)
    Draws a string at the current cursor position.
 public  void endPage() throws OutputTargetException
    Signals that the current page is ended. Some targets need to know when a page is finished, others can simply ignore this message.
 public  void fillShape(Shape shape)
    Fills the shape relative to the current position.
 public FontDefinition getFont()
    Returns the current font.
 public LogicalPage getLogicalPage()
    Returns the logical page.
 public Rectangle2D getOperationBounds()
    Returns the operation bounds.
 public Paint getPaint()
    Returns the current paint.
 public String getProperty(String property)
    Returns the value of the specified property. If the property is not found, null is returned.
 public String getProperty(String property,
    String defaultValue)
    Returns the value of the specified property. If the property is not found, the defaultValue is returned.
 public Stroke getStroke()
    Returns the current stroke.
 public boolean isOpen()
    Returns true if the target is open, and false otherwise.
 public  void open() throws OutputTargetException
    Opens the target.
 public  void setFont(FontDefinition font) throws OutputTargetException
    Sets the font.
 public  void setOperationBounds(Rectangle2D bounds)
    Defines the bounds for the next set of operations.
 public  void setPaint(Paint paint) throws OutputTargetException
    Sets the paint.
 public  void setProperty(String property,
    String value)
    Defines a property for this target.

    Properties provide a mechanism for configuring a target. For example, you can add title and author information to a PDF report using the 'title' and 'author' properties.

 public  void setStroke(Stroke stroke) throws OutputTargetException
    Defines the current stroke for the target.

    The stroke is used to draw the outlines of shapes.