com.arcway.cockpit.docgen.provider.interfaces

Interface IGraphicsHelper

public interface IGraphicsHelper

The IGraphicsHelper provides access methods used for graphic functionallity. The IGraphicsHelper can be referenced directly within a document template by its name graphicsHelper.

Method Summary

Modifier and Type	Method and Description
ITextStyle	createTextStyle(java.lang.String fontName, boolean isBold, boolean isItalic) Creates a text style.
int	getNumberOfTextLines(java.lang.String text, ITextStyle textStyle, double textHeight, double width) Gets the needed number of text lines.
double	getTextLength(java.lang.String text, ITextStyle textStyle, double textHeight) Gets the length of the given text.

Method Detail

createTextStyle

ITextStyle createTextStyle(java.lang.String fontName,
                           boolean isBold,
                           boolean isItalic)

Creates a text style.

Parameters:

fontName - font name

isBold - true for bold

isItalic - true for italic

Returns:

text style

getNumberOfTextLines

int getNumberOfTextLines(java.lang.String text,
                         ITextStyle textStyle,
                         double textHeight,
                         double width)

Gets the needed number of text lines.

Parameters:

text - The text

textStyle - the text style

textHeight - text line height in mm (distance between two base lines)

width - available width in mm

Returns:

needed number of text lines

getTextLength

double getTextLength(java.lang.String text,
                     ITextStyle textStyle,
                     double textHeight)

Gets the length of the given text.

Parameters:

text - The text

textStyle - the text style

textHeight - text line height in mm (distance between two base lines)

Returns:

width width in mm