net.sf.jasperreports.engine.fill
Class JRTemplatePrintText

java.lang.Object
  net.sf.jasperreports.engine.fill.JRTemplatePrintElement
      net.sf.jasperreports.engine.fill.JRTemplatePrintText

All Implemented Interfaces:

java.io.Serializable, JRAlignment, JRPrintAnchor, JRPrintElement, JRPrintHyperlink, JRPrintText

public class JRTemplatePrintText
extends JRTemplatePrintElement
implements JRPrintText

Version:

$Id: JRTemplatePrintText.java,v 1.31 2005/10/09 21:34:26 teodord Exp $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

protected int

bookmarkLevel The bookmark level for the anchor associated with this field.

Fields inherited from class net.sf.jasperreports.engine.fill.JRTemplatePrintElement

template

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

RUN_DIRECTION_LTR, 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

Constructor Summary

JRTemplatePrintText(JRTemplateText text)

Method Summary

java.lang.String	getAnchorName()
int	getBookmarkLevel() Returns the level of the bookmark corresponding to the anchor.
JRBox	getBox()
JRFont	getFont()
byte	getHorizontalAlignment() Gets the text horizontal alignment.
java.lang.String	getHyperlinkAnchor()
java.lang.Integer	getHyperlinkPage()
java.lang.String	getHyperlinkReference()
byte	getHyperlinkTarget()
byte	getHyperlinkType()
float	getLeadingOffset()
byte	getLineSpacing()
float	getLineSpacingFactor()
byte	getRotation()
byte	getRunDirection()
java.lang.String	getText()
byte	getTextAlignment() Deprecated. Replaced by getHorizontalAlignment().
float	getTextHeight()
byte	getVerticalAlignment() Gets the text vertical alignment.
boolean	isStyledText()
void	setAnchorName(java.lang.String anchorName)
void	setBookmarkLevel(int bookmarkLevel) Sets the boomark level for the anchor.
void	setBox(JRBox box)
void	setFont(JRFont font)
void	setHorizontalAlignment(byte horizontalAlignment) Sets the text horizontal alignment.
void	setHyperlinkAnchor(java.lang.String hyperlinkAnchor)
void	setHyperlinkPage(java.lang.Integer hyperlinkPage)
void	setHyperlinkReference(java.lang.String hyperlinkReference)
void	setHyperlinkTarget(byte hyperlinkTarget)
void	setHyperlinkType(byte hyperlinkType)
void	setLeadingOffset(float leadingOffset)
void	setLineSpacing(byte lineSpacing)
void	setLineSpacingFactor(float lineSpacingFactor)
void	setRotation(byte rotation)
void	setRunDirection(byte runDirection)
void	setStyledText(boolean isStyledText)
void	setText(java.lang.String text)
void	setTextAlignment(byte horizontalAlignment) Deprecated. Replaced by setHorizontalAlignment(byte).
void	setTextHeight(float textHeight)
void	setVerticalAlignment(byte verticalAlignment) Gets the text vertical alignment.

Methods inherited from class net.sf.jasperreports.engine.fill.JRTemplatePrintElement

getBackcolor, getForecolor, getHeight, getMode, getWidth, getX, getY, setBackcolor, setForecolor, setHeight, setMode, setWidth, setX, setY

Methods inherited from class java.lang.Object

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

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

getBackcolor, getForecolor, getHeight, getMode, getWidth, getX, getY, setBackcolor, setForecolor, setHeight, setMode, setWidth, setX, setY

Field Detail

bookmarkLevel

protected int bookmarkLevel

The bookmark level for the anchor associated with this field.

See Also:

JRAnchor.getBookmarkLevel()

Constructor Detail

JRTemplatePrintText

public JRTemplatePrintText(JRTemplateText text)

Method Detail

getText

public java.lang.String getText()

Specified by:

getText in interface JRPrintText

setText

public void setText(java.lang.String text)

Specified by:

setText in interface JRPrintText

getLineSpacingFactor

public float getLineSpacingFactor()

Specified by:

getLineSpacingFactor in interface JRPrintText

setLineSpacingFactor

public void setLineSpacingFactor(float lineSpacingFactor)

Specified by:

setLineSpacingFactor in interface JRPrintText

getLeadingOffset

public float getLeadingOffset()

Specified by:

getLeadingOffset in interface JRPrintText

setLeadingOffset

public void setLeadingOffset(float leadingOffset)

Specified by:

setLeadingOffset in interface JRPrintText

getTextAlignment

public byte getTextAlignment()

Deprecated. Replaced by getHorizontalAlignment().

Specified by:

getTextAlignment in interface JRPrintText

setTextAlignment

public void setTextAlignment(byte horizontalAlignment)

Deprecated. Replaced by setHorizontalAlignment(byte).

Specified by:

setTextAlignment in interface JRPrintText

getHorizontalAlignment

public byte getHorizontalAlignment()

Description copied from interface: JRAlignment

Gets the text horizontal alignment.

Specified by:

getHorizontalAlignment in interface JRAlignment

Returns:

a value representing one of the horizontal alignment constants in JRAlignment

setHorizontalAlignment

public void setHorizontalAlignment(byte horizontalAlignment)

Description copied from interface: JRAlignment

Sets the text horizontal alignment.

Specified by:

setHorizontalAlignment in interface JRAlignment

Parameters:

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

getVerticalAlignment

public byte getVerticalAlignment()

Description copied from interface: JRAlignment

Gets the text vertical alignment.

Specified by:

getVerticalAlignment in interface JRAlignment

Specified by:

getVerticalAlignment in interface JRPrintText

Returns:

a value representing one of the vertical alignment constants in JRAlignment

setVerticalAlignment

public void setVerticalAlignment(byte verticalAlignment)

Description copied from interface: JRAlignment

Gets the text vertical alignment.

Specified by:

setVerticalAlignment in interface JRAlignment

Specified by:

setVerticalAlignment in interface JRPrintText

Parameters:

verticalAlignment - a value representing one of the vertical alignment constants in JRAlignment

getRotation

public byte getRotation()

Specified by:

getRotation in interface JRPrintText

setRotation

public void setRotation(byte rotation)

Specified by:

setRotation in interface JRPrintText

getRunDirection

public byte getRunDirection()

Specified by:

getRunDirection in interface JRPrintText

setRunDirection

public void setRunDirection(byte runDirection)

Specified by:

setRunDirection in interface JRPrintText

getTextHeight

public float getTextHeight()

Specified by:

getTextHeight in interface JRPrintText

setTextHeight

public void setTextHeight(float textHeight)

Specified by:

setTextHeight in interface JRPrintText

getLineSpacing

public byte getLineSpacing()

Specified by:

getLineSpacing in interface JRPrintText

setLineSpacing

public void setLineSpacing(byte lineSpacing)

Specified by:

setLineSpacing in interface JRPrintText

isStyledText

public boolean isStyledText()

Specified by:

isStyledText in interface JRPrintText

setStyledText

public void setStyledText(boolean isStyledText)

Specified by:

setStyledText in interface JRPrintText

getBox

public JRBox getBox()

Specified by:

getBox in interface JRPrintText

setBox

public void setBox(JRBox box)

Specified by:

setBox in interface JRPrintText

getFont

public JRFont getFont()

Specified by:

getFont in interface JRPrintText

setFont

public void setFont(JRFont font)

Specified by:

setFont in interface JRPrintText

getAnchorName

public java.lang.String getAnchorName()

Specified by:

getAnchorName in interface JRPrintAnchor

setAnchorName

public void setAnchorName(java.lang.String anchorName)

Specified by:

setAnchorName in interface JRPrintAnchor

getHyperlinkType

public byte getHyperlinkType()

Specified by:

getHyperlinkType in interface JRPrintHyperlink

setHyperlinkType

public void setHyperlinkType(byte hyperlinkType)

Specified by:

setHyperlinkType in interface JRPrintHyperlink

getHyperlinkTarget

public byte getHyperlinkTarget()

Specified by:

getHyperlinkTarget in interface JRPrintHyperlink

setHyperlinkTarget

public void setHyperlinkTarget(byte hyperlinkTarget)

Specified by:

setHyperlinkTarget in interface JRPrintHyperlink

getHyperlinkReference

public java.lang.String getHyperlinkReference()

Specified by:

getHyperlinkReference in interface JRPrintHyperlink

setHyperlinkReference

public void setHyperlinkReference(java.lang.String hyperlinkReference)

Specified by:

setHyperlinkReference in interface JRPrintHyperlink

getHyperlinkAnchor

public java.lang.String getHyperlinkAnchor()

Specified by:

getHyperlinkAnchor in interface JRPrintHyperlink

setHyperlinkAnchor

public void setHyperlinkAnchor(java.lang.String hyperlinkAnchor)

Specified by:

setHyperlinkAnchor in interface JRPrintHyperlink

getHyperlinkPage

public java.lang.Integer getHyperlinkPage()

Specified by:

getHyperlinkPage in interface JRPrintHyperlink

setHyperlinkPage

public void setHyperlinkPage(java.lang.Integer hyperlinkPage)

Specified by:

setHyperlinkPage in interface JRPrintHyperlink

getBookmarkLevel

public int getBookmarkLevel()

Description copied from interface: JRPrintAnchor

Returns the level of the bookmark corresponding to the anchor.

Specified by:

getBookmarkLevel in interface JRPrintAnchor

Returns:

the level of the bookmark corresponding to the anchor (starting from 1) or NO_BOOKMARK if no bookmark should be created for this anchor

setBookmarkLevel

public void setBookmarkLevel(int bookmarkLevel)

Description copied from interface: JRPrintAnchor

Sets the boomark level for the anchor.

Specified by:

setBookmarkLevel in interface JRPrintAnchor

Parameters:

bookmarkLevel - the bookmark level (starting from 1) or NO_BOOKMARK if no bookmark should be created