Package com.inet.report
Class Paragraph
java.lang.Object
com.inet.report.ReportComponent
com.inet.report.Element
com.inet.report.Paragraph
- All Implemented Interfaces:
GeneralProperties
,ParagraphProperties
,NodeParser
,com.inet.report.ReferenceHolder
,Serializable
,Cloneable
The
This class is part of the RDC.
Paragraph
class represents a line in a Text
and is a set of TextPart
elements and FieldPart
elements.
I.e. a Paragraph
that consists of a text formatted with blue
color, a field, a text formatted with red color and a text formatted with
blue color, has to be split into four parts; three TextPart
elements and one FieldPart
element.
The last part of a Paragraph
is terminated with a newline.
After a FieldPart
element, a TextPart
element
that contains a newline is required. This class is part of the RDC.
- See Also:
-
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.GeneralProperties
ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT
Fields inherited from interface com.inet.report.ParagraphProperties
INDENT_DEFAULT, LINE_SPACING_ABSOLUTE, LINE_SPACING_RELATIVE
-
Method Summary
Modifier and TypeMethodDescription@Nonnull FieldPart
addFieldPart
(Field newField) Creates a new field part element and adds it into this paragraph.@Nonnull TextPart
addTextPart
(String newText) Creates a new text part element and adds it into this paragraph.int
Returns the value of the property 'first line indent'.Returns the formula whose return value determines the property 'first line indent'.int
Returns the value of the property 'left indent'.Returns the formula whose return value determines the property 'left indent'.int
Returns the absolute distance between baselines of the lines in this paragraph, measured in twips.Returns the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.double
Returns the factor by which the default line spacing is to be multiplied for this paragraph.Returns the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph.getPart
(int idx) Returns the TextPart or the FieldPart at the specified index.int
Returns the number of TextParts and FieldParts of this paragraph.int
Returns the value of the property 'rightIndent'.Returns the formula whose return value determines the property 'right indent'.List<? extends ReportComponent>
Returns allReportComponent
s that are descendants of this one.getText()
Returns the parentText
element.int
indexOf()
Returns the index of this Paragraph inside the parent Text element.@Nonnull FieldPart
insertFieldPart
(int pos, Field newfield) Inserts a FieldPart element into this Paragraph.@Nonnull TextPart
insertTextPart
(int pos, String newtext) Inserts a text element into this Paragraph.void
Move FieldParts and TextParts from this Paragraph, beginning at the specified position, to the specified position of the destination Paragraph.void
normalize
(boolean replacePrompts) Normalizes this paragraph.Creates and return a String representation for debugging.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
removePart
(int idx) Removes the TextPart or the FieldPart at the specified index.void
FOR INTERNAL USE ONLYvoid
setFirstLineIndent
(int newValue) Sets the value of the property 'first line indent'.void
setFirstLineIndentFormula
(FormulaField formula) Sets the formula whose return value determines the property 'first line indent'.void
setLeftIndent
(int newLeftIndent) Sets the value of the property 'left indent'.void
setLeftIndentFormula
(FormulaField formula) Sets the formula whose return value determines the property 'left indent'.void
setLineSpacingAbsolute
(int lineSpacingAbsolute) Sets the absolute distance between baselines of the lines in this paragraph, measured in twips.void
Sets the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.void
setLineSpacingRelative
(double lineSpacingRelative) Sets the factor by which the default line spacing is to be multiplied for this paragraph.void
Sets the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph.void
FOR INTERNAL USE ONLYvoid
setRightIndent
(int newRightIndent) Sets the value of the property 'rightIndent'.void
setRightIndentFormula
(FormulaField formula) Sets the formula whose return value determines the property 'right indent'.Methods inherited from class com.inet.report.Element
addListener, copy, getBottomLineStyle, getBottomLineStyleFormula, getBulletValueStack, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getListStack, getParent, getPropertyFormulas, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, getTypeAsString, isCanGrow, isCloseBorderOnPageBreak, isCloseBorderOnPageBreakInternal, isDropShadow, isInCrossTab, isSuppressIfDuplicated, isTightHorizontal, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setBulletValueStack, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHorAlign, 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.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
-
Method Details
-
getText
Returns the parentText
element.- Returns:
- The parent of this Paragraph.
- Since:
- 6.0
-
addTextPart
Creates a new text part element and adds it into this paragraph. If parametertext
isnull
, it will be replaced by an empty String.- Parameters:
newText
- the text of the text part as String- Returns:
- the created text part element
- Since:
- 6.0
-
insertTextPart
Inserts a text element into this Paragraph. The new text element will be placed at the desired position. Invalid positions will be adjusted to the nearest boundary of this Paragraph.- Parameters:
pos
- The position where the text element shall be stored.newtext
- The new text element that shall be stored.- Returns:
- the inserted TextPart
- Since:
- 7.0
-
addFieldPart
Creates a new field part element and adds it into this paragraph.- Parameters:
newField
- The field which should be added into the paragraph.- Returns:
- the created field part element.
- Since:
- 6.0
- See Also:
-
insertFieldPart
Inserts a FieldPart element into this Paragraph. The new field will be placed at the desired position. Invalid positions will be adjusted to the nearest boundary of this Paragraph.- Parameters:
pos
- The position where the element shall be stored.newfield
- The new field that shall be stored.- Returns:
- the inserted FieldPart
- Since:
- 7.0
-
getPart
Returns the TextPart or the FieldPart at the specified index.- Parameters:
idx
- The index of the FieldPart or of the TextPart that should returned.- Returns:
- the part at the given index
- Since:
- 6.0
- See Also:
-
getPartCount
public int getPartCount()Returns the number of TextParts and FieldParts of this paragraph.- Returns:
- the number of child parts
- Since:
- 6.0
- See Also:
-
removePart
public void removePart(int idx) Removes the TextPart or the FieldPart at the specified index.- Parameters:
idx
- The index of the FieldPart or of the TextPart that should removed.- Throws:
IndexOutOfBoundsException
- ifidx
is out of bounds.- Since:
- 6.0
- See Also:
-
moveParts
public void moveParts(int srcPos, Paragraph dest, int destPos, int length) throws IndexOutOfBoundsException, IllegalArgumentException Move FieldParts and TextParts from this Paragraph, beginning at the specified position, to the specified position of the destination Paragraph. Both Paragraph must come from the same Engine. It work also with the same Paragraph if the destPos is outside of the source range.- Parameters:
srcPos
- starting position in this Paragraph. This is the index of FieldPart and TextPart starting with 0.dest
- the destination ParagraphdestPos
- starting position in the destination Paragraph. This is the index of FieldPart and TextPart starting with 0.length
- count of parts that should be moved.- Throws:
IndexOutOfBoundsException
- if srcPos, destPost or length is out of bounds.IllegalArgumentException
- If the Paragraph come from different Engines- Since:
- 9.1
-
paramString
Creates and return a String representation for debugging.- Overrides:
paramString
in classElement
- Returns:
- String representation of this Element for debugging purposes
-
indexOf
public int indexOf()Returns the index of this Paragraph inside the parent Text element. -
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
-
getFirstLineIndent
public int getFirstLineIndent()Returns the value of the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).- Specified by:
getFirstLineIndent
in interfaceParagraphProperties
- Returns:
- The value of the property 'first line indent'.
-
setFirstLineIndent
public void setFirstLineIndent(int newValue) Sets the value of the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).- Specified by:
setFirstLineIndent
in interfaceParagraphProperties
- Parameters:
newValue
- The new value of the property 'first line indent'. May be negative (which would cause the first line to be left of the left margin).
-
getLeftIndent
public int getLeftIndent()Returns the value of the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).- Specified by:
getLeftIndent
in interfaceParagraphProperties
- Returns:
- The value of the property 'left indent'.
-
setLeftIndent
public void setLeftIndent(int newLeftIndent) Sets the value of the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).- Specified by:
setLeftIndent
in interfaceParagraphProperties
- Parameters:
newLeftIndent
- The new value of the property 'left indent'.
-
getRightIndent
public int getRightIndent()Returns the value of the property 'rightIndent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).- Specified by:
getRightIndent
in interfaceParagraphProperties
- Returns:
- The current value of the property 'rightIndent'.
-
setRightIndent
public void setRightIndent(int newRightIndent) Sets the value of the property 'rightIndent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).- Specified by:
setRightIndent
in interfaceParagraphProperties
- Parameters:
newRightIndent
- The new value of the property 'rightIndent'.
-
setLineSpacingAbsolute
public void setLineSpacingAbsolute(int lineSpacingAbsolute) Sets the absolute distance between baselines of the lines in this paragraph, measured in twips. It is also possible to set LINE_SPACING_RELATIVE, which restores the default setting.- Specified by:
setLineSpacingAbsolute
in interfaceParagraphProperties
- Parameters:
lineSpacingAbsolute
- Absolute distance between baselines in this paragraph, measured in twips, or LINE_SPACING_RELATIVE in order to restore the default setting.- See Also:
-
getLineSpacingAbsolute
public int getLineSpacingAbsolute()Returns the absolute distance between baselines of the lines in this paragraph, measured in twips. If a relative factor has been set, this will return the constant LINE_SPACING_RELATIVE.- Specified by:
getLineSpacingAbsolute
in interfaceParagraphProperties
- Returns:
- Absolute distance between baselines in this paragraph, measured in twips, or LINE_SPACING_RELATIVE
- See Also:
-
setLineSpacingRelative
public void setLineSpacingRelative(double lineSpacingRelative) Sets the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this number. Setting LINE_SPACING_ABSOLUTE will cause the value to be reset to its default, which is "1".- Specified by:
setLineSpacingRelative
in interfaceParagraphProperties
- Parameters:
lineSpacingRelative
- Factor by which the default line spacing is to be multiplied for this paragraph, or LINE_SPACING_ABSOLUTE if the default value is to be set (equivalent to "1")- See Also:
-
getLineSpacingRelative
public double getLineSpacingRelative()Returns the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this number. If an absolute value has been set, this will return LINE_SPACING_ABSOLUTE instead.- Specified by:
getLineSpacingRelative
in interfaceParagraphProperties
- Returns:
- Factor by which the default line spacing is to be multiplied for this paragraph, or LINE_SPACING_ABSOLUTE if an absolute line spacing distance has been set.
- See Also:
-
normalize
public void normalize(boolean replacePrompts) Normalizes this paragraph. This means that empty TextParts will be removed and TextParts with the same font properties will be merged. Currently the following properties will be compared to check if the TextParts can be merged.
- font color and formula
- fonr name and formula
- font size and formula
- font style and formula
- strikeout and formula
- underline and formula
- Parameters:
replacePrompts
- replace prompt fields with it current value- Since:
- 9.1
-
getFirstLineIndentFormula
Returns the formula whose return value determines the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).- Specified by:
getFirstLineIndentFormula
in interfaceParagraphProperties
- Returns:
- The formula whose return value determines the property 'first line indent'.
-
getLeftIndentFormula
Returns the formula whose return value determines the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).- Specified by:
getLeftIndentFormula
in interfaceParagraphProperties
- Returns:
- The formula whose return value determines the property 'left indent'.
-
getLineSpacingAbsoluteFormula
Returns the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.- Specified by:
getLineSpacingAbsoluteFormula
in interfaceParagraphProperties
- Returns:
- Absolute distance between baselines in this paragraph, measured in twips
- See Also:
-
getLineSpacingRelativeFormula
Returns the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this formula's value.- Specified by:
getLineSpacingRelativeFormula
in interfaceParagraphProperties
- Returns:
- formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph
- See Also:
-
getRightIndentFormula
Returns the formula whose return value determines the property 'right indent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).- Specified by:
getRightIndentFormula
in interfaceParagraphProperties
- Returns:
- The formula whose return value determines the property 'right indent'.
-
setFirstLineIndentFormula
Sets the formula whose return value determines the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).- Specified by:
setFirstLineIndentFormula
in interfaceParagraphProperties
- Parameters:
formula
- The formula whose return value determines the property 'first line indent'.
-
setLeftIndentFormula
Sets the formula whose return value determines the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).- Specified by:
setLeftIndentFormula
in interfaceParagraphProperties
- Parameters:
formula
- The formula whose return value determines the property 'left indent'.
-
setLineSpacingAbsoluteFormula
Sets the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.- Specified by:
setLineSpacingAbsoluteFormula
in interfaceParagraphProperties
- Parameters:
formula
- formula whose return value determines the absolute distance between baselines in this paragraph, measured in twips- See Also:
-
setLineSpacingRelativeFormula
Sets the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this formula's value.- Specified by:
setLineSpacingRelativeFormula
in interfaceParagraphProperties
- Parameters:
formula
- formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph- See Also:
-
setRightIndentFormula
Sets the formula whose return value determines the property 'right indent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).- Specified by:
setRightIndentFormula
in interfaceParagraphProperties
- Parameters:
formula
- The formula whose return value determines the property 'right indent'.
-
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
-