net.sf.jasperreports.engine.base

Class JRBaseTextElement

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseElement

net.sf.jasperreports.engine.base.JRBaseTextElement

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRAlignment, JRBoxContainer, JRChild, JRCloneable, JRCommonElement, JRCommonText, JRElement, JRFont, JRIdentifiable, JRParagraphContainer, JRPropertiesHolder, JRStyleContainer, JRTextAlignment, JRTextElement, JRVisitable

Direct Known Subclasses:

JRBaseStaticText, JRBaseTextField

public abstract class JRBaseTextElement
extends JRBaseElement
implements JRTextElement

This class provides functionality common to text elements. It provides implementation for the methods described in JRTextElement.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	fontName
protected Float	fontsize
protected HorizontalTextAlignEnum	horizontalTextAlign
protected Boolean	isBold
protected Boolean	isItalic
protected Boolean	isPdfEmbedded
protected Boolean	isStrikeThrough
protected Boolean	isUnderline
protected JRLineBox	lineBox
protected String	markup
protected JRParagraph	paragraph
protected String	pdfEncoding
protected String	pdfFontName
protected RotationEnum	rotationValue
protected VerticalTextAlignEnum	verticalTextAlign

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement

backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, modeValue, parentStyle, parentStyleNameReference, positionTypeValue, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchTypeValue, uuid, width, x, y

Fields inherited from interface net.sf.jasperreports.engine.JRTextElement

PROPERTY_PRINT_KEEP_FULL_TEXT, PROPERTY_SAVE_LINE_BREAKS, PROPERTY_TRUNCATE_AT_CHAR, PROPERTY_TRUNCATE_SUFFIX

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

Fields inherited from interface net.sf.jasperreports.engine.JRCommonText

MARKUP_HTML, MARKUP_NONE, MARKUP_RTF, MARKUP_STYLED_TEXT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JRBaseTextElement(JRTextElement textElement, JRBaseObjectFactory factory) Initializes properties that are specific to text elements.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
Color	getDefaultLineColor()
JRFont	getFont() Deprecated.
String	getFontName()
float	getFontsize()
int	getFontSize() Deprecated. Replaced by getFontsize().
HorizontalAlignEnum	getHorizontalAlignmentValue() Deprecated. Replaced by getHorizontalTextAlign().
HorizontalTextAlignEnum	getHorizontalTextAlign() Gets the text horizontal alignment.
JRLineBox	getLineBox()
LineSpacingEnum	getLineSpacingValue() Deprecated. Replaced by JRParagraph.getLineSpacing().
String	getMarkup() Returns the text markup.
ModeEnum	getModeValue() Returns the element transparency mode.
String	getOwnFontName()
Float	getOwnFontsize()
Integer	getOwnFontSize() Deprecated. Replaced by getOwnFontsize().
HorizontalAlignEnum	getOwnHorizontalAlignmentValue() Deprecated. Replaced by getOwnHorizontalTextAlign().
HorizontalTextAlignEnum	getOwnHorizontalTextAlign()
LineSpacingEnum	getOwnLineSpacingValue() Deprecated. Replaced by JRParagraph.getOwnLineSpacing().
String	getOwnMarkup()
String	getOwnPdfEncoding()
String	getOwnPdfFontName()
RotationEnum	getOwnRotationValue() Gets the text own rotation.
VerticalAlignEnum	getOwnVerticalAlignmentValue() Deprecated. Replaced by getOwnVerticalTextAlign().
VerticalTextAlignEnum	getOwnVerticalTextAlign()
JRParagraph	getParagraph()
String	getPdfEncoding()
String	getPdfFontName()
RotationEnum	getRotationValue() Gets the text rotation.
VerticalAlignEnum	getVerticalAlignmentValue() Deprecated. Replaced by getVerticalTextAlign().
VerticalTextAlignEnum	getVerticalTextAlign() Gets the text vertical alignment.
boolean	isBold()
boolean	isItalic()
Boolean	isOwnBold()
Boolean	isOwnItalic()
Boolean	isOwnPdfEmbedded()
Boolean	isOwnStrikeThrough()
Boolean	isOwnUnderline()
boolean	isPdfEmbedded()
boolean	isStrikeThrough()
boolean	isUnderline()
void	setBold(boolean isBold)
void	setBold(Boolean isBold) Alternative setBold method which allows also to reset the "own" isBold property.
void	setFontName(String fontName)
void	setFontSize(Float fontSize) Method which allows also to reset the "own" size property.
void	setFontSize(int fontSize) Deprecated. Replaced by setFontSize(Float).
void	setFontSize(Integer fontSize) Deprecated. Replaced by setFontSize(Float).
void	setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue) Deprecated. Replaced by setHorizontalTextAlign(HorizontalTextAlignEnum).
void	setHorizontalTextAlign(HorizontalTextAlignEnum horizontalTextAlign) Sets the text horizontal alignment.
void	setItalic(boolean isItalic)
void	setItalic(Boolean isItalic) Alternative setItalic method which allows also to reset the "own" isItalic property.
void	setLineSpacing(LineSpacingEnum lineSpacing) Deprecated. Replaced by JRParagraph.setLineSpacing(LineSpacingEnum).
void	setMarkup(String markup)
void	setPdfEmbedded(boolean isPdfEmbedded)
void	setPdfEmbedded(Boolean isPdfEmbedded) Alternative setPdfEmbedded method which allows also to reset the "own" isPdfEmbedded property.
void	setPdfEncoding(String pdfEncoding)
void	setPdfFontName(String pdfFontName)
void	setRotation(RotationEnum rotationValue) Sets the text rotation.
void	setStrikeThrough(boolean isStrikeThrough)
void	setStrikeThrough(Boolean isStrikeThrough) Alternative setStrikeThrough method which allows also to reset the "own" isStrikeThrough property.
void	setUnderline(boolean isUnderline)
void	setUnderline(Boolean isUnderline) Alternative setUnderline method which allows also to reset the "own" isUnderline property.
void	setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue) Deprecated. Replaced by setVerticalTextAlign(VerticalTextAlignEnum).
void	setVerticalTextAlign(VerticalTextAlignEnum verticalTextAlign) Gets the text vertical alignment.

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement

clone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getStretchTypeValue, getStyle, getStyleNameReference, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.jasperreports.engine.JRElement

clone, collectExpressions, getElementGroup, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

Methods inherited from interface net.sf.jasperreports.engine.JRChild

clone

Methods inherited from interface net.sf.jasperreports.engine.JRVisitable

visit

Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder

getParentProperties, getPropertiesMap, hasProperties

Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable

getUUID

Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement

getBackcolor, getForecolor, getHeight, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode

Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer

getDefaultStyleProvider, getStyle, getStyleNameReference

Field Detail

horizontalTextAlign

protected HorizontalTextAlignEnum horizontalTextAlign

verticalTextAlign

protected VerticalTextAlignEnum verticalTextAlign

rotationValue

protected RotationEnum rotationValue

markup

protected String markup

lineBox

protected JRLineBox lineBox

paragraph

protected JRParagraph paragraph

fontName

protected String fontName

isBold

protected Boolean isBold

isItalic

protected Boolean isItalic

isUnderline

protected Boolean isUnderline

isStrikeThrough

protected Boolean isStrikeThrough

fontsize

protected Float fontsize

pdfFontName

protected String pdfFontName

pdfEncoding

protected String pdfEncoding

isPdfEmbedded

protected Boolean isPdfEmbedded

Constructor Detail

JRBaseTextElement

protected JRBaseTextElement(JRTextElement textElement,
                 JRBaseObjectFactory factory)

Initializes properties that are specific to text elements. Common properties are initialized by its parent constructor.

Parameters:

textElement - an element whose properties are copied to this element. Usually it is a JRDesignTextElement that must be transformed into an JRBaseTextElement at compile time.

factory - a factory used in the compile process

Method Detail

getHorizontalAlignmentValue

public HorizontalAlignEnum getHorizontalAlignmentValue()

Deprecated. Replaced by getHorizontalTextAlign().

Description copied from interface: JRAlignment

Gets the text horizontal alignment.

Specified by:

getHorizontalAlignmentValue in interface JRAlignment

Returns:

a value representing one of the horizontal alignment constants in HorizontalAlignEnum

getOwnHorizontalAlignmentValue

public HorizontalAlignEnum getOwnHorizontalAlignmentValue()

Deprecated. Replaced by getOwnHorizontalTextAlign().

Specified by:

getOwnHorizontalAlignmentValue in interface JRAlignment

setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)

Deprecated. Replaced by setHorizontalTextAlign(HorizontalTextAlignEnum).

Description copied from interface: JRAlignment

Sets the text horizontal alignment.

Specified by:

setHorizontalAlignment in interface JRAlignment

Parameters:

horizontalAlignmentValue - a value representing one of the horizontal alignment constants in HorizontalAlignEnum

getVerticalAlignmentValue

public VerticalAlignEnum getVerticalAlignmentValue()

Deprecated. Replaced by getVerticalTextAlign().

Description copied from interface: JRAlignment

Gets the text vertical alignment.

Specified by:

getVerticalAlignmentValue in interface JRAlignment

Returns:

a value representing one of the vertical alignment constants in VerticalAlignEnum

getOwnVerticalAlignmentValue

public VerticalAlignEnum getOwnVerticalAlignmentValue()

Deprecated. Replaced by getOwnVerticalTextAlign().

Specified by:

getOwnVerticalAlignmentValue in interface JRAlignment

setVerticalAlignment

public void setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)

Deprecated. Replaced by setVerticalTextAlign(VerticalTextAlignEnum).

Description copied from interface: JRAlignment

Gets the text vertical alignment.

Specified by:

setVerticalAlignment in interface JRAlignment

Parameters:

verticalAlignmentValue - a value representing one of the vertical alignment constants in VerticalAlignEnum

getHorizontalTextAlign

public HorizontalTextAlignEnum getHorizontalTextAlign()

Description copied from interface: JRTextAlignment

Gets the text horizontal alignment.

Specified by:

getHorizontalTextAlign in interface JRTextAlignment

Returns:

a value representing one of the horizontal text alignment constants in HorizontalTextAlignEnum

getOwnHorizontalTextAlign

public HorizontalTextAlignEnum getOwnHorizontalTextAlign()

Specified by:

getOwnHorizontalTextAlign in interface JRTextAlignment

setHorizontalTextAlign

public void setHorizontalTextAlign(HorizontalTextAlignEnum horizontalTextAlign)

Description copied from interface: JRTextAlignment

Sets the text horizontal alignment.

Specified by:

setHorizontalTextAlign in interface JRTextAlignment

Parameters:

horizontalTextAlign - a value representing one of the horizontal text alignment constants in HorizontalTextAlignEnum

getVerticalTextAlign

public VerticalTextAlignEnum getVerticalTextAlign()

Description copied from interface: JRTextAlignment

Gets the text vertical alignment.

Specified by:

getVerticalTextAlign in interface JRTextAlignment

Returns:

a value representing one of the vertical text alignment constants in VerticalTextAlignEnum

getOwnVerticalTextAlign

public VerticalTextAlignEnum getOwnVerticalTextAlign()

Specified by:

getOwnVerticalTextAlign in interface JRTextAlignment

setVerticalTextAlign

public void setVerticalTextAlign(VerticalTextAlignEnum verticalTextAlign)

Description copied from interface: JRTextAlignment

Gets the text vertical alignment.

Specified by:

setVerticalTextAlign in interface JRTextAlignment

Parameters:

verticalTextAlign - a value representing one of the vertical text alignment constants in VerticalTextAlignEnum

getRotationValue

public RotationEnum getRotationValue()

Description copied from interface: JRCommonText

Gets the text rotation.

Specified by:

getRotationValue in interface JRCommonText

Returns:

a value representing one of the text rotation constants in RotationEnum

getOwnRotationValue

public RotationEnum getOwnRotationValue()

Description copied from interface: JRCommonText

Gets the text own rotation.

Specified by:

getOwnRotationValue in interface JRCommonText

Returns:

a value representing one of the text rotation constants in RotationEnum

setRotation

public void setRotation(RotationEnum rotationValue)

Description copied from interface: JRCommonText

Sets the text rotation.

Specified by:

setRotation in interface JRCommonText

Parameters:

rotationValue - a value representing one of the text rotation constants in RotationEnum

getLineSpacingValue

public LineSpacingEnum getLineSpacingValue()

Deprecated. Replaced by JRParagraph.getLineSpacing().

Specified by:

getLineSpacingValue in interface JRCommonText

getOwnLineSpacingValue

public LineSpacingEnum getOwnLineSpacingValue()

Deprecated. Replaced by JRParagraph.getOwnLineSpacing().

Specified by:

getOwnLineSpacingValue in interface JRCommonText

setLineSpacing

public void setLineSpacing(LineSpacingEnum lineSpacing)

Deprecated. Replaced by JRParagraph.setLineSpacing(LineSpacingEnum).

Specified by:

setLineSpacing in interface JRCommonText

getMarkup

public String getMarkup()

Description copied from interface: JRCommonText

Returns the text markup.

Specified by:

getMarkup in interface JRCommonText

getOwnMarkup

public String getOwnMarkup()

Specified by:

getOwnMarkup in interface JRCommonText

setMarkup

public void setMarkup(String markup)

Specified by:

setMarkup in interface JRCommonText

getLineBox

public JRLineBox getLineBox()

Specified by:

getLineBox in interface JRBoxContainer

getParagraph

public JRParagraph getParagraph()

Specified by:

getParagraph in interface JRParagraphContainer

getFont

public JRFont getFont()

Deprecated.

getModeValue

public ModeEnum getModeValue()

Description copied from interface: JRCommonElement

Returns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements.

Specified by:

getModeValue in interface JRCommonElement

Overrides:

getModeValue in class JRBaseElement

getFontName

public String getFontName()

Specified by:

getFontName in interface JRFont

getOwnFontName

public String getOwnFontName()

Specified by:

getOwnFontName in interface JRFont

setFontName

public void setFontName(String fontName)

Specified by:

setFontName in interface JRFont

isBold

public boolean isBold()

Specified by:

isBold in interface JRFont

isOwnBold

public Boolean isOwnBold()

Specified by:

isOwnBold in interface JRFont

setBold

public void setBold(boolean isBold)

Specified by:

setBold in interface JRFont

setBold

public void setBold(Boolean isBold)

Alternative setBold method which allows also to reset the "own" isBold property.

Specified by:

setBold in interface JRFont

isItalic

public boolean isItalic()

Specified by:

isItalic in interface JRFont

isOwnItalic

public Boolean isOwnItalic()

Specified by:

isOwnItalic in interface JRFont

setItalic

public void setItalic(boolean isItalic)

Specified by:

setItalic in interface JRFont

setItalic

public void setItalic(Boolean isItalic)

Alternative setItalic method which allows also to reset the "own" isItalic property.

Specified by:

setItalic in interface JRFont

isUnderline

public boolean isUnderline()

Specified by:

isUnderline in interface JRFont

isOwnUnderline

public Boolean isOwnUnderline()

Specified by:

isOwnUnderline in interface JRFont

setUnderline

public void setUnderline(boolean isUnderline)

Specified by:

setUnderline in interface JRFont

setUnderline

public void setUnderline(Boolean isUnderline)

Alternative setUnderline method which allows also to reset the "own" isUnderline property.

Specified by:

setUnderline in interface JRFont

isStrikeThrough

public boolean isStrikeThrough()

Specified by:

isStrikeThrough in interface JRFont

isOwnStrikeThrough

public Boolean isOwnStrikeThrough()

Specified by:

isOwnStrikeThrough in interface JRFont

setStrikeThrough

public void setStrikeThrough(boolean isStrikeThrough)

Specified by:

setStrikeThrough in interface JRFont

setStrikeThrough

public void setStrikeThrough(Boolean isStrikeThrough)

Alternative setStrikeThrough method which allows also to reset the "own" isStrikeThrough property.

Specified by:

setStrikeThrough in interface JRFont

getFontsize

public float getFontsize()

Specified by:

getFontsize in interface JRCommonText

Specified by:

getFontsize in interface JRFont

getOwnFontsize

public Float getOwnFontsize()

Specified by:

getOwnFontsize in interface JRFont

setFontSize

public void setFontSize(Float fontSize)

Method which allows also to reset the "own" size property.

Specified by:

setFontSize in interface JRFont

getFontSize

public int getFontSize()

Deprecated. Replaced by getFontsize().

Specified by:

getFontSize in interface JRCommonText

Specified by:

getFontSize in interface JRFont

getOwnFontSize

public Integer getOwnFontSize()

Deprecated. Replaced by getOwnFontsize().

Specified by:

getOwnFontSize in interface JRFont

setFontSize

public void setFontSize(int fontSize)

Deprecated. Replaced by setFontSize(Float).

Specified by:

setFontSize in interface JRFont

setFontSize

public void setFontSize(Integer fontSize)

Deprecated. Replaced by setFontSize(Float).

Specified by:

setFontSize in interface JRFont

getPdfFontName

public String getPdfFontName()

Specified by:

getPdfFontName in interface JRFont

getOwnPdfFontName

public String getOwnPdfFontName()

Specified by:

getOwnPdfFontName in interface JRFont

setPdfFontName

public void setPdfFontName(String pdfFontName)

Specified by:

setPdfFontName in interface JRFont

getPdfEncoding

public String getPdfEncoding()

Specified by:

getPdfEncoding in interface JRFont

getOwnPdfEncoding

public String getOwnPdfEncoding()

Specified by:

getOwnPdfEncoding in interface JRFont

setPdfEncoding

public void setPdfEncoding(String pdfEncoding)

Specified by:

setPdfEncoding in interface JRFont

isPdfEmbedded

public boolean isPdfEmbedded()

Specified by:

isPdfEmbedded in interface JRFont

isOwnPdfEmbedded

public Boolean isOwnPdfEmbedded()

Specified by:

isOwnPdfEmbedded in interface JRFont

setPdfEmbedded

public void setPdfEmbedded(boolean isPdfEmbedded)

Specified by:

setPdfEmbedded in interface JRFont

setPdfEmbedded

public void setPdfEmbedded(Boolean isPdfEmbedded)

Alternative setPdfEmbedded method which allows also to reset the "own" isPdfEmbedded property.

Specified by:

setPdfEmbedded in interface JRFont

getDefaultLineColor

public Color getDefaultLineColor()

Specified by:

getDefaultLineColor in interface JRBoxContainer

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRBaseElement