net.sf.jasperreports.engine.fill
public class JRTemplateImage extends JRTemplateGraphicElement implements JRAlignment, JRBox, JRCommonImage
JRTemplatePrintImage
,
Serialized FormModifier and Type | Field and Description |
---|---|
protected boolean |
isLazy |
protected OnErrorTypeEnum |
onErrorTypeValue |
linePen
defaultStyleProvider, origin, parentStyle
HORIZONTAL_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, setPen
getBackcolor, 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, setStyle
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getFill, getFillValue, getLinePen, getOwnFill, getOwnFillValue, setFill, setFill, setFill
getBackcolor, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode, setMode, setMode
getDefaultLineColor
getDefaultStyleProvider, getStyle, getStyleNameReference
getDefaultLineColor
protected 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 JRBoxContainer
public void setBox(JRBox box)
getLineBox()
public ModeEnum getModeValue()
JRCommonElement
getModeValue
in interface JRCommonElement
getModeValue
in class JRTemplateElement
public byte getScaleImage()
getScaleImageValue()
.getScaleImage
in interface JRCommonImage
public java.lang.Byte getOwnScaleImage()
getOwnScaleImageValue()
.getOwnScaleImage
in interface JRCommonImage
public void setScaleImage(byte scaleImage)
setScaleImage(ScaleImageEnum)
.setScaleImage
in interface JRCommonImage
public void setScaleImage(java.lang.Byte scaleImage)
setScaleImage(ScaleImageEnum)
.setScaleImage
in interface JRCommonImage
public ScaleImageEnum getScaleImageValue()
JRCommonImage
getScaleImageValue
in interface JRCommonImage
ScaleImageEnum
public ScaleImageEnum getOwnScaleImageValue()
JRCommonImage
getOwnScaleImageValue
in interface JRCommonImage
ScaleImageEnum
public void setScaleImage(ScaleImageEnum scaleImageValue)
JRCommonImage
setScaleImage
in interface JRCommonImage
scaleImageValue
- a value representing one of the scale type constants in ScaleImageEnum
public boolean isUsingCache()
public void setUsingCache(boolean isUsingCache)
public byte getHorizontalAlignment()
getHorizontalAlignmentValue()
.getHorizontalAlignment
in interface JRAlignment
public java.lang.Byte getOwnHorizontalAlignment()
getOwnHorizontalAlignmentValue()
.getOwnHorizontalAlignment
in interface JRAlignment
public HorizontalAlignEnum getHorizontalAlignmentValue()
JRAlignment
getHorizontalAlignmentValue
in interface JRAlignment
HorizontalAlignEnum
public HorizontalAlignEnum getOwnHorizontalAlignmentValue()
getOwnHorizontalAlignmentValue
in interface JRAlignment
public void setHorizontalAlignment(byte horizontalAlignment)
setHorizontalAlignment(HorizontalAlignEnum)
.setHorizontalAlignment
in interface JRAlignment
public void setHorizontalAlignment(java.lang.Byte horizontalAlignment)
setHorizontalAlignment(HorizontalAlignEnum)
.setHorizontalAlignment
in interface JRAlignment
public void setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
JRAlignment
setHorizontalAlignment
in interface JRAlignment
horizontalAlignmentValue
- a value representing one of the horizontal alignment constants in HorizontalAlignEnum
public byte getVerticalAlignment()
getVerticalAlignmentValue()
.getVerticalAlignment
in interface JRAlignment
public java.lang.Byte getOwnVerticalAlignment()
getOwnVerticalAlignmentValue()
.getOwnVerticalAlignment
in interface JRAlignment
public VerticalAlignEnum getVerticalAlignmentValue()
JRAlignment
getVerticalAlignmentValue
in interface JRAlignment
VerticalAlignEnum
public VerticalAlignEnum getOwnVerticalAlignmentValue()
getOwnVerticalAlignmentValue
in interface JRAlignment
public void setVerticalAlignment(byte verticalAlignment)
setVerticalAlignment(VerticalAlignEnum)
.setVerticalAlignment
in interface JRAlignment
public void setVerticalAlignment(java.lang.Byte verticalAlignment)
setVerticalAlignment(VerticalAlignEnum)
.setVerticalAlignment
in interface JRAlignment
public void setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
JRAlignment
setVerticalAlignment
in interface JRAlignment
verticalAlignmentValue
- a value representing one of the vertical alignment constants in VerticalAlignEnum
public 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 JRPenContainer
getDefaultLineWidth
in class JRTemplateGraphicElement
public byte getBorder()
getBox()
public java.lang.Byte getOwnBorder()
getBox()
getOwnBorder
in interface JRBox
public void setBorder(byte border)
getBox()
public void setBorder(java.lang.Byte border)
getBox()
public java.awt.Color getBorderColor()
getBox()
getBorderColor
in interface JRBox
public java.awt.Color getOwnBorderColor()
getBox()
getOwnBorderColor
in interface JRBox
public void setBorderColor(java.awt.Color borderColor)
getBox()
setBorderColor
in interface JRBox
public int getPadding()
getBox()
getPadding
in interface JRBox
public java.lang.Integer getOwnPadding()
getBox()
getOwnPadding
in interface JRBox
public void setPadding(int padding)
getBox()
setPadding
in interface JRBox
public void setPadding(java.lang.Integer padding)
getBox()
setPadding
in interface JRBox
public byte getTopBorder()
getBox()
getTopBorder
in interface JRBox
public java.lang.Byte getOwnTopBorder()
getBox()
getOwnTopBorder
in interface JRBox
public void setTopBorder(byte topBorder)
getBox()
setTopBorder
in interface JRBox
public void setTopBorder(java.lang.Byte topBorder)
getBox()
setTopBorder
in interface JRBox
public java.awt.Color getTopBorderColor()
getBox()
getTopBorderColor
in interface JRBox
public java.awt.Color getOwnTopBorderColor()
getBox()
getOwnTopBorderColor
in interface JRBox
public void setTopBorderColor(java.awt.Color topBorderColor)
getBox()
setTopBorderColor
in interface JRBox
public int getTopPadding()
getBox()
getTopPadding
in interface JRBox
public java.lang.Integer getOwnTopPadding()
getBox()
getOwnTopPadding
in interface JRBox
public void setTopPadding(int topPadding)
getBox()
setTopPadding
in interface JRBox
public void setTopPadding(java.lang.Integer topPadding)
getBox()
setTopPadding
in interface JRBox
public byte getLeftBorder()
getBox()
getLeftBorder
in interface JRBox
public java.lang.Byte getOwnLeftBorder()
getBox()
getOwnLeftBorder
in interface JRBox
public void setLeftBorder(byte leftBorder)
getBox()
setLeftBorder
in interface JRBox
public void setLeftBorder(java.lang.Byte leftBorder)
getBox()
setLeftBorder
in interface JRBox
public java.awt.Color getLeftBorderColor()
getBox()
getLeftBorderColor
in interface JRBox
public java.awt.Color getOwnLeftBorderColor()
getBox()
getOwnLeftBorderColor
in interface JRBox
public void setLeftBorderColor(java.awt.Color leftBorderColor)
getBox()
setLeftBorderColor
in interface JRBox
public int getLeftPadding()
getBox()
getLeftPadding
in interface JRBox
public java.lang.Integer getOwnLeftPadding()
getBox()
getOwnLeftPadding
in interface JRBox
public void setLeftPadding(int leftPadding)
getBox()
setLeftPadding
in interface JRBox
public void setLeftPadding(java.lang.Integer leftPadding)
getBox()
setLeftPadding
in interface JRBox
public byte getBottomBorder()
getBox()
getBottomBorder
in interface JRBox
public java.lang.Byte getOwnBottomBorder()
getBox()
getOwnBottomBorder
in interface JRBox
public void setBottomBorder(byte bottomBorder)
getBox()
setBottomBorder
in interface JRBox
public void setBottomBorder(java.lang.Byte bottomBorder)
getBox()
setBottomBorder
in interface JRBox
public java.awt.Color getBottomBorderColor()
getBox()
getBottomBorderColor
in interface JRBox
public java.awt.Color getOwnBottomBorderColor()
getBox()
getOwnBottomBorderColor
in interface JRBox
public void setBottomBorderColor(java.awt.Color bottomBorderColor)
getBox()
setBottomBorderColor
in interface JRBox
public int getBottomPadding()
getBox()
getBottomPadding
in interface JRBox
public java.lang.Integer getOwnBottomPadding()
getBox()
getOwnBottomPadding
in interface JRBox
public void setBottomPadding(int bottomPadding)
getBox()
setBottomPadding
in interface JRBox
public void setBottomPadding(java.lang.Integer bottomPadding)
getBox()
setBottomPadding
in interface JRBox
public byte getRightBorder()
getBox()
getRightBorder
in interface JRBox
public java.lang.Byte getOwnRightBorder()
getBox()
getOwnRightBorder
in interface JRBox
public void setRightBorder(byte rightBorder)
getBox()
setRightBorder
in interface JRBox
public void setRightBorder(java.lang.Byte rightBorder)
getBox()
setRightBorder
in interface JRBox
public java.awt.Color getRightBorderColor()
getBox()
getRightBorderColor
in interface JRBox
public java.awt.Color getOwnRightBorderColor()
getBox()
getOwnRightBorderColor
in interface JRBox
public void setRightBorderColor(java.awt.Color rightBorderColor)
getBox()
setRightBorderColor
in interface JRBox
public int getRightPadding()
getBox()
getRightPadding
in interface JRBox
public java.lang.Integer getOwnRightPadding()
getBox()
getOwnRightPadding
in interface JRBox
public void setRightPadding(int rightPadding)
getBox()
setRightPadding
in interface JRBox
public void setRightPadding(java.lang.Integer rightPadding)
getBox()
setRightPadding
in interface JRBox
© 2001-2010 Jaspersoft Corporation www.jaspersoft.com