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, JRStyleContainer

public class JRTemplateImage
extends JRTemplateGraphicElement
implements JRAlignment, JRBox

Version:
$Id: JRTemplateImage.java 1355 2006-08-04 17:31:54 +0300 (Fri, 04 Aug 2006) lucianc $
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
protected  java.lang.Byte border
           
protected  java.awt.Color borderColor
           
protected  java.lang.Byte bottomBorder
           
protected  java.awt.Color bottomBorderColor
           
protected  java.lang.Integer bottomPadding
           
protected  boolean isLazy
           
protected  java.lang.Byte leftBorder
           
protected  java.awt.Color leftBorderColor
           
protected  java.lang.Integer leftPadding
           
protected  java.lang.Integer padding
           
protected  java.lang.Byte rightBorder
           
protected  java.awt.Color rightBorderColor
           
protected  java.lang.Integer rightPadding
           
protected  java.lang.Byte topBorder
           
protected  java.awt.Color topBorderColor
           
protected  java.lang.Integer topPadding
           
 
Fields inherited from class net.sf.jasperreports.engine.fill.JRTemplateElement
defaultStyleProvider, 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(JRDefaultStyleProvider defaultStyleProvider, JRChart chart)
           
protected JRTemplateImage(JRDefaultStyleProvider defaultStyleProvider, JRImage image)
           
 
Method Summary
 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).
 byte getBottomBorder()
           
 java.awt.Color getBottomBorderColor()
           
 int getBottomPadding()
           
 JRBox getBox()
          Deprecated.  
 byte getHorizontalAlignment()
          Gets the text horizontal alignment.
 byte getHyperlinkTarget()
           
 byte getHyperlinkType()
          Retrieves the hyperlink type for the element.
 byte getLeftBorder()
           
 java.awt.Color getLeftBorderColor()
           
 int getLeftPadding()
           
 java.lang.String getLinkType()
          Returns the hyperlink type.
 byte getMode()
           
 byte getOnErrorType()
           
 java.lang.Byte getOwnBorder()
           
 java.awt.Color getOwnBorderColor()
           
 java.lang.Byte getOwnBottomBorder()
           
 java.awt.Color getOwnBottomBorderColor()
           
 java.lang.Integer getOwnBottomPadding()
           
 java.lang.Byte getOwnHorizontalAlignment()
           
 java.lang.Byte getOwnLeftBorder()
           
 java.awt.Color getOwnLeftBorderColor()
           
 java.lang.Integer getOwnLeftPadding()
           
 java.lang.Integer getOwnPadding()
           
 java.lang.Byte getOwnRightBorder()
           
 java.awt.Color getOwnRightBorderColor()
           
 java.lang.Integer getOwnRightPadding()
           
 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()
           
 int getPadding()
          Gets the default padding in pixels (can be overwritten by individual settings).
 byte getPen()
           
 byte getRightBorder()
           
 java.awt.Color getRightBorderColor()
           
 int getRightPadding()
           
 byte getScaleImage()
           
 byte getTopBorder()
          Gets the top border pen size.
 java.awt.Color getTopBorderColor()
          Gets the top border color.
 int getTopPadding()
           
 byte getVerticalAlignment()
          Gets the text vertical alignment.
 boolean isLazy()
           
protected  void normalizeLinkType()
           
 void setBorder(byte border)
          Sets the default border pen size (can be overwritten by individual settings).
 void setBorder(java.lang.Byte border)
           
 void setBorderColor(java.awt.Color borderColor)
          Sets the default border color (can be overwritten by individual settings).
 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)
           
protected  void setBox(JRBox box)
           
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)
           
 void setLeftBorder(java.lang.Byte leftBorder)
           
 void setLeftBorderColor(java.awt.Color leftBorderColor)
           
 void setLeftPadding(int leftPadding)
           
 void setLeftPadding(java.lang.Integer leftPadding)
           
 void setLinkType(java.lang.String linkType)
          Sets the hyperlink type.
 void setOnErrorType(byte onErrorType)
           
 void setPadding(int padding)
          Sets the default padding in pixels (can be overwritten by individual settings).
 void setPadding(java.lang.Integer padding)
           
 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)
           
protected  void setScaleImage(byte scaleImage)
           
protected  void setScaleImage(java.lang.Byte scaleImage)
           
 void setTopBorder(byte topBorder)
          Sets the top border pen size.
 void setTopBorder(java.lang.Byte topBorder)
           
 void setTopBorderColor(java.awt.Color topBorderColor)
          Sets the top border color.
 void setTopPadding(int topPadding)
           
 void setTopPadding(java.lang.Integer topPadding)
           
 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
getFill, getOwnFill, getOwnPen, setFill, setFill, setGraphicElement, setPen, setPen
 
Methods inherited from class net.sf.jasperreports.engine.fill.JRTemplateElement
getBackcolor, getBaseStyle, getDefaultStyleProvider, getForecolor, getId, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getStyle, 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.JRStyleContainer
getDefaultStyleProvider, getStyle
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle
 

Field Detail

isLazy

protected boolean isLazy

border

protected java.lang.Byte border

topBorder

protected java.lang.Byte topBorder

leftBorder

protected java.lang.Byte leftBorder

bottomBorder

protected java.lang.Byte bottomBorder

rightBorder

protected java.lang.Byte rightBorder

borderColor

protected java.awt.Color borderColor

topBorderColor

protected java.awt.Color topBorderColor

leftBorderColor

protected java.awt.Color leftBorderColor

bottomBorderColor

protected java.awt.Color bottomBorderColor

rightBorderColor

protected java.awt.Color rightBorderColor

padding

protected java.lang.Integer padding

topPadding

protected java.lang.Integer topPadding

leftPadding

protected java.lang.Integer leftPadding

bottomPadding

protected java.lang.Integer bottomPadding

rightPadding

protected java.lang.Integer rightPadding
Constructor Detail

JRTemplateImage

protected JRTemplateImage(JRDefaultStyleProvider defaultStyleProvider,
                          JRImage image)

JRTemplateImage

protected JRTemplateImage(JRDefaultStyleProvider defaultStyleProvider,
                          JRChart chart)
Method Detail

setBox

protected void setBox(JRBox box)

setImage

protected void setImage(JRImage image)

setChart

protected void setChart(JRChart chart)

getMode

public byte getMode()
Overrides:
getMode in class JRTemplateElement

getPen

public byte getPen()
Overrides:
getPen in class JRTemplateGraphicElement

getScaleImage

public byte getScaleImage()

getOwnScaleImage

public java.lang.Byte getOwnScaleImage()

setScaleImage

protected void setScaleImage(byte scaleImage)

setScaleImage

protected void setScaleImage(java.lang.Byte scaleImage)

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)

getBox

public JRBox getBox()
Deprecated. 


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)

getBorder

public byte getBorder()
Description copied from interface: JRBox
Gets the default border pen size (can be overwritten by individual settings).

Specified by:
getBorder in interface JRBox

getOwnBorder

public java.lang.Byte getOwnBorder()
Specified by:
getOwnBorder in interface JRBox

setBorder

public void setBorder(byte border)
Description copied from interface: JRBox
Sets the default border pen size (can be overwritten by individual settings).

Specified by:
setBorder in interface JRBox

getBorderColor

public java.awt.Color getBorderColor()
Description copied from interface: JRBox
Gets the default border color (can be overwritten by individual settings).

Specified by:
getBorderColor in interface JRBox

getOwnBorderColor

public java.awt.Color getOwnBorderColor()
Specified by:
getOwnBorderColor in interface JRBox

setBorderColor

public void setBorderColor(java.awt.Color borderColor)
Description copied from interface: JRBox
Sets the default border color (can be overwritten by individual settings).

Specified by:
setBorderColor in interface JRBox

getPadding

public int getPadding()
Description copied from interface: JRBox
Gets the default padding in pixels (can be overwritten by individual settings).

Specified by:
getPadding in interface JRBox

getOwnPadding

public java.lang.Integer getOwnPadding()
Specified by:
getOwnPadding in interface JRBox

setPadding

public void setPadding(int padding)
Description copied from interface: JRBox
Sets the default padding in pixels (can be overwritten by individual settings).

Specified by:
setPadding in interface JRBox

getTopBorder

public byte getTopBorder()
Description copied from interface: JRBox
Gets the top border pen size.

Specified by:
getTopBorder in interface JRBox

getOwnTopBorder

public java.lang.Byte getOwnTopBorder()
Description copied from interface: JRBox
Gets the top border pen size (if the default value was overwritten).

Specified by:
getOwnTopBorder in interface JRBox

setTopBorder

public void setTopBorder(byte topBorder)
Description copied from interface: JRBox
Sets the top border pen size.

Specified by:
setTopBorder in interface JRBox

getTopBorderColor

public java.awt.Color getTopBorderColor()
Description copied from interface: JRBox
Gets the top border color.

Specified by:
getTopBorderColor in interface JRBox

getOwnTopBorderColor

public java.awt.Color getOwnTopBorderColor()
Description copied from interface: JRBox
Gets the top border color (if the default value was overwritten).

Specified by:
getOwnTopBorderColor in interface JRBox

setTopBorderColor

public void setTopBorderColor(java.awt.Color topBorderColor)
Description copied from interface: JRBox
Sets the top border color.

Specified by:
setTopBorderColor in interface JRBox

getTopPadding

public int getTopPadding()
Specified by:
getTopPadding in interface JRBox

getOwnTopPadding

public java.lang.Integer getOwnTopPadding()
Specified by:
getOwnTopPadding in interface JRBox

setTopPadding

public void setTopPadding(int topPadding)
Specified by:
setTopPadding in interface JRBox

getLeftBorder

public byte getLeftBorder()
Specified by:
getLeftBorder in interface JRBox

getOwnLeftBorder

public java.lang.Byte getOwnLeftBorder()
Specified by:
getOwnLeftBorder in interface JRBox

setLeftBorder

public void setLeftBorder(byte leftBorder)
Specified by:
setLeftBorder in interface JRBox

getLeftBorderColor

public java.awt.Color getLeftBorderColor()
Specified by:
getLeftBorderColor in interface JRBox

getOwnLeftBorderColor

public java.awt.Color getOwnLeftBorderColor()
Specified by:
getOwnLeftBorderColor in interface JRBox

setLeftBorderColor

public void setLeftBorderColor(java.awt.Color leftBorderColor)
Specified by:
setLeftBorderColor in interface JRBox

getLeftPadding

public int getLeftPadding()
Specified by:
getLeftPadding in interface JRBox

getOwnLeftPadding

public java.lang.Integer getOwnLeftPadding()
Specified by:
getOwnLeftPadding in interface JRBox

setLeftPadding

public void setLeftPadding(int leftPadding)
Specified by:
setLeftPadding in interface JRBox

getBottomBorder

public byte getBottomBorder()
Specified by:
getBottomBorder in interface JRBox

getOwnBottomBorder

public java.lang.Byte getOwnBottomBorder()
Specified by:
getOwnBottomBorder in interface JRBox

setBottomBorder

public void setBottomBorder(byte bottomBorder)
Specified by:
setBottomBorder in interface JRBox

getBottomBorderColor

public java.awt.Color getBottomBorderColor()
Specified by:
getBottomBorderColor in interface JRBox

getOwnBottomBorderColor

public java.awt.Color getOwnBottomBorderColor()
Specified by:
getOwnBottomBorderColor in interface JRBox

setBottomBorderColor

public void setBottomBorderColor(java.awt.Color bottomBorderColor)
Specified by:
setBottomBorderColor in interface JRBox

getBottomPadding

public int getBottomPadding()
Specified by:
getBottomPadding in interface JRBox

getOwnBottomPadding

public java.lang.Integer getOwnBottomPadding()
Specified by:
getOwnBottomPadding in interface JRBox

setBottomPadding

public void setBottomPadding(int bottomPadding)
Specified by:
setBottomPadding in interface JRBox

getRightBorder

public byte getRightBorder()
Specified by:
getRightBorder in interface JRBox

getOwnRightBorder

public java.lang.Byte getOwnRightBorder()
Specified by:
getOwnRightBorder in interface JRBox

setRightBorder

public void setRightBorder(byte rightBorder)
Specified by:
setRightBorder in interface JRBox

getRightBorderColor

public java.awt.Color getRightBorderColor()
Specified by:
getRightBorderColor in interface JRBox

getOwnRightBorderColor

public java.awt.Color getOwnRightBorderColor()
Specified by:
getOwnRightBorderColor in interface JRBox

setRightBorderColor

public void setRightBorderColor(java.awt.Color rightBorderColor)
Specified by:
setRightBorderColor in interface JRBox

getRightPadding

public int getRightPadding()
Specified by:
getRightPadding in interface JRBox

getOwnRightPadding

public java.lang.Integer getOwnRightPadding()
Specified by:
getOwnRightPadding in interface JRBox

setRightPadding

public void setRightPadding(int rightPadding)
Specified by:
setRightPadding in interface JRBox

setBorder

public void setBorder(java.lang.Byte border)
Specified by:
setBorder in interface JRBox

setPadding

public void setPadding(java.lang.Integer padding)
Specified by:
setPadding in interface JRBox

setTopBorder

public void setTopBorder(java.lang.Byte topBorder)
Specified by:
setTopBorder in interface JRBox

setTopPadding

public void setTopPadding(java.lang.Integer topPadding)
Specified by:
setTopPadding in interface JRBox

setLeftBorder

public void setLeftBorder(java.lang.Byte leftBorder)
Specified by:
setLeftBorder in interface JRBox

setLeftPadding

public void setLeftPadding(java.lang.Integer leftPadding)
Specified by:
setLeftPadding in interface JRBox

setBottomBorder

public void setBottomBorder(java.lang.Byte bottomBorder)
Specified by:
setBottomBorder in interface JRBox

setBottomPadding

public void setBottomPadding(java.lang.Integer bottomPadding)
Specified by:
setBottomPadding in interface JRBox

setRightBorder

public void setRightBorder(java.lang.Byte rightBorder)
Specified by:
setRightBorder in interface JRBox

setRightPadding

public void setRightPadding(java.lang.Integer rightPadding)
Specified by:
setRightPadding in interface JRBox

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


© 2001-2006 JasperSoft Corporation www.jaspersoft.com