com.inet.report

Class Text

java.lang.Object

com.inet.report.ReportComponent

com.inet.report.Element

com.inet.report.Text

All Implemented Interfaces:

BorderProperties, GeneralProperties, HyperlinkProperties, NodeParser, com.inet.report.ReferenceHolder, TextProperties, java.io.Serializable, java.lang.Cloneable

public class Text
extends Element
implements TextProperties, com.inet.report.ReferenceHolder, HyperlinkProperties, BorderProperties

This class provides an object that represents a label. It consists of paragraph elements and will be used like a frame for the containing paragraphs. Note that it is not possible to insert a text or a field directly. You have to add it into a paragraph and the paragraph into a text object.
code example:
Text text = section.addText(0,0,1000,200);
Paragraph para = text.addParagraph();
para.addTextPart("This line has");
TextPart tPart = para.addTextPart("different ");tPart.setCursive(true);
para.addTextPart(" format.\n");
Paragraph paraDyn = text.addParagraph();
paraDyn.addFieldPart(fields.getDatabaseField(0));
FieldPart fPart = paraDyn.addFieldPart(fields.getDatabaseField(1));fPart.setFontColor(CoderXML.COLOR_BLUE);
paraDyn.addTextPart("\n");

This example inserts a label into the section section and into the label two lines para and paraDyn. Into both lines it inserts three parts, four static texts and two dynamic. The dynamic parts consists of the database fields with idx 0 and 1. Note that you need one single part for each field.

This class is part of the RDC.

Since:

6.0

See Also:

Paragraph, TextPart, FieldPart, FieldElement, Section.addText(int, int, int, int), Section.remove(Element), Section.getElements(), Section.getElementsV(), Serialized Form

Field Summary

Fields inherited from class com.inet.report.Element

BOX, CHART, CROSSTAB, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, FORMFIELD, INTERACTIVE_SORTING, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART

Fields inherited from interface com.inet.report.TextProperties

GLYPH_DEFAULT, GLYPH_DOWN, GLYPH_LEFT, GLYPH_RIGHT, GLYPH_UP, ROTATE_0, ROTATE_180, ROTATE_270, ROTATE_90

Fields inherited from interface com.inet.report.BorderProperties

LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_DOUBLE, LINE_STYLE_SINGLE, NO_LINE

Fields inherited from interface com.inet.report.GeneralProperties

ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT

Method Summary

Modifier and Type	Method and Description
Paragraph	addParagraph() Create a new paragraph element and adds it into this text element.
int	getGlyphOrientation() Returns the glyph orientation.
FormulaField	getGlyphOrientationFormula() Returns the formula whose return value determines the glyph orientation.
int	getHorAlign() Returns the common HorAlign value from Paragraph Elements if they're all equals or ALIGN_HORIZONTAL_DEFAULT otherwise
Paragraph	getParagraph(int idx) Returns the Paragraph with the specified index.
int	getParagraphCount() Returns the count of Paragraphs in this Text.
java.util.List<Paragraph>	getSubComponents() Returns all ReportComponents that are descendants of this one.
int	getTextRotation() Returns the value of the property 'text rotation'.
FormulaField	getTextRotationFormula() Returns the formula whose return value determines the property 'text rotation'.
Paragraph	insertParagraph(int pos) Creates a new Paragraph instance which is located at a specific position within the text.
void	removeAllParagraphs() Removes all Paragraphs from the Text Element.
void	removeParagraph(int idx) Removes the Paragraph at the specified index.
void	setGlyphOrientation(int orientation) Sets the orientation of the glyphs.
void	setGlyphOrientationFormula(FormulaField formula) Sets the formula whose return value determines the glyph orientation.
void	setHorAlign(int value) Sets the value of the property 'horizontal alignment'.
void	setTextRotation(int rotation) Sets the value of the property 'text rotation'.
void	setTextRotationFormula(FormulaField formula) Sets the formula whose return value determines the property 'text rotation'.

Methods inherited from class com.inet.report.Element

addListener, copy, getBottomLineStyle, getBottomLineStyleFormula, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getParent, getPropertyFormulas, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, indexOf, isCanGrow, isCloseBorderOnPageBreak, isDropShadow, isSuppressIfDuplicated, isTightHorizontal, paramString, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula

Methods inherited from class com.inet.report.ReportComponent

getBackColor, getBackColorFormula, getHeight, getKeepTogetherFormula, getSuppressFormula, getType, getWidth, getX, getY, isKeepTogether, isSuppress, setBackColor, setBackColorFormula, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY

Methods inherited from interface com.inet.report.HyperlinkProperties

getHyperlinkUrl, getHyperlinkUrlFormula, setHyperlinkUrl, setHyperlinkUrlFormula

Methods inherited from interface com.inet.report.BorderProperties

getBackColor, getBackColorFormula, getBottomLineStyle, getBottomLineStyleFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getForeColor, getForeColorFormula, getLeftLineStyle, getLeftLineStyleFormula, getRightLineStyle, getRightLineStyleFormula, getTightHorizontalFormula, getTopLineStyle, getTopLineStyleFormula, isCloseBorderOnPageBreak, isDropShadow, isTightHorizontal, setBackColor, setBackColorFormula, setBottomLineStyle, setBottomLineStyleFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setForeColor, setForeColorFormula, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setTightHorizontal, setTightHorizontalFormula, setTopLineStyle, setTopLineStyleFormula

Methods inherited from interface com.inet.report.GeneralProperties

getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula

Methods inherited from interface com.inet.report.parser.NodeParser

isDOMParser, parseDOM, parseElement, parseEndElement, parseText

Method Detail

addParagraph

public Paragraph addParagraph()

Create a new paragraph element and adds it into this text element. The added paragraph is empty, that means it contains no field or text part element.

Returns:

the created paragraph

Since:

6.0

See Also:

Paragraph

insertParagraph

public Paragraph insertParagraph(int pos)

Creates a new Paragraph instance which is located at a specific position within the text.

Parameters:

pos - The index for the position of the Paragraph.

Returns:

The newly created Paragraph instance.

Since:

7.0

getParagraph

public Paragraph getParagraph(int idx)

Returns the Paragraph with the specified index.

Parameters:

idx - The 0-based index of the Paragraph that should returned.

Returns:

the paragraph at the desired index

Since:

6.0

See Also:

Paragraph, addParagraph(), getParagraphCount(), removeParagraph(int)

getParagraphCount

public int getParagraphCount()

Returns the count of Paragraphs in this Text.

Returns:

the number of paragraphs of this Text element

Since:

6.0

See Also:

Paragraph, addParagraph(), getParagraph(int), removeParagraph(int)

removeParagraph

public void removeParagraph(int idx)

Removes the Paragraph at the specified index.

Parameters:

idx - The 0-based index of the Paragraph that should removed.

Throws:

java.lang.IndexOutOfBoundsException - If the paragraph at the desired position does not exist.

Since:

6.0

See Also:

Paragraph, addParagraph(), getParagraph(int), getParagraphCount(), removeAllParagraphs()

removeAllParagraphs

public void removeAllParagraphs()

Removes all Paragraphs from the Text Element.

Since:

6.0

See Also:

Paragraph, addParagraph(), getParagraph(int), getParagraphCount(), removeParagraph(int)

getGlyphOrientation

public int getGlyphOrientation()

Returns the glyph orientation. This is the rotation of every individual character in the line. The default value is GLYPH_DEFAULT, that is, the glyphs point towards the source of the given block progression. Use the GLYPH constants for the orientation.

Specified by:

getGlyphOrientation in interface TextProperties

Returns:

glyph orientation

See Also:

TextProperties.setGlyphOrientation(int), TextProperties.GLYPH_DEFAULT, TextProperties.GLYPH_UP, TextProperties.GLYPH_DOWN, TextProperties.GLYPH_RIGHT, TextProperties.GLYPH_LEFT

setGlyphOrientation

public void setGlyphOrientation(int orientation)

Sets the orientation of the glyphs. This is the rotation of every individual character in the line. The default value is GLYPH_DEFAULT, that is, the glyphs point towards the source of the given block progression. Use the GLYPH constants for the orientation.

Specified by:

setGlyphOrientation in interface TextProperties

Parameters:

orientation - Orientation to be set for the glyphs (i.e. the rotation of every individual character of the line of text)

See Also:

TextProperties.getGlyphOrientation(), TextProperties.GLYPH_DEFAULT, TextProperties.GLYPH_UP, TextProperties.GLYPH_DOWN, TextProperties.GLYPH_RIGHT, TextProperties.GLYPH_LEFT

setGlyphOrientationFormula

public void setGlyphOrientationFormula(FormulaField formula)

Sets the formula whose return value determines the glyph orientation. This is the rotation of every individual character in each line. This formula should return one of the formula constants GlyphDefault, GlyphLeft, GlyphRight, or GlyphDown.

Specified by:

setGlyphOrientationFormula in interface TextProperties

Parameters:

formula - the formula whose return value determines the glyph orientation

getGlyphOrientationFormula

public FormulaField getGlyphOrientationFormula()

Returns the formula whose return value determines the glyph orientation. This is the rotation of every individual character in each line. This formula should return one of the formula constants GlyphDefault, GlyphLeft, GlyphRight, or GlyphDown.

Specified by:

getGlyphOrientationFormula in interface TextProperties

Returns:

the formula whose return value determines the glyph orientation

setTextRotation

public void setTextRotation(int rotation)

Sets the value of the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. For example, to have a text element have vertical text running from top to bottom and each line run from right to left, you'd set a glyph orientation of GLYPH_LEFT and a text rotation of ROTATE_270.

Specified by:

setTextRotation in interface TextProperties

Parameters:

rotation - The new value of the property 'text rotation'. Rotation is done counter-clockwise.

Since:

5.4

See Also:

TextProperties.ROTATE_0, TextProperties.ROTATE_90, TextProperties.ROTATE_180, TextProperties.ROTATE_270

getTextRotation

public int getTextRotation()

Returns the value of the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. For example, to have a text element have vertical text running from top to bottom and each line run from right to left, you'd set a glyph orientation of GLYPH_LEFT and a text rotation of ROTATE_270.

Specified by:

getTextRotation in interface TextProperties

Returns:

The value of the property 'text rotation'.

Since:

5.4

See Also:

TextProperties.ROTATE_0, TextProperties.ROTATE_90, TextProperties.ROTATE_180, TextProperties.ROTATE_270

getTextRotationFormula

public FormulaField getTextRotationFormula()

Returns the formula whose return value determines the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. This formula should return one of the formula constants Rotate0, Rotate90, Rotate180, or Rotate270.

Specified by:

getTextRotationFormula in interface TextProperties

Returns:

formula whose return value determines the property 'text rotation'.

See Also:

TextProperties.getTextRotation(), TextProperties.setTextRotation(int)

setTextRotationFormula

public void setTextRotationFormula(FormulaField formula)

Sets the formula whose return value determines the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. This formula should return one of the formula constants Rotate0, Rotate90, Rotate180, or Rotate270.

Specified by:

setTextRotationFormula in interface TextProperties

Parameters:

formula - formula whose return value determines the property 'text rotation'.

See Also:

TextProperties.getTextRotation(), TextProperties.setTextRotation(int)

setHorAlign

public void setHorAlign(int value)

Sets the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.

Specified by:

setHorAlign in interface GeneralProperties

Overrides:

setHorAlign in class Element

Parameters:

value - The new value of the property 'horizontal alignment'.

See Also:

GeneralProperties.ALIGN_HORIZONTAL_DEFAULT, GeneralProperties.ALIGN_HORIZONTAL_LEFT, GeneralProperties.ALIGN_HORIZONTAL_CENTER, GeneralProperties.ALIGN_HORIZONTAL_RIGHT, GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED

getHorAlign

public int getHorAlign()

Returns the common HorAlign value from Paragraph Elements if they're all equals or ALIGN_HORIZONTAL_DEFAULT otherwise

Specified by:

getHorAlign in interface GeneralProperties

Overrides:

getHorAlign in class Element

Returns:

the horizontal alignment for all paragraphs or GeneralProperties.ALIGN_HORIZONTAL_DEFAULT if they have different horizontal alignments

Since:

6.0

See Also:

GeneralProperties.ALIGN_HORIZONTAL_DEFAULT, GeneralProperties.ALIGN_HORIZONTAL_LEFT, GeneralProperties.ALIGN_HORIZONTAL_CENTER, GeneralProperties.ALIGN_HORIZONTAL_RIGHT, GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED

getSubComponents

public java.util.List<Paragraph> getSubComponents()

Returns all ReportComponents that are descendants of this one. E.G. this will return all Element of a Section. But it's as well useful for CrossTabs or Text elements which have additional elements.

Specified by:

getSubComponents in class ReportComponent

Returns:

a list with all sub components which can be empty as well; will be null if the component has no descendants