JRStyle (JasperReports 5.5.1 API)

All Superinterfaces:

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 5878 2013-01-07 20:23:13Z teodord $

Author:

Ionut Nedelcu (ionutned@users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field and Description
`static 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

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

Interface JRStyle

Field Summary

Method Summary

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

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

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

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

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

Field Detail

PROPERTY_EVALUATION_TIME_ENABLED

Method Detail

getName

isDefault

getModeValue

getOwnModeValue

getForecolor

getOwnForecolor

getBackcolor

getOwnBackcolor

getLinePen

getFillValue

getOwnFillValue

getRadius

getOwnRadius

getScaleImageValue

getOwnScaleImageValue

getHorizontalAlignmentValue

getOwnHorizontalAlignmentValue

getVerticalAlignmentValue

getOwnVerticalAlignmentValue

getLineBox

getRotationValue

getOwnRotationValue

getLineSpacingValue

getOwnLineSpacingValue

getMarkup

getOwnMarkup

getFontName

getOwnFontName

isBold

isOwnBold

isItalic

isOwnItalic

isUnderline

isOwnUnderline

isStrikeThrough

isOwnStrikeThrough

getFontSize

getOwnFontSize

getPdfFontName

getOwnPdfFontName

getPdfEncoding

getOwnPdfEncoding

isPdfEmbedded

isOwnPdfEmbedded

getPattern

getOwnPattern

isBlankWhenNull

isOwnBlankWhenNull

setForecolor

setBackcolor

setMode

setFill

setRadius

setRadius

setScaleImage

setHorizontalAlignment

setVerticalAlignment

setRotation

setFontName

setBold

setBold

setItalic

setItalic

setPdfEmbedded

setPdfEmbedded

setStrikeThrough

setStrikeThrough

setMarkup

setUnderline