public class JRTemplateImage extends JRTemplateGraphicElement implements JRAlignment, JRBox, JRCommonImage
JRTemplatePrintImage,
Serialized Form| Modifier and Type | Field and Description |
|---|---|
protected boolean |
isLazy |
protected OnErrorTypeEnum |
onErrorTypeValue |
linePendefaultStyleProvider, origin, parentStyleHORIZONTAL_ALIGN_CENTER, HORIZONTAL_ALIGN_JUSTIFIED, HORIZONTAL_ALIGN_LEFT, HORIZONTAL_ALIGN_RIGHT, VERTICAL_ALIGN_BOTTOM, VERTICAL_ALIGN_JUSTIFIED, VERTICAL_ALIGN_MIDDLE, VERTICAL_ALIGN_TOP| Modifier | Constructor and Description |
|---|---|
|
JRTemplateImage(JROrigin origin,
JRDefaultStyleProvider defaultStyleProvider)
Creates a template image.
|
protected |
JRTemplateImage(JROrigin origin,
JRDefaultStyleProvider defaultStyleProvider,
JRChart chart) |
protected |
JRTemplateImage(JROrigin origin,
JRDefaultStyleProvider defaultStyleProvider,
JRImage image) |
| Modifier and Type | Method and Description |
|---|---|
void |
copyLineBox(JRLineBox box)
Copies box attributes.
|
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()
Deprecated.
Replaced by
getHorizontalAlignmentValue(). |
HorizontalAlignEnum |
getHorizontalAlignmentValue()
Gets the text horizontal alignment.
|
byte |
getHyperlinkTarget()
Deprecated.
Replaced by
getHyperlinkTargetValue(). |
HyperlinkTargetEnum |
getHyperlinkTargetValue() |
byte |
getHyperlinkType()
Deprecated.
Replaced by
getHyperlinkTypeValue(). |
HyperlinkTypeEnum |
getHyperlinkTypeValue()
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.
|
ModeEnum |
getModeValue()
Returns the element transparency mode.
|
byte |
getOnErrorType()
Deprecated.
Replaced by
getOnErrorTypeValue(). |
OnErrorTypeEnum |
getOnErrorTypeValue() |
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()
Deprecated.
Replaced by
getOwnHorizontalAlignmentValue(). |
HorizontalAlignEnum |
getOwnHorizontalAlignmentValue() |
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()
Deprecated.
Replaced by
getOwnScaleImageValue(). |
ScaleImageEnum |
getOwnScaleImageValue()
Gets the image own scale type.
|
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()
Deprecated.
Replaced by
getOwnVerticalAlignmentValue(). |
VerticalAlignEnum |
getOwnVerticalAlignmentValue() |
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()
Deprecated.
Replaced by
getScaleImageValue(). |
ScaleImageEnum |
getScaleImageValue()
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()
Deprecated.
Replaced by
getVerticalAlignmentValue(). |
VerticalAlignEnum |
getVerticalAlignmentValue()
Gets the text vertical alignment.
|
boolean |
isLazy() |
boolean |
isUsingCache() |
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)
Deprecated.
Replaced by
setHorizontalAlignment(HorizontalAlignEnum). |
void |
setHorizontalAlignment(java.lang.Byte horizontalAlignment)
Deprecated.
Replaced by
setHorizontalAlignment(HorizontalAlignEnum). |
void |
setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
Sets the text horizontal alignment.
|
protected void |
setHyperlinkTarget(byte hyperlinkTarget)
Deprecated.
Replaced by
setHyperlinkTarget(HyperlinkTargetEnum). |
protected void |
setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget) |
protected void |
setHyperlinkType(byte hyperlinkType)
Deprecated.
Replaced by
setHyperlinkType(HyperlinkTypeEnum). |
protected void |
setHyperlinkType(HyperlinkTypeEnum 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 |
setLinkTarget(java.lang.String linkTarget)
Sets the hyperlink target name.
|
void |
setLinkType(java.lang.String linkType)
Sets the hyperlink type.
|
void |
setOnErrorType(byte onErrorType)
Deprecated.
Replaced by
setOnErrorType(OnErrorTypeEnum). |
void |
setOnErrorType(OnErrorTypeEnum onErrorTypeValue) |
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() |
void |
setScaleImage(byte scaleImage)
Deprecated.
Replaced by
setScaleImage(ScaleImageEnum). |
void |
setScaleImage(java.lang.Byte scaleImage)
Deprecated.
Replaced by
setScaleImage(ScaleImageEnum). |
void |
setScaleImage(ScaleImageEnum scaleImageValue)
Sets the image scale type.
|
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)
Deprecated.
Replaced by
setVerticalAlignment(VerticalAlignEnum). |
void |
setVerticalAlignment(java.lang.Byte verticalAlignment)
Deprecated.
Replaced by
setVerticalAlignment(VerticalAlignEnum). |
void |
setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
Gets the text vertical alignment.
|
copyLinePen, getDefaultLineColor, getFill, getFillValue, getLinePen, getOwnFill, getOwnFillValue, getOwnPen, getPen, setFill, setFill, setFill, setGraphicElement, setPen, setPengetBackcolor, getBaseStyle, getDefaultStyleProvider, getForecolor, getHeight, getId, getKey, getMode, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getParentProperties, getPropertiesMap, getStyle, getStyleNameReference, getWidth, hasProperties, setBackcolor, setElement, setForecolor, setKey, setMode, setMode, setMode, setStyleclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetFill, getFillValue, getLinePen, getOwnFill, getOwnFillValue, setFill, setFill, setFillgetBackcolor, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode, setMode, setModegetDefaultLineColorgetDefaultStyleProvider, getStyle, getStyleNameReferencegetDefaultLineColorprotected boolean isLazy
protected OnErrorTypeEnum onErrorTypeValue
protected JRTemplateImage(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider, JRImage image)
protected JRTemplateImage(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider, JRChart chart)
public JRTemplateImage(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider)
origin - the origin of the elements that will use this templatedefaultStyleProvider - the default style provider to use for
this templateprotected void setImage(JRImage image)
protected void setChart(JRChart chart)
public void copyLineBox(JRLineBox box)
box - the object to copy attributes frompublic JRBox getBox()
getLineBox()public JRLineBox getLineBox()
getLineBox in interface JRBoxContainerpublic void setBox(JRBox box)
getLineBox()public ModeEnum getModeValue()
JRCommonElementgetModeValue in interface JRCommonElementgetModeValue in class JRTemplateElementpublic byte getScaleImage()
getScaleImageValue().getScaleImage in interface JRCommonImagepublic java.lang.Byte getOwnScaleImage()
getOwnScaleImageValue().getOwnScaleImage in interface JRCommonImagepublic void setScaleImage(byte scaleImage)
setScaleImage(ScaleImageEnum).setScaleImage in interface JRCommonImagepublic void setScaleImage(java.lang.Byte scaleImage)
setScaleImage(ScaleImageEnum).setScaleImage in interface JRCommonImagepublic ScaleImageEnum getScaleImageValue()
JRCommonImagegetScaleImageValue in interface JRCommonImageScaleImageEnumpublic ScaleImageEnum getOwnScaleImageValue()
JRCommonImagegetOwnScaleImageValue in interface JRCommonImageScaleImageEnumpublic void setScaleImage(ScaleImageEnum scaleImageValue)
JRCommonImagesetScaleImage in interface JRCommonImagescaleImageValue - a value representing one of the scale type constants in ScaleImageEnumpublic boolean isUsingCache()
public void setUsingCache(boolean isUsingCache)
public byte getHorizontalAlignment()
getHorizontalAlignmentValue().getHorizontalAlignment in interface JRAlignmentpublic java.lang.Byte getOwnHorizontalAlignment()
getOwnHorizontalAlignmentValue().getOwnHorizontalAlignment in interface JRAlignmentpublic HorizontalAlignEnum getHorizontalAlignmentValue()
JRAlignmentgetHorizontalAlignmentValue in interface JRAlignmentHorizontalAlignEnumpublic HorizontalAlignEnum getOwnHorizontalAlignmentValue()
getOwnHorizontalAlignmentValue in interface JRAlignmentpublic void setHorizontalAlignment(byte horizontalAlignment)
setHorizontalAlignment(HorizontalAlignEnum).setHorizontalAlignment in interface JRAlignmentpublic void setHorizontalAlignment(java.lang.Byte horizontalAlignment)
setHorizontalAlignment(HorizontalAlignEnum).setHorizontalAlignment in interface JRAlignmentpublic void setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
JRAlignmentsetHorizontalAlignment in interface JRAlignmenthorizontalAlignmentValue - a value representing one of the horizontal alignment constants in HorizontalAlignEnumpublic byte getVerticalAlignment()
getVerticalAlignmentValue().getVerticalAlignment in interface JRAlignmentpublic java.lang.Byte getOwnVerticalAlignment()
getOwnVerticalAlignmentValue().getOwnVerticalAlignment in interface JRAlignmentpublic VerticalAlignEnum getVerticalAlignmentValue()
JRAlignmentgetVerticalAlignmentValue in interface JRAlignmentVerticalAlignEnumpublic VerticalAlignEnum getOwnVerticalAlignmentValue()
getOwnVerticalAlignmentValue in interface JRAlignmentpublic void setVerticalAlignment(byte verticalAlignment)
setVerticalAlignment(VerticalAlignEnum).setVerticalAlignment in interface JRAlignmentpublic void setVerticalAlignment(java.lang.Byte verticalAlignment)
setVerticalAlignment(VerticalAlignEnum).setVerticalAlignment in interface JRAlignmentpublic void setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
JRAlignmentsetVerticalAlignment in interface JRAlignmentverticalAlignmentValue - a value representing one of the vertical alignment constants in VerticalAlignEnumpublic boolean isLazy()
public void setLazy(boolean isLazy)
public byte getOnErrorType()
getOnErrorTypeValue().public void setOnErrorType(byte onErrorType)
setOnErrorType(OnErrorTypeEnum).public OnErrorTypeEnum getOnErrorTypeValue()
public void setOnErrorType(OnErrorTypeEnum onErrorTypeValue)
public byte getHyperlinkType()
getHyperlinkTypeValue().public HyperlinkTypeEnum getHyperlinkTypeValue()
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, CUSTOM is returned.
getLinkType()protected void setHyperlinkType(byte hyperlinkType)
setHyperlinkType(HyperlinkTypeEnum).protected void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
hyperlinkType - the built-in hyperlink typegetLinkType()public byte getHyperlinkTarget()
getHyperlinkTargetValue().public HyperlinkTargetEnum getHyperlinkTargetValue()
protected void setHyperlinkTarget(byte hyperlinkTarget)
setHyperlinkTarget(HyperlinkTargetEnum).protected void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
public java.lang.String getLinkTarget()
The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
public void setLinkTarget(java.lang.String linkTarget)
The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
linkTarget - the hyperlink target namepublic java.lang.String getLinkType()
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
public void setLinkType(java.lang.String linkType)
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
linkType - the hyperlink typepublic java.lang.Float getDefaultLineWidth()
getDefaultLineWidth in interface JRPenContainergetDefaultLineWidth in class JRTemplateGraphicElementpublic byte getBorder()
getBox()public java.lang.Byte getOwnBorder()
getBox()getOwnBorder in interface JRBoxpublic void setBorder(byte border)
getBox()public void setBorder(java.lang.Byte border)
getBox()public 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 JRBox© 2001-2010 Jaspersoft Corporation www.jaspersoft.com