BufferedImageRenderer (overlap-examples-cli-dist 0.3.5 API)

java.lang.Object
- com.chemaxon.overlap.cli.util.images.BufferedImageRenderer

All Implemented Interfaces:

Renderer
```
public final class BufferedImageRenderer
extends Object
implements Renderer
```
Renderer implementation to paint on a BufferedImage.

Constructor Summary

Constructors
Constructor and Description

BufferedImageRenderer(int sx, int sy)
Size of image in pixels.

Constructors
Constructor and Description
`BufferedImageRenderer(int sx, int sy)` Size of image in pixels.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Renderer`	`drawBorder(Area area, int overflow)` Draw border in/around an Area.
`Renderer`	`drawEllipse(Area area)` Draw an ellipse or circle.
`Renderer`	`drawLine(int x1, int y1, int x2, int y2)` Draw a line.
`Renderer`	`drawLine(Px2d p1, Px2d p2)` Draw a line.
`Renderer`	`drawMolecule(Molecule mol, Area area)` Render a `Molecule` into an area.
`Renderer`	`fillArea(Area area, int overflow)` Fill an area.
`Renderer`	`fillEllipse(Area area)` Draw an ellipse or circle.
`int`	`getSx()` Horizontal size.
`int`	`getSy()` Vertical size.
`Renderer`	`placeCenteredHorizontalTextInto(String sq, Area area)` Place text into the middle of an area.
`Renderer`	`placeHorizontalTextInto(String text, Halign halign, Valign valign, Area area, int offsetX, int offsetY)` Render text into an area.
`Renderer`	`placeVerticalTextInto(String text, Halign halign, Valign valign, Area area, int offsetX, int offsetY)` Render rotated text into an area.
`Renderer`	`setColor(String spec)` Set color.
`Renderer`	`setFontHeight(int desiredHeight)` Set a suitable font size for a specific pixel height.
`Renderer`	`setFontHeight(int desiredHeight, double scale)` Set a suitable font size for a specific pixel height.
`Renderer`	`setRGB(int r, int g, int b)` Set RGB color.
`boolean`	`writePngImage(OutputStream outputStream)` Write image.

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

- Constructor Detail
  - BufferedImageRenderer
```
public BufferedImageRenderer(int sx,
                             int sy)
```
    Size of image in pixels.
    
    Parameters:
    
    sx - Horizontal size
    
    sy - Vertical size
- Method Detail
  - writePngImage
```
public boolean writePngImage(OutputStream outputStream)
                      throws IOException
```
    Write image.
    
    Parameters:
    
    outputStream - See ImageIO.write(java.awt.image.RenderedImage, java.lang.String, java.io.OutputStream)
    
    Returns:
    
    See ImageIO.write(java.awt.image.RenderedImage, java.lang.String, java.io.OutputStream)
    
    Throws:
    
    IOException - propagated from See ImageIO.write(java.awt.image.RenderedImage, java.lang.String, java.io.OutputStream)
  - getSx
```
public int getSx()
```
    Horizontal size.
    
    Returns:
    
    Horizontal size in pixels.
  - getSy
```
public int getSy()
```
    Vertical size.
    
    Returns:
    
    vertical size in pixels.
  - setColor
```
public Renderer setColor(String spec)
```
    Description copied from interface: Renderer
    
    Set color.
    
    Specified by:
    
    setColor in interface Renderer
    
    Parameters:
    
    spec - Color to set. Should be compatible with Integer.decode(java.lang.String).
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - setRGB
```
public Renderer setRGB(int r,
                       int g,
                       int b)
```
    Description copied from interface: Renderer
    
    Set RGB color.
    
    Specified by:
    
    setRGB in interface Renderer
    
    Parameters:
    
    r - Red component, value must be between 0 and 255, inclusive
    
    g - Green component, value must be between 0 and 255, inclusive
    
    b - Blue component, value must be between 0 and 255, inclusive
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - drawLine
```
public Renderer drawLine(int x1,
                         int y1,
                         int x2,
                         int y2)
```
    Description copied from interface: Renderer
    
    Draw a line.
    
    Specified by:
    
    drawLine in interface Renderer
    
    Parameters:
    
    x1 - First endpoint
    
    y1 - First endpoint
    
    x2 - Second endpoint
    
    y2 - Second endpoint
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - drawLine
```
public Renderer drawLine(Px2d p1,
                         Px2d p2)
```
    Description copied from interface: Renderer
    
    Draw a line.
    
    Specified by:
    
    drawLine in interface Renderer
    
    Parameters:
    
    p1 - First endpoint
    
    p2 - Second endpoint
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - drawBorder
```
public Renderer drawBorder(Area area,
                           int overflow)
```
    Description copied from interface: Renderer
    
    Draw border in/around an Area.
    
    Specified by:
    
    drawBorder in interface Renderer
    
    Parameters:
    
    area - Area
    
    overflow - Use 0 to draw the inside bounds, 1 to draw immediate outside bounds.
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - fillArea
```
public Renderer fillArea(Area area,
                         int overflow)
```
    Description copied from interface: Renderer
    
    Fill an area.
    
    Specified by:
    
    fillArea in interface Renderer
    
    Parameters:
    
    area - Area to fill.
    
    overflow - Use 0 to fill the represented area, 1 to fill the area and its immediate outside bounds
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - drawEllipse
```
public Renderer drawEllipse(Area area)
```
    Description copied from interface: Renderer
    
    Draw an ellipse or circle. The drawn ellipse/circle will fit into the specified Area. In case of a Graphics based target the delegated method Graphics.drawOval(int, int, int, int) will be invoked 1 pixel by 1 pixel smaller size.
    
    Specified by:
    
    drawEllipse in interface Renderer
    
    Parameters:
    
    area - Area to fit into
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - fillEllipse
```
public Renderer fillEllipse(Area area)
```
    Description copied from interface: Renderer
    
    Draw an ellipse or circle.
    
    Specified by:
    
    fillEllipse in interface Renderer
    
    Parameters:
    
    area - Area to fit into
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - setFontHeight
```
public Renderer setFontHeight(int desiredHeight)
```
    Description copied from interface: Renderer
    
    Set a suitable font size for a specific pixel height. See http://stackoverflow.com/questions/5829703/java-getting-a-font-with-a-specific-height-in-pixels
    
    Specified by:
    
    setFontHeight in interface Renderer
    
    Parameters:
    
    desiredHeight - Desired font height
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - setFontHeight
```
public Renderer setFontHeight(int desiredHeight,
                              double scale)
```
    Description copied from interface: Renderer
    
    Set a suitable font size for a specific pixel height. See http://stackoverflow.com/questions/5829703/java-getting-a-font-with-a-specific-height-in-pixels
    
    Specified by:
    
    setFontHeight in interface Renderer
    
    Parameters:
    
    desiredHeight - Desired font height
    
    scale - Scale factor to apply to the desired height
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - placeHorizontalTextInto
```
public Renderer placeHorizontalTextInto(String text,
                                        Halign halign,
                                        Valign valign,
                                        Area area,
                                        int offsetX,
                                        int offsetY)
```
    Description copied from interface: Renderer
    
    Render text into an area.
    
    Specified by:
    
    placeHorizontalTextInto in interface Renderer
    
    Parameters:
    
    text - Single line text to render
    
    halign - Horizontal alignment of the text in the containing area
    
    valign - Vertical alignment of the text in the containing area
    
    area - The containing area
    
    offsetX - X offset, applied after alignment
    
    offsetY - Y offset, applied after alignment
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - placeVerticalTextInto
```
public Renderer placeVerticalTextInto(String text,
                                      Halign halign,
                                      Valign valign,
                                      Area area,
                                      int offsetX,
                                      int offsetY)
```
    Description copied from interface: Renderer
    
    Render rotated text into an area.
    
    Specified by:
    
    placeVerticalTextInto in interface Renderer
    
    Parameters:
    
    text - Single line text to render
    
    halign - Horizontal alignment of the rendered text in the containing area
    
    valign - Vertical alignment of the rendered text in the containing area
    
    area - The containing area
    
    offsetX - X offset, applied after alignment
    
    offsetY - Y offset, applied after alignment
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - placeCenteredHorizontalTextInto
```
public Renderer placeCenteredHorizontalTextInto(String sq,
                                                Area area)
```
    Description copied from interface: Renderer
    
    Place text into the middle of an area.
    
    Specified by:
    
    placeCenteredHorizontalTextInto in interface Renderer
    
    Parameters:
    
    sq - Text to place
    
    area - An area
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.
  - drawMolecule
```
public Renderer drawMolecule(Molecule mol,
                             Area area)
```
    Description copied from interface: Renderer
    
    Render a Molecule into an area.
    
    Specified by:
    
    drawMolecule in interface Renderer
    
    Parameters:
    
    mol - Molecule to render
    
    area - Target area
    
    Returns:
    
    Reference to a Renderer which can be used equivalently to this. An implementation might choose to return this.

Class BufferedImageRenderer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BufferedImageRenderer

Method Detail

writePngImage

getSx

getSy

setColor

setRGB

drawLine

drawLine

drawBorder

fillArea

drawEllipse

fillEllipse

setFontHeight

setFontHeight

placeHorizontalTextInto

placeVerticalTextInto

placeCenteredHorizontalTextInto

drawMolecule