|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JRImage
An abstract representation of a graphic element representing an image. Images can be aligned and scaled. They can also contain hyperlinks or be anchors for other hyperlinks.
Field Summary | |
---|---|
static byte |
ON_ERROR_TYPE_BLANK
Deprecated. Replaced by OnErrorTypeEnum.BLANK . |
static byte |
ON_ERROR_TYPE_ERROR
Deprecated. Replaced by OnErrorTypeEnum.ERROR . |
static byte |
ON_ERROR_TYPE_ICON
Deprecated. Replaced by OnErrorTypeEnum.ICON . |
static byte |
SCALE_IMAGE_CLIP
Deprecated. Replaced by ScaleImageEnum.CLIP . |
static byte |
SCALE_IMAGE_FILL_FRAME
Deprecated. Replaced by ScaleImageEnum.FILL_FRAME . |
static byte |
SCALE_IMAGE_REAL_HEIGHT
Deprecated. Replaced by ScaleImageEnum.REAL_HEIGHT . |
static byte |
SCALE_IMAGE_REAL_SIZE
Deprecated. Replaced by ScaleImageEnum.REAL_SIZE . |
static byte |
SCALE_IMAGE_RETAIN_SHAPE
Deprecated. Replaced by ScaleImageEnum.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_CUSTOM, HYPERLINK_TARGET_PARENT, HYPERLINK_TARGET_SELF, HYPERLINK_TARGET_TOP, HYPERLINK_TYPE_CUSTOM, HYPERLINK_TYPE_LOCAL_ANCHOR, HYPERLINK_TYPE_LOCAL_PAGE, HYPERLINK_TYPE_NONE, HYPERLINK_TYPE_NULL, 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 |
Method Summary | |
---|---|
JRBox |
getBox()
Deprecated. Replaced by JRBoxContainer.getLineBox() |
JRGroup |
getEvaluationGroup()
Gets the evaluation group for this text field. |
byte |
getEvaluationTime()
Deprecated. Replaced by getEvaluationTimeValue() . |
EvaluationTimeEnum |
getEvaluationTimeValue()
Indicates the evaluation time for this image. |
JRExpression |
getExpression()
|
byte |
getOnErrorType()
Deprecated. Replaced by getOnErrorTypeValue() . |
OnErrorTypeEnum |
getOnErrorTypeValue()
Indicates how the engine will treat a missing image. |
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 |
setLazy(boolean isLazy)
Gives control over when the images are retrieved from their specified location. |
void |
setOnErrorType(byte onErrorType)
Deprecated. Replaced by setOnErrorType(OnErrorTypeEnum) . |
void |
setOnErrorType(OnErrorTypeEnum onErrorTypeEnum)
Specifies how the engine should treat a missing image. |
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. |
Methods inherited from interface net.sf.jasperreports.engine.JRGraphicElement |
---|
getOwnPen, getPen, setPen, setPen |
Methods inherited from interface net.sf.jasperreports.engine.JRElement |
---|
collectExpressions, getElementGroup, getKey, getPositionType, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setStretchType, setWidth, setX |
Methods inherited from interface net.sf.jasperreports.engine.JRChild |
---|
clone |
Methods inherited from interface net.sf.jasperreports.engine.JRVisitable |
---|
visit |
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable |
---|
clone |
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Methods inherited from interface net.sf.jasperreports.engine.JRAnchor |
---|
getAnchorNameExpression, getBookmarkLevel |
Methods inherited from interface net.sf.jasperreports.engine.JRHyperlink |
---|
getHyperlinkAnchorExpression, getHyperlinkPageExpression, getHyperlinkParameters, getHyperlinkReferenceExpression, getHyperlinkTarget, getHyperlinkTooltipExpression, getHyperlinkType, getHyperlinkTypeValue, getLinkTarget, getLinkType |
Methods inherited from interface net.sf.jasperreports.engine.JRAlignment |
---|
getHorizontalAlignment, getHorizontalAlignmentValue, getOwnHorizontalAlignment, getOwnHorizontalAlignmentValue, getOwnVerticalAlignment, getOwnVerticalAlignmentValue, getVerticalAlignment, getVerticalAlignmentValue, setHorizontalAlignment, setHorizontalAlignment, setHorizontalAlignment, setVerticalAlignment, setVerticalAlignment, setVerticalAlignment |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonImage |
---|
getOwnScaleImage, getOwnScaleImageValue, getScaleImage, getScaleImageValue, setScaleImage, setScaleImage, setScaleImage |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonGraphicElement |
---|
getFill, getFillValue, getLinePen, getOwnFill, getOwnFillValue, setFill, setFill, setFill |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
---|
getBackcolor, getForecolor, getHeight, getMode, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode, setMode, setMode |
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, getLineBox |
Field Detail |
---|
static final byte SCALE_IMAGE_CLIP
ScaleImageEnum.CLIP
.static final byte SCALE_IMAGE_FILL_FRAME
ScaleImageEnum.FILL_FRAME
.static final byte SCALE_IMAGE_RETAIN_SHAPE
ScaleImageEnum.RETAIN_SHAPE
.static final byte SCALE_IMAGE_REAL_HEIGHT
ScaleImageEnum.REAL_HEIGHT
.static final byte SCALE_IMAGE_REAL_SIZE
ScaleImageEnum.REAL_SIZE
.static final byte ON_ERROR_TYPE_ERROR
OnErrorTypeEnum.ERROR
.static final byte ON_ERROR_TYPE_BLANK
OnErrorTypeEnum.BLANK
.static final byte ON_ERROR_TYPE_ICON
OnErrorTypeEnum.ICON
.Method Detail |
---|
boolean isUsingCache()
java.lang.Boolean isOwnUsingCache()
void setUsingCache(boolean isUsingCache)
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.
void setUsingCache(java.lang.Boolean isUsingCache)
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.
boolean isLazy()
void setLazy(boolean isLazy)
isLazy
- specifies whetherbyte getOnErrorType()
getOnErrorTypeValue()
.
void setOnErrorType(byte onErrorType)
setOnErrorType(OnErrorTypeEnum)
.
OnErrorTypeEnum getOnErrorTypeValue()
OnErrorTypeEnum
void setOnErrorType(OnErrorTypeEnum onErrorTypeEnum)
onErrorTypeEnum
- a value representing one of the missing image handling constants in OnErrorTypeEnum
byte getEvaluationTime()
getEvaluationTimeValue()
.
EvaluationTimeEnum getEvaluationTimeValue()
EvaluationTimeEnum
JRGroup getEvaluationGroup()
EvaluationTimeEnum.GROUP
JRExpression getExpression()
JRBox getBox()
JRBoxContainer.getLineBox()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |