net.sf.jasperreports.engine
Interface JRStyle

All Superinterfaces:

java.lang.Cloneable, JRBoxContainer, JRCloneable, JRParagraphContainer, JRPenContainer, JRStyleContainer

All Known Subinterfaces:

JRConditionalStyle

All Known Implementing Classes:

JRBaseConditionalStyle, JRBaseStyle, JRDesignConditionalStyle, JRDesignStyle

public interface JRStyle
extends JRStyleContainer, JRBoxContainer, JRPenContainer, JRParagraphContainer, JRCloneable

Version:

$Id: JRStyle.java 5180 2012-03-29 13:23:12Z teodord $

Author:

Ionut Nedelcu (ionutned@users.sourceforge.net)

Field Summary

static java.lang.String

PROPERTY_EVALUATION_TIME_ENABLED A flag the determines whether the style of an element is evaluated at the element evaluation time, or at the time the band on which the element is placed is rendered.

Method Summary

java.awt.Color	getBackcolor()
JRConditionalStyle[]	getConditionalStyles()
FillEnum	getFillValue() Indicates the fill type used for this element.
java.lang.String	getFontName()
java.lang.Integer	getFontSize()
java.awt.Color	getForecolor()
HorizontalAlignEnum	getHorizontalAlignmentValue() Gets the horizontal alignment of the element.
JRLineBox	getLineBox()
JRPen	getLinePen()
LineSpacingEnum	getLineSpacingValue() Deprecated. Replaced by JRParagraph.getLineSpacing().
java.lang.String	getMarkup() Returns the markup language used to format the text.
ModeEnum	getModeValue() Returns the element transparency mode.
java.lang.String	getName() Gets the style unique name.
java.awt.Color	getOwnBackcolor()
FillEnum	getOwnFillValue()
java.lang.String	getOwnFontName()
java.lang.Integer	getOwnFontSize()
java.awt.Color	getOwnForecolor()
HorizontalAlignEnum	getOwnHorizontalAlignmentValue()
LineSpacingEnum	getOwnLineSpacingValue() Deprecated. Replaced by JRParagraph.getOwnLineSpacing().
java.lang.String	getOwnMarkup()
ModeEnum	getOwnModeValue()
java.lang.String	getOwnPattern()
java.lang.String	getOwnPdfEncoding()
java.lang.String	getOwnPdfFontName()
java.lang.Integer	getOwnRadius()
RotationEnum	getOwnRotationValue() Gets the text own rotation.
ScaleImageEnum	getOwnScaleImageValue() Gets the image own scale type.
VerticalAlignEnum	getOwnVerticalAlignmentValue()
java.lang.String	getPattern() Gets the pattern used for this text field.
java.lang.String	getPdfEncoding()
java.lang.String	getPdfFontName()
java.lang.Integer	getRadius() Indicates the corner radius for rectangles with round corners.
RotationEnum	getRotationValue() Gets the text rotation.
ScaleImageEnum	getScaleImageValue() Gets the image scale type.
VerticalAlignEnum	getVerticalAlignmentValue() Gets the vertical alignment of the element.
java.lang.Boolean	isBlankWhenNull()
java.lang.Boolean	isBold()
boolean	isDefault() Gets a flag that specifies if this is the default report style.
java.lang.Boolean	isItalic()
java.lang.Boolean	isOwnBlankWhenNull()
java.lang.Boolean	isOwnBold()
java.lang.Boolean	isOwnItalic()
java.lang.Boolean	isOwnPdfEmbedded()
java.lang.Boolean	isOwnStrikeThrough()
java.lang.Boolean	isOwnUnderline()
java.lang.Boolean	isPdfEmbedded()
java.lang.Boolean	isStrikeThrough()
java.lang.Boolean	isUnderline()
void	setBackcolor(java.awt.Color backcolor)
void	setBlankWhenNull(boolean isBlankWhenNull)
void	setBlankWhenNull(java.lang.Boolean isBlankWhenNull)
void	setBold(boolean bold)
void	setBold(java.lang.Boolean bold)
void	setFill(FillEnum fill)
void	setFontName(java.lang.String fontName)
void	setFontSize(int fontSize)
void	setFontSize(java.lang.Integer fontSize)
void	setForecolor(java.awt.Color forecolor)
void	setHorizontalAlignment(HorizontalAlignEnum horizontalAlignment)
void	setItalic(boolean italic)
void	setItalic(java.lang.Boolean italic)
void	setLineSpacing(LineSpacingEnum lineSpacing) Deprecated. Replaced by JRParagraph.setLineSpacing(LineSpacingEnum)
void	setMarkup(java.lang.String markup)
void	setMode(ModeEnum mode)
void	setPattern(java.lang.String pattern)
void	setPdfEmbedded(boolean pdfEmbedded)
void	setPdfEmbedded(java.lang.Boolean pdfEmbedded)
void	setPdfEncoding(java.lang.String pdfEncoding)
void	setPdfFontName(java.lang.String pdfFontName)
void	setRadius(int radius)
void	setRadius(java.lang.Integer radius)
void	setRotation(RotationEnum rotation)
void	setScaleImage(ScaleImageEnum scaleImage)
void	setStrikeThrough(boolean strikeThrough)
void	setStrikeThrough(java.lang.Boolean strikeThrough)
void	setUnderline(boolean underline)
void	setUnderline(java.lang.Boolean underline)
void	setVerticalAlignment(VerticalAlignEnum verticalAlignment)

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

getDefaultLineColor

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

getDefaultLineColor, getDefaultLineWidth

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

getParagraph

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

getDefaultStyleProvider, getStyle, getStyleNameReference

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

clone

Field Detail

PROPERTY_EVALUATION_TIME_ENABLED

static final java.lang.String PROPERTY_EVALUATION_TIME_ENABLED

A flag the determines whether the style of an element is evaluated at the element evaluation time, or at the time the band on which the element is placed is rendered.

This applies to report elements that can have delayed evaluations times (such as text fields and images). When this flag is set to true, conditional style expressions of the style that is associated with the element are evaluated at the moment the element is set to evaluate, and the resulting style to the generated print element.

By default, this flag is set to false. The property can be set globally, at report level and at element level.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Gets the style unique name.

isDefault

boolean isDefault()

Gets a flag that specifies if this is the default report style.

getModeValue

ModeEnum getModeValue()

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.

getOwnModeValue

ModeEnum getOwnModeValue()

getForecolor

java.awt.Color getForecolor()

getOwnForecolor

java.awt.Color getOwnForecolor()

getBackcolor

java.awt.Color getBackcolor()

getOwnBackcolor

java.awt.Color getOwnBackcolor()

getLinePen

JRPen getLinePen()

getFillValue

FillEnum getFillValue()

Indicates the fill type used for this element.

Returns:

one of the fill constants in FillEnum.

getOwnFillValue

FillEnum getOwnFillValue()

getRadius

java.lang.Integer getRadius()

Indicates the corner radius for rectangles with round corners. The default is 0.

getOwnRadius

java.lang.Integer getOwnRadius()

getScaleImageValue

ScaleImageEnum getScaleImageValue()

Gets the image scale type.

Returns:

one of the scale types defined in ScaleImageEnum

getOwnScaleImageValue

ScaleImageEnum getOwnScaleImageValue()

Gets the image own scale type.

Returns:

one of the scale types defined in ScaleImageEnum

getHorizontalAlignmentValue

HorizontalAlignEnum getHorizontalAlignmentValue()

Gets the horizontal alignment of the element.

Returns:

one of the alignment values defined in HorizontalAlignEnum

getOwnHorizontalAlignmentValue

HorizontalAlignEnum getOwnHorizontalAlignmentValue()

getVerticalAlignmentValue

VerticalAlignEnum getVerticalAlignmentValue()

Gets the vertical alignment of the element.

Returns:

one of the alignment values defined in JRAlignment

getOwnVerticalAlignmentValue

VerticalAlignEnum getOwnVerticalAlignmentValue()

getLineBox

JRLineBox getLineBox()

Specified by:

getLineBox in interface JRBoxContainer

getRotationValue

RotationEnum getRotationValue()

Gets the text rotation.

Returns:

a value representing one of the rotation values in the RotationEnum.

getOwnRotationValue

RotationEnum getOwnRotationValue()

Gets the text own rotation.

Returns:

a value representing one of the rotation values in the RotationEnum.

getLineSpacingValue

LineSpacingEnum getLineSpacingValue()

Deprecated. Replaced by JRParagraph.getLineSpacing().

getOwnLineSpacingValue

LineSpacingEnum getOwnLineSpacingValue()

Deprecated. Replaced by JRParagraph.getOwnLineSpacing().

getMarkup

java.lang.String getMarkup()

Returns the markup language used to format the text.

getOwnMarkup

java.lang.String getOwnMarkup()

getFontName

java.lang.String getFontName()

getOwnFontName

java.lang.String getOwnFontName()

isBold

java.lang.Boolean isBold()

isOwnBold

java.lang.Boolean isOwnBold()

isItalic

java.lang.Boolean isItalic()

isOwnItalic

java.lang.Boolean isOwnItalic()

isUnderline

java.lang.Boolean isUnderline()

isOwnUnderline

java.lang.Boolean isOwnUnderline()

isStrikeThrough

java.lang.Boolean isStrikeThrough()

isOwnStrikeThrough

java.lang.Boolean isOwnStrikeThrough()

getFontSize

java.lang.Integer getFontSize()

getOwnFontSize

java.lang.Integer getOwnFontSize()

getPdfFontName

java.lang.String getPdfFontName()

getOwnPdfFontName

java.lang.String getOwnPdfFontName()

getPdfEncoding

java.lang.String getPdfEncoding()

getOwnPdfEncoding

java.lang.String getOwnPdfEncoding()

isPdfEmbedded

java.lang.Boolean isPdfEmbedded()

isOwnPdfEmbedded

java.lang.Boolean isOwnPdfEmbedded()

getPattern

java.lang.String getPattern()

Gets the pattern used for this text field. The pattern will be used in a SimpleDateFormat for dates and a DecimalFormat for numeric text fields. The pattern format must follow one of these two classes formatting rules, as specified in the JDK API docs.

Returns:

a string containing the pattern.

getOwnPattern

java.lang.String getOwnPattern()

isBlankWhenNull

java.lang.Boolean isBlankWhenNull()

isOwnBlankWhenNull

java.lang.Boolean isOwnBlankWhenNull()

setForecolor

void setForecolor(java.awt.Color forecolor)

setBackcolor

void setBackcolor(java.awt.Color backcolor)

setMode

void setMode(ModeEnum mode)

setFill

void setFill(FillEnum fill)

setRadius

void setRadius(int radius)

setRadius

void setRadius(java.lang.Integer radius)

setScaleImage

void setScaleImage(ScaleImageEnum scaleImage)

setHorizontalAlignment

void setHorizontalAlignment(HorizontalAlignEnum horizontalAlignment)

setVerticalAlignment

void setVerticalAlignment(VerticalAlignEnum verticalAlignment)

setRotation

void setRotation(RotationEnum rotation)

setFontName

void setFontName(java.lang.String fontName)

setBold

void setBold(boolean bold)

setBold

void setBold(java.lang.Boolean bold)

setItalic

void setItalic(boolean italic)

setItalic

void setItalic(java.lang.Boolean italic)

setPdfEmbedded

void setPdfEmbedded(boolean pdfEmbedded)

setPdfEmbedded

void setPdfEmbedded(java.lang.Boolean pdfEmbedded)

setStrikeThrough

void setStrikeThrough(boolean strikeThrough)

setStrikeThrough

void setStrikeThrough(java.lang.Boolean strikeThrough)

setMarkup

void setMarkup(java.lang.String markup)

setUnderline

void setUnderline(boolean underline)

setUnderline

void setUnderline(java.lang.Boolean underline)

setLineSpacing

void setLineSpacing(LineSpacingEnum lineSpacing)

Deprecated. Replaced by JRParagraph.setLineSpacing(LineSpacingEnum)

setPattern

void setPattern(java.lang.String pattern)

setBlankWhenNull

void setBlankWhenNull(boolean isBlankWhenNull)

setBlankWhenNull

void setBlankWhenNull(java.lang.Boolean isBlankWhenNull)

setPdfEncoding

void setPdfEncoding(java.lang.String pdfEncoding)

setPdfFontName

void setPdfFontName(java.lang.String pdfFontName)

setFontSize

void setFontSize(int fontSize)

setFontSize

void setFontSize(java.lang.Integer fontSize)

getConditionalStyles

JRConditionalStyle[] getConditionalStyles()