net.sf.jasperreports.engine
Interface JRTextElement

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

public interface JRTextElement
extends JRElement, JRAlignment

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

Version:
$Id: JRTextElement.java,v 1.13 2005/07/15 13:06:54 teodord Exp $
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 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
 
Method Summary
 JRBox getBox()
          Returns an object containing all border and padding properties for this text element
 JRFont getFont()
          Returns an object containing all font properties for this text element
 byte getLineSpacing()
          Gets the line spacing.
 byte getRotation()
          Gets the text rotation.
 byte getTextAlignment()
          Deprecated. Replaced by JRAlignment.getHorizontalAlignment().
 boolean isStyledText()
          Returns true if the text can contain style tags.
 void setLineSpacing(byte lineSpacing)
          Sets the line spacing.
 void setRotation(byte rotation)
          Sets the text rotation.
 void setStyledText(boolean isStyledText)
          Specifies whether the text can contain style tags.
 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, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, 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.JRAlignment
getHorizontalAlignment, getVerticalAlignment, setHorizontalAlignment, setVerticalAlignment
 

Field Detail

TEXT_ALIGN_LEFT

public static final byte TEXT_ALIGN_LEFT
Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_LEFT.

See Also:
Constant Field Values

TEXT_ALIGN_CENTER

public static final byte TEXT_ALIGN_CENTER
Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_CENTER.

See Also:
Constant Field Values

TEXT_ALIGN_RIGHT

public static final byte TEXT_ALIGN_RIGHT
Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_RIGHT.

See Also:
Constant Field Values

TEXT_ALIGN_JUSTIFIED

public static final byte TEXT_ALIGN_JUSTIFIED
Deprecated. Replaced by JRAlignment.HORIZONTAL_ALIGN_JUSTIFIED.

See Also:
Constant Field Values

ROTATION_NONE

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

See Also:
Constant Field Values

ROTATION_LEFT

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

See Also:
Constant Field Values

ROTATION_RIGHT

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

See Also:
Constant Field Values

LINE_SPACING_SINGLE

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

See Also:
Constant Field Values

LINE_SPACING_1_1_2

public 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

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

See Also:
Constant Field Values
Method Detail

getTextAlignment

public 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

public 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

public byte getRotation()
Gets the text rotation.

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

setRotation

public void setRotation(byte rotation)
Sets the text rotation.

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

getLineSpacing

public byte getLineSpacing()
Gets the line spacing.

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

setLineSpacing

public void setLineSpacing(byte lineSpacing)
Sets the line spacing.

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

isStyledText

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


setStyledText

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


getBox

public JRBox getBox()
Returns an object containing all border and padding properties for this text element


getFont

public JRFont getFont()
Returns an object containing all font properties for this text element



© 2001-2005 JasperSoft Corporation www.jaspersoft.com