Package 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
,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:
This example inserts a label into the section
This class is part of the RDC.
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.inet.report.Element
Element.BorderProps, Element.CommonProperties, Element.ElementTypes, Element.HyperlinkProps, Element.StringProps
-
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.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
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
-
Method Summary
Modifier and TypeMethodDescriptionCreate a new paragraph element and adds it into this text element.int
Returns the glyph orientation.Returns the formula whose return value determines the glyph orientation.int
Returns the common HorAlign value from Paragraph Elements if they're all equals or ALIGN_HORIZONTAL_DEFAULT otherwisegetParagraph
(int idx) Returns the Paragraph with the specified index.int
Returns the count of Paragraphs in this Text.Returns allReportComponent
s that are descendants of this one.int
Returns the value of the property 'text rotation'.Returns the formula whose return value determines the property 'text rotation'.insertParagraph
(int pos) Creates a new Paragraph instance which is located at a specific position within the text.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 XMLvoid
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
Removes all Paragraphs from the Text Element.void
removeParagraph
(int idx) Removes the Paragraph at the specified index.void
FOR INTERNAL USE ONLYvoid
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
FOR INTERNAL USE ONLYvoid
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, 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, 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
Methods inherited from class com.inet.report.ReportComponent
addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getSuppressFormula, getType, getWidth, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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.HyperlinkProperties
getHyperlinkUrl, getHyperlinkUrlFormula, setHyperlinkUrl, setHyperlinkUrlFormula
Methods inherited from interface com.inet.report.ReferenceHolder
addReferencedObject, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, removeReferencedObject
-
Method Details
-
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:
-
insertParagraph
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
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:
-
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:
-
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:
IndexOutOfBoundsException
- If the paragraph at the desired position does not exist.- Since:
- 6.0
- See Also:
-
removeAllParagraphs
public void removeAllParagraphs()Removes all Paragraphs from the Text Element.- Since:
- 6.0
- See Also:
-
setReferences
public void setReferences()FOR INTERNAL USE ONLY- Specified by:
setReferences
in interfacecom.inet.report.ReferenceHolder
- Overrides:
setReferences
in classElement
- Since:
- 6.0
-
resetReferences
public void resetReferences()FOR INTERNAL USE ONLY- Specified by:
resetReferences
in interfacecom.inet.report.ReferenceHolder
- Overrides:
resetReferences
in classReportComponent
-
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 interfaceTextProperties
- Returns:
- glyph orientation
- See Also:
-
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 interfaceTextProperties
- Parameters:
orientation
- Orientation to be set for the glyphs (i.e. the rotation of every individual character of the line of text)- See Also:
-
setGlyphOrientationFormula
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 interfaceTextProperties
- Parameters:
formula
- the formula whose return value determines the glyph orientation
-
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 interfaceTextProperties
- 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 interfaceTextProperties
- Parameters:
rotation
- The new value of the property 'text rotation'. Rotation is done counter-clockwise.- Since:
- 5.4
- See Also:
-
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 interfaceTextProperties
- Returns:
- The value of the property 'text rotation'.
- Since:
- 5.4
- See Also:
-
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 interfaceTextProperties
- Returns:
- formula whose return value determines the property 'text rotation'.
- See Also:
-
setTextRotationFormula
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 interfaceTextProperties
- Parameters:
formula
- formula whose return value determines the property 'text rotation'.- See Also:
-
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 interfaceGeneralProperties
- Overrides:
setHorAlign
in classElement
- Parameters:
value
- The new value of the property 'horizontal alignment'.- See Also:
-
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 interfaceGeneralProperties
- Overrides:
getHorAlign
in classElement
- Returns:
- the horizontal alignment for all paragraphs or
GeneralProperties.ALIGN_HORIZONTAL_DEFAULT
if they have different horizontal alignments - Since:
- 6.0
- See Also:
-
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLParses 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.
- Specified by:
parseElement
in interfaceNodeParser
- Overrides:
parseElement
in classElement
- Parameters:
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 parsedatts
- The set of attributes in the current XMLTagparserMap
- The map of current Parser.- Returns:
- The NodeParser sub-element if one needed to be created, or null if none was created.
- Throws:
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
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLThis 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)
- Specified by:
parseText
in interfaceNodeParser
- Overrides:
parseText
in classElement
- Parameters:
text
- text encountered and to be storedparserMap
- The map of current Parser.
-
getSubComponents
Returns allReportComponent
s that are descendants of this one. E.G. this will return all Element of aSection
. But it's as well useful forCrossTab
s orText
elements which have additional elements.- Specified by:
getSubComponents
in classReportComponent
- Returns:
- a list with all sub components which can be empty as well; will be
null
if the component has no descendants
-