|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.fill.JRTemplatePrintElement
net.sf.jasperreports.engine.fill.JRTemplatePrintGraphicElement
net.sf.jasperreports.engine.fill.JRTemplatePrintImage
public class JRTemplatePrintImage
Implementation of JRPrintImage that uses
a JRTemplateImage instance to
store common attributes.
| Field Summary | |
|---|---|
protected int |
bookmarkLevel
The bookmark level for the anchor associated with this field. |
| Fields inherited from class net.sf.jasperreports.engine.fill.JRTemplatePrintElement |
|---|
template |
| 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 | |
|---|---|
JRTemplatePrintImage(JRTemplateImage image)
Creates a print image element. |
|
| Method Summary | |
|---|---|
java.lang.String |
getAnchorName()
|
int |
getBookmarkLevel()
Returns the level of the bookmark corresponding to the anchor. |
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() |
byte |
getHorizontalAlignment()
Gets the text horizontal alignment. |
java.lang.String |
getHyperlinkAnchor()
|
java.lang.Integer |
getHyperlinkPage()
|
JRPrintHyperlinkParameters |
getHyperlinkParameters()
Returns the set of custom hyperlink parameters. |
java.lang.String |
getHyperlinkReference()
|
byte |
getHyperlinkTarget()
|
java.lang.String |
getHyperlinkTooltip()
Returns the hyperlink tooltip. |
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 |
getLinkTarget()
Returns the hyperlink target name. |
java.lang.String |
getLinkType()
Returns the hyperlink type. |
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() |
JRRenderable |
getRenderer()
|
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()
|
void |
setAnchorName(java.lang.String anchorName)
|
void |
setBookmarkLevel(int bookmarkLevel)
Sets the boomark level for the anchor. |
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() |
void |
setHorizontalAlignment(byte horizontalAlignment)
Sets the text horizontal alignment. |
void |
setHorizontalAlignment(java.lang.Byte horizontalAlignment)
|
void |
setHyperlinkAnchor(java.lang.String hyperlinkAnchor)
|
void |
setHyperlinkPage(java.lang.Integer hyperlinkPage)
|
void |
setHyperlinkParameters(JRPrintHyperlinkParameters parameters)
Sets the custom hyperlink parameters. |
void |
setHyperlinkReference(java.lang.String hyperlinkReference)
|
void |
setHyperlinkTarget(byte hyperlinkTarget)
|
void |
setHyperlinkTooltip(java.lang.String hyperlinkTooltip)
Sets the tooltip to be used for the hyperlink. |
void |
setHyperlinkType(byte hyperlinkType)
Sets the link type as a built-in hyperlink type. |
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 |
setLinkTarget(java.lang.String target)
Sets the hyperlink target name. |
void |
setLinkType(java.lang.String type)
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 |
setRenderer(JRRenderable renderer)
|
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() |
void |
setScaleImage(byte scaleImage)
|
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.JRTemplatePrintGraphicElement |
|---|
getDefaultLineColor, getDefaultLineWidth, getFill, getLinePen, getOwnFill, getOwnPen, getPen, setFill, setFill, setPen, setPen |
| Methods inherited from class net.sf.jasperreports.engine.fill.JRTemplatePrintElement |
|---|
getBackcolor, getDefaultStyleProvider, getForecolor, getHeight, getKey, getMode, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnMode, getParentProperties, getPropertiesMap, getStyle, getStyleNameReference, getTemplate, getWidth, getX, getY, hasProperties, setBackcolor, setForecolor, setHeight, setMode, setMode, setStyle, setTemplate, setWidth, setX, setY, updateElementTemplate |
| 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.JRPrintGraphicElement |
|---|
getOwnPen, getPen, setFill, setFill, setPen, setPen |
| Methods inherited from interface net.sf.jasperreports.engine.JRPrintElement |
|---|
getHeight, getKey, getOrigin, getWidth, getX, getY, setBackcolor, setForecolor, setHeight, setMode, setMode, setStyle, setWidth, setX, setY |
| Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
|---|
getParentProperties, getPropertiesMap, hasProperties |
| Methods inherited from interface net.sf.jasperreports.engine.JRCommonGraphicElement |
|---|
getFill, getLinePen, getOwnFill |
| Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
|---|
getBackcolor, getForecolor, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode |
| Methods inherited from interface net.sf.jasperreports.engine.JRPenContainer |
|---|
getDefaultLineColor, getDefaultLineWidth |
| Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
|---|
getDefaultStyleProvider, getStyle, getStyleNameReference |
| Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer |
|---|
getDefaultLineColor |
| Field Detail |
|---|
protected int bookmarkLevel
JRAnchor.getBookmarkLevel()| Constructor Detail |
|---|
public JRTemplatePrintImage(JRTemplateImage image)
image - the template image that the element will use| Method Detail |
|---|
public JRRenderable getRenderer()
getRenderer in interface JRPrintImagepublic void setRenderer(JRRenderable renderer)
setRenderer in interface JRPrintImagepublic byte getScaleImage()
JRCommonImage
getScaleImage in interface JRCommonImagepublic java.lang.Byte getOwnScaleImage()
getOwnScaleImage in interface JRCommonImagepublic void setScaleImage(byte scaleImage)
setScaleImage in interface JRPrintImagepublic void setScaleImage(java.lang.Byte scaleImage)
setScaleImage in interface JRPrintImagepublic boolean isUsingCache()
isUsingCache in interface JRPrintImagepublic void setUsingCache(boolean isUsingCache)
setUsingCache in interface JRPrintImagepublic byte getHorizontalAlignment()
JRAlignment
getHorizontalAlignment in interface JRAlignmentJRAlignmentpublic java.lang.Byte getOwnHorizontalAlignment()
getOwnHorizontalAlignment in interface JRAlignmentpublic void setHorizontalAlignment(byte horizontalAlignment)
JRAlignment
setHorizontalAlignment in interface JRAlignmenthorizontalAlignment - a value representing one of the horizontal alignment constants in JRAlignmentpublic void setHorizontalAlignment(java.lang.Byte horizontalAlignment)
setHorizontalAlignment in interface JRAlignmentpublic byte getVerticalAlignment()
JRAlignment
getVerticalAlignment in interface JRAlignmentJRAlignmentpublic java.lang.Byte getOwnVerticalAlignment()
getOwnVerticalAlignment in interface JRAlignmentpublic void setVerticalAlignment(byte verticalAlignment)
JRAlignment
setVerticalAlignment in interface JRAlignmentverticalAlignment - a value representing one of the vertical alignment constants in JRAlignmentpublic void setVerticalAlignment(java.lang.Byte verticalAlignment)
setVerticalAlignment in interface JRAlignmentpublic boolean isLazy()
isLazy in interface JRPrintImagepublic void setLazy(boolean isLazy)
setLazy in interface JRPrintImagepublic byte getOnErrorType()
getOnErrorType in interface JRPrintImagepublic void setOnErrorType(byte onErrorType)
setOnErrorType in interface JRPrintImagepublic JRBox getBox()
getLineBox()
getBox in interface JRPrintImagepublic JRLineBox getLineBox()
getLineBox in interface JRBoxContainerpublic void setBox(JRBox box)
getLineBox()
setBox in interface JRPrintImagepublic java.lang.String getAnchorName()
getAnchorName in interface JRPrintAnchorpublic void setAnchorName(java.lang.String anchorName)
setAnchorName in interface JRPrintAnchorpublic byte getHyperlinkType()
JRPrintHyperlink
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.
getHyperlinkType in interface JRPrintHyperlinkJRPrintHyperlink.getLinkType()public void setHyperlinkType(byte hyperlinkType)
JRPrintHyperlink
setHyperlinkType in interface JRPrintHyperlinkhyperlinkType - the built-in hyperlink typeJRPrintHyperlink.getLinkType()public byte getHyperlinkTarget()
getHyperlinkTarget in interface JRPrintHyperlinkpublic void setHyperlinkTarget(byte hyperlinkTarget)
setHyperlinkTarget in interface JRPrintHyperlinkpublic java.lang.String getHyperlinkReference()
getHyperlinkReference in interface JRPrintHyperlinkpublic void setHyperlinkReference(java.lang.String hyperlinkReference)
setHyperlinkReference in interface JRPrintHyperlinkpublic java.lang.String getHyperlinkAnchor()
getHyperlinkAnchor in interface JRPrintHyperlinkpublic void setHyperlinkAnchor(java.lang.String hyperlinkAnchor)
setHyperlinkAnchor in interface JRPrintHyperlinkpublic java.lang.Integer getHyperlinkPage()
getHyperlinkPage in interface JRPrintHyperlinkpublic void setHyperlinkPage(java.lang.Integer hyperlinkPage)
setHyperlinkPage in interface JRPrintHyperlinkpublic int getBookmarkLevel()
JRPrintAnchor
getBookmarkLevel in interface JRPrintAnchorNO_BOOKMARK if no bookmark should be created for this anchorpublic void setBookmarkLevel(int bookmarkLevel)
JRPrintAnchor
setBookmarkLevel in interface JRPrintAnchorbookmarkLevel - the bookmark level (starting from 1)
or NO_BOOKMARK if no bookmark should be createdpublic byte getBorder()
getBox()
getBorder in interface JRBoxpublic java.lang.Byte getOwnBorder()
getBox()
getOwnBorder in interface JRBoxpublic void setBorder(byte border)
getBox()
setBorder in interface JRBoxpublic void setBorder(java.lang.Byte border)
getBox()
setBorder in interface JRBoxpublic java.awt.Color getBorderColor()
getBox()
getBorderColor in interface JRBoxpublic java.awt.Color getOwnBorderColor()
getBox()
getOwnBorderColor in interface JRBoxpublic void setBorderColor(java.awt.Color borderColor)
getBox()
setBorderColor in interface JRBoxpublic int getPadding()
getBox()
getPadding in interface JRBoxpublic java.lang.Integer getOwnPadding()
getBox()
getOwnPadding in interface JRBoxpublic void setPadding(int padding)
getBox()
setPadding in interface JRBoxpublic void setPadding(java.lang.Integer padding)
getBox()
setPadding in interface JRBoxpublic byte getTopBorder()
getBox()
getTopBorder in interface JRBoxpublic java.lang.Byte getOwnTopBorder()
getBox()
getOwnTopBorder in interface JRBoxpublic void setTopBorder(byte topBorder)
getBox()
setTopBorder in interface JRBoxpublic void setTopBorder(java.lang.Byte topBorder)
getBox()
setTopBorder in interface JRBoxpublic java.awt.Color getTopBorderColor()
getBox()
getTopBorderColor in interface JRBoxpublic java.awt.Color getOwnTopBorderColor()
getBox()
getOwnTopBorderColor in interface JRBoxpublic void setTopBorderColor(java.awt.Color topBorderColor)
getBox()
setTopBorderColor in interface JRBoxpublic int getTopPadding()
getBox()
getTopPadding in interface JRBoxpublic java.lang.Integer getOwnTopPadding()
getBox()
getOwnTopPadding in interface JRBoxpublic void setTopPadding(int topPadding)
getBox()
setTopPadding in interface JRBoxpublic void setTopPadding(java.lang.Integer topPadding)
getBox()
setTopPadding in interface JRBoxpublic byte getLeftBorder()
getBox()
getLeftBorder in interface JRBoxpublic java.lang.Byte getOwnLeftBorder()
getBox()
getOwnLeftBorder in interface JRBoxpublic void setLeftBorder(byte leftBorder)
getBox()
setLeftBorder in interface JRBoxpublic void setLeftBorder(java.lang.Byte leftBorder)
getBox()
setLeftBorder in interface JRBoxpublic java.awt.Color getLeftBorderColor()
getBox()
getLeftBorderColor in interface JRBoxpublic java.awt.Color getOwnLeftBorderColor()
getBox()
getOwnLeftBorderColor in interface JRBoxpublic void setLeftBorderColor(java.awt.Color leftBorderColor)
getBox()
setLeftBorderColor in interface JRBoxpublic int getLeftPadding()
getBox()
getLeftPadding in interface JRBoxpublic java.lang.Integer getOwnLeftPadding()
getBox()
getOwnLeftPadding in interface JRBoxpublic void setLeftPadding(int leftPadding)
getBox()
setLeftPadding in interface JRBoxpublic void setLeftPadding(java.lang.Integer leftPadding)
getBox()
setLeftPadding in interface JRBoxpublic byte getBottomBorder()
getBox()
getBottomBorder in interface JRBoxpublic java.lang.Byte getOwnBottomBorder()
getBox()
getOwnBottomBorder in interface JRBoxpublic void setBottomBorder(byte bottomBorder)
getBox()
setBottomBorder in interface JRBoxpublic void setBottomBorder(java.lang.Byte bottomBorder)
getBox()
setBottomBorder in interface JRBoxpublic java.awt.Color getBottomBorderColor()
getBox()
getBottomBorderColor in interface JRBoxpublic java.awt.Color getOwnBottomBorderColor()
getBox()
getOwnBottomBorderColor in interface JRBoxpublic void setBottomBorderColor(java.awt.Color bottomBorderColor)
getBox()
setBottomBorderColor in interface JRBoxpublic int getBottomPadding()
getBox()
getBottomPadding in interface JRBoxpublic java.lang.Integer getOwnBottomPadding()
getBox()
getOwnBottomPadding in interface JRBoxpublic void setBottomPadding(int bottomPadding)
getBox()
setBottomPadding in interface JRBoxpublic void setBottomPadding(java.lang.Integer bottomPadding)
getBox()
setBottomPadding in interface JRBoxpublic byte getRightBorder()
getBox()
getRightBorder in interface JRBoxpublic java.lang.Byte getOwnRightBorder()
getBox()
getOwnRightBorder in interface JRBoxpublic void setRightBorder(byte rightBorder)
getBox()
setRightBorder in interface JRBoxpublic void setRightBorder(java.lang.Byte rightBorder)
getBox()
setRightBorder in interface JRBoxpublic java.awt.Color getRightBorderColor()
getBox()
getRightBorderColor in interface JRBoxpublic java.awt.Color getOwnRightBorderColor()
getBox()
getOwnRightBorderColor in interface JRBoxpublic void setRightBorderColor(java.awt.Color rightBorderColor)
getBox()
setRightBorderColor in interface JRBoxpublic int getRightPadding()
getBox()
getRightPadding in interface JRBoxpublic java.lang.Integer getOwnRightPadding()
getBox()
getOwnRightPadding in interface JRBoxpublic void setRightPadding(int rightPadding)
getBox()
setRightPadding in interface JRBoxpublic void setRightPadding(java.lang.Integer rightPadding)
getBox()
setRightPadding in interface JRBoxpublic JRPrintHyperlinkParameters getHyperlinkParameters()
JRPrintHyperlink
getHyperlinkParameters in interface JRPrintHyperlinkJRPrintHyperlink.setHyperlinkParameters(JRPrintHyperlinkParameters),
JRPrintHyperlinkParameterpublic void setHyperlinkParameters(JRPrintHyperlinkParameters parameters)
JRPrintHyperlinkThese parameters will be used to produce the actual hyperlink when the report is exported.
setHyperlinkParameters in interface JRPrintHyperlinkparameters - the set of custom hyperlink parameterspublic java.lang.String getLinkType()
JRPrintHyperlink
getLinkType in interface JRPrintHyperlinkpublic void setLinkType(java.lang.String type)
JRPrintHyperlinkThe type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
setLinkType in interface JRPrintHyperlinktype - the hyperlink typepublic java.lang.String getLinkTarget()
JRPrintHyperlinkThe target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget in interface JRPrintHyperlinkpublic void setLinkTarget(java.lang.String target)
JRPrintHyperlinkThe target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
setLinkTarget in interface JRPrintHyperlinktarget - the hyperlink target namepublic java.lang.String getHyperlinkTooltip()
JRPrintHyperlink
getHyperlinkTooltip in interface JRPrintHyperlinkpublic void setHyperlinkTooltip(java.lang.String hyperlinkTooltip)
JRPrintHyperlink
setHyperlinkTooltip in interface JRPrintHyperlinkhyperlinkTooltip - the tooltip
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||