net.sf.jasperreports.engine
Interface JRPrintText

All Superinterfaces:
JRAlignment, JRBox, JRFont, JRPrintAnchor, JRPrintElement, JRPrintHyperlink, JRStyleContainer
All Known Implementing Classes:
JRBasePrintText, JRRecordedValuesPrintText, JRTemplatePrintText

public interface JRPrintText
extends JRPrintElement, JRAlignment, JRPrintAnchor, JRPrintHyperlink, JRBox, JRFont

Version:
$Id: JRPrintText.java 1485 2006-11-14 20:23:17 +0200 (Tue, 14 Nov 2006) teodord $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Field Summary
static byte RUN_DIRECTION_LTR
           
static byte RUN_DIRECTION_RTL
           
 
Fields inherited from interface net.sf.jasperreports.engine.JRAlignment
HORIZONTAL_ALIGN_CENTER, HORIZONTAL_ALIGN_JUSTIFIED, HORIZONTAL_ALIGN_LEFT, HORIZONTAL_ALIGN_RIGHT, VERTICAL_ALIGN_BOTTOM, VERTICAL_ALIGN_JUSTIFIED, VERTICAL_ALIGN_MIDDLE, VERTICAL_ALIGN_TOP
 
Fields inherited from interface net.sf.jasperreports.engine.JRFont
DEFAULT_FONT_NAME, DEFAULT_FONT_SIZE, DEFAULT_PDF_EMBEDDED, DEFAULT_PDF_ENCODING, DEFAULT_PDF_FONT_NAME
 
Method Summary
 JRBox getBox()
          Deprecated.  
 JRFont getFont()
          Deprecated.  
 java.lang.String getFormatFactoryClass()
          Returns the name of the class implementing the FormatFactory interface to use with this text element, in case it is not the same as the one for the overall document.
 float getLeadingOffset()
           
 byte getLineSpacing()
           
 float getLineSpacingFactor()
           
 java.lang.String getLocaleCode()
          Returns the code of the java.util.Locale which was used while formatting the source value of the text.
 java.lang.Byte getOwnLineSpacing()
           
 java.lang.Byte getOwnRotation()
           
 java.lang.String getPattern()
          Returns the pattern used to format a value that was the source of this text.
 byte getRotation()
           
 byte getRunDirection()
           
 java.lang.String getText()
           
 byte getTextAlignment()
          Deprecated. Replaced by JRAlignment.getHorizontalAlignment().
 float getTextHeight()
           
 java.lang.String getTimeZoneId()
          Returns the ID of the java.util.TimeZone used to format this text's date source value.
 java.lang.String getValueClassName()
          Returns the type of the value which was used to generate this text.
 java.lang.Boolean isOwnStyledText()
           
 boolean isStyledText()
           
 void setBox(JRBox box)
          Deprecated.  
 void setFont(JRFont font)
          Deprecated.  
 void setLeadingOffset(float leadingOffset)
           
 void setLineSpacing(byte lineSpacing)
           
 void setLineSpacing(java.lang.Byte lineSpacing)
           
 void setLineSpacingFactor(float lineSpacingFactor)
           
 void setRotation(byte rotation)
           
 void setRotation(java.lang.Byte rotation)
           
 void setRunDirection(byte rotation)
           
 void setStyledText(boolean isStyledText)
           
 void setStyledText(java.lang.Boolean isStyledText)
           
 void setText(java.lang.String text)
           
 void setTextAlignment(byte horizontalAlignment)
          Deprecated. Replaced by JRAlignment.setHorizontalAlignment(byte).
 void setTextHeight(float textHeight)
           
 
Methods inherited from interface net.sf.jasperreports.engine.JRPrintElement
getBackcolor, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, getX, getY, setBackcolor, setForecolor, setHeight, setMode, setMode, setStyle, setWidth, setX, setY
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle
 
Methods inherited from interface net.sf.jasperreports.engine.JRAlignment
getHorizontalAlignment, getOwnHorizontalAlignment, getOwnVerticalAlignment, getVerticalAlignment, setHorizontalAlignment, setHorizontalAlignment, setVerticalAlignment, setVerticalAlignment
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle
 
Methods inherited from interface net.sf.jasperreports.engine.JRPrintAnchor
getAnchorName, getBookmarkLevel, setAnchorName, setBookmarkLevel
 
Methods inherited from interface net.sf.jasperreports.engine.JRPrintHyperlink
getHyperlinkAnchor, getHyperlinkPage, getHyperlinkParameters, getHyperlinkReference, getHyperlinkTarget, getHyperlinkTooltip, getHyperlinkType, getLinkType, setHyperlinkAnchor, setHyperlinkPage, setHyperlinkParameters, setHyperlinkReference, setHyperlinkTarget, setHyperlinkTooltip, setHyperlinkType, setLinkType
 
Methods inherited from interface net.sf.jasperreports.engine.JRBox
getBorder, getBorderColor, getBottomBorder, getBottomBorderColor, getBottomPadding, getLeftBorder, getLeftBorderColor, getLeftPadding, getOwnBorder, getOwnBorderColor, getOwnBottomBorder, getOwnBottomBorderColor, getOwnBottomPadding, getOwnLeftBorder, getOwnLeftBorderColor, getOwnLeftPadding, getOwnPadding, getOwnRightBorder, getOwnRightBorderColor, getOwnRightPadding, getOwnTopBorder, getOwnTopBorderColor, getOwnTopPadding, getPadding, getRightBorder, getRightBorderColor, getRightPadding, getTopBorder, getTopBorderColor, getTopPadding, setBorder, setBorder, setBorderColor, setBottomBorder, setBottomBorder, setBottomBorderColor, setBottomPadding, setBottomPadding, setLeftBorder, setLeftBorder, setLeftBorderColor, setLeftPadding, setLeftPadding, setPadding, setPadding, setRightBorder, setRightBorder, setRightBorderColor, setRightPadding, setRightPadding, setTopBorder, setTopBorder, setTopBorderColor, setTopPadding, setTopPadding
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle
 
Methods inherited from interface net.sf.jasperreports.engine.JRFont
getFontName, getFontSize, getOwnFontName, getOwnFontSize, getOwnPdfEncoding, getOwnPdfFontName, getOwnSize, getPdfEncoding, getPdfFontName, getReportFont, getSize, isBold, isItalic, isOwnBold, isOwnItalic, isOwnPdfEmbedded, isOwnStrikeThrough, isOwnUnderline, isPdfEmbedded, isStrikeThrough, isUnderline, setBold, setBold, setFontName, setFontSize, setFontSize, setItalic, setItalic, setPdfEmbedded, setPdfEmbedded, setPdfEncoding, setPdfFontName, setReportFont, setSize, setSize, setStrikeThrough, setStrikeThrough, setUnderline, setUnderline
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle
 

Field Detail

RUN_DIRECTION_LTR

static final byte RUN_DIRECTION_LTR
See Also:
Constant Field Values

RUN_DIRECTION_RTL

static final byte RUN_DIRECTION_RTL
See Also:
Constant Field Values
Method Detail

getText

java.lang.String getText()

setText

void setText(java.lang.String text)

getLineSpacingFactor

float getLineSpacingFactor()

setLineSpacingFactor

void setLineSpacingFactor(float lineSpacingFactor)

getLeadingOffset

float getLeadingOffset()

setLeadingOffset

void setLeadingOffset(float leadingOffset)

getTextAlignment

byte getTextAlignment()
Deprecated. Replaced by JRAlignment.getHorizontalAlignment().


setTextAlignment

void setTextAlignment(byte horizontalAlignment)
Deprecated. Replaced by JRAlignment.setHorizontalAlignment(byte).


getRotation

byte getRotation()

getOwnRotation

java.lang.Byte getOwnRotation()

setRotation

void setRotation(byte rotation)

setRotation

void setRotation(java.lang.Byte rotation)

getRunDirection

byte getRunDirection()

setRunDirection

void setRunDirection(byte rotation)

getTextHeight

float getTextHeight()

setTextHeight

void setTextHeight(float textHeight)

getLineSpacing

byte getLineSpacing()

getOwnLineSpacing

java.lang.Byte getOwnLineSpacing()

setLineSpacing

void setLineSpacing(byte lineSpacing)

setLineSpacing

void setLineSpacing(java.lang.Byte lineSpacing)

isStyledText

boolean isStyledText()

isOwnStyledText

java.lang.Boolean isOwnStyledText()

setStyledText

void setStyledText(boolean isStyledText)

setStyledText

void setStyledText(java.lang.Boolean isStyledText)

getBox

JRBox getBox()
Deprecated. 


setBox

void setBox(JRBox box)
Deprecated. 


getFont

JRFont getFont()
Deprecated. 


setFont

void setFont(JRFont font)
Deprecated. 


getValueClassName

java.lang.String getValueClassName()
Returns the type of the value which was used to generate this text.

Text fields that have a non-String expression save the value type using this attribute. This information can be used by exporters to treat numerical or date texts (for instance) in a special manner.

Returns:
the type of the original value used to generate the text

getPattern

java.lang.String getPattern()
Returns the pattern used to format a value that was the source of this text.

The pattern can be used to parse the text back to its source value.

Returns:
the pattern used to format this text's source value
See Also:
getValueClassName()

getFormatFactoryClass

java.lang.String getFormatFactoryClass()
Returns the name of the class implementing the FormatFactory interface to use with this text element, in case it is not the same as the one for the overall document.


getLocaleCode

java.lang.String getLocaleCode()
Returns the code of the java.util.Locale which was used while formatting the source value of the text.

The code is created using the java.util.Locale.toString() convention.

When this attribute is null, the locale returned by JasperPrint.getLocaleCode() is used. This way, the locale is specified in a single place when all the (or many ) texts from a print object were formatted using the same locale.

Returns:
the code of the java.util.Locale used when formatting this text's source value

getTimeZoneId

java.lang.String getTimeZoneId()
Returns the ID of the java.util.TimeZone used to format this text's date source value.

When this attribute is null, the time zone returned by JasperPrint.getTimeZoneId() is used.

Returns:
the ID of the java.util.TimeZone used to format this text's date source value


© 2001-2006 JasperSoft Corporation www.jaspersoft.com