net.sf.jasperreports.engine
Interface JRStyle

All Superinterfaces:
JRStyleContainer
All Known Implementing Classes:
JRBaseStyle

public interface JRStyle
extends JRStyleContainer

Version:
$Id
Author:
Ionut Nedelcu (ionutned@users.sourceforge.net)

Method Summary
 java.awt.Color getBackcolor()
           
 java.lang.Byte getBorder()
          Gets the default border pen size (can be overwritten by individual settings).
 java.awt.Color getBorderColor()
          Gets the default border color (can be overwritten by individual settings).
 java.lang.Byte getBottomBorder()
           
 java.awt.Color getBottomBorderColor()
           
 java.lang.Integer getBottomPadding()
           
 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()
           
 java.awt.Color getLeftBorderColor()
           
 java.lang.Integer getLeftPadding()
           
 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()
           
 java.awt.Color getOwnBorderColor()
           
 java.lang.Byte getOwnBottomBorder()
           
 java.awt.Color getOwnBottomBorderColor()
           
 java.lang.Integer getOwnBottomPadding()
           
 java.lang.Byte getOwnFill()
           
 java.lang.String getOwnFontName()
           
 java.lang.Integer getOwnFontSize()
           
 java.awt.Color getOwnForecolor()
           
 java.lang.Byte getOwnHorizontalAlignment()
           
 java.lang.Byte getOwnLeftBorder()
           
 java.awt.Color getOwnLeftBorderColor()
           
 java.lang.Integer getOwnLeftPadding()
           
 java.lang.Byte getOwnLineSpacing()
           
 java.lang.Byte getOwnMode()
           
 java.lang.Integer getOwnPadding()
           
 java.lang.String getOwnPattern()
           
 java.lang.String getOwnPdfEncoding()
           
 java.lang.String getOwnPdfFontName()
           
 java.lang.Byte getOwnPen()
           
 java.lang.Integer getOwnRadius()
           
 java.lang.Byte getOwnRightBorder()
           
 java.awt.Color getOwnRightBorderColor()
           
 java.lang.Integer getOwnRightPadding()
           
 java.lang.Byte getOwnRotation()
           
 java.lang.Byte getOwnScaleImage()
           
 java.lang.Byte getOwnTopBorder()
          Gets the top border pen size (if the default value was overwritten).
 java.awt.Color getOwnTopBorderColor()
          Gets the top border color (if the default value was overwritten).
 java.lang.Integer getOwnTopPadding()
           
 java.lang.Byte getOwnVerticalAlignment()
           
 java.lang.Integer getPadding()
          Gets the default padding in pixels (can be overwritten by individual settings).
 java.lang.String getPattern()
          Gets the pattern used for this text field.
 java.lang.String getPdfEncoding()
           
 java.lang.String getPdfFontName()
           
 java.lang.Byte getPen()
          Indicates the pen type used for this element.
 java.lang.Integer getRadius()
          Indicates the corner radius for rectangles with round corners.
 java.lang.Byte getRightBorder()
           
 java.awt.Color getRightBorderColor()
           
 java.lang.Integer getRightPadding()
           
 java.lang.Byte getRotation()
          Gets the text rotation.
 java.lang.Byte getScaleImage()
          Gets the image scale type.
 java.lang.Byte getTopBorder()
          Gets the top border pen size.
 java.awt.Color getTopBorderColor()
          Gets the top border color.
 java.lang.Integer getTopPadding()
           
 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)
           
 void setPen(java.lang.Byte pen)
           
 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
 

Method Detail

getName

public java.lang.String getName()
Gets the style unique name.


isDefault

public boolean isDefault()
Gets a flag that specifies if this is the default report style.


getMode

public 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

public java.lang.Byte getOwnMode()

getForecolor

public java.awt.Color getForecolor()

getOwnForecolor

public java.awt.Color getOwnForecolor()

getBackcolor

public java.awt.Color getBackcolor()

getOwnBackcolor

public java.awt.Color getOwnBackcolor()

getPen

public java.lang.Byte getPen()
Indicates the pen type used for this element.

Returns:
one of the pen constants in this class

getOwnPen

public java.lang.Byte getOwnPen()

getFill

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

Returns:
one of the pen constants in this class

getOwnFill

public java.lang.Byte getOwnFill()

getRadius

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


getOwnRadius

public java.lang.Integer getOwnRadius()

getScaleImage

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

Returns:
one of the scale constants in this class

getOwnScaleImage

public java.lang.Byte getOwnScaleImage()

getHorizontalAlignment

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

Returns:
one of the alignment values defined in JRAlignment

getOwnHorizontalAlignment

public java.lang.Byte getOwnHorizontalAlignment()

getVerticalAlignment

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

Returns:
one of the alignment values defined in JRAlignment

getOwnVerticalAlignment

public java.lang.Byte getOwnVerticalAlignment()

getBorder

public java.lang.Byte getBorder()
Gets the default border pen size (can be overwritten by individual settings).


getOwnBorder

public java.lang.Byte getOwnBorder()

getBorderColor

public java.awt.Color getBorderColor()
Gets the default border color (can be overwritten by individual settings).


getOwnBorderColor

public java.awt.Color getOwnBorderColor()

getPadding

public java.lang.Integer getPadding()
Gets the default padding in pixels (can be overwritten by individual settings).


getOwnPadding

public java.lang.Integer getOwnPadding()

getTopBorder

public java.lang.Byte getTopBorder()
Gets the top border pen size.


getOwnTopBorder

public java.lang.Byte getOwnTopBorder()
Gets the top border pen size (if the default value was overwritten).


getTopBorderColor

public java.awt.Color getTopBorderColor()
Gets the top border color.


getOwnTopBorderColor

public java.awt.Color getOwnTopBorderColor()
Gets the top border color (if the default value was overwritten).


getTopPadding

public java.lang.Integer getTopPadding()

getOwnTopPadding

public java.lang.Integer getOwnTopPadding()

getLeftBorder

public java.lang.Byte getLeftBorder()

getOwnLeftBorder

public java.lang.Byte getOwnLeftBorder()

getLeftBorderColor

public java.awt.Color getLeftBorderColor()

getOwnLeftBorderColor

public java.awt.Color getOwnLeftBorderColor()

getLeftPadding

public java.lang.Integer getLeftPadding()

getOwnLeftPadding

public java.lang.Integer getOwnLeftPadding()

getBottomBorder

public java.lang.Byte getBottomBorder()

getOwnBottomBorder

public java.lang.Byte getOwnBottomBorder()

getBottomBorderColor

public java.awt.Color getBottomBorderColor()

getOwnBottomBorderColor

public java.awt.Color getOwnBottomBorderColor()

getBottomPadding

public java.lang.Integer getBottomPadding()

getOwnBottomPadding

public java.lang.Integer getOwnBottomPadding()

getRightBorder

public java.lang.Byte getRightBorder()

getOwnRightBorder

public java.lang.Byte getOwnRightBorder()

getRightBorderColor

public java.awt.Color getRightBorderColor()

getOwnRightBorderColor

public java.awt.Color getOwnRightBorderColor()

getRightPadding

public java.lang.Integer getRightPadding()

getOwnRightPadding

public java.lang.Integer getOwnRightPadding()

getRotation

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

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

getOwnRotation

public java.lang.Byte getOwnRotation()

getLineSpacing

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

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

getOwnLineSpacing

public java.lang.Byte getOwnLineSpacing()

isStyledText

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


isOwnStyledText

public java.lang.Boolean isOwnStyledText()

getFontName

public java.lang.String getFontName()

getOwnFontName

public java.lang.String getOwnFontName()

isBold

public java.lang.Boolean isBold()

isOwnBold

public java.lang.Boolean isOwnBold()

isItalic

public java.lang.Boolean isItalic()

isOwnItalic

public java.lang.Boolean isOwnItalic()

isUnderline

public java.lang.Boolean isUnderline()

isOwnUnderline

public java.lang.Boolean isOwnUnderline()

isStrikeThrough

public java.lang.Boolean isStrikeThrough()

isOwnStrikeThrough

public java.lang.Boolean isOwnStrikeThrough()

getFontSize

public java.lang.Integer getFontSize()

getOwnFontSize

public java.lang.Integer getOwnFontSize()

getPdfFontName

public java.lang.String getPdfFontName()

getOwnPdfFontName

public java.lang.String getOwnPdfFontName()

getPdfEncoding

public java.lang.String getPdfEncoding()

getOwnPdfEncoding

public java.lang.String getOwnPdfEncoding()

isPdfEmbedded

public java.lang.Boolean isPdfEmbedded()

isOwnPdfEmbedded

public java.lang.Boolean isOwnPdfEmbedded()

getPattern

public 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

public java.lang.String getOwnPattern()

isBlankWhenNull

public java.lang.Boolean isBlankWhenNull()

isOwnBlankWhenNull

public java.lang.Boolean isOwnBlankWhenNull()

setForecolor

public void setForecolor(java.awt.Color forecolor)

setBackcolor

public void setBackcolor(java.awt.Color backcolor)

setMode

public void setMode(byte mode)

setMode

public void setMode(java.lang.Byte mode)

setPen

public void setPen(byte pen)

setPen

public void setPen(java.lang.Byte pen)

setFill

public void setFill(byte fill)

setFill

public void setFill(java.lang.Byte fill)

setRadius

public void setRadius(int radius)

setRadius

public void setRadius(java.lang.Integer radius)

setScaleImage

public void setScaleImage(byte scaleImage)

setScaleImage

public void setScaleImage(java.lang.Byte scaleImage)

setHorizontalAlignment

public void setHorizontalAlignment(byte horizontalAlignment)

setHorizontalAlignment

public void setHorizontalAlignment(java.lang.Byte horizontalAlignment)

setVerticalAlignment

public void setVerticalAlignment(byte verticalAlignment)

setVerticalAlignment

public void setVerticalAlignment(java.lang.Byte verticalAlignment)

setBorder

public void setBorder(byte border)

setBorder

public void setBorder(java.lang.Byte border)

setBorderColor

public void setBorderColor(java.awt.Color borderColor)

setPadding

public void setPadding(int padding)

setPadding

public void setPadding(java.lang.Integer padding)

setTopBorder

public void setTopBorder(byte topBorder)

setTopBorder

public void setTopBorder(java.lang.Byte topBorder)

setTopBorderColor

public void setTopBorderColor(java.awt.Color topBorderColor)

setTopPadding

public void setTopPadding(int topPadding)

setTopPadding

public void setTopPadding(java.lang.Integer topPadding)

setLeftBorder

public void setLeftBorder(byte leftBorder)

setLeftBorder

public void setLeftBorder(java.lang.Byte leftBorder)

setLeftBorderColor

public void setLeftBorderColor(java.awt.Color leftBorderColor)

setLeftPadding

public void setLeftPadding(int leftPadding)

setLeftPadding

public void setLeftPadding(java.lang.Integer leftPadding)

setBottomBorder

public void setBottomBorder(byte bottomBorder)

setBottomBorder

public void setBottomBorder(java.lang.Byte bottomBorder)

setBottomBorderColor

public void setBottomBorderColor(java.awt.Color bottomBorderColor)

setBottomPadding

public void setBottomPadding(int bottomPadding)

setBottomPadding

public void setBottomPadding(java.lang.Integer bottomPadding)

setRightBorder

public void setRightBorder(byte rightBorder)

setRightBorder

public void setRightBorder(java.lang.Byte rightBorder)

setRightBorderColor

public void setRightBorderColor(java.awt.Color rightBorderColor)

setRightPadding

public void setRightPadding(int rightPadding)

setRightPadding

public void setRightPadding(java.lang.Integer rightPadding)

setRotation

public void setRotation(byte rotation)

setRotation

public void setRotation(java.lang.Byte rotation)

setFontName

public void setFontName(java.lang.String fontName)

setBold

public void setBold(boolean bold)

setBold

public void setBold(java.lang.Boolean bold)

setItalic

public void setItalic(boolean italic)

setItalic

public void setItalic(java.lang.Boolean italic)

setPdfEmbedded

public void setPdfEmbedded(boolean pdfEmbedded)

setPdfEmbedded

public void setPdfEmbedded(java.lang.Boolean pdfEmbedded)

setStrikeThrough

public void setStrikeThrough(boolean strikeThrough)

setStrikeThrough

public void setStrikeThrough(java.lang.Boolean strikeThrough)

setStyledText

public void setStyledText(boolean styledText)

setStyledText

public void setStyledText(java.lang.Boolean styledText)

setUnderline

public void setUnderline(boolean underline)

setUnderline

public void setUnderline(java.lang.Boolean underline)

setLineSpacing

public void setLineSpacing(byte lineSpacing)

setLineSpacing

public void setLineSpacing(java.lang.Byte lineSpacing)

setPattern

public void setPattern(java.lang.String pattern)

setBlankWhenNull

public void setBlankWhenNull(boolean isBlankWhenNull)

setBlankWhenNull

public void setBlankWhenNull(java.lang.Boolean isBlankWhenNull)

setPdfEncoding

public void setPdfEncoding(java.lang.String pdfEncoding)

setPdfFontName

public void setPdfFontName(java.lang.String pdfFontName)

setFontSize

public void setFontSize(int fontSize)

setFontSize

public void setFontSize(java.lang.Integer fontSize)


© 2001-2005 JasperSoft Corporation www.jaspersoft.com