|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseElement
net.sf.jasperreports.engine.design.JRDesignElement
net.sf.jasperreports.engine.design.JRDesignGraphicElement
net.sf.jasperreports.engine.design.JRDesignImage
The actual implementation of a graphic element representing an image, used at design time.
Field Summary | |
protected JRExpression |
anchorNameExpression
|
protected int |
bookmarkLevel
The bookmark level for the anchor associated with this image. |
protected JRBox |
box
|
protected JRGroup |
evaluationGroup
|
protected byte |
evaluationTime
|
protected JRExpression |
expression
|
protected 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 byte |
onErrorType
|
protected byte |
scaleImage
|
protected byte |
verticalAlignment
|
Fields inherited from class net.sf.jasperreports.engine.design.JRDesignGraphicElement |
fill, pen |
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement |
backcolor, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, 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_LOCAL_ANCHOR, HYPERLINK_TYPE_LOCAL_PAGE, HYPERLINK_TYPE_NONE, 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 | |
JRDesignImage()
|
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. |
JRBox |
getBox()
Returns an object containing all border and padding properties for this text element |
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 horizontal alignment of the element. |
JRExpression |
getHyperlinkAnchorExpression()
Returns the expression whose value represents the anchor. |
JRExpression |
getHyperlinkPageExpression()
Returns an integer representing the page index of the link. |
JRExpression |
getHyperlinkReferenceExpression()
Returns the expression whose value represents the hyperlink reference. |
byte |
getHyperlinkTarget()
Retrieves the hyperlink target for the element. |
byte |
getHyperlinkType()
Retrieves the hyperlink type for the element. |
byte |
getOnErrorType()
Indicates how the engine will treat a missing image. |
byte |
getScaleImage()
Gets the image scale type. |
byte |
getVerticalAlignment()
Gets the vertical alignment of the element. |
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. |
void |
setAnchorNameExpression(JRExpression anchorNameExpression)
|
void |
setBookmarkLevel(int bookmarkLevel)
Sets the boomark level for the anchor associated with this image. |
void |
setBox(JRBox box)
|
void |
setEvaluationGroup(JRGroup evaluationGroup)
|
void |
setEvaluationTime(byte evaluationTime)
Sets the evaluation time for this image. |
void |
setExpression(JRExpression expression)
|
void |
setHorizontalAlignment(byte horizontalAlignment)
Sets the horizontal alignment of the element. |
void |
setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
|
void |
setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
|
void |
setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
|
void |
setHyperlinkTarget(byte hyperlinkTarget)
|
void |
setHyperlinkType(byte hyperlinkType)
|
void |
setLazy(boolean isLazy)
Gives control over when the images are retrieved from their specified location. |
void |
setOnErrorType(byte onErrorType)
Specifies how the engine should treat a missing image. |
void |
setScaleImage(byte scaleImage)
Sets the image scale type. |
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)
Sets the vertical alignment of the element. |
void |
writeXml(JRXmlWriter xmlWriter)
|
Methods inherited from class net.sf.jasperreports.engine.design.JRDesignGraphicElement |
getFill, getPen, setFill, setPen |
Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElement |
setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setY |
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement |
getBackcolor, getElementGroup, getForecolor, getHeight, getKey, getMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, 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, getPen, setFill, setPen |
Methods inherited from interface net.sf.jasperreports.engine.JRElement |
getBackcolor, getElementGroup, getForecolor, getHeight, getKey, getMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX |
Field Detail |
protected byte scaleImage
protected byte horizontalAlignment
protected byte verticalAlignment
protected java.lang.Boolean isUsingCache
protected boolean isLazy
protected byte onErrorType
protected byte evaluationTime
protected byte hyperlinkType
protected byte hyperlinkTarget
protected JRBox box
protected JRGroup evaluationGroup
protected JRExpression expression
protected JRExpression anchorNameExpression
protected JRExpression hyperlinkReferenceExpression
protected JRExpression hyperlinkAnchorExpression
protected JRExpression hyperlinkPageExpression
protected int bookmarkLevel
JRAnchor.getBookmarkLevel()
Constructor Detail |
public JRDesignImage()
Method Detail |
public byte getScaleImage()
JRImage
getScaleImage
in interface JRImage
public byte getHorizontalAlignment()
JRImage
getHorizontalAlignment
in interface JRImage
JRAlignment
public byte getVerticalAlignment()
JRImage
getVerticalAlignment
in interface JRImage
JRAlignment
public boolean isUsingCache()
JRImage
isUsingCache
in interface JRImage
public java.lang.Boolean isOwnUsingCache()
JRImage
isOwnUsingCache
in interface JRImage
public byte getEvaluationTime()
JRImage
getEvaluationTime
in interface JRImage
JRExpression
public JRBox getBox()
JRImage
getBox
in interface JRImage
public byte getHyperlinkType()
JRHyperlink
getHyperlinkType
in interface JRHyperlink
public byte getHyperlinkTarget()
JRHyperlink
getHyperlinkTarget
in interface JRHyperlink
public JRGroup getEvaluationGroup()
JRImage
getEvaluationGroup
in interface JRImage
JRExpression
public JRExpression getExpression()
JRImage
getExpression
in interface JRImage
JRExpression.EVALUATION_TIME_GROUP
public JRExpression getAnchorNameExpression()
JRAnchor
getAnchorNameExpression
in interface JRAnchor
public JRExpression getHyperlinkReferenceExpression()
JRHyperlink
getHyperlinkReferenceExpression
in interface JRHyperlink
public JRExpression getHyperlinkAnchorExpression()
JRHyperlink
getHyperlinkAnchorExpression
in interface JRHyperlink
public JRExpression getHyperlinkPageExpression()
JRHyperlink
getHyperlinkPageExpression
in interface JRHyperlink
public void setScaleImage(byte scaleImage)
JRImage
setScaleImage
in interface JRImage
scaleImage
- one of the scale constants in this classpublic void setHorizontalAlignment(byte horizontalAlignment)
JRImage
setHorizontalAlignment
in interface JRImage
horizontalAlignment
- one of the alignment values defined in JRAlignment
public void setVerticalAlignment(byte verticalAlignment)
JRImage
setVerticalAlignment
in interface JRImage
verticalAlignment
- one of the alignment values defined in JRAlignment
public void setUsingCache(boolean isUsingCache)
JRImage
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.
setUsingCache
in interface JRImage
public void setUsingCache(java.lang.Boolean isUsingCache)
JRImage
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.
setUsingCache
in interface JRImage
public boolean isLazy()
JRImage
isLazy
in interface JRImage
public void setLazy(boolean isLazy)
JRImage
setLazy
in interface JRImage
isLazy
- specifies whetherpublic byte getOnErrorType()
JRImage
getOnErrorType
in interface JRImage
public void setOnErrorType(byte onErrorType)
JRImage
setOnErrorType
in interface JRImage
onErrorType
- one of the constants for missing image error typespublic void setEvaluationTime(byte evaluationTime)
public void setBox(JRBox box)
public void setHyperlinkType(byte hyperlinkType)
public void setHyperlinkTarget(byte hyperlinkTarget)
public void setEvaluationGroup(JRGroup evaluationGroup)
public void setExpression(JRExpression expression)
public void setAnchorNameExpression(JRExpression anchorNameExpression)
public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
public JRChild getCopy(JRAbstractObjectFactory factory)
getCopy
in interface JRChild
public void collectExpressions(JRExpressionCollector collector)
collectExpressions
in interface JRElement
public void writeXml(JRXmlWriter xmlWriter)
writeXml
in interface JRChild
public int getBookmarkLevel()
JRAnchor
getBookmarkLevel
in interface JRAnchor
NO_BOOKMARK
if no bookmark should be created for this anchorpublic void setBookmarkLevel(int bookmarkLevel)
bookmarkLevel
- the bookmark level (starting from 1)
or NO_BOOKMARK
if no bookmark should be created
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |