com.chemaxon.overlap.cli.util.images

Interface Renderer

All Known Implementing Classes:

BufferedImageRenderer

public interface Renderer

Methods to render onto a target medium. A Renderer provides methods to draw onto a target medium like a BufferedImage. Methods use integer pixel coordinates and the size of the medium is fixed. A typical use case is to compose a layout containing SubPanes and create a Renderer representing the desired target medium and the layed out size.

Method Summary

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.
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.

Method Detail

setColor

Renderer setColor(String spec)

Set color.

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

Renderer setRGB(int r,
                int g,
                int b)

Set RGB color.

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

Renderer drawLine(int x1,
                  int y1,
                  int x2,
                  int y2)

Draw a line.

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

Renderer drawLine(Px2d p1,
                  Px2d p2)

Draw a line.

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

Renderer drawBorder(Area area,
                    int overflow)

Draw border in/around an Area.

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

Renderer fillArea(Area area,
                  int overflow)

Fill an area.

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

Renderer drawEllipse(Area area)

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.

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

Renderer fillEllipse(Area area)

Draw an ellipse or circle.

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

Renderer setFontHeight(int desiredHeight)

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

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

Renderer setFontHeight(int desiredHeight,
                       double scale)

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

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.

placeCenteredHorizontalTextInto

Renderer placeCenteredHorizontalTextInto(String sq,
                                         Area area)

Place text into the middle of an area.

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.

placeVerticalTextInto

Renderer placeVerticalTextInto(String text,
                               Halign halign,
                               Valign valign,
                               Area area,
                               int offsetX,
                               int offsetY)

Render rotated text into an area.

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.

placeHorizontalTextInto

Renderer placeHorizontalTextInto(String text,
                                 Halign halign,
                                 Valign valign,
                                 Area area,
                                 int offsetX,
                                 int offsetY)

Render text into an area.

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.

drawMolecule

Renderer drawMolecule(Molecule mol,
                      Area area)

Render a Molecule into an area.

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.