public class JRFillImage extends JRFillGraphicElement implements JRImage
| Modifier and Type | Field and Description |
|---|---|
static String |
EXCEPTION_MESSAGE_KEY_UNKNOWN_SOURCE_CLASS |
protected JRLineBox |
initLineBox |
protected JRLineBox |
lineBox |
initPen, penband, conditionalStylesContainer, currentEvaluation, currentStyle, defaultStyleProvider, delayedEvaluationsMap, dynamicProperties, dynamicTransferProperties, elementGroup, expressionEvaluator, fillContainerContext, filler, initStyle, mergedProperties, originProvider, parent, printElementOriginator, printWhenGroupChanges, propertyExpressions, providerStyle, staticProperties, styleProviders, templatesNO_BOOKMARK| Modifier | Constructor and Description |
|---|---|
protected |
JRFillImage(JRBaseFiller filler,
JRImage image,
JRFillObjectFactory factory) |
protected |
JRFillImage(JRFillImage image,
JRFillCloneFactory factory) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
collectDelayedEvaluations() |
void |
collectExpressions(JRExpressionCollector collector) |
protected void |
copy(JRPrintImage printImage) |
JRFillCloneable |
createClone(JRFillCloneFactory factory)
Creates a working clone of itself.
|
protected JRTemplateElement |
createElementTemplate() |
protected void |
evaluate(byte evaluation) |
protected void |
evaluateImage(byte evaluation) |
protected void |
evaluateStyle(byte evaluation) |
protected JRPrintElement |
fill() |
protected boolean |
fitImage(Dimension2D imageSize,
int availableHeight,
boolean overflowAllowed,
HorizontalImageAlignEnum hAlign) |
protected String |
getAnchorName() |
JRExpression |
getAnchorNameExpression()
Returns an expression whose value represents the anchor name.
|
int |
getBookmarkLevel()
Returns the level of the bookmark corresponding to the anchor.
|
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.
|
protected String |
getHyperlinkAnchor() |
JRExpression |
getHyperlinkAnchorExpression()
Returns the expression whose value represents the anchor.
|
protected Integer |
getHyperlinkPage() |
JRExpression |
getHyperlinkPageExpression()
Returns an integer representing the page index of the link.
|
JRHyperlinkParameter[] |
getHyperlinkParameters()
Returns the list of hyperlink parameters.
|
protected String |
getHyperlinkReference() |
JRExpression |
getHyperlinkReferenceExpression()
Returns the expression whose value represents the hyperlink reference.
|
byte |
getHyperlinkTarget()
Retrieves the hyperlink target for the element.
|
protected String |
getHyperlinkTooltip() |
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.
|
protected JRTemplateImage |
getJRTemplateImage() |
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() |
protected Renderable |
getRenderable() |
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(). |
protected boolean |
prepare(int availableHeight,
boolean isOverflow) |
protected void |
reset() |
protected void |
resolveElement(JRPrintElement element,
byte evaluation)
Resolves an element.
|
void |
setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
Deprecated.
Replaced by
setHorizontalImageAlign(HorizontalImageAlignEnum). |
void |
setHorizontalImageAlign(HorizontalImageAlignEnum horizontalAlignment)
Sets the image horizontal alignment.
|
void |
setLazy(boolean isLazy)
Gives control over when the images are retrieved from their specified location.
|
void |
setOnErrorType(OnErrorTypeEnum onErrorType)
Specifies how the engine should treat a missing image.
|
void |
setScaleImage(ScaleImageEnum scaleImage)
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 verticalAlignment)
Gets the image vertical alignment.
|
void |
visit(JRVisitor visitor) |
getDefaultLineColor, getDefaultLineWidth, getFillValue, getLinePen, getOwnFillValue, rewind, setFill_moveDependantElements, _stretchElement, _stretchElementToHeight, addDependantElement, addDynamicProperty, clone, clone, clone, collectDelayedEvaluations, collectDelayedEvaluations, collectStyleDelayedEvaluations, collectStyleProviderDelayedEvaluations, delayedEvaluate, delayedEvaluationUpdatesTemplate, evaluateExpression, evaluatePrintWhenExpression, evaluateProperties, getBackcolor, getBand, getCollapsedHeightAbove, getCollapsedHeightBelow, getConditionalStylesContainer, getDefaultStyleProvider, getDependantElements, getDynamicProperties, getElementGroup, getElementOrigin, getElementTemplate, getEvaluatedProperties, getField, getFiller, getForecolor, getGroupElements, getHeight, getInitStyle, getKey, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParent, getParentProperties, getPositionTypeValue, getPrepareHeight, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getRelativeY, getStretchHeight, getStretchTypeValue, getStyle, getStyleNameReference, getStyleResolver, getTemplate, getUUID, getVariable, getWidth, getX, getY, hasDynamicProperties, hasDynamicProperty, hasProperties, initDelayedEvaluationPrint, initDelayedEvaluations, initStyleProviders, isAlreadyPrinted, isAutoEvaluateNow, isDelayedStyleEvaluation, isEvaluateAuto, isEvaluateNow, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isPrintWhenExpressionNull, isPrintWhenTrue, isRemoveLineWhenBlank, isReprinted, isToPrint, isValueRepeating, moveDependantElements, performDelayedEvaluation, registerTemplate, resolveElement, setAlreadyPrinted, setBackcolor, setBand, setCollapsedHeightAbove, setCollapsedHeightBelow, setConditionalStylesContainer, setCurrentEvaluation, setExpressionEvaluator, setForecolor, setHeight, setMode, setOriginProvider, setPositionType, setPrepareHeight, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setPrintWhenExpressionNull, setPrintWhenTrue, setRelativeY, setRemoveLineWhenBlank, setReprinted, setShrinkable, setStretchHeight, setStretchType, setStyle, setStyleNameReference, setToPrint, setValueRepeating, setWidth, setX, setY, stretchElement, stretchElementToContainer, stretchElementToElementGroup, stretchElementToHeight, stretchHeightFinal, transferProperties, transferPropertiesequals, 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, setXclonegetParentProperties, getPropertiesMap, hasPropertiesgetUUIDgetFillValue, getLinePen, getOwnFillValue, setFillgetBackcolor, getForecolor, getHeight, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setModegetDefaultLineColor, getDefaultLineWidthgetDefaultStyleProvider, getStyle, getStyleNameReferencegetDefaultLineColorpublic static final String EXCEPTION_MESSAGE_KEY_UNKNOWN_SOURCE_CLASS
protected final JRLineBox initLineBox
protected JRLineBox lineBox
protected JRFillImage(JRBaseFiller filler, JRImage image, JRFillObjectFactory factory)
protected JRFillImage(JRFillImage image, JRFillCloneFactory factory)
protected void evaluateStyle(byte evaluation)
throws JRException
evaluateStyle in class JRFillGraphicElementJRExceptionpublic ModeEnum getModeValue()
JRCommonElementgetModeValue in interface JRCommonElementgetModeValue in class JRFillElementpublic ScaleImageEnum getScaleImageValue()
JRCommonImagegetScaleImageValue in interface JRCommonImageScaleImageEnumpublic ScaleImageEnum getOwnScaleImageValue()
JRCommonImagegetOwnScaleImageValue in interface JRCommonImageScaleImageEnumpublic void setScaleImage(ScaleImageEnum scaleImage)
JRCommonImagesetScaleImage in interface JRCommonImagescaleImage - 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 horizontalAlignment)
JRImageAlignmentsetHorizontalImageAlign in interface JRImageAlignmenthorizontalAlignment - 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 verticalAlignment)
JRImageAlignmentsetVerticalImageAlign in interface JRImageAlignmentverticalAlignment - 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 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 onErrorType)
JRImagesetOnErrorType in interface JRImageonErrorType - a value representing one of the missing image handling constants in OnErrorTypeEnumpublic EvaluationTimeEnum getEvaluationTimeValue()
JREvaluationgetEvaluationTimeValue in interface JREvaluationgetEvaluationTimeValue in class JRFillElementJRExpressionpublic JRGroup getEvaluationGroup()
JREvaluationgetEvaluationGroup in interface JREvaluationEvaluationTimeEnum.GROUPpublic 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 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 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 JRHyperlinkprotected Renderable getRenderable()
protected String getAnchorName()
protected String getHyperlinkReference()
protected String getHyperlinkAnchor()
protected Integer getHyperlinkPage()
protected String getHyperlinkTooltip()
protected JRTemplateImage getJRTemplateImage()
protected JRTemplateElement createElementTemplate()
createElementTemplate in class JRFillElementprotected void evaluate(byte evaluation)
throws JRException
evaluate in class JRFillElementJRExceptionprotected void evaluateImage(byte evaluation)
throws JRException
JRExceptionprotected boolean prepare(int availableHeight,
boolean isOverflow)
throws JRException
prepare in class JRFillGraphicElementJRExceptionprotected void reset()
reset in class JRFillElementprotected boolean fitImage(Dimension2D imageSize, int availableHeight, boolean overflowAllowed, HorizontalImageAlignEnum hAlign) throws JRException
JRExceptionprotected JRPrintElement fill() throws JRException
fill in class JRFillElementJRExceptionprotected void copy(JRPrintImage printImage)
public void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic void visit(JRVisitor visitor)
visit in interface JRVisitableprotected void resolveElement(JRPrintElement element, byte evaluation) throws JRException
JRFillElementresolveElement in class JRFillElementelement - the elementevaluation - the evaluation typeJRExceptionpublic int getBookmarkLevel()
JRAnchorgetBookmarkLevel in interface JRAnchorNO_BOOKMARK if no bookmark should be created for this anchorpublic JRFillCloneable createClone(JRFillCloneFactory factory)
JRFillCloneablecreateClone in interface JRFillCloneablefactory - the clone factory to use while creating the cloneprotected void collectDelayedEvaluations()
collectDelayedEvaluations in class JRFillElementpublic JRHyperlinkParameter[] getHyperlinkParameters()
JRHyperlinkThe parameters can be used by custom hyperlink types to generate dynamic links.
getHyperlinkParameters in interface JRHyperlinkpublic 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 JRExpression getHyperlinkTooltipExpression()
JRHyperlinkgetHyperlinkTooltipExpression in interface JRHyperlinkCopyright © 2017. All rights reserved.