Package com.inet.report
Class TextPart
java.lang.Object
com.inet.report.ReportComponent
com.inet.report.Element
com.inet.report.AbstractFontElement
com.inet.report.TextPart
- All Implemented Interfaces:
FontProperties,GeneralProperties,NodeParser,com.inet.report.ReferenceHolder,Serializable,Cloneable
The text objects in a report are separated into parts of text, where each part has its own format, i.e. color and size. This elements are called text parts and are represented by this class. Note
that it is not possible to instantiate this class directly. Please use the
example: adding the line "hello World" into a text
This class is part of the RDC.
Paragraph.addTextPart(String) method from class Paragraph instead. example: adding the line "hello World" into a text
TextPart tPartHello = paragraph.addTextPart("hello ");
TextPart tPartWorld = paragraph.addTextPart("World");
tPartWorld.setFontBold(true);
paragraph is a reference to a line of a text you want to insert. The method addTextPart creates a new instance of TextPart, initialize it with
the given String and formats it with default. The method saves one reference to the new TextPart into paragraph and returns one. In the example it
happens twice times, because the two parts get different format. If the whole String should use the same format add only one TextPart with both words.This class is part of the RDC.
- Since:
- 6.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.inet.report.AbstractFontElement
AbstractFontElement.FontPropsNested 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, TEXTPARTFields inherited from interface com.inet.report.FontProperties
FONT_DIALOG, FONT_MONOSPACED, FONT_SANS_SERIF, FONT_SERIF, FONT_STYLE_BOLD, FONT_STYLE_ITALIC, FONT_STYLE_STRIKETHROUGH, FONT_STYLE_UNDERLINEFields inherited from interface com.inet.report.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 -
Method Summary
Modifier and TypeMethodDescriptionintUse the value of the parent paragraph.Use the value of the parent paragraph.Returns this field part's parent's paragraph.List<? extends ReportComponent>Returns allReportComponents that are descendants of this one.getText()Gets the value of the property 'text'.intindexOf()Returns The current index of this text part in its paragraph.Creates and return a String representation for debugging.voidFOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoidsetHorAlign(int value) Use the value of the parent paragraph.voidsetHorAlignFormula(FormulaField newFormula) Use the value of the parent paragraph.voidSets the value of the property 'text'.Methods inherited from class com.inet.report.AbstractFontElement
getFontColor, getFontColorFormula, getFontName, getFontNameFormula, getFontSize, getFontSizeFormula, getFontSizeTwips, getFontStyle, getFontStyleFormula, getPropertyFormulas, getStrikeoutFormula, getUnderlineFormula, isBold, isItalic, isStrikeout, isUnderline, parseElement, setBold, setFontColor, setFontColorFormula, setFontName, setFontNameFormula, setFontSize, setFontSizeFormula, setFontSizeTwips, setFontStyle, setFontStyleFormula, setItalic, setStrikeout, setStrikeoutFormula, setUnderline, setUnderlineFormulaMethods inherited from class com.inet.report.Element
addListener, copy, getBottomLineStyle, getBottomLineStyleFormula, getBulletValueStack, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getListStack, getParent, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, getTypeAsString, getVerAlign, getVerAlignFormula, isCanGrow, isCloseBorderOnPageBreak, isCloseBorderOnPageBreakInternal, isDropShadow, isInCrossTab, isSuppressIfDuplicated, isTightHorizontal, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setBulletValueStack, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setListStack, setReferences, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula, setVerAlign, setVerAlignFormulaMethods 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, resetReferences, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setYMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.inet.report.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
-
Method Details
-
getParentParagraph
Returns this field part's parent's paragraph.- Returns:
- This field part's parent's paragraph.
- Since:
- 7.0
- See Also:
-
getText
Gets the value of the property 'text'. The property text contains the string, that is shown by the label, that TextPart belongs to.- Returns:
- The value of the property 'text'.
- Since:
- 6.0
-
setText
Sets the value of the property 'text'. The property text contains the string, that is shown by the label, that TextPart belongs to.- Parameters:
newValue- The new value of the property 'text'.- Since:
- 6.0
-
paramString
Creates and return a String representation for debugging.- Overrides:
paramStringin classElement- Returns:
- String representation of this Element for debugging purposes
-
indexOf
public int indexOf()Returns The current index of this text part in its paragraph. -
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:
parseTextin interfaceNodeParser- Overrides:
parseTextin classElement- Parameters:
text- text encountered and to be storedparserMap- The map of current Parser.
-
getHorAlign
public int getHorAlign()Use the value of the parent paragraph. Returns the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
getHorAlignin interfaceGeneralProperties- Overrides:
getHorAlignin classElement- Returns:
- Possible return values are default, left, center, right or justified.
- See Also:
-
getHorAlignFormula
Use the value of the parent paragraph. Returns the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
getHorAlignFormulain interfaceGeneralProperties- Overrides:
getHorAlignFormulain classElement- Returns:
- FormulaField The formula for the property 'horizontal alignment'.
-
setHorAlign
public void setHorAlign(int value) Use the value of the parent paragraph. Sets the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
setHorAlignin interfaceGeneralProperties- Overrides:
setHorAlignin classElement- Parameters:
value- The new value of the property 'horizontal alignment'.- See Also:
-
setHorAlignFormula
Use the value of the parent paragraph. Sets the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
setHorAlignFormulain interfaceGeneralProperties- Overrides:
setHorAlignFormulain classElement- Parameters:
newFormula- The new formula for the property 'horizontal alignment'. The result of the formula should be in range from 0 to 4.- See Also:
-
getSubComponents
Returns allReportComponents that are descendants of this one. E.G. this will return all Element of aSection. But it's as well useful forCrossTabs orTextelements which have additional elements.- Specified by:
getSubComponentsin classReportComponent- Returns:
- a list with all sub components which can be empty as well; will be
nullif the component has no descendants
-