|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.jasperreports.engine.base.JRBasePrintElement net.sf.jasperreports.engine.base.JRBasePrintGraphicElement net.sf.jasperreports.engine.base.JRBasePrintImage
public class JRBasePrintImage
Field Summary | |
---|---|
protected java.lang.String |
anchorName
|
protected int |
bookmarkLevel
The bookmark level for the anchor associated with this field. |
protected HorizontalAlignEnum |
horizontalAlignmentValue
|
protected java.lang.String |
hyperlinkAnchor
|
protected java.lang.Integer |
hyperlinkPage
|
protected JRPrintHyperlinkParameters |
hyperlinkParameters
|
protected java.lang.String |
hyperlinkReference
|
protected java.lang.String |
hyperlinkTooltip
|
protected boolean |
isLazy
|
protected java.lang.Boolean |
isUsingCache
|
protected JRLineBox |
lineBox
|
protected java.lang.String |
linkTarget
|
protected java.lang.String |
linkType
|
protected OnErrorTypeEnum |
onErrorTypeValue
|
protected Renderable |
renderable
|
protected ScaleImageEnum |
scaleImageValue
|
protected VerticalAlignEnum |
verticalAlignmentValue
|
Fields inherited from class net.sf.jasperreports.engine.base.JRBasePrintGraphicElement |
---|
fillValue, linePen |
Fields inherited from class net.sf.jasperreports.engine.base.JRBasePrintElement |
---|
backcolor, defaultStyleProvider, forecolor, height, key, modeValue, origin, style, uuid, width, x, y |
Fields inherited from interface net.sf.jasperreports.engine.JRPrintElement |
---|
UNSET_SOURCE_ELEMENT_ID |
Constructor Summary | |
---|---|
JRBasePrintImage(JRDefaultStyleProvider defaultStyleProvider)
|
Method Summary | ||
---|---|---|
|
accept(PrintElementVisitor<T> visitor,
T arg)
Accepts a print element visitor. |
|
void |
addHyperlinkParameter(JRPrintHyperlinkParameter parameter)
Adds a custom hyperlink parameter. |
|
void |
copyBox(JRLineBox lineBox)
|
|
java.lang.String |
getAnchorName()
|
|
int |
getBookmarkLevel()
Returns the level of the bookmark corresponding to the anchor. |
|
java.lang.Float |
getDefaultLineWidth()
|
|
HorizontalAlignEnum |
getHorizontalAlignmentValue()
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()
|
|
HyperlinkTargetEnum |
getHyperlinkTargetValue()
|
|
java.lang.String |
getHyperlinkTooltip()
Returns the hyperlink tooltip. |
|
HyperlinkTypeEnum |
getHyperlinkTypeValue()
Retrieves the hyperlink type for the element. |
|
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. |
|
OnErrorTypeEnum |
getOnErrorTypeValue()
|
|
HorizontalAlignEnum |
getOwnHorizontalAlignmentValue()
|
|
ScaleImageEnum |
getOwnScaleImageValue()
Gets the image own scale type. |
|
VerticalAlignEnum |
getOwnVerticalAlignmentValue()
|
|
Renderable |
getRenderable()
|
|
JRRenderable |
getRenderer()
Deprecated. Replaced by getRenderable() . |
|
ScaleImageEnum |
getScaleImageValue()
Gets the image scale type. |
|
VerticalAlignEnum |
getVerticalAlignmentValue()
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 |
setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
Sets the text horizontal alignment. |
|
void |
setHyperlinkAnchor(java.lang.String hyperlinkAnchor)
|
|
void |
setHyperlinkPage(java.lang.Integer hyperlinkPage)
|
|
void |
setHyperlinkPage(java.lang.String hyperlinkPage)
|
|
void |
setHyperlinkParameters(JRPrintHyperlinkParameters hyperlinkParameters)
Sets the custom hyperlink parameters. |
|
void |
setHyperlinkReference(java.lang.String hyperlinkReference)
|
|
void |
setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
|
|
void |
setHyperlinkTooltip(java.lang.String hyperlinkTooltip)
Sets the tooltip to be used for the hyperlink. |
|
void |
setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
Sets the link type as a built-in hyperlink type. |
|
void |
setLazy(boolean isLazy)
|
|
void |
setLinkTarget(java.lang.String linkTarget)
Sets the hyperlink target name. |
|
void |
setLinkType(java.lang.String linkType)
Sets the hyperlink type. |
|
void |
setOnErrorType(OnErrorTypeEnum onErrorTypeValue)
|
|
void |
setRenderable(Renderable renderable)
|
|
void |
setRenderer(JRRenderable renderer)
Deprecated. Replaced by setRenderable(Renderable) . |
|
void |
setScaleImage(ScaleImageEnum scaleImageValue)
Sets the image scale type. |
|
void |
setUsingCache(boolean isUsingCache)
|
|
void |
setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
Gets the text vertical alignment. |
Methods inherited from class net.sf.jasperreports.engine.base.JRBasePrintGraphicElement |
---|
copyPen, getDefaultLineColor, getFillValue, getLinePen, getOwnFillValue, setFill |
Methods inherited from class net.sf.jasperreports.engine.base.JRBasePrintElement |
---|
getBackcolor, getDefaultStyleProvider, getForecolor, getHeight, getKey, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPropertiesMap, getSourceElementId, getStyle, getStyleNameReference, getUUID, getWidth, getX, getY, hasProperties, setBackcolor, setForecolor, setHeight, setKey, setMode, setOrigin, setSourceElementId, setStyle, setWidth, setX, setY |
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 |
---|
setFill |
Methods inherited from interface net.sf.jasperreports.engine.JRPrintElement |
---|
getHeight, getKey, getOrigin, getSourceElementId, getWidth, getX, getY, setHeight, 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 |
---|
getFillValue, getLinePen, getOwnFillValue |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
---|
getBackcolor, getForecolor, getOwnBackcolor, getOwnForecolor, getOwnModeValue, setBackcolor, setForecolor, setMode |
Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable |
---|
getUUID |
Methods inherited from interface net.sf.jasperreports.engine.JRPenContainer |
---|
getDefaultLineColor |
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 Renderable renderable
protected ScaleImageEnum scaleImageValue
protected java.lang.Boolean isUsingCache
protected HorizontalAlignEnum horizontalAlignmentValue
protected VerticalAlignEnum verticalAlignmentValue
protected boolean isLazy
protected OnErrorTypeEnum onErrorTypeValue
protected JRLineBox lineBox
protected java.lang.String anchorName
protected java.lang.String linkType
protected java.lang.String linkTarget
protected java.lang.String hyperlinkReference
protected java.lang.String hyperlinkAnchor
protected java.lang.Integer hyperlinkPage
protected java.lang.String hyperlinkTooltip
protected JRPrintHyperlinkParameters hyperlinkParameters
protected int bookmarkLevel
JRAnchor.getBookmarkLevel()
Constructor Detail |
---|
public JRBasePrintImage(JRDefaultStyleProvider defaultStyleProvider)
Method Detail |
---|
public ModeEnum getModeValue()
JRCommonElement
getModeValue
in interface JRCommonElement
getModeValue
in class JRBasePrintElement
public Renderable getRenderable()
getRenderable
in interface JRPrintImage
public void setRenderable(Renderable renderable)
setRenderable
in interface JRPrintImage
public JRRenderable getRenderer()
getRenderable()
.
getRenderer
in interface JRPrintImage
public void setRenderer(JRRenderable renderer)
setRenderable(Renderable)
.
setRenderer
in interface JRPrintImage
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
setScaleImage
in interface JRPrintImage
scaleImageValue
- a value representing one of the scale type constants in ScaleImageEnum
public boolean isUsingCache()
isUsingCache
in interface JRPrintImage
public void setUsingCache(boolean isUsingCache)
setUsingCache
in interface JRPrintImage
public HorizontalAlignEnum getHorizontalAlignmentValue()
JRAlignment
getHorizontalAlignmentValue
in interface JRAlignment
HorizontalAlignEnum
public HorizontalAlignEnum getOwnHorizontalAlignmentValue()
getOwnHorizontalAlignmentValue
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 VerticalAlignEnum getVerticalAlignmentValue()
JRAlignment
getVerticalAlignmentValue
in interface JRAlignment
VerticalAlignEnum
public VerticalAlignEnum getOwnVerticalAlignmentValue()
getOwnVerticalAlignmentValue
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()
isLazy
in interface JRPrintImage
public void setLazy(boolean isLazy)
setLazy
in interface JRPrintImage
public OnErrorTypeEnum getOnErrorTypeValue()
getOnErrorTypeValue
in interface JRPrintImage
public void setOnErrorType(OnErrorTypeEnum onErrorTypeValue)
setOnErrorType
in interface JRPrintImage
public JRLineBox getLineBox()
getLineBox
in interface JRBoxContainer
public void copyBox(JRLineBox lineBox)
public java.lang.Float getDefaultLineWidth()
getDefaultLineWidth
in interface JRPenContainer
getDefaultLineWidth
in class JRBasePrintGraphicElement
public java.lang.String getAnchorName()
getAnchorName
in interface JRPrintAnchor
public void setAnchorName(java.lang.String anchorName)
setAnchorName
in interface JRPrintAnchor
public HyperlinkTypeEnum getHyperlinkTypeValue()
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, CUSTOM
is returned.
getHyperlinkTypeValue
in interface JRPrintHyperlink
JRPrintHyperlink.getLinkType()
public void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
JRPrintHyperlink
setHyperlinkType
in interface JRPrintHyperlink
hyperlinkType
- the built-in hyperlink typeJRPrintHyperlink.getLinkType()
public HyperlinkTargetEnum getHyperlinkTargetValue()
getHyperlinkTargetValue
in interface JRPrintHyperlink
public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
setHyperlinkTarget
in interface JRPrintHyperlink
public java.lang.String getHyperlinkReference()
getHyperlinkReference
in interface JRPrintHyperlink
public void setHyperlinkReference(java.lang.String hyperlinkReference)
setHyperlinkReference
in interface JRPrintHyperlink
public java.lang.String getHyperlinkAnchor()
getHyperlinkAnchor
in interface JRPrintHyperlink
public void setHyperlinkAnchor(java.lang.String hyperlinkAnchor)
setHyperlinkAnchor
in interface JRPrintHyperlink
public java.lang.Integer getHyperlinkPage()
getHyperlinkPage
in interface JRPrintHyperlink
public void setHyperlinkPage(java.lang.Integer hyperlinkPage)
setHyperlinkPage
in interface JRPrintHyperlink
public void setHyperlinkPage(java.lang.String hyperlinkPage)
public int getBookmarkLevel()
JRPrintAnchor
getBookmarkLevel
in interface JRPrintAnchor
NO_BOOKMARK
if no bookmark should be created for this anchorpublic void setBookmarkLevel(int bookmarkLevel)
JRPrintAnchor
setBookmarkLevel
in interface JRPrintAnchor
bookmarkLevel
- the bookmark level (starting from 1)
or NO_BOOKMARK
if no bookmark should be createdpublic JRPrintHyperlinkParameters getHyperlinkParameters()
JRPrintHyperlink
getHyperlinkParameters
in interface JRPrintHyperlink
JRPrintHyperlink.setHyperlinkParameters(JRPrintHyperlinkParameters)
,
JRPrintHyperlinkParameter
public void setHyperlinkParameters(JRPrintHyperlinkParameters hyperlinkParameters)
JRPrintHyperlink
These parameters will be used to produce the actual hyperlink when the report is exported.
setHyperlinkParameters
in interface JRPrintHyperlink
hyperlinkParameters
- the set of custom hyperlink parameterspublic void addHyperlinkParameter(JRPrintHyperlinkParameter parameter)
parameter
- the parameter to addgetHyperlinkParameters()
,
JRPrintHyperlinkParameters.addParameter(JRPrintHyperlinkParameter)
public java.lang.String getLinkType()
JRPrintHyperlink
getLinkType
in interface JRPrintHyperlink
public void setLinkType(java.lang.String linkType)
JRPrintHyperlink
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
setLinkType
in interface JRPrintHyperlink
linkType
- the hyperlink typepublic java.lang.String getLinkTarget()
JRPrintHyperlink
The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget
in interface JRPrintHyperlink
public void setLinkTarget(java.lang.String linkTarget)
JRPrintHyperlink
The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
setLinkTarget
in interface JRPrintHyperlink
linkTarget
- the hyperlink target namepublic java.lang.String getHyperlinkTooltip()
JRPrintHyperlink
getHyperlinkTooltip
in interface JRPrintHyperlink
public void setHyperlinkTooltip(java.lang.String hyperlinkTooltip)
JRPrintHyperlink
setHyperlinkTooltip
in interface JRPrintHyperlink
hyperlinkTooltip
- the tooltippublic <T> void accept(PrintElementVisitor<T> visitor, T arg)
JRPrintElement
The element calls the method that corresponds to the element type on the visitor.
accept
in interface JRPrintElement
accept
in class JRBasePrintElement
T
- the type of the argument passed to the visit operationvisitor
- the visitor objectsarg
- the argument passed to the visit operation
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |