net.sf.jasperreports.engine.fill
Class JRTemplateImage

java.lang.Object
  extended by net.sf.jasperreports.engine.fill.JRTemplateElement
      extended by net.sf.jasperreports.engine.fill.JRTemplateGraphicElement
          extended by net.sf.jasperreports.engine.fill.JRTemplateImage
All Implemented Interfaces:
java.io.Serializable, JRAlignment, JRBox, JRBoxContainer, JRCommonElement, JRCommonGraphicElement, JRCommonImage, JRPenContainer, JRStyleContainer

public class JRTemplateImage
extends JRTemplateGraphicElement
implements JRAlignment, JRBox, JRCommonImage

Version:
$Id: JRTemplateImage.java 2009 2007-12-06 15:43:52Z teodord $
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
protected  boolean isLazy
           
 
Fields inherited from class net.sf.jasperreports.engine.fill.JRTemplateGraphicElement
linePen
 
Fields inherited from class net.sf.jasperreports.engine.fill.JRTemplateElement
defaultStyleProvider, origin, parentStyle
 
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
protected JRTemplateImage(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider, JRChart chart)
           
protected JRTemplateImage(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider, JRImage image)
           
 
Method Summary
 byte getBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getBorderColor()
          Deprecated. Replaced by getBox()
 byte getBottomBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getBottomBorderColor()
          Deprecated. Replaced by getBox()
 int getBottomPadding()
          Deprecated. Replaced by getBox()
 JRBox getBox()
          Deprecated. Replaced by getLineBox()
 java.lang.Float getDefaultLineWidth()
           
 byte getHorizontalAlignment()
          Gets the text horizontal alignment.
 byte getHyperlinkTarget()
           
 byte getHyperlinkType()
          Retrieves the hyperlink type for the element.
 byte getLeftBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getLeftBorderColor()
          Deprecated. Replaced by getBox()
 int getLeftPadding()
          Deprecated. Replaced by getBox()
 JRLineBox getLineBox()
           
 java.lang.String getLinkType()
          Returns the hyperlink type.
 byte getMode()
          Returns the element transparency mode.
 byte getOnErrorType()
           
 java.lang.Byte getOwnBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Byte getOwnBottomBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnBottomBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Integer getOwnBottomPadding()
          Deprecated. Replaced by getBox()
 java.lang.Byte getOwnHorizontalAlignment()
           
 java.lang.Byte getOwnLeftBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnLeftBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Integer getOwnLeftPadding()
          Deprecated. Replaced by getBox()
 java.lang.Integer getOwnPadding()
          Deprecated. Replaced by getBox()
 java.lang.Byte getOwnRightBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnRightBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Integer getOwnRightPadding()
          Deprecated. Replaced by getBox()
 java.lang.Byte getOwnScaleImage()
           
 java.lang.Byte getOwnTopBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnTopBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Integer getOwnTopPadding()
          Deprecated. Replaced by getBox()
 java.lang.Byte getOwnVerticalAlignment()
           
 int getPadding()
          Deprecated. Replaced by getBox()
 byte getRightBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getRightBorderColor()
          Deprecated. Replaced by getBox()
 int getRightPadding()
          Deprecated. Replaced by getBox()
 byte getScaleImage()
          Gets the image scale type.
 byte getTopBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getTopBorderColor()
          Deprecated. Replaced by getBox()
 int getTopPadding()
          Deprecated. Replaced by getBox()
 byte getVerticalAlignment()
          Gets the text vertical alignment.
 boolean isLazy()
           
 boolean isUsingCache()
           
protected  void normalizeLinkType()
           
 void setBorder(byte border)
          Deprecated. Replaced by getBox()
 void setBorder(java.lang.Byte border)
          Deprecated. Replaced by getBox()
 void setBorderColor(java.awt.Color borderColor)
          Deprecated. Replaced by getBox()
 void setBottomBorder(byte bottomBorder)
          Deprecated. Replaced by getBox()
 void setBottomBorder(java.lang.Byte bottomBorder)
          Deprecated. Replaced by getBox()
 void setBottomBorderColor(java.awt.Color bottomBorderColor)
          Deprecated. Replaced by getBox()
 void setBottomPadding(int bottomPadding)
          Deprecated. Replaced by getBox()
 void setBottomPadding(java.lang.Integer bottomPadding)
          Deprecated. Replaced by getBox()
 void setBox(JRBox box)
          Deprecated. Replaced by getLineBox()
protected  void setChart(JRChart chart)
           
 void setHorizontalAlignment(byte horizontalAlignment)
          Sets the text horizontal alignment.
 void setHorizontalAlignment(java.lang.Byte horizontalAlignment)
           
protected  void setHyperlinkTarget(byte hyperlinkTarget)
           
protected  void setHyperlinkType(byte hyperlinkType)
          Sets the link type as a built-in hyperlink type.
protected  void setImage(JRImage image)
           
 void setLazy(boolean isLazy)
           
 void setLeftBorder(byte leftBorder)
          Deprecated. Replaced by getBox()
 void setLeftBorder(java.lang.Byte leftBorder)
          Deprecated. Replaced by getBox()
 void setLeftBorderColor(java.awt.Color leftBorderColor)
          Deprecated. Replaced by getBox()
 void setLeftPadding(int leftPadding)
          Deprecated. Replaced by getBox()
 void setLeftPadding(java.lang.Integer leftPadding)
          Deprecated. Replaced by getBox()
 void setLinkType(java.lang.String linkType)
          Sets the hyperlink type.
 void setOnErrorType(byte onErrorType)
           
 void setPadding(int padding)
          Deprecated. Replaced by getBox()
 void setPadding(java.lang.Integer padding)
          Deprecated. Replaced by getBox()
 void setRightBorder(byte rightBorder)
          Deprecated. Replaced by getBox()
 void setRightBorder(java.lang.Byte rightBorder)
          Deprecated. Replaced by getBox()
 void setRightBorderColor(java.awt.Color rightBorderColor)
          Deprecated. Replaced by getBox()
 void setRightPadding(int rightPadding)
          Deprecated. Replaced by getBox()
 void setRightPadding(java.lang.Integer rightPadding)
          Deprecated. Replaced by getBox()
protected  void setScaleImage(byte scaleImage)
           
protected  void setScaleImage(java.lang.Byte scaleImage)
           
 void setTopBorder(byte topBorder)
          Deprecated. Replaced by getBox()
 void setTopBorder(java.lang.Byte topBorder)
          Deprecated. Replaced by getBox()
 void setTopBorderColor(java.awt.Color topBorderColor)
          Deprecated. Replaced by getBox()
 void setTopPadding(int topPadding)
          Deprecated. Replaced by getBox()
 void setTopPadding(java.lang.Integer topPadding)
          Deprecated. Replaced by getBox()
 void setUsingCache(boolean isUsingCache)
           
 void setVerticalAlignment(byte verticalAlignment)
          Gets the text vertical alignment.
 void setVerticalAlignment(java.lang.Byte verticalAlignment)
           
 
Methods inherited from class net.sf.jasperreports.engine.fill.JRTemplateGraphicElement
getDefaultLineColor, getFill, getLinePen, getOwnFill, getOwnPen, getPen, setFill, setFill, setGraphicElement, setPen, setPen
 
Methods inherited from class net.sf.jasperreports.engine.fill.JRTemplateElement
getBackcolor, getBaseStyle, getDefaultStyleProvider, getForecolor, getId, getKey, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnMode, getStyle, getStyleNameReference, setBackcolor, setElement, setForecolor, setKey, setMode, setMode
 
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.JRCommonGraphicElement
getFill, getLinePen, getOwnFill
 
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode
 
Methods inherited from interface net.sf.jasperreports.engine.JRPenContainer
getDefaultLineColor
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleNameReference
 
Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer
getDefaultLineColor
 

Field Detail

isLazy

protected boolean isLazy
Constructor Detail

JRTemplateImage

protected JRTemplateImage(JROrigin origin,
                          JRDefaultStyleProvider defaultStyleProvider,
                          JRImage image)

JRTemplateImage

protected JRTemplateImage(JROrigin origin,
                          JRDefaultStyleProvider defaultStyleProvider,
                          JRChart chart)
Method Detail

setImage

protected void setImage(JRImage image)

setChart

protected void setChart(JRChart chart)

getBox

public JRBox getBox()
Deprecated. Replaced by getLineBox()


getLineBox

public JRLineBox getLineBox()
Specified by:
getLineBox in interface JRBoxContainer

setBox

public void setBox(JRBox box)
Deprecated. Replaced by getLineBox()


getMode

public byte getMode()
Description copied from interface: JRCommonElement
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.

Specified by:
getMode in interface JRCommonElement
Overrides:
getMode in class JRTemplateElement
Returns:
MODE_OPAQUE or MODE_TRANSPARENT

getScaleImage

public byte getScaleImage()
Description copied from interface: JRCommonImage
Gets the image scale type.

Specified by:
getScaleImage in interface JRCommonImage
Returns:
one of the scale constants in this class

getOwnScaleImage

public java.lang.Byte getOwnScaleImage()
Specified by:
getOwnScaleImage in interface JRCommonImage

setScaleImage

protected void setScaleImage(byte scaleImage)

setScaleImage

protected void setScaleImage(java.lang.Byte scaleImage)

isUsingCache

public boolean isUsingCache()

setUsingCache

public void setUsingCache(boolean isUsingCache)

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

getOwnHorizontalAlignment

public java.lang.Byte getOwnHorizontalAlignment()
Specified by:
getOwnHorizontalAlignment in interface 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

setHorizontalAlignment

public void setHorizontalAlignment(java.lang.Byte horizontalAlignment)
Specified by:
setHorizontalAlignment in interface JRAlignment

getVerticalAlignment

public byte getVerticalAlignment()
Description copied from interface: JRAlignment
Gets the text vertical alignment.

Specified by:
getVerticalAlignment in interface JRAlignment
Returns:
a value representing one of the vertical alignment constants in JRAlignment

getOwnVerticalAlignment

public java.lang.Byte getOwnVerticalAlignment()
Specified by:
getOwnVerticalAlignment in interface JRAlignment

setVerticalAlignment

public void setVerticalAlignment(byte verticalAlignment)
Description copied from interface: JRAlignment
Gets the text vertical alignment.

Specified by:
setVerticalAlignment in interface JRAlignment
Parameters:
verticalAlignment - a value representing one of the vertical alignment constants in JRAlignment

setVerticalAlignment

public void setVerticalAlignment(java.lang.Byte verticalAlignment)
Specified by:
setVerticalAlignment in interface JRAlignment

isLazy

public boolean isLazy()

setLazy

public void setLazy(boolean isLazy)

getOnErrorType

public byte getOnErrorType()

setOnErrorType

public void setOnErrorType(byte onErrorType)

getHyperlinkType

public byte getHyperlinkType()
Retrieves the hyperlink type for the element.

The actual hyperlink type is determined by getLinkType(). This method can is used to determine whether the hyperlink type is one of the built-in types or a custom type. When hyperlink is of custom type, HYPERLINK_TYPE_CUSTOM is returned.

Returns:
one of the hyperlink type constants
See Also:
getLinkType()

setHyperlinkType

protected void setHyperlinkType(byte hyperlinkType)
Sets the link type as a built-in hyperlink type.

Parameters:
hyperlinkType - the built-in hyperlink type
See Also:
getLinkType()

getHyperlinkTarget

public byte getHyperlinkTarget()

setHyperlinkTarget

protected void setHyperlinkTarget(byte hyperlinkTarget)

getLinkType

public java.lang.String getLinkType()
Returns the hyperlink type.

The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.

Returns:
the hyperlink type

setLinkType

public void setLinkType(java.lang.String linkType)
Sets the hyperlink type.

The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.

Parameters:
linkType - the hyperlink type

normalizeLinkType

protected void normalizeLinkType()

getDefaultLineWidth

public java.lang.Float getDefaultLineWidth()
Specified by:
getDefaultLineWidth in interface JRPenContainer
Overrides:
getDefaultLineWidth in class JRTemplateGraphicElement

getBorder

public byte getBorder()
Deprecated. Replaced by getBox()

Specified by:
getBorder in interface JRBox

getOwnBorder

public java.lang.Byte getOwnBorder()
Deprecated. Replaced by getBox()

Specified by:
getOwnBorder in interface JRBox

setBorder

public void setBorder(byte border)
Deprecated. Replaced by getBox()

Specified by:
setBorder in interface JRBox

setBorder

public void setBorder(java.lang.Byte border)
Deprecated. Replaced by getBox()

Specified by:
setBorder in interface JRBox

getBorderColor

public java.awt.Color getBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getBorderColor in interface JRBox

getOwnBorderColor

public java.awt.Color getOwnBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getOwnBorderColor in interface JRBox

setBorderColor

public void setBorderColor(java.awt.Color borderColor)
Deprecated. Replaced by getBox()

Specified by:
setBorderColor in interface JRBox

getPadding

public int getPadding()
Deprecated. Replaced by getBox()

Specified by:
getPadding in interface JRBox

getOwnPadding

public java.lang.Integer getOwnPadding()
Deprecated. Replaced by getBox()

Specified by:
getOwnPadding in interface JRBox

setPadding

public void setPadding(int padding)
Deprecated. Replaced by getBox()

Specified by:
setPadding in interface JRBox

setPadding

public void setPadding(java.lang.Integer padding)
Deprecated. Replaced by getBox()

Specified by:
setPadding in interface JRBox

getTopBorder

public byte getTopBorder()
Deprecated. Replaced by getBox()

Specified by:
getTopBorder in interface JRBox

getOwnTopBorder

public java.lang.Byte getOwnTopBorder()
Deprecated. Replaced by getBox()

Specified by:
getOwnTopBorder in interface JRBox

setTopBorder

public void setTopBorder(byte topBorder)
Deprecated. Replaced by getBox()

Specified by:
setTopBorder in interface JRBox

setTopBorder

public void setTopBorder(java.lang.Byte topBorder)
Deprecated. Replaced by getBox()

Specified by:
setTopBorder in interface JRBox

getTopBorderColor

public java.awt.Color getTopBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getTopBorderColor in interface JRBox

getOwnTopBorderColor

public java.awt.Color getOwnTopBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getOwnTopBorderColor in interface JRBox

setTopBorderColor

public void setTopBorderColor(java.awt.Color topBorderColor)
Deprecated. Replaced by getBox()

Specified by:
setTopBorderColor in interface JRBox

getTopPadding

public int getTopPadding()
Deprecated. Replaced by getBox()

Specified by:
getTopPadding in interface JRBox

getOwnTopPadding

public java.lang.Integer getOwnTopPadding()
Deprecated. Replaced by getBox()

Specified by:
getOwnTopPadding in interface JRBox

setTopPadding

public void setTopPadding(int topPadding)
Deprecated. Replaced by getBox()

Specified by:
setTopPadding in interface JRBox

setTopPadding

public void setTopPadding(java.lang.Integer topPadding)
Deprecated. Replaced by getBox()

Specified by:
setTopPadding in interface JRBox

getLeftBorder

public byte getLeftBorder()
Deprecated. Replaced by getBox()

Specified by:
getLeftBorder in interface JRBox

getOwnLeftBorder

public java.lang.Byte getOwnLeftBorder()
Deprecated. Replaced by getBox()

Specified by:
getOwnLeftBorder in interface JRBox

setLeftBorder

public void setLeftBorder(byte leftBorder)
Deprecated. Replaced by getBox()

Specified by:
setLeftBorder in interface JRBox

setLeftBorder

public void setLeftBorder(java.lang.Byte leftBorder)
Deprecated. Replaced by getBox()

Specified by:
setLeftBorder in interface JRBox

getLeftBorderColor

public java.awt.Color getLeftBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getLeftBorderColor in interface JRBox

getOwnLeftBorderColor

public java.awt.Color getOwnLeftBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getOwnLeftBorderColor in interface JRBox

setLeftBorderColor

public void setLeftBorderColor(java.awt.Color leftBorderColor)
Deprecated. Replaced by getBox()

Specified by:
setLeftBorderColor in interface JRBox

getLeftPadding

public int getLeftPadding()
Deprecated. Replaced by getBox()

Specified by:
getLeftPadding in interface JRBox

getOwnLeftPadding

public java.lang.Integer getOwnLeftPadding()
Deprecated. Replaced by getBox()

Specified by:
getOwnLeftPadding in interface JRBox

setLeftPadding

public void setLeftPadding(int leftPadding)
Deprecated. Replaced by getBox()

Specified by:
setLeftPadding in interface JRBox

setLeftPadding

public void setLeftPadding(java.lang.Integer leftPadding)
Deprecated. Replaced by getBox()

Specified by:
setLeftPadding in interface JRBox

getBottomBorder

public byte getBottomBorder()
Deprecated. Replaced by getBox()

Specified by:
getBottomBorder in interface JRBox

getOwnBottomBorder

public java.lang.Byte getOwnBottomBorder()
Deprecated. Replaced by getBox()

Specified by:
getOwnBottomBorder in interface JRBox

setBottomBorder

public void setBottomBorder(byte bottomBorder)
Deprecated. Replaced by getBox()

Specified by:
setBottomBorder in interface JRBox

setBottomBorder

public void setBottomBorder(java.lang.Byte bottomBorder)
Deprecated. Replaced by getBox()

Specified by:
setBottomBorder in interface JRBox

getBottomBorderColor

public java.awt.Color getBottomBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getBottomBorderColor in interface JRBox

getOwnBottomBorderColor

public java.awt.Color getOwnBottomBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getOwnBottomBorderColor in interface JRBox

setBottomBorderColor

public void setBottomBorderColor(java.awt.Color bottomBorderColor)
Deprecated. Replaced by getBox()

Specified by:
setBottomBorderColor in interface JRBox

getBottomPadding

public int getBottomPadding()
Deprecated. Replaced by getBox()

Specified by:
getBottomPadding in interface JRBox

getOwnBottomPadding

public java.lang.Integer getOwnBottomPadding()
Deprecated. Replaced by getBox()

Specified by:
getOwnBottomPadding in interface JRBox

setBottomPadding

public void setBottomPadding(int bottomPadding)
Deprecated. Replaced by getBox()

Specified by:
setBottomPadding in interface JRBox

setBottomPadding

public void setBottomPadding(java.lang.Integer bottomPadding)
Deprecated. Replaced by getBox()

Specified by:
setBottomPadding in interface JRBox

getRightBorder

public byte getRightBorder()
Deprecated. Replaced by getBox()

Specified by:
getRightBorder in interface JRBox

getOwnRightBorder

public java.lang.Byte getOwnRightBorder()
Deprecated. Replaced by getBox()

Specified by:
getOwnRightBorder in interface JRBox

setRightBorder

public void setRightBorder(byte rightBorder)
Deprecated. Replaced by getBox()

Specified by:
setRightBorder in interface JRBox

setRightBorder

public void setRightBorder(java.lang.Byte rightBorder)
Deprecated. Replaced by getBox()

Specified by:
setRightBorder in interface JRBox

getRightBorderColor

public java.awt.Color getRightBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getRightBorderColor in interface JRBox

getOwnRightBorderColor

public java.awt.Color getOwnRightBorderColor()
Deprecated. Replaced by getBox()

Specified by:
getOwnRightBorderColor in interface JRBox

setRightBorderColor

public void setRightBorderColor(java.awt.Color rightBorderColor)
Deprecated. Replaced by getBox()

Specified by:
setRightBorderColor in interface JRBox

getRightPadding

public int getRightPadding()
Deprecated. Replaced by getBox()

Specified by:
getRightPadding in interface JRBox

getOwnRightPadding

public java.lang.Integer getOwnRightPadding()
Deprecated. Replaced by getBox()

Specified by:
getOwnRightPadding in interface JRBox

setRightPadding

public void setRightPadding(int rightPadding)
Deprecated. Replaced by getBox()

Specified by:
setRightPadding in interface JRBox

setRightPadding

public void setRightPadding(java.lang.Integer rightPadding)
Deprecated. Replaced by getBox()

Specified by:
setRightPadding in interface JRBox


© 2001-2006 JasperSoft Corporation www.jaspersoft.com