net.sf.jasperreports.engine.base
Class JRBaseImage

java.lang.Object
  extended by net.sf.jasperreports.engine.base.JRBaseElement
      extended by net.sf.jasperreports.engine.base.JRBaseGraphicElement
          extended by net.sf.jasperreports.engine.base.JRBaseImage
All Implemented Interfaces:
java.io.Serializable, JRAlignment, JRAnchor, JRBox, JRChild, JRElement, JRGraphicElement, JRHyperlink, JRImage, JRStyleContainer

public class JRBaseImage
extends JRBaseGraphicElement
implements JRImage

The actual implementation of a graphic element representing an image.

Version:
$Id: JRBaseImage.java 1364 2006-08-31 18:13:20 +0300 (Thu, 31 Aug 2006) lucianc $
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
protected  JRExpression anchorNameExpression
           
protected  int bookmarkLevel
          The bookmark level for the anchor associated with this image.
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  JRGroup evaluationGroup
           
protected  byte evaluationTime
           
protected  JRExpression expression
           
protected  java.lang.Byte horizontalAlignment
           
protected  JRExpression hyperlinkAnchorExpression
           
protected  JRExpression hyperlinkPageExpression
           
protected  JRExpression hyperlinkReferenceExpression
           
protected  byte hyperlinkTarget
           
protected  byte hyperlinkType
           
protected  boolean isLazy
           
protected  java.lang.Boolean isUsingCache
           
protected  java.lang.Byte leftBorder
           
protected  java.awt.Color leftBorderColor
           
protected  java.lang.Integer leftPadding
           
protected  java.lang.String linkType
           
protected  byte onErrorType
           
protected  java.lang.Integer padding
           
protected  java.lang.Byte rightBorder
           
protected  java.awt.Color rightBorderColor
           
protected  java.lang.Integer rightPadding
           
protected  java.lang.Byte scaleImage
           
protected  java.lang.Byte topBorder
           
protected  java.awt.Color topBorderColor
           
protected  java.lang.Integer topPadding
           
protected  java.lang.Byte verticalAlignment
           
 
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseGraphicElement
fill, pen
 
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement
backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, parentStyle, positionType, printWhenExpression, printWhenGroupChanges, stretchType, width, x, y
 
Fields inherited from interface net.sf.jasperreports.engine.JRImage
ON_ERROR_TYPE_BLANK, ON_ERROR_TYPE_ERROR, ON_ERROR_TYPE_ICON, SCALE_IMAGE_CLIP, SCALE_IMAGE_FILL_FRAME, SCALE_IMAGE_RETAIN_SHAPE
 
Fields inherited from interface net.sf.jasperreports.engine.JRGraphicElement
FILL_SOLID, PEN_1_POINT, PEN_2_POINT, PEN_4_POINT, PEN_DOTTED, PEN_NONE, PEN_THIN
 
Fields inherited from interface net.sf.jasperreports.engine.JRElement
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
 
Fields inherited from interface net.sf.jasperreports.engine.JRAnchor
NO_BOOKMARK
 
Fields inherited from interface net.sf.jasperreports.engine.JRHyperlink
HYPERLINK_TARGET_BLANK, HYPERLINK_TARGET_SELF, HYPERLINK_TYPE_CUSTOM, HYPERLINK_TYPE_LOCAL_ANCHOR, HYPERLINK_TYPE_LOCAL_PAGE, HYPERLINK_TYPE_NONE, HYPERLINK_TYPE_NULL, HYPERLINK_TYPE_REFERENCE, HYPERLINK_TYPE_REMOTE_ANCHOR, HYPERLINK_TYPE_REMOTE_PAGE
 
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 JRBaseImage(JRImage image, JRBaseObjectFactory factory)
          protected JRBaseImage() { super(); } /** Initializes properties that are specific to images.
 
Method Summary
 void collectExpressions(JRExpressionCollector collector)
           
 JRExpression getAnchorNameExpression()
          Returns an expression whose value represents the anchor name.
 int getBookmarkLevel()
          Returns the level of the bookmark corresponding to the anchor.
 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.  
 JRChild getCopy(JRAbstractObjectFactory factory)
           
 JRGroup getEvaluationGroup()
          Indicates the evaluation time for this image.
 byte getEvaluationTime()
          Indicates the evaluation time for this image.
 JRExpression getExpression()
          Gets the evaluation group for this text field.
 byte getHorizontalAlignment()
          Gets the text horizontal alignment.
 JRExpression getHyperlinkAnchorExpression()
          Returns the expression whose value represents the anchor.
 JRExpression getHyperlinkPageExpression()
          Returns an integer representing the page index of the link.
 JRHyperlinkParameter[] getHyperlinkParameters()
          Returns the list of hyperlink parameters.
 JRExpression getHyperlinkReferenceExpression()
          Returns the expression whose value represents the hyperlink reference.
 byte getHyperlinkTarget()
          Retrieves the hyperlink target for the element.
 JRExpression getHyperlinkTooltipExpression()
          Returns the expression which will generate the hyperlink tooltip.
 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()
          Returns the element transparency mode.
 byte getOnErrorType()
          Indicates how the engine will treat a missing image.
 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()
          Indicates the pen type used for this element.
 byte getRightBorder()
           
 java.awt.Color getRightBorderColor()
           
 int getRightPadding()
           
 byte getScaleImage()
          Gets the image scale type.
 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()
          Indicates if the images will be loaded lazily or not.
 java.lang.Boolean isOwnUsingCache()
          Indicates if the engine is loading the current image from cache.
 boolean isUsingCache()
          Indicates if the engine is loading the current image from cache.
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)
           
 void setHorizontalAlignment(byte horizontalAlignment)
          Sets the text horizontal alignment.
 void setHorizontalAlignment(java.lang.Byte horizontalAlignment)
           
 void setLazy(boolean isLazy)
          Gives control over when the images are retrieved from their specified location.
 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 setOnErrorType(byte onErrorType)
          Specifies how the engine should treat a missing image.
 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)
           
 void setScaleImage(byte scaleImage)
          Sets the image scale type.
 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 setUsingCache(boolean isUsingCache)
          Specifies if the engine should be loading the current image from cache.
 void setUsingCache(java.lang.Boolean isUsingCache)
          Specifies if the engine should be loading the current image from cache.
 void setVerticalAlignment(byte verticalAlignment)
          Gets the text vertical alignment.
 void setVerticalAlignment(java.lang.Byte verticalAlignment)
           
 void writeXml(JRXmlWriter xmlWriter)
           
 
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseGraphicElement
getFill, getOwnFill, getOwnPen, setFill, setFill, setPen, setPen
 
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement
getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getStyle, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
 
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.JRGraphicElement
getFill, getOwnFill, getOwnPen, setFill, setFill, setPen, setPen
 
Methods inherited from interface net.sf.jasperreports.engine.JRElement
getBackcolor, getElementGroup, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle
 

Field Detail

scaleImage

protected java.lang.Byte scaleImage

horizontalAlignment

protected java.lang.Byte horizontalAlignment

verticalAlignment

protected java.lang.Byte verticalAlignment

isUsingCache

protected java.lang.Boolean isUsingCache

isLazy

protected boolean isLazy

onErrorType

protected byte onErrorType

evaluationTime

protected byte evaluationTime

hyperlinkType

protected byte hyperlinkType

linkType

protected java.lang.String linkType

hyperlinkTarget

protected byte hyperlinkTarget

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

evaluationGroup

protected JRGroup evaluationGroup

expression

protected JRExpression expression

anchorNameExpression

protected JRExpression anchorNameExpression

hyperlinkReferenceExpression

protected JRExpression hyperlinkReferenceExpression

hyperlinkAnchorExpression

protected JRExpression hyperlinkAnchorExpression

hyperlinkPageExpression

protected JRExpression hyperlinkPageExpression

bookmarkLevel

protected int bookmarkLevel
The bookmark level for the anchor associated with this image.

See Also:
JRAnchor.getBookmarkLevel()
Constructor Detail

JRBaseImage

protected JRBaseImage(JRImage image,
                      JRBaseObjectFactory factory)
protected JRBaseImage() { super(); } /** Initializes properties that are specific to images. Common properties are initialized by its parent constructors.

Parameters:
image - an element whose properties are copied to this element. Usually it is a JRDesignImage that must be transformed into an JRBaseImage at compile time.
factory - a factory used in the compile process
Method Detail

getMode

public byte getMode()
Description copied from interface: JRElement
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 JRElement
Overrides:
getMode in class JRBaseElement
Returns:
MODE_OPAQUE or MODE_TRANSPARENT

getPen

public byte getPen()
Description copied from interface: JRGraphicElement
Indicates the pen type used for this element.

Specified by:
getPen in interface JRGraphicElement
Overrides:
getPen in class JRBaseGraphicElement
Returns:
one of the pen constants in this class

getScaleImage

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

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

getOwnScaleImage

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

setScaleImage

public void setScaleImage(byte scaleImage)
Description copied from interface: JRImage
Sets the image scale type.

Specified by:
setScaleImage in interface JRImage
Parameters:
scaleImage - one of the scale constants in this class

setScaleImage

public void setScaleImage(java.lang.Byte scaleImage)
Specified by:
setScaleImage in interface JRImage

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

isUsingCache

public boolean isUsingCache()
Description copied from interface: JRImage
Indicates if the engine is loading the current image from cache. Implementations of this method rely on default values that depend on the type of the image expression if a value was not explicitly set of this flag.

Specified by:
isUsingCache in interface JRImage
Returns:
true if the image should be loaded from cache, false otherwise

isOwnUsingCache

public java.lang.Boolean isOwnUsingCache()
Description copied from interface: JRImage
Indicates if the engine is loading the current image from cache. Implementations of this method return the actual value for the internal flag that was explicitly set on this image element.

Specified by:
isOwnUsingCache in interface JRImage
Returns:
Boolean.TRUE if the image should be loaded from cache, Boolean.FALSE otherwise or null in case the flag was never explicitly set on this image element

setUsingCache

public void setUsingCache(boolean isUsingCache)
Description copied from interface: JRImage
Specifies if the engine should be loading the current image from cache. If set to true, the reporting engine will try to recognize previously loaded images using their specified source. For example, it will recognize an image if the image source is a file name that it has already loaded, or if it is the same URL.

For image elements that have expressions returning java.lang.String objects as the image source, representing file names, URLs or classpath resources, the default value for this flag is true.

Specified by:
setUsingCache in interface JRImage

setUsingCache

public void setUsingCache(java.lang.Boolean isUsingCache)
Description copied from interface: JRImage
Specifies if the engine should be loading the current image from cache. If set to Boolean.TRUE, the reporting engine will try to recognize previously loaded images using their specified source. For example, it will recognize an image if the image source is a file name that it has already loaded, or if it is the same URL.

If set to null, the engine will rely on some default value which depends on the type of the image expression. The cache is turned on by default only for images that have java.lang.String objects in their expressions.

Specified by:
setUsingCache in interface JRImage

isLazy

public boolean isLazy()
Description copied from interface: JRImage
Indicates if the images will be loaded lazily or not.

Specified by:
isLazy in interface JRImage

setLazy

public void setLazy(boolean isLazy)
Description copied from interface: JRImage
Gives control over when the images are retrieved from their specified location. If set to true, the image is loaded from the specified location only when the document is viewed or exported to other formats. Otherwise it is loaded during the report filling process and stored in the resulting document.

Specified by:
setLazy in interface JRImage
Parameters:
isLazy - specifies whether

getOnErrorType

public byte getOnErrorType()
Description copied from interface: JRImage
Indicates how the engine will treat a missing image.

Specified by:
getOnErrorType in interface JRImage
Returns:
one of the constants for missing image error types

setOnErrorType

public void setOnErrorType(byte onErrorType)
Description copied from interface: JRImage
Specifies how the engine should treat a missing image.

Specified by:
setOnErrorType in interface JRImage
Parameters:
onErrorType - one of the constants for missing image error types

getEvaluationTime

public byte getEvaluationTime()
Description copied from interface: JRImage
Indicates the evaluation time for this image.

Specified by:
getEvaluationTime in interface JRImage
Returns:
one of the evaluation time constants in JRExpression

getBox

public JRBox getBox()
Deprecated. 

Description copied from interface: JRImage
Returns an object containing all border and padding properties for this text element

Specified by:
getBox in interface JRImage

getHyperlinkType

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

Specified by:
getHyperlinkType in interface JRHyperlink
Returns:
one of the hyperlink type constants
See Also:
JRHyperlink.getLinkType()

getHyperlinkTarget

public byte getHyperlinkTarget()
Description copied from interface: JRHyperlink
Retrieves the hyperlink target for the element.

Specified by:
getHyperlinkTarget in interface JRHyperlink
Returns:
one of the hyperlink target constants

getEvaluationGroup

public JRGroup getEvaluationGroup()
Description copied from interface: JRImage
Indicates the evaluation time for this image.

Specified by:
getEvaluationGroup in interface JRImage
Returns:
one of the evaluation time constants in JRExpression

getExpression

public JRExpression getExpression()
Description copied from interface: JRImage
Gets the evaluation group for this text field. Used only when evaluation time is group.

Specified by:
getExpression in interface JRImage
See Also:
JRExpression.EVALUATION_TIME_GROUP

getAnchorNameExpression

public JRExpression getAnchorNameExpression()
Description copied from interface: JRAnchor
Returns an expression whose value represents the anchor name.

Specified by:
getAnchorNameExpression in interface JRAnchor

getHyperlinkReferenceExpression

public JRExpression getHyperlinkReferenceExpression()
Description copied from interface: JRHyperlink
Returns the expression whose value represents the hyperlink reference. It is only used when the hyperlink type is reference or anchor

Specified by:
getHyperlinkReferenceExpression in interface JRHyperlink

getHyperlinkAnchorExpression

public JRExpression getHyperlinkAnchorExpression()
Description copied from interface: JRHyperlink
Returns the expression whose value represents the anchor. It is only used when the hyperlink type is anchor.

Specified by:
getHyperlinkAnchorExpression in interface JRHyperlink

getHyperlinkPageExpression

public JRExpression getHyperlinkPageExpression()
Description copied from interface: JRHyperlink
Returns an integer representing the page index of the link. It is only used when the hyperlink type is page. If the expression does not evaluate to an integer, an exception will be thrown.

Specified by:
getHyperlinkPageExpression in interface JRHyperlink

getCopy

public JRChild getCopy(JRAbstractObjectFactory factory)
Specified by:
getCopy in interface JRChild

collectExpressions

public void collectExpressions(JRExpressionCollector collector)
Specified by:
collectExpressions in interface JRElement

writeXml

public void writeXml(JRXmlWriter xmlWriter)
              throws java.io.IOException
Specified by:
writeXml in interface JRChild
Throws:
java.io.IOException

getBookmarkLevel

public int getBookmarkLevel()
Description copied from interface: JRAnchor
Returns the level of the bookmark corresponding to the anchor.

Specified by:
getBookmarkLevel in interface JRAnchor
Returns:
the level of the bookmark corresponding to the anchor (starting from 1) or NO_BOOKMARK if no bookmark should be created for this anchor

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()
Description copied from interface: JRHyperlink
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.

Specified by:
getLinkType in interface JRHyperlink
Returns:
the hyperlink type

getHyperlinkParameters

public JRHyperlinkParameter[] getHyperlinkParameters()
Description copied from interface: JRHyperlink
Returns the list of hyperlink parameters.

The parameters can be used by custom hyperlink types to generate dynamic links.

Specified by:
getHyperlinkParameters in interface JRHyperlink
Returns:
the list of hyperlink parameters

normalizeLinkType

protected void normalizeLinkType()

getHyperlinkTooltipExpression

public JRExpression getHyperlinkTooltipExpression()
Description copied from interface: JRHyperlink
Returns the expression which will generate the hyperlink tooltip.

Specified by:
getHyperlinkTooltipExpression in interface JRHyperlink
Returns:
the expression which will generate the hyperlink tooltip


© 2001-2006 JasperSoft Corporation www.jaspersoft.com