public class JRDesignImage extends JRDesignGraphicElement implements JRImage
fillValue, linePenPROPERTY_ELEMENT_GROUP, PROPERTY_HEIGHT, PROPERTY_KEY, PROPERTY_PARENT_STYLE, PROPERTY_PARENT_STYLE_NAME_REFERENCE, PROPERTY_PRINT_WHEN_EXPRESSION, PROPERTY_PRINT_WHEN_GROUP_CHANGES, PROPERTY_PROPERTY_EXPRESSIONS, PROPERTY_Ybackcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, modeValue, parentStyle, parentStyleNameReference, positionTypeValue, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchTypeValue, uuid, width, x, yNO_BOOKMARK| Constructor and Description |
|---|
JRDesignImage(JRDefaultStyleProvider defaultStyleProvider) |
| Modifier and Type | Method and Description |
|---|---|
void |
addHyperlinkParameter(JRHyperlinkParameter parameter)
Adds a custom hyperlink parameter.
|
Object |
clone() |
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.
|
Float |
getDefaultLineWidth() |
JRGroup |
getEvaluationGroup()
Gets the evaluation group for this text field.
|
EvaluationTimeEnum |
getEvaluationTimeValue()
Gets the evaluation time for this text field.
|
JRExpression |
getExpression() |
HorizontalAlignEnum |
getHorizontalAlignmentValue()
Deprecated.
Replaced by
getHorizontalImageAlign(). |
HorizontalImageAlignEnum |
getHorizontalImageAlign()
Gets the image horizontal alignment.
|
JRExpression |
getHyperlinkAnchorExpression()
Returns the expression whose value represents the anchor.
|
JRExpression |
getHyperlinkPageExpression()
Returns an integer representing the page index of the link.
|
JRHyperlinkParameter[] |
getHyperlinkParameters()
Returns the list of hyperlink parameters.
|
List<JRHyperlinkParameter> |
getHyperlinkParametersList()
Returns the list of custom hyperlink parameters.
|
JRExpression |
getHyperlinkReferenceExpression()
Returns the expression whose value represents the hyperlink reference.
|
byte |
getHyperlinkTarget()
Retrieves the hyperlink target for the element.
|
JRExpression |
getHyperlinkTooltipExpression()
Returns the expression which will generate the hyperlink tooltip.
|
byte |
getHyperlinkType()
Deprecated.
Replaced by
getHyperlinkTypeValue(). |
HyperlinkTypeEnum |
getHyperlinkTypeValue()
Retrieves the hyperlink type for the element.
|
JRExpression |
getHyperlinkWhenExpression()
Returns the expression that is evaluated in order to decide if the hyperlink should be displayed.
|
JRLineBox |
getLineBox() |
String |
getLinkTarget()
Returns the hyperlink target name.
|
String |
getLinkType()
Returns the hyperlink type.
|
ModeEnum |
getModeValue()
Returns the element transparency mode.
|
OnErrorTypeEnum |
getOnErrorTypeValue()
Indicates how the engine will treat a missing image.
|
HorizontalAlignEnum |
getOwnHorizontalAlignmentValue()
Deprecated.
Replaced by
getOwnHorizontalImageAlign(). |
HorizontalImageAlignEnum |
getOwnHorizontalImageAlign() |
ScaleImageEnum |
getOwnScaleImageValue()
Gets the image own scale type.
|
VerticalAlignEnum |
getOwnVerticalAlignmentValue()
Deprecated.
Replaced by
getOwnVerticalImageAlign(). |
VerticalImageAlignEnum |
getOwnVerticalImageAlign() |
ScaleImageEnum |
getScaleImageValue()
Gets the image scale type.
|
Boolean |
getUsingCache()
Indicates if the engine is loading the current image from cache.
|
VerticalAlignEnum |
getVerticalAlignmentValue()
Deprecated.
Replaced by
getVerticalImageAlign(). |
VerticalImageAlignEnum |
getVerticalImageAlign()
Gets the image vertical alignment.
|
boolean |
isLazy()
Indicates if the images will be loaded lazily or not.
|
Boolean |
isOwnUsingCache()
Deprecated.
Replaced by
getUsingCache(). |
boolean |
isUsingCache()
Deprecated.
Replaced by
getUsingCache(). |
void |
removeHyperlinkParameter(JRHyperlinkParameter parameter)
Removes a custom hyperlink parameter.
|
void |
removeHyperlinkParameter(String parameterName)
Removes a custom hyperlink parameter.
|
void |
setAnchorNameExpression(JRExpression anchorNameExpression) |
void |
setBookmarkLevel(int bookmarkLevel)
Sets the boomark level for the anchor associated with this image.
|
void |
setEvaluationGroup(JRGroup evaluationGroup) |
void |
setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
Sets the evaluation time for this image.
|
void |
setExpression(JRExpression expression) |
void |
setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
Deprecated.
Replaced by
setHorizontalImageAlign(HorizontalImageAlignEnum). |
void |
setHorizontalImageAlign(HorizontalImageAlignEnum horizontalImageAlign)
Sets the image horizontal alignment.
|
void |
setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression) |
void |
setHyperlinkPageExpression(JRExpression hyperlinkPageExpression) |
void |
setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression) |
void |
setHyperlinkTarget(byte hyperlinkTarget)
Deprecated.
Replaced by
setHyperlinkTarget(HyperlinkTargetEnum). |
void |
setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget) |
void |
setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
Sets the expression which will be used to generate the hyperlink tooltip.
|
void |
setHyperlinkType(byte hyperlinkType)
Deprecated.
Replaced by
setHyperlinkType(HyperlinkTypeEnum). |
void |
setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
Sets the link type as a built-in hyperlink type.
|
void |
setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression) |
void |
setLazy(boolean isLazy)
Gives control over when the images are retrieved from their specified location.
|
void |
setLinkTarget(String target)
Sets the hyperlink target name.
|
void |
setLinkType(String type)
Sets the hyperlink type.
|
void |
setOnErrorType(OnErrorTypeEnum onErrorTypeValue)
Specifies how the engine should treat a missing image.
|
void |
setScaleImage(ScaleImageEnum scaleImageValue)
Sets the image scale type.
|
void |
setUsingCache(boolean isUsingCache)
Specifies if the engine should be loading the current image from cache.
|
void |
setUsingCache(Boolean isUsingCache)
Specifies if the engine should be loading the current image from cache.
|
void |
setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
Deprecated.
Replaced by
setVerticalImageAlign(VerticalImageAlignEnum). |
void |
setVerticalImageAlign(VerticalImageAlignEnum verticalImageAlign)
Gets the image vertical alignment.
|
void |
visit(JRVisitor visitor) |
getDefaultLineColor, getFillValue, getLinePen, getOwnFillValue, setFilladdPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleNameReference, setUUID, setYclone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getStretchTypeValue, getStyle, getStyleNameReference, getStyleResolver, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclone, getElementGroup, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXgetParentProperties, getPropertiesMap, hasPropertiesgetUUIDgetFillValue, getLinePen, getOwnFillValue, setFillgetBackcolor, getForecolor, getHeight, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setModegetDefaultLineColorgetDefaultStyleProvider, getStyle, getStyleNameReferencegetDefaultLineColorpublic static final String PROPERTY_ANCHOR_NAME_EXPRESSION
public static final String PROPERTY_BOOKMARK_LEVEL
public static final String PROPERTY_EVALUATION_GROUP
public static final String PROPERTY_EVALUATION_TIME
public static final String PROPERTY_EXPRESSION
protected ScaleImageEnum scaleImageValue
protected HorizontalImageAlignEnum horizontalImageAlign
protected VerticalImageAlignEnum verticalImageAlign
protected Boolean isUsingCache
protected boolean isLazy
protected OnErrorTypeEnum onErrorTypeValue
protected EvaluationTimeEnum evaluationTimeValue
protected String linkType
protected String linkTarget
protected JRLineBox lineBox
protected JRGroup evaluationGroup
protected JRExpression expression
protected JRExpression anchorNameExpression
protected JRExpression hyperlinkReferenceExpression
protected JRExpression hyperlinkWhenExpression
protected JRExpression hyperlinkAnchorExpression
protected JRExpression hyperlinkPageExpression
protected int bookmarkLevel
JRAnchor.getBookmarkLevel()public JRDesignImage(JRDefaultStyleProvider defaultStyleProvider)
public ModeEnum getModeValue()
JRCommonElementgetModeValue in interface JRCommonElementgetModeValue in class JRBaseElementpublic 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 HorizontalAlignEnum getHorizontalAlignmentValue()
getHorizontalImageAlign().JRAlignmentgetHorizontalAlignmentValue in interface JRAlignmentHorizontalAlignEnumpublic HorizontalAlignEnum getOwnHorizontalAlignmentValue()
getOwnHorizontalImageAlign().getOwnHorizontalAlignmentValue in interface JRAlignmentpublic void setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
setHorizontalImageAlign(HorizontalImageAlignEnum).JRAlignmentsetHorizontalAlignment in interface JRAlignmenthorizontalAlignmentValue - a value representing one of the horizontal alignment constants in HorizontalAlignEnumpublic VerticalAlignEnum getVerticalAlignmentValue()
getVerticalImageAlign().JRAlignmentgetVerticalAlignmentValue in interface JRAlignmentVerticalAlignEnumpublic VerticalAlignEnum getOwnVerticalAlignmentValue()
getOwnVerticalImageAlign().getOwnVerticalAlignmentValue in interface JRAlignmentpublic void setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
setVerticalImageAlign(VerticalImageAlignEnum).JRAlignmentsetVerticalAlignment in interface JRAlignmentverticalAlignmentValue - a value representing one of the vertical alignment constants in VerticalAlignEnumpublic HorizontalImageAlignEnum getHorizontalImageAlign()
JRImageAlignmentgetHorizontalImageAlign in interface JRImageAlignmentHorizontalImageAlignEnumpublic HorizontalImageAlignEnum getOwnHorizontalImageAlign()
getOwnHorizontalImageAlign in interface JRImageAlignmentpublic void setHorizontalImageAlign(HorizontalImageAlignEnum horizontalImageAlign)
JRImageAlignmentsetHorizontalImageAlign in interface JRImageAlignmenthorizontalImageAlign - a value representing one of the horizontal image alignment constants in HorizontalImageAlignEnumpublic VerticalImageAlignEnum getVerticalImageAlign()
JRImageAlignmentgetVerticalImageAlign in interface JRImageAlignmentVerticalImageAlignEnumpublic VerticalImageAlignEnum getOwnVerticalImageAlign()
getOwnVerticalImageAlign in interface JRImageAlignmentpublic void setVerticalImageAlign(VerticalImageAlignEnum verticalImageAlign)
JRImageAlignmentsetVerticalImageAlign in interface JRImageAlignmentverticalImageAlign - a value representing one of the vertical image alignment constants in VerticalImageAlignEnumpublic boolean isUsingCache()
getUsingCache().JRImageisUsingCache in interface JRImagepublic Boolean isOwnUsingCache()
getUsingCache().isOwnUsingCache in interface JRImagepublic Boolean getUsingCache()
JRImagegetUsingCache in interface JRImagepublic EvaluationTimeEnum getEvaluationTimeValue()
JREvaluationgetEvaluationTimeValue in interface JREvaluationJRExpressionpublic JRLineBox getLineBox()
getLineBox in interface JRBoxContainerpublic byte getHyperlinkType()
getHyperlinkTypeValue().public HyperlinkTypeEnum getHyperlinkTypeValue()
JRHyperlink
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 JRHyperlinkJRHyperlink.getLinkType()public byte getHyperlinkTarget()
JRHyperlink
The actual hyperlink target is determined by getLinkTarget().
This method can is used to determine whether the hyperlink target is one of the
built-in target names or a custom one.
When hyperlink has a custom target name, HyperlinkTargetEnum.CUSTOM is returned.
getHyperlinkTarget in interface JRHyperlinkJRHyperlink.getLinkTarget()public JRGroup getEvaluationGroup()
JREvaluationgetEvaluationGroup in interface JREvaluationEvaluationTimeEnum.GROUPpublic JRExpression getExpression()
getExpression in interface JRImagepublic JRExpression getAnchorNameExpression()
JRAnchorgetAnchorNameExpression in interface JRAnchorpublic JRExpression getHyperlinkReferenceExpression()
JRHyperlinkgetHyperlinkReferenceExpression in interface JRHyperlinkpublic JRExpression getHyperlinkWhenExpression()
JRHyperlinkgetHyperlinkWhenExpression in interface JRHyperlinkpublic JRExpression getHyperlinkAnchorExpression()
JRHyperlinkgetHyperlinkAnchorExpression in interface JRHyperlinkpublic JRExpression getHyperlinkPageExpression()
JRHyperlinkgetHyperlinkPageExpression in interface JRHyperlinkpublic void setUsingCache(boolean isUsingCache)
JRImageFor 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 JRImagepublic void setUsingCache(Boolean isUsingCache)
JRImageIf 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 JRImagepublic boolean isLazy()
JRImagepublic void setLazy(boolean isLazy)
JRImagepublic OnErrorTypeEnum getOnErrorTypeValue()
JRImagegetOnErrorTypeValue in interface JRImageOnErrorTypeEnumpublic void setOnErrorType(OnErrorTypeEnum onErrorTypeValue)
JRImagesetOnErrorType in interface JRImageonErrorTypeValue - a value representing one of the missing image handling constants in OnErrorTypeEnumpublic void setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
public void setHyperlinkType(byte hyperlinkType)
setHyperlinkType(HyperlinkTypeEnum).public void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
hyperlinkType - the built-in hyperlink typegetLinkType()public void setHyperlinkTarget(byte hyperlinkTarget)
setHyperlinkTarget(HyperlinkTargetEnum).public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
public void setEvaluationGroup(JRGroup evaluationGroup)
public void setExpression(JRExpression expression)
public void setAnchorNameExpression(JRExpression anchorNameExpression)
public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
public void setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression)
public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
public void visit(JRVisitor visitor)
visit in interface JRVisitablepublic void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic int getBookmarkLevel()
JRAnchorgetBookmarkLevel in interface JRAnchorNO_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 createdpublic Float getDefaultLineWidth()
getDefaultLineWidth in interface JRPenContainergetDefaultLineWidth in class JRDesignGraphicElementpublic String getLinkType()
JRHyperlinkThe type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
getLinkType in interface JRHyperlinkpublic String getLinkTarget()
JRHyperlinkThe type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget in interface JRHyperlinkpublic void setLinkType(String type)
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
type - the hyperlink typepublic void setLinkTarget(String target)
The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
target - the hyperlink target namepublic JRHyperlinkParameter[] getHyperlinkParameters()
JRHyperlinkThe parameters can be used by custom hyperlink types to generate dynamic links.
getHyperlinkParameters in interface JRHyperlinkpublic List<JRHyperlinkParameter> getHyperlinkParametersList()
public void addHyperlinkParameter(JRHyperlinkParameter parameter)
parameter - the parameter to addpublic void removeHyperlinkParameter(JRHyperlinkParameter parameter)
parameter - the parameter to removepublic void removeHyperlinkParameter(String parameterName)
If multiple parameters having the specified name exist, all of them will be removed
parameterName - the parameter namepublic JRExpression getHyperlinkTooltipExpression()
JRHyperlinkgetHyperlinkTooltipExpression in interface JRHyperlinkpublic void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
hyperlinkTooltipExpression - the expression which will be used to generate the hyperlink tooltipgetHyperlinkTooltipExpression()public Object clone()
clone in interface JRCloneableclone in class JRDesignGraphicElementCopyright © 2017. All rights reserved.