com.arcway.cockpit.docgen.provider.interfaces

Interface IProjectionFactory

public interface IProjectionFactory

Projection factory.

Field Summary

Fields

Modifier and Type	Field and Description
static int	H_CENTER horizontal center alignment
static int	H_LEFT horizontal left alignment
static int	H_RIGHT horizontal right alignment
static int	MODE_WIDTH_IS_EXACT_WITDH schoud be accurate textArrayWidthHint
static int	MODE_WIDTH_IS_MAXMIMUM_WITDH shoud be smaler then textArrayWidthHint when the Text is shorter
static int	MODE_WIDTH_IS_MINIMUM_WITDH shoud be biger then textArrayWidthHint when the Text is longer
static int	V_BOTTOM vertical bottom alignment
static int	V_CENTER vertical center alignment
static int	V_TOP vertical top alignment

Method Summary

Modifier and Type	Method and Description
com.arcway.planagent.controllinginterface.planviewer.IProjection	createBubbleContainerProjection(java.util.List<com.arcway.planagent.controllinginterface.planviewer.IProjection> projections) Wrappes the given projections into a bubble.
IColor	createColor(int red, int green, int blue) Creates a color.
com.arcway.planagent.controllinginterface.planviewer.IProjection	createCounterProjection(int count) Counter.
com.arcway.planagent.controllinginterface.planviewer.IProjection	createCounterProjection(int count, IColor color) Counter.
com.arcway.planagent.controllinginterface.planviewer.IProjection	createCounterProjection(java.lang.String text, IColor color) Counter.
com.arcway.planagent.controllinginterface.planviewer.IProjection	createDimensionedProgressBarProjection(double barAreaWidth, double textAreaMinWidth, double barAreaHeight, double axisAreaHeight, IColor axisColor, double axisLength, IColor axisBorderColor, IColor axisLabelColor, ITextStyle axisLabelTextStyle, java.lang.String axisLabelText, IColor barPartLeftFillColor, IColor barPartLeftTextColor, ITextStyle barPartLeftTextStyle, java.lang.String barPartLeftText, double barPartLeftLength, IColor barPartRightFillColor, IColor barPartRightTextColor, ITextStyle barPartRightTextStyle, java.lang.String barPartRightText, double barPartRigthLength, IColor barBorderColor, IColor barLabelColor, ITextStyle barLabelTextStyle, java.lang.String barLabelText) Dimensioned progress bar projection Use createColor(int, int, int) and #createTextStyle(String, int, int) to create the colors and text styles.
com.arcway.planagent.controllinginterface.planviewer.IProjection	createProgressBarProjection(int progress) Progress bar.
com.arcway.planagent.controllinginterface.planviewer.IProjection	createTextArrayProjection(java.util.List<java.lang.String> texts, IColor textColor, double textArrayWidthHint, int textArrayWidthMode, ITextStyle textStyle, double textHeight, int hAlignment, int vAlignment) Text projection.
com.arcway.planagent.controllinginterface.planviewer.IProjection	createTextLabelProjection(java.lang.String text) Text label.
com.arcway.planagent.controllinginterface.planviewer.IProjection	createTextProjection(java.lang.String text, IColor textColor, double textWidth, ITextStyle textStyle, double textHeight, int hAlignment, int vAlignment) Text projection.
ITextStyle	createTextStyle(java.lang.String fontName, boolean isBold, boolean isItalic) Creates a text style.
com.arcway.planagent.controllinginterface.planviewer.IProjection	createWarningSignProjection() Creates a warning sign projection.

Field Detail

H_LEFT

static final int H_LEFT

horizontal left alignment

See Also:

Constant Field Values

H_CENTER

static final int H_CENTER

horizontal center alignment

See Also:

Constant Field Values

H_RIGHT

static final int H_RIGHT

horizontal right alignment

See Also:

Constant Field Values

V_TOP

static final int V_TOP

vertical top alignment

See Also:

Constant Field Values

V_CENTER

static final int V_CENTER

vertical center alignment

See Also:

Constant Field Values

V_BOTTOM

static final int V_BOTTOM

vertical bottom alignment

See Also:

Constant Field Values

MODE_WIDTH_IS_EXACT_WITDH

static final int MODE_WIDTH_IS_EXACT_WITDH

schoud be accurate textArrayWidthHint

See Also:

Constant Field Values

MODE_WIDTH_IS_MINIMUM_WITDH

static final int MODE_WIDTH_IS_MINIMUM_WITDH

shoud be biger then textArrayWidthHint when the Text is longer

See Also:

Constant Field Values

MODE_WIDTH_IS_MAXMIMUM_WITDH

static final int MODE_WIDTH_IS_MAXMIMUM_WITDH

shoud be smaler then textArrayWidthHint when the Text is shorter

See Also:

Constant Field Values

Method Detail

createWarningSignProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createWarningSignProjection()

Creates a warning sign projection.

Returns:

the created projection

createTextProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createTextProjection(java.lang.String text,
                                                                                      IColor textColor,
                                                                                      double textWidth,
                                                                                      ITextStyle textStyle,
                                                                                      double textHeight,
                                                                                      int hAlignment,
                                                                                      int vAlignment)

Text projection.

Parameters:

text - the text to be displayed

textColor - the text color (use createColor(int, int, int) to create the color)

textWidth - the text array width

textStyle - the text style to use (use #createTextStyle(String, int, int) to create the style)

textHeight - the text height

hAlignment - H_LEFT, H_CENTER or H_RIGHT

vAlignment - V_TOP, V_CENTER or V_BOTTOM

createTextArrayProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createTextArrayProjection(java.util.List<java.lang.String> texts,
                                                                                           IColor textColor,
                                                                                           double textArrayWidthHint,
                                                                                           int textArrayWidthMode,
                                                                                           ITextStyle textStyle,
                                                                                           double textHeight,
                                                                                           int hAlignment,
                                                                                           int vAlignment)

Text projection.

Parameters:

texts -

textColor - the text color (use createColor(int, int, int) to create the color)

textArrayWidthHint -

textArrayWidthMode - (use MODE_WIDTH_IS_EXACT_WITDH}, MODE_WIDTH_IS_MINIMUM_WITDH or MODE_WIDTH_IS_MAXMIMUM_WITDH})

textStyle - the text style to use (use #createTextStyle(String, int, int) to create the style)

textHeight -

hAlignment - H_LEFT, H_CENTER or H_RIGHT

vAlignment - V_TOP, V_CENTER or V_BOTTOM

Returns:

createTextLabelProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createTextLabelProjection(java.lang.String text)

Text label.

Parameters:

text -

Returns:

the created projection

createCounterProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createCounterProjection(int count)

Counter.

Parameters:

count -

Returns:

the created projection

createCounterProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createCounterProjection(int count,
                                                                                         IColor color)

Counter.

Parameters:

count -

color - the background color (use createColor(int, int, int) to create the color)

Returns:

the created projection

createCounterProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createCounterProjection(java.lang.String text,
                                                                                         IColor color)

Counter.

Parameters:

text -

color - the background color (use createColor(int, int, int) to create the color)

Returns:

the created projection

createProgressBarProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createProgressBarProjection(int progress)

Progress bar.

Parameters:

progress - 0..100

Returns:

the created projection

createBubbleContainerProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createBubbleContainerProjection(java.util.List<com.arcway.planagent.controllinginterface.planviewer.IProjection> projections)

Wrappes the given projections into a bubble.

Parameters:

projections - to be wrapped

Returns:

the created projection

createDimensionedProgressBarProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection createDimensionedProgressBarProjection(double barAreaWidth,
                                                                                                        double textAreaMinWidth,
                                                                                                        double barAreaHeight,
                                                                                                        double axisAreaHeight,
                                                                                                        IColor axisColor,
                                                                                                        double axisLength,
                                                                                                        IColor axisBorderColor,
                                                                                                        IColor axisLabelColor,
                                                                                                        ITextStyle axisLabelTextStyle,
                                                                                                        java.lang.String axisLabelText,
                                                                                                        IColor barPartLeftFillColor,
                                                                                                        IColor barPartLeftTextColor,
                                                                                                        ITextStyle barPartLeftTextStyle,
                                                                                                        java.lang.String barPartLeftText,
                                                                                                        double barPartLeftLength,
                                                                                                        IColor barPartRightFillColor,
                                                                                                        IColor barPartRightTextColor,
                                                                                                        ITextStyle barPartRightTextStyle,
                                                                                                        java.lang.String barPartRightText,
                                                                                                        double barPartRigthLength,
                                                                                                        IColor barBorderColor,
                                                                                                        IColor barLabelColor,
                                                                                                        ITextStyle barLabelTextStyle,
                                                                                                        java.lang.String barLabelText)

Dimensioned progress bar projection

Use createColor(int, int, int) and #createTextStyle(String, int, int) to create the colors and text styles.

Parameters:

barAreaWidth - width of bar area in 1/72 dpi

textAreaMinWidth - minimum width of bar text in 1/72 dpi

barAreaHeight - height of the bar in 1/72 dpi

axisAreaHeight - height of the axis in 1/72 dpi

axisColor - axis color (null if no axis and no axis label)

axisLength - axis length (in the same unit as barPartLeftLength and barPartRigthLength)

axisBorderColor - color of the border of the axis

axisLabelColor - color of axis label (null if no axis label)

axisLabelTextStyle - text style of the axis label (null if no axis label)

axisLabelText - text of axis label (null if no axis label)

barPartLeftFillColor - fill color of the left part of the bar

barPartLeftTextColor - color of the text in the left part of the bar (null if no text for this bar part)

barPartLeftTextStyle - text style of the left bar part label (null if no label)

barPartLeftText - text in the left part of the bar (null if no text for this bar part)

barPartLeftLength - left bar part length (in the same unit as axisLength and barPartRigthLength)

barPartRightFillColor - fill color of the rigth part of the bar

barPartRightTextColor - color of the text in the right part of the bar (null if no text for this bar part)

barPartRightTextStyle - text style of the right bar part label (null if no label)

barPartRightText - text in the right part of the bar (null if no text for this bar part)

barPartRigthLength - right bar part length (in the same unit as axisLength and barPartLeftLength)

barBorderColor - color of the border of the bar

barLabelColor - color of bar label (null if no bar label)

barLabelTextStyle - style of the bar label (null if no bar label)

barLabelText - text of bar label (null if no bar label)

Returns:

the created projection

createColor

IColor createColor(int red,
                   int green,
                   int blue)

Creates a color.

Parameters:

red - 0..255

green - 0..255

blue - 0..255

Returns:

the created color

createTextStyle

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

Creates a text style.

Parameters:

fontName -

isBold - true for bold

isItalic - true for italic

Returns:

the created text style