i-net Clear Reports

com.inet.report
Class TextPart

java.lang.Object
  extended by com.inet.report.ReportComponent
      extended by com.inet.report.Element
          extended by com.inet.report.AbstractFontElement
              extended by com.inet.report.TextPart
All Implemented Interfaces:
BorderProperties, 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 & 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 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, initialises 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.

See Also:
Text, Paragraph, FieldPart, Serialized Form

Field Summary
 
Fields inherited from class com.inet.report.Element
BOX, CHART, CROSSTAB, CROSSTABCELL, CROSSTABCOLUMN, CROSSTABROW, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, 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.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
 
Method Summary
 Paragraph getParentParagraph()
          Returns this field part's parent's paragraph.
 java.lang.String getText()
          Gets the value of the property 'text'.
 int indexOf()
          Returns The current index of this text part in its paragraph.
 java.lang.String paramString()
          Creates and return a String representation for debugging.
 void parseText(java.lang.String text, java.util.Map parserMap)
          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.
 void setText(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, copyXML2, getBottomLineStyle, getBottomLineStyleFormula, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getParent, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, isCanGrow, isCloseBorderOnPageBreak, isDropShadow, isSuppressIfDuplicated, isTightHorizontal, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHorAlign, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula
 
Methods inherited from class com.inet.report.ReportComponent
getBackColor, getBackColorFormula, getHeight, getKeepTogetherFormula, getSuppressFormula, getType, getWidth, getX, getY, isKeepTogether, isSuppress, setBackColor, setBackColorFormula, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY
 
Methods inherited from interface com.inet.report.BorderProperties
getBackColor, getBackColorFormula, setBackColor, setBackColorFormula
 
Methods inherited from interface com.inet.report.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
 
Methods inherited from interface com.inet.report.parser.NodeParser
isDOMParser, parseDOM, parseEndElement
 

Method Detail

getParentParagraph

public Paragraph getParentParagraph()
Returns this field part's parent's paragraph.

Returns:
This field part's parent's paragraph.
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'.

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

paramString

public java.lang.String paramString()
Creates and return a String representation for debugging.

Overrides:
paramString in class Element
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:
indexOf in class Element
Returns:
The current index of this text in its paragraph.
See Also:
Element.setIndex(int)

parseText

public void parseText(java.lang.String text,
                      java.util.Map parserMap)
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)

Specified by:
parseText in interface NodeParser
Parameters:
text - text encountered and to be stored
parserMap - The map of current Parser.

i-net Clear Reports

Copyright © 1999-2011 by i-net software GmbH