Klasse Text

java.lang.Object

com.inet.report.ReportComponent

com.inet.report.Element

com.inet.report.Text

Alle implementierten Schnittstellen:

BorderProperties, GeneralProperties, HyperlinkProperties, NodeParser, com.inet.report.ReferenceHolder, TextProperties, Serializable, 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.

Seit:

6.0

Siehe auch:

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

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen Element

Element.BorderProps, Element.CommonProperties, Element.ElementTypes, Element.HyperlinkProps, Element.StringProps

Feldübersicht

Von Klasse geerbte Felder Element

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

Von Schnittstelle geerbte Felder BorderProperties

LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_DOUBLE, LINE_STYLE_SINGLE, NO_LINE

Von Schnittstelle geerbte Felder GeneralProperties

ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT, ALIGN_VERTICAL_BOTTOM, ALIGN_VERTICAL_CENTER, ALIGN_VERTICAL_TOP

Von Schnittstelle geerbte Felder TextProperties

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

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
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.
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.
NodeParser	parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String,Object> parserMap)	FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML
void	parseText(String text, Map<String,Object> parserMap)	FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML
void	removeAllParagraphs()	Removes all Paragraphs from the Text Element.
void	removeParagraph(int idx)	Removes the Paragraph at the specified index.
void	resetReferences()	FOR INTERNAL USE ONLY
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'. Possible alignments are default, left, center, right or justified.
void	setReferences()	FOR INTERNAL USE ONLY
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'.

Von Klasse geerbte Methoden Element

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

Von Klasse geerbte Methoden ReportComponent

addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getStructElem, getSuppressFormula, getType, getWidth, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setStructElem, setSuppress, setSuppressFormula, setWidth, setX, setY

Von Klasse geerbte Methoden Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Von Schnittstelle geerbte Methoden 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

Von Schnittstelle geerbte Methoden GeneralProperties

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

Von Schnittstelle geerbte Methoden HyperlinkProperties

getHyperlinkUrl, getHyperlinkUrlFormula, setHyperlinkUrl, setHyperlinkUrlFormula

Von Schnittstelle geerbte Methoden com.inet.report.ReferenceHolder

addReferencedObject, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, removeReferencedObject

Methodendetails

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.

Gibt zurück:

the created paragraph

Seit:

6.0

Siehe auch:

• Paragraph

insertParagraph

public Paragraph insertParagraph(int pos)

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

Parameter:

pos - The index for the position of the Paragraph.

Gibt zurück:

The newly created Paragraph instance.

Seit:

7.0

getParagraph

public Paragraph getParagraph(int idx)

Returns the Paragraph with the specified index.

Parameter:

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

Gibt zurück:

the paragraph at the desired index

Seit:

6.0

Siehe auch:

• Paragraph
• addParagraph()
• getParagraphCount()
• removeParagraph(int)

getParagraphCount

public int getParagraphCount()

Returns the count of Paragraphs in this Text.

Gibt zurück:

the number of paragraphs of this Text element

Seit:

6.0

Siehe auch:

• Paragraph
• addParagraph()
• getParagraph(int)
• removeParagraph(int)

removeParagraph

public void removeParagraph(int idx)

Removes the Paragraph at the specified index.

Parameter:

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

Löst aus:

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

Seit:

6.0

Siehe auch:

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

removeAllParagraphs

public void removeAllParagraphs()

Removes all Paragraphs from the Text Element.

Seit:

6.0

Siehe auch:

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

setReferences

public void setReferences()

FOR INTERNAL USE ONLY

Angegeben von:

setReferences in Schnittstelle com.inet.report.ReferenceHolder

Setzt außer Kraft:

setReferences in Klasse Element

Seit:

6.0

resetReferences

public void resetReferences()

FOR INTERNAL USE ONLY

Angegeben von:

resetReferences in Schnittstelle com.inet.report.ReferenceHolder

Setzt außer Kraft:

resetReferences in Klasse ReportComponent

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.

Angegeben von:

getGlyphOrientation in Schnittstelle TextProperties

Gibt zurück:

glyph orientation

Siehe auch:

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

Angegeben von:

setGlyphOrientation in Schnittstelle TextProperties

Parameter:

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

Siehe auch:

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

Angegeben von:

setGlyphOrientationFormula in Schnittstelle TextProperties

Parameter:

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.

Angegeben von:

getGlyphOrientationFormula in Schnittstelle TextProperties

Gibt zurück:

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.

Angegeben von:

setTextRotation in Schnittstelle TextProperties

Parameter:

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

Seit:

5.4

Siehe auch:

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

Angegeben von:

getTextRotation in Schnittstelle TextProperties

Gibt zurück:

The value of the property 'text rotation'.

Seit:

5.4

Siehe auch:

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

Angegeben von:

getTextRotationFormula in Schnittstelle TextProperties

Gibt zurück:

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

Siehe auch:

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

Angegeben von:

setTextRotationFormula in Schnittstelle TextProperties

Parameter:

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

Siehe auch:

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

Angegeben von:

setHorAlign in Schnittstelle GeneralProperties

Setzt außer Kraft:

setHorAlign in Klasse Element

Parameter:

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

Siehe auch:

• 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

Angegeben von:

getHorAlign in Schnittstelle GeneralProperties

Setzt außer Kraft:

getHorAlign in Klasse Element

Gibt zurück:

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

Seit:

6.0

Siehe auch:

• GeneralProperties.ALIGN_HORIZONTAL_DEFAULT
• GeneralProperties.ALIGN_HORIZONTAL_LEFT
• GeneralProperties.ALIGN_HORIZONTAL_CENTER
• GeneralProperties.ALIGN_HORIZONTAL_RIGHT
• GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED

parseElement

public NodeParser parseElement(com.inet.report.parser.XMLTag group,
 String tag,
 Attributes atts,
 Map<String,Object> parserMap)
                        throws FatalParserException

FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

Parses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.

Angegeben von:

parseElement in Schnittstelle NodeParser

Setzt außer Kraft:

parseElement in Klasse Element

Parameter:

group - XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.

tag - The XMLTag to be parsed

atts - The set of attributes in the current XMLTag

parserMap - The map of current Parser.

Gibt zurück:

The NodeParser sub-element if one needed to be created, or null if none was created.

Löst aus:

FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.

parseText

public void parseText(String text,
 Map<String,Object> parserMap)

FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

This method is called if text was encountered in the context of this node. (Examples would be a formula's text or a text element's text)

Angegeben von:

parseText in Schnittstelle NodeParser

Setzt außer Kraft:

parseText in Klasse Element

Parameter:

text - text encountered and to be stored

parserMap - The map of current Parser.

getSubComponents

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

Angegeben von:

getSubComponents in Klasse ReportComponent

Gibt zurück:

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