net.sf.jasperreports.engine
Interface JRStyle

All Superinterfaces:
JRBoxContainer, JRPenContainer, JRStyleContainer
All Known Subinterfaces:
JRConditionalStyle
All Known Implementing Classes:
JRBaseConditionalStyle, JRBaseStyle, JRDesignConditionalStyle, JRDesignStyle

public interface JRStyle
extends JRStyleContainer, JRBoxContainer, JRPenContainer

Version:
$Id: JRStyle.java 2042 2007-12-12 21:55:16Z teodord $
Author:
Ionut Nedelcu (ionutned@users.sourceforge.net)

Method Summary
 java.awt.Color getBackcolor()
           
 java.lang.Byte getBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Byte getBottomBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getBottomBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Integer getBottomPadding()
          Deprecated. Replaced by getLineBox()
 JRConditionalStyle[] getConditionalStyles()
           
 java.lang.Byte getFill()
          Indicates the fill type used for this element.
 java.lang.String getFontName()
           
 java.lang.Integer getFontSize()
           
 java.awt.Color getForecolor()
           
 java.lang.Byte getHorizontalAlignment()
          Gets the horizontal alignment of the element.
 java.lang.Byte getLeftBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getLeftBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Integer getLeftPadding()
          Deprecated. Replaced by getLineBox()
 JRLineBox getLineBox()
           
 JRPen getLinePen()
           
 java.lang.Byte getLineSpacing()
          Gets the line spacing.
 java.lang.Byte getMode()
          Returns the element transparency mode.
 java.lang.String getName()
          Gets the style unique name.
 java.awt.Color getOwnBackcolor()
           
 java.lang.Byte getOwnBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getOwnBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Byte getOwnBottomBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getOwnBottomBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Integer getOwnBottomPadding()
          Deprecated. Replaced by getLineBox()
 java.lang.Byte getOwnFill()
           
 java.lang.String getOwnFontName()
           
 java.lang.Integer getOwnFontSize()
           
 java.awt.Color getOwnForecolor()
           
 java.lang.Byte getOwnHorizontalAlignment()
           
 java.lang.Byte getOwnLeftBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getOwnLeftBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Integer getOwnLeftPadding()
          Deprecated. Replaced by getLineBox()
 java.lang.Byte getOwnLineSpacing()
           
 java.lang.Byte getOwnMode()
           
 java.lang.Integer getOwnPadding()
          Deprecated. Replaced by getLineBox()
 java.lang.String getOwnPattern()
           
 java.lang.String getOwnPdfEncoding()
           
 java.lang.String getOwnPdfFontName()
           
 java.lang.Byte getOwnPen()
          Deprecated. Replaced by getLinePen()
 java.lang.Integer getOwnRadius()
           
 java.lang.Byte getOwnRightBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getOwnRightBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Integer getOwnRightPadding()
          Deprecated. Replaced by getLineBox()
 java.lang.Byte getOwnRotation()
           
 java.lang.Byte getOwnScaleImage()
           
 java.lang.Byte getOwnTopBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getOwnTopBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Integer getOwnTopPadding()
          Deprecated. Replaced by getLineBox()
 java.lang.Byte getOwnVerticalAlignment()
           
 java.lang.Integer getPadding()
          Deprecated. Replaced by getLineBox()
 java.lang.String getPattern()
          Gets the pattern used for this text field.
 java.lang.String getPdfEncoding()
           
 java.lang.String getPdfFontName()
           
 java.lang.Byte getPen()
          Deprecated. Replaced by getLinePen()
 java.lang.Integer getRadius()
          Indicates the corner radius for rectangles with round corners.
 java.lang.Byte getRightBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getRightBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Integer getRightPadding()
          Deprecated. Replaced by getLineBox()
 java.lang.Byte getRotation()
          Gets the text rotation.
 java.lang.Byte getScaleImage()
          Gets the image scale type.
 java.lang.Byte getTopBorder()
          Deprecated. Replaced by getLineBox()
 java.awt.Color getTopBorderColor()
          Deprecated. Replaced by getLineBox()
 java.lang.Integer getTopPadding()
          Deprecated. Replaced by getLineBox()
 java.lang.Byte getVerticalAlignment()
          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 isOwnStyledText()
           
 java.lang.Boolean isOwnUnderline()
           
 java.lang.Boolean isPdfEmbedded()
           
 java.lang.Boolean isStrikeThrough()
           
 java.lang.Boolean isStyledText()
          Returns true if the text can contain style tags.
 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 setBorder(byte border)
           
 void setBorder(java.lang.Byte border)
           
 void setBorderColor(java.awt.Color borderColor)
           
 void setBottomBorder(byte bottomBorder)
           
 void setBottomBorder(java.lang.Byte bottomBorder)
           
 void setBottomBorderColor(java.awt.Color bottomBorderColor)
           
 void setBottomPadding(int bottomPadding)
           
 void setBottomPadding(java.lang.Integer bottomPadding)
           
 void setFill(byte fill)
           
 void setFill(java.lang.Byte 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(byte horizontalAlignment)
           
 void setHorizontalAlignment(java.lang.Byte horizontalAlignment)
           
 void setItalic(boolean italic)
           
 void setItalic(java.lang.Boolean italic)
           
 void setLeftBorder(byte leftBorder)
           
 void setLeftBorder(java.lang.Byte leftBorder)
           
 void setLeftBorderColor(java.awt.Color leftBorderColor)
           
 void setLeftPadding(int leftPadding)
           
 void setLeftPadding(java.lang.Integer leftPadding)
           
 void setLineSpacing(byte lineSpacing)
           
 void setLineSpacing(java.lang.Byte lineSpacing)
           
 void setMode(byte mode)
           
 void setMode(java.lang.Byte mode)
           
 void setPadding(int padding)
           
 void setPadding(java.lang.Integer padding)
           
 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 setPen(byte pen)
          Deprecated. Replaced by getLinePen()
 void setPen(java.lang.Byte pen)
          Deprecated. Replaced by getLinePen()
 void setRadius(int radius)
           
 void setRadius(java.lang.Integer radius)
           
 void setRightBorder(byte rightBorder)
           
 void setRightBorder(java.lang.Byte rightBorder)
           
 void setRightBorderColor(java.awt.Color rightBorderColor)
           
 void setRightPadding(int rightPadding)
           
 void setRightPadding(java.lang.Integer rightPadding)
           
 void setRotation(byte rotation)
           
 void setRotation(java.lang.Byte rotation)
           
 void setScaleImage(byte scaleImage)
           
 void setScaleImage(java.lang.Byte scaleImage)
           
 void setStrikeThrough(boolean strikeThrough)
           
 void setStrikeThrough(java.lang.Boolean strikeThrough)
           
 void setStyledText(boolean styledText)
           
 void setStyledText(java.lang.Boolean styledText)
           
 void setTopBorder(byte topBorder)
           
 void setTopBorder(java.lang.Byte topBorder)
           
 void setTopBorderColor(java.awt.Color topBorderColor)
           
 void setTopPadding(int topPadding)
           
 void setTopPadding(java.lang.Integer topPadding)
           
 void setUnderline(boolean underline)
           
 void setUnderline(java.lang.Boolean underline)
           
 void setVerticalAlignment(byte verticalAlignment)
           
 void setVerticalAlignment(java.lang.Byte verticalAlignment)
           
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleNameReference
 
Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer
getDefaultLineColor
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleNameReference
 
Methods inherited from interface net.sf.jasperreports.engine.JRPenContainer
getDefaultLineColor, getDefaultLineWidth
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleNameReference
 

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.


getMode

java.lang.Byte getMode()
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.

Returns:
MODE_OPAQUE or MODE_TRANSPARENT

getOwnMode

java.lang.Byte getOwnMode()

getForecolor

java.awt.Color getForecolor()

getOwnForecolor

java.awt.Color getOwnForecolor()

getBackcolor

java.awt.Color getBackcolor()

getOwnBackcolor

java.awt.Color getOwnBackcolor()

getLinePen

JRPen getLinePen()

getPen

java.lang.Byte getPen()
Deprecated. Replaced by getLinePen()

Indicates the pen type used for this element.

Returns:
one of the pen constants in this class

getOwnPen

java.lang.Byte getOwnPen()
Deprecated. Replaced by getLinePen()


getFill

java.lang.Byte getFill()
Indicates the fill type used for this element.

Returns:
one of the pen constants in this class

getOwnFill

java.lang.Byte getOwnFill()

getRadius

java.lang.Integer getRadius()
Indicates the corner radius for rectangles with round corners. The default is 0.


getOwnRadius

java.lang.Integer getOwnRadius()

getScaleImage

java.lang.Byte getScaleImage()
Gets the image scale type.

Returns:
one of the scale constants in this class

getOwnScaleImage

java.lang.Byte getOwnScaleImage()

getHorizontalAlignment

java.lang.Byte getHorizontalAlignment()
Gets the horizontal alignment of the element.

Returns:
one of the alignment values defined in JRAlignment

getOwnHorizontalAlignment

java.lang.Byte getOwnHorizontalAlignment()

getVerticalAlignment

java.lang.Byte getVerticalAlignment()
Gets the vertical alignment of the element.

Returns:
one of the alignment values defined in JRAlignment

getOwnVerticalAlignment

java.lang.Byte getOwnVerticalAlignment()

getLineBox

JRLineBox getLineBox()
Specified by:
getLineBox in interface JRBoxContainer

getBorder

java.lang.Byte getBorder()
Deprecated. Replaced by getLineBox()


getOwnBorder

java.lang.Byte getOwnBorder()
Deprecated. Replaced by getLineBox()


getBorderColor

java.awt.Color getBorderColor()
Deprecated. Replaced by getLineBox()


getOwnBorderColor

java.awt.Color getOwnBorderColor()
Deprecated. Replaced by getLineBox()


getPadding

java.lang.Integer getPadding()
Deprecated. Replaced by getLineBox()


getOwnPadding

java.lang.Integer getOwnPadding()
Deprecated. Replaced by getLineBox()


getTopBorder

java.lang.Byte getTopBorder()
Deprecated. Replaced by getLineBox()


getOwnTopBorder

java.lang.Byte getOwnTopBorder()
Deprecated. Replaced by getLineBox()


getTopBorderColor

java.awt.Color getTopBorderColor()
Deprecated. Replaced by getLineBox()


getOwnTopBorderColor

java.awt.Color getOwnTopBorderColor()
Deprecated. Replaced by getLineBox()


getTopPadding

java.lang.Integer getTopPadding()
Deprecated. Replaced by getLineBox()


getOwnTopPadding

java.lang.Integer getOwnTopPadding()
Deprecated. Replaced by getLineBox()


getLeftBorder

java.lang.Byte getLeftBorder()
Deprecated. Replaced by getLineBox()


getOwnLeftBorder

java.lang.Byte getOwnLeftBorder()
Deprecated. Replaced by getLineBox()


getLeftBorderColor

java.awt.Color getLeftBorderColor()
Deprecated. Replaced by getLineBox()


getOwnLeftBorderColor

java.awt.Color getOwnLeftBorderColor()
Deprecated. Replaced by getLineBox()


getLeftPadding

java.lang.Integer getLeftPadding()
Deprecated. Replaced by getLineBox()


getOwnLeftPadding

java.lang.Integer getOwnLeftPadding()
Deprecated. Replaced by getLineBox()


getBottomBorder

java.lang.Byte getBottomBorder()
Deprecated. Replaced by getLineBox()


getOwnBottomBorder

java.lang.Byte getOwnBottomBorder()
Deprecated. Replaced by getLineBox()


getBottomBorderColor

java.awt.Color getBottomBorderColor()
Deprecated. Replaced by getLineBox()


getOwnBottomBorderColor

java.awt.Color getOwnBottomBorderColor()
Deprecated. Replaced by getLineBox()


getBottomPadding

java.lang.Integer getBottomPadding()
Deprecated. Replaced by getLineBox()


getOwnBottomPadding

java.lang.Integer getOwnBottomPadding()
Deprecated. Replaced by getLineBox()


getRightBorder

java.lang.Byte getRightBorder()
Deprecated. Replaced by getLineBox()


getOwnRightBorder

java.lang.Byte getOwnRightBorder()
Deprecated. Replaced by getLineBox()


getRightBorderColor

java.awt.Color getRightBorderColor()
Deprecated. Replaced by getLineBox()


getOwnRightBorderColor

java.awt.Color getOwnRightBorderColor()
Deprecated. Replaced by getLineBox()


getRightPadding

java.lang.Integer getRightPadding()
Deprecated. Replaced by getLineBox()


getOwnRightPadding

java.lang.Integer getOwnRightPadding()
Deprecated. Replaced by getLineBox()


getRotation

java.lang.Byte getRotation()
Gets the text rotation.

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

getOwnRotation

java.lang.Byte getOwnRotation()

getLineSpacing

java.lang.Byte getLineSpacing()
Gets the line spacing.

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

getOwnLineSpacing

java.lang.Byte getOwnLineSpacing()

isStyledText

java.lang.Boolean isStyledText()
Returns true if the text can contain style tags.


isOwnStyledText

java.lang.Boolean isOwnStyledText()

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(byte mode)

setMode

void setMode(java.lang.Byte mode)

setPen

void setPen(byte pen)
Deprecated. Replaced by getLinePen()


setPen

void setPen(java.lang.Byte pen)
Deprecated. Replaced by getLinePen()


setFill

void setFill(byte fill)

setFill

void setFill(java.lang.Byte fill)

setRadius

void setRadius(int radius)

setRadius

void setRadius(java.lang.Integer radius)

setScaleImage

void setScaleImage(byte scaleImage)

setScaleImage

void setScaleImage(java.lang.Byte scaleImage)

setHorizontalAlignment

void setHorizontalAlignment(byte horizontalAlignment)

setHorizontalAlignment

void setHorizontalAlignment(java.lang.Byte horizontalAlignment)

setVerticalAlignment

void setVerticalAlignment(byte verticalAlignment)

setVerticalAlignment

void setVerticalAlignment(java.lang.Byte verticalAlignment)

setBorder

void setBorder(byte border)

setBorder

void setBorder(java.lang.Byte border)

setBorderColor

void setBorderColor(java.awt.Color borderColor)

setPadding

void setPadding(int padding)

setPadding

void setPadding(java.lang.Integer padding)

setTopBorder

void setTopBorder(byte topBorder)

setTopBorder

void setTopBorder(java.lang.Byte topBorder)

setTopBorderColor

void setTopBorderColor(java.awt.Color topBorderColor)

setTopPadding

void setTopPadding(int topPadding)

setTopPadding

void setTopPadding(java.lang.Integer topPadding)

setLeftBorder

void setLeftBorder(byte leftBorder)

setLeftBorder

void setLeftBorder(java.lang.Byte leftBorder)

setLeftBorderColor

void setLeftBorderColor(java.awt.Color leftBorderColor)

setLeftPadding

void setLeftPadding(int leftPadding)

setLeftPadding

void setLeftPadding(java.lang.Integer leftPadding)

setBottomBorder

void setBottomBorder(byte bottomBorder)

setBottomBorder

void setBottomBorder(java.lang.Byte bottomBorder)

setBottomBorderColor

void setBottomBorderColor(java.awt.Color bottomBorderColor)

setBottomPadding

void setBottomPadding(int bottomPadding)

setBottomPadding

void setBottomPadding(java.lang.Integer bottomPadding)

setRightBorder

void setRightBorder(byte rightBorder)

setRightBorder

void setRightBorder(java.lang.Byte rightBorder)

setRightBorderColor

void setRightBorderColor(java.awt.Color rightBorderColor)

setRightPadding

void setRightPadding(int rightPadding)

setRightPadding

void setRightPadding(java.lang.Integer rightPadding)

setRotation

void setRotation(byte rotation)

setRotation

void setRotation(java.lang.Byte 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)

setStyledText

void setStyledText(boolean styledText)

setStyledText

void setStyledText(java.lang.Boolean styledText)

setUnderline

void setUnderline(boolean underline)

setUnderline

void setUnderline(java.lang.Boolean underline)

setLineSpacing

void setLineSpacing(byte lineSpacing)

setLineSpacing

void setLineSpacing(java.lang.Byte lineSpacing)

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()


© 2001-2006 JasperSoft Corporation www.jaspersoft.com