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,java.io.Serializable,java.lang.Cloneable
public class TextPart extends AbstractFontElement
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 theParagraph.addTextPart(String)method from classParagraphinstead.
example: adding the line "hello World" into a text
TextPart tPartHello = paragraph.addTextPart("hello ");
TextPart tPartWorld = paragraph.addTextPart("World");
tPartWorld.setFontBold(true);
paragraphis a reference to a line of a text you want to insert. The methodaddTextPartcreates a new instance ofTextPart, initialize it with the givenStringand formats it with default. The method saves one reference to the newTextPartintoparagraphand returns one. In the example it happens twice times, because the two parts get different format. If the wholeStringshould use the same format add only oneTextPartwith both words.
This class is part of the RDC.- Since:
- 6.0
- See Also:
Text,Paragraph,FieldPart, Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.inet.report.AbstractFontElement
AbstractFontElement.FontProps
-
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.FontProperties
FONT_DIALOG, FONT_MONOSPACED, FONT_SANS_SERIF, FONT_SERIF, FONT_STYLE_BOLD, FONT_STYLE_ITALIC, FONT_STYLE_STRIKETHROUGH, FONT_STYLE_UNDERLINE
-
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetHorAlign()Use the value of the parent paragraph.FormulaFieldgetHorAlignFormula()Use the value of the parent paragraph.ParagraphgetParentParagraph()Returns this field part's parent's paragraph.java.util.List<? extends ReportComponent>getSubComponents()Returns allReportComponents that are descendants of this one.java.lang.StringgetText()Gets the value of the property 'text'.intindexOf()Returns The current index of this text part in its paragraph.java.lang.StringparamString()Creates and return a String representation for debugging.voidparseText(java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> parserMap)FOR 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.voidsetText(java.lang.String newValue)Sets 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, setUnderlineFormula
-
Methods 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, 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
-
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, resetReferences, 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 Detail
-
getParentParagraph
public Paragraph getParentParagraph()
Returns this field part's parent's paragraph.- Returns:
- This field part's parent's paragraph.
- Since:
- 7.0
- See Also:
Paragraph
-
getText
public java.lang.String 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
public void setText(java.lang.String newValue)
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
public java.lang.String 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.- Overrides:
indexOfin classElement- Returns:
- The current index of this text in its paragraph.
- Since:
- 6.0
- See Also:
Element.setIndex(int)
-
parseText
public void parseText(java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> parserMap)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:
GeneralProperties.ALIGN_HORIZONTAL_DEFAULT,GeneralProperties.ALIGN_HORIZONTAL_LEFT,GeneralProperties.ALIGN_HORIZONTAL_CENTER,GeneralProperties.ALIGN_HORIZONTAL_RIGHT,GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED
-
getHorAlignFormula
public FormulaField 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:
GeneralProperties.ALIGN_HORIZONTAL_DEFAULT,GeneralProperties.ALIGN_HORIZONTAL_LEFT,GeneralProperties.ALIGN_HORIZONTAL_CENTER,GeneralProperties.ALIGN_HORIZONTAL_RIGHT,GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED
-
setHorAlignFormula
public void setHorAlignFormula(FormulaField newFormula)
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:
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<? extends ReportComponent> 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
-
-