net.sf.jasperreports.engine
Interface JRTextElement

All Superinterfaces:
JRAlignment, JRBox, JRChild, JRElement, JRFont, JRStyleContainer
All Known Subinterfaces:
JRStaticText, JRTextField
All Known Implementing Classes:
JRBaseStaticText, JRBaseTextElement, JRBaseTextField, JRDesignStaticText, JRDesignTextElement, JRDesignTextField, JRFillStaticText, JRFillTextElement, JRFillTextField

public interface JRTextElement
extends JRElement, JRAlignment, JRBox, JRFont

An abstract representation of a report text element. It provides basic functionality for static texts and text fields.

Version:
$Id: JRTextElement.java 1444 2006-10-24 17:04:48 +0300 (Tue, 24 Oct 2006) ionut $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Field Summary
static byte LINE_SPACING_1_1_2
          Constant for setting spacing between lines to 50% more than normal.
static byte LINE_SPACING_DOUBLE
          Constant for setting spacing between lines to double size.
static byte LINE_SPACING_SINGLE
          Constant for setting normal spacing between lines.
static byte ROTATION_LEFT
          Constant useful for rotating the text 90 degrees counter clockwise.
static byte ROTATION_NONE
          Constant useful for displaying the text without rotating it
static byte ROTATION_RIGHT
          Constant useful for rotating the text 90 degrees clockwise.
static byte ROTATION_UPSIDE_DOWN
          Constant useful for rotating the text 180 degrees.
static byte TEXT_ALIGN_CENTER
          Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_CENTER.
static byte TEXT_ALIGN_JUSTIFIED
          Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_JUSTIFIED.
static byte TEXT_ALIGN_LEFT
          Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_LEFT.
static byte TEXT_ALIGN_RIGHT
          Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_RIGHT.
 
Fields inherited from interface net.sf.jasperreports.engine.JRElement
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
 
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.  
 byte getLineSpacing()
          Gets the line spacing.
 java.lang.Byte getOwnLineSpacing()
           
 java.lang.Byte getOwnRotation()
           
 byte getRotation()
          Gets the text rotation.
 byte getTextAlignment()
          Deprecated. Replaced by JRAlignment.getHorizontalAlignment().
 java.lang.Boolean isOwnStyledText()
           
 boolean isStyledText()
          Returns true if the text can contain style tags.
 void setLineSpacing(byte lineSpacing)
          Sets the line spacing.
 void setLineSpacing(java.lang.Byte lineSpacing)
           
 void setRotation(byte rotation)
          Sets the text rotation.
 void setRotation(java.lang.Byte rotation)
           
 void setStyledText(boolean isStyledText)
          Specifies whether the text can contain style tags.
 void setStyledText(java.lang.Boolean isStyledText)
           
 void setTextAlignment(byte horizontalAlignment)
          Deprecated. Replaced by JRAlignment.setHorizontalAlignment(byte).
 
Methods inherited from interface net.sf.jasperreports.engine.JRElement
collectExpressions, getBackcolor, getElementGroup, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
 
Methods inherited from interface net.sf.jasperreports.engine.JRChild
getCopy, writeXml
 
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.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

TEXT_ALIGN_LEFT

static final byte TEXT_ALIGN_LEFT
Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_LEFT.
See Also:
Constant Field Values

TEXT_ALIGN_CENTER

static final byte TEXT_ALIGN_CENTER
Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_CENTER.
See Also:
Constant Field Values

TEXT_ALIGN_RIGHT

static final byte TEXT_ALIGN_RIGHT
Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_RIGHT.
See Also:
Constant Field Values

TEXT_ALIGN_JUSTIFIED

static final byte TEXT_ALIGN_JUSTIFIED
Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_JUSTIFIED.
See Also:
Constant Field Values

ROTATION_NONE

static final byte ROTATION_NONE
Constant useful for displaying the text without rotating it

See Also:
Constant Field Values

ROTATION_LEFT

static final byte ROTATION_LEFT
Constant useful for rotating the text 90 degrees counter clockwise.

See Also:
Constant Field Values

ROTATION_RIGHT

static final byte ROTATION_RIGHT
Constant useful for rotating the text 90 degrees clockwise.

See Also:
Constant Field Values

ROTATION_UPSIDE_DOWN

static final byte ROTATION_UPSIDE_DOWN
Constant useful for rotating the text 180 degrees.

See Also:
Constant Field Values

LINE_SPACING_SINGLE

static final byte LINE_SPACING_SINGLE
Constant for setting normal spacing between lines.

See Also:
Constant Field Values

LINE_SPACING_1_1_2

static final byte LINE_SPACING_1_1_2
Constant for setting spacing between lines to 50% more than normal.

See Also:
Constant Field Values

LINE_SPACING_DOUBLE

static final byte LINE_SPACING_DOUBLE
Constant for setting spacing between lines to double size.

See Also:
Constant Field Values
Method Detail

getTextAlignment

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

Gets the text horizontal alignment.

Returns:
a value representing one of the horizontal alignment constants in JRAlignment

setTextAlignment

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

Sets the text horizontal alignment.

Parameters:
horizontalAlignment - a value representing one of the horizontal alignment constants in JRAlignment

getRotation

byte getRotation()
Gets the text rotation.

Returns:
a value representing one of the rotation constants in this class

getOwnRotation

java.lang.Byte getOwnRotation()

setRotation

void setRotation(byte rotation)
Sets the text rotation.

Parameters:
rotation - a value representing one of the rotation constants in this class

setRotation

void setRotation(java.lang.Byte rotation)

getLineSpacing

byte getLineSpacing()
Gets the line spacing.

Returns:
a value representing one of the line spacing constants in this class

getOwnLineSpacing

java.lang.Byte getOwnLineSpacing()

setLineSpacing

void setLineSpacing(byte lineSpacing)
Sets the line spacing.

Parameters:
lineSpacing - a value representing one of the line spacing constants in this class

setLineSpacing

void setLineSpacing(java.lang.Byte lineSpacing)

isStyledText

boolean isStyledText()
Returns true if the text can contain style tags.


isOwnStyledText

java.lang.Boolean isOwnStyledText()

setStyledText

void setStyledText(boolean isStyledText)
Specifies whether the text can contain style tags.


setStyledText

void setStyledText(java.lang.Boolean isStyledText)

getBox

JRBox getBox()
Deprecated. 

Returns an object containing all border and padding properties for this text element


getFont

JRFont getFont()
Deprecated. 

Returns an object containing all font properties for this text element



© 2001-2006 JasperSoft Corporation www.jaspersoft.com