Package com.inet.report
Class AbstractPictureElement
java.lang.Object
com.inet.report.ReportComponent
com.inet.report.Element
com.inet.report.AbstractPictureElement
- All Implemented Interfaces:
BorderProperties
,GeneralProperties
,HyperlinkProperties
,NodeParser
,PictureProperties
,com.inet.report.ReferenceHolder
,Serializable
,Cloneable
- Direct Known Subclasses:
DatabasePicture
,Picture
public abstract class AbstractPictureElement
extends Element
implements PictureProperties, HyperlinkProperties, BorderProperties
Parent class of all elements which shows a picture.
This class implements PictureProperties interface.
- Since:
- 6.0
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
FOR INTERNAL USE ONLYNested classes/interfaces inherited from class com.inet.report.Element
Element.BorderProps, Element.CommonProperties, Element.ElementTypes, Element.HyperlinkProps, Element.StringProps
-
Field Summary
Fields inherited from class com.inet.report.Element
BOX, CHART, CROSSTAB, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, FORMFIELD, INTERACTIVE_SORTING, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART
Fields inherited from interface com.inet.report.BorderProperties
LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_DOUBLE, LINE_STYLE_SINGLE, NO_LINE
Fields inherited from interface com.inet.report.GeneralProperties
ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT
Fields inherited from interface com.inet.report.PictureProperties
ALIGN_VERTICAL_BOTTOM, ALIGN_VERTICAL_CENTER, ALIGN_VERTICAL_TOP, SCALE_BEST_FIT_KEEP_ASPECT_RATIO, SCALE_FIT_HEIGHT_KEEP_ASPECT_RATIO, SCALE_FIT_WIDTH_FIT_HEIGHT, SCALE_FIT_WIDTH_FIXED_HEIGHT, SCALE_FIT_WIDTH_KEEP_ASPECT_RATIO, SCALE_FIXED_WIDTH_FIT_HEIGHT, SCALE_FIXED_WIDTH_FIXED_HEIGHT
-
Method Summary
Modifier and TypeMethodDescriptioncreatePreviewImage
(com.inet.report.encode.PictureMetaData metaData) Creates a preview image of this picture.int
Gets the value of the property 'bottom cropping size'.Returns the formula of the property 'can shrink'.double
Gets the property 'height scaling factor'.Return the image key formula for this picture.int
Gets the value of the property 'left cropping size'.Returns a list with all property formulas that are set for this report element.int
Gets the value of the property 'right cropping size'.int
Gets the scaling option which represents the way to scale the source image into its element frame.FOR INTERNAL USE ONLY.
Returns the list of supported document file suffixes.FOR INTERNAL USE ONLY.
Returns the list of supported image file suffixes.int
Gets the value of the property 'top cropping size'.int
Returns the value of the property 'vertical alignment'.Gets the formula for the property 'vertical alignment'.double
Gets the property 'width scaling factor'.boolean
Returns the value of the property 'can shrink'.void
setBottomCropping
(int bottomCropping) Sets the value of the property 'bottom cropping size'.void
setCanShrink
(boolean canShrink) Sets the value of the property 'can shrink'.void
setCanShrinkFormula
(FormulaField newFormula) Sets the formula for the property 'can shrink'.void
setHeightScalingFactor
(double factor) Sets the property 'height scaling factor'.void
setHorAlign
(int value) Sets the value of the property 'horizontal alignment'.void
setImageKeyFormula
(FormulaField newFormula) Sets a Formulafield which contains a key string to identify identical images.void
setLeftCropping
(int leftCropping) Sets the value of the property 'left cropping size'.void
setRightCropping
(int rightCropping) Sets the value of the property 'right cropping size'.void
setScalingOption
(int option) Sets the scaling option which represents the way to scale the source image into its element frame.void
setSuppressIfDuplicated
(boolean newValue) The property 'suppress if duplicated' is not defined for instances of AbstractPictureElement.void
setSuppressIfDuplicatedFormula
(FormulaField newFormula) The property 'suppress if duplicated' is not defined for instances of AbstractPictureElement.void
setTopCropping
(int topCropping) Sets the value of the property 'top cropping size'.void
setVerAlign
(int value) Sets the value of the property 'vertical alignment'.void
setVerAlignFormula
(FormulaField newFormula) Sets the formula for the property 'vertical alignment'.void
setWidthScalingFactor
(double factor) Sets the property 'width scaling factor'.Methods inherited from class com.inet.report.Element
addListener, copy, getBottomLineStyle, getBottomLineStyleFormula, getBulletValueStack, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getListStack, getParent, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, getTypeAsString, indexOf, isCanGrow, isCloseBorderOnPageBreak, isCloseBorderOnPageBreakInternal, isDropShadow, isInCrossTab, isSuppressIfDuplicated, isTightHorizontal, paramString, parseElement, parseText, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setBulletValueStack, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setListStack, setReferences, setRightLineStyle, setRightLineStyleFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula
Methods inherited from class com.inet.report.ReportComponent
addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getSubComponents, getSuppressFormula, getType, getWidth, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, resetReferences, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, 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 com.inet.report.BorderProperties
getBackColor, getBackColorFormula, getBottomLineStyle, getBottomLineStyleFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getForeColor, getForeColorFormula, getLeftLineStyle, getLeftLineStyleFormula, getRightLineStyle, getRightLineStyleFormula, getTightHorizontalFormula, getTopLineStyle, getTopLineStyleFormula, isCloseBorderOnPageBreak, isDropShadow, isTightHorizontal, setBackColor, setBackColorFormula, setBottomLineStyle, setBottomLineStyleFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setForeColor, setForeColorFormula, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setTightHorizontal, setTightHorizontalFormula, setTopLineStyle, setTopLineStyleFormula
Methods inherited from interface com.inet.report.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
Methods inherited from interface com.inet.report.HyperlinkProperties
getHyperlinkUrl, getHyperlinkUrlFormula, setHyperlinkUrl, setHyperlinkUrlFormula
Methods inherited from interface com.inet.report.PictureProperties
createPictureMetaData, getCanGrowFormula, getHeight, getHeightRenderingFactor, getHorAlign, getHorAlignFormula, getWidth, getWidthRenderingFactor, isCanGrow, setCanGrow, setCanGrowFormula, setHeight, setHorAlignFormula, setWidth
-
Method Details
-
setSuppressIfDuplicated
public void setSuppressIfDuplicated(boolean newValue) The property 'suppress if duplicated' is not defined for instances of AbstractPictureElement. Setting this property will have no effect.- Specified by:
setSuppressIfDuplicated
in interfaceGeneralProperties
- Overrides:
setSuppressIfDuplicated
in classElement
- Parameters:
newValue
- This has no effect.- Since:
- 6.0
-
setSuppressIfDuplicatedFormula
The property 'suppress if duplicated' is not defined for instances of AbstractPictureElement. Setting this property will have no effect.- Specified by:
setSuppressIfDuplicatedFormula
in interfaceGeneralProperties
- Overrides:
setSuppressIfDuplicatedFormula
in classElement
- Parameters:
newFormula
- This has no effect.- Since:
- 6.0
-
setBottomCropping
public void setBottomCropping(int bottomCropping) Sets the value of the property 'bottom cropping size'.- Specified by:
setBottomCropping
in interfacePictureProperties
- Parameters:
bottomCropping
- The long value of the property 'bottom cropping size'.
-
getBottomCropping
public int getBottomCropping()Gets the value of the property 'bottom cropping size'.- Specified by:
getBottomCropping
in interfacePictureProperties
- Returns:
- The long value of the property 'bottom cropping size'.
-
setLeftCropping
public void setLeftCropping(int leftCropping) Sets the value of the property 'left cropping size'.- Specified by:
setLeftCropping
in interfacePictureProperties
- Parameters:
leftCropping
- The value of the property 'left cropping size'.
-
getLeftCropping
public int getLeftCropping()Gets the value of the property 'left cropping size'.- Specified by:
getLeftCropping
in interfacePictureProperties
- Returns:
- The value of the property 'left cropping size'.
-
setRightCropping
public void setRightCropping(int rightCropping) Sets the value of the property 'right cropping size'.- Specified by:
setRightCropping
in interfacePictureProperties
- Parameters:
rightCropping
- The long value of the property 'right cropping size'.
-
getRightCropping
public int getRightCropping()Gets the value of the property 'right cropping size'.- Specified by:
getRightCropping
in interfacePictureProperties
- Returns:
- The value of the property 'right cropping size'.
-
setTopCropping
public void setTopCropping(int topCropping) Sets the value of the property 'top cropping size'.- Specified by:
setTopCropping
in interfacePictureProperties
- Parameters:
topCropping
- The value of the property 'top cropping size'.
-
getTopCropping
public int getTopCropping()Gets the value of the property 'top cropping size'.- Specified by:
getTopCropping
in interfacePictureProperties
- Returns:
- The long value of the property 'top cropping size'.
-
setWidthScalingFactor
public void setWidthScalingFactor(double factor) Sets the property 'width scaling factor'.- Specified by:
setWidthScalingFactor
in interfacePictureProperties
- Parameters:
factor
- The value of the property 'width scaling factor'. I.e. 0.1 means 10%, 5.0 means 500%.
-
getWidthScalingFactor
public double getWidthScalingFactor()Gets the property 'width scaling factor'.- Specified by:
getWidthScalingFactor
in interfacePictureProperties
- Returns:
- The value of the property 'width scaling factor'. I.e. 0.1 means 10%, 1.0 5.0 means 500%.
-
setHeightScalingFactor
public void setHeightScalingFactor(double factor) Sets the property 'height scaling factor'.- Specified by:
setHeightScalingFactor
in interfacePictureProperties
- Parameters:
factor
- The value of the property 'height scaling factor'. I.e. 0.1 means 10%, 5.0 means 500%.
-
getHeightScalingFactor
public double getHeightScalingFactor()Gets the property 'height scaling factor'.- Specified by:
getHeightScalingFactor
in interfacePictureProperties
- Returns:
- The value of the property 'height scaling factor'. I.e. 0.1 means 10%, 5.0 means 500%.
-
getVerAlignFormula
Gets the formula for the property 'vertical alignment'. Possible alignments are default, top, center, or bottom.- Specified by:
getVerAlignFormula
in interfacePictureProperties
- Returns:
- The formula for the property 'vertical alignment'.
- See Also:
-
setVerAlignFormula
Sets the formula for the property 'vertical alignment'. Possible alignments are default, top, center, or bottom.- Specified by:
setVerAlignFormula
in interfacePictureProperties
- Parameters:
newFormula
- The new formula for the property 'horizontal alignment'.- See Also:
-
setVerAlign
public void setVerAlign(int value) Sets the value of the property 'vertical alignment'. Possible alignments are default, left, center, right or justified.- Specified by:
setVerAlign
in interfacePictureProperties
- Parameters:
value
- The new value of the property 'vertical alignment'.- See Also:
-
getVerAlign
public int getVerAlign()Returns the value of the property 'vertical alignment'. Possible alignments are default, left, center, right or justified.- Specified by:
getVerAlign
in interfacePictureProperties
- Returns:
- the 'vertical alignment' property of this element.
- See Also:
-
getScalingOption
public int getScalingOption()Gets the scaling option which represents the way to scale the source image into its element frame. E.g.PictureProperties.SCALE_FIT_WIDTH_FIXED_HEIGHT
will scale the width of source image to the width of the element and the height by the given scale factor set using thePictureProperties.setHeightScalingFactor(double)
.- Specified by:
getScalingOption
in interfacePictureProperties
- Returns:
- An integer values which represents the scale option.
- See Also:
-
PictureProperties.SCALE_FIT_WIDTH_FIT_HEIGHT
PictureProperties.SCALE_FIXED_WIDTH_FIXED_HEIGHT
PictureProperties.SCALE_FIXED_WIDTH_FIT_HEIGHT
PictureProperties.SCALE_FIT_WIDTH_FIXED_HEIGHT
PictureProperties.SCALE_FIT_WIDTH_KEEP_ASPECT_RATIO
PictureProperties.SCALE_FIT_HEIGHT_KEEP_ASPECT_RATIO
PictureProperties.SCALE_BEST_FIT_KEEP_ASPECT_RATIO
-
setScalingOption
public void setScalingOption(int option) Sets the scaling option which represents the way to scale the source image into its element frame. E.g.PictureProperties.SCALE_FIT_WIDTH_FIXED_HEIGHT
will scale the width of source image to the width of the element and the height by the given scale factor set using thePictureProperties.setHeightScalingFactor(double)
.- Specified by:
setScalingOption
in interfacePictureProperties
- Parameters:
option
- An integer, which represents the scaling option.- See Also:
-
PictureProperties.SCALE_FIT_WIDTH_FIT_HEIGHT
PictureProperties.SCALE_FIXED_WIDTH_FIXED_HEIGHT
PictureProperties.SCALE_FIXED_WIDTH_FIT_HEIGHT
PictureProperties.SCALE_FIT_WIDTH_FIXED_HEIGHT
PictureProperties.SCALE_FIT_WIDTH_KEEP_ASPECT_RATIO
PictureProperties.SCALE_FIT_HEIGHT_KEEP_ASPECT_RATIO
PictureProperties.SCALE_BEST_FIT_KEEP_ASPECT_RATIO
-
isCanShrink
public boolean isCanShrink()Returns the value of the property 'can shrink'. If this property is enabled an element with dynamic state will be shrunk when the content of the element is smaller than its container.- Specified by:
isCanShrink
in interfacePictureProperties
- Returns:
- The value of the property 'can shrink'.
-
setCanShrink
public void setCanShrink(boolean canShrink) Sets the value of the property 'can shrink'. If this property is enabled an element with dynamic state will be shrunk when the content of the element is smaller than its container.- Specified by:
setCanShrink
in interfacePictureProperties
- Parameters:
canShrink
- If true shrinking to the image size is allowed.
-
getCanShrinkFormula
Returns the formula of the property 'can shrink'. If this property is enabled an element with dynamic state will be shrunk dynamically when the content of the element is larger than its container.- Specified by:
getCanShrinkFormula
in interfacePictureProperties
- Returns:
FormulaField
The formula of the property 'can grow'.
-
setCanShrinkFormula
Sets the formula for the property 'can shrink'. If this property is enabled an element with dynamic state will be shrunk dynamically when then content of the element is larger than its container.- Specified by:
setCanShrinkFormula
in interfacePictureProperties
- Parameters:
newFormula
- The new formula for the property 'can grow'.
-
getPropertyFormulas
Returns a list with all property formulas that are set for this report element. This includes property formulas for any type of sub-component but excludes formulas for any descendantReportComponent
of this one. To get the property formulas for descendantReportComponent
useReportComponent.getSubComponents()
- Overrides:
getPropertyFormulas
in classElement
- Returns:
- List of property formulas
-
setHorAlign
public void setHorAlign(int value) Sets the value of the property 'horizontal alignment'. Possible alignments are default, left, center or right.- Specified by:
setHorAlign
in interfaceGeneralProperties
- Specified by:
setHorAlign
in interfacePictureProperties
- Overrides:
setHorAlign
in classElement
- Parameters:
value
- The new value of the property 'horizontal alignment'.- Throws:
IllegalArgumentException
- when parameter 'value' is none of the four possible horizontal alignments- Since:
- 6.0
- See Also:
-
getImageKeyFormula
Return the image key formula for this picture. Renderers which are using a cache mechanism (e.g. PDF) can use this key to optimize its rendering and memory performance. Picture Objects with the same key will be treated as the picture objects with the same image.- Specified by:
getImageKeyFormula
in interfacePictureProperties
- Returns:
- Return the image key formula for this picture.
-
setImageKeyFormula
Sets a Formulafield which contains a key string to identify identical images. Renderers which are using a cache mechanism (e.g. PDF) can use this key to optimize its rendering and memory performance. Picture Objects with the same key will be treated as the picture objects with the same image.- Specified by:
setImageKeyFormula
in interfacePictureProperties
- Parameters:
newFormula
- the formula containing the image key.
-
createPreviewImage
Creates a preview image of this picture. The image is scaled and aligned to the properties of this model object only ifPictureMetaData.isAutoScaledAndAligned()
returnstrue
for this picture format.- Parameters:
metaData
- a meta data instance created byPictureProperties.createPictureMetaData()
- Returns:
- the created preview image
- Throws:
IllegalArgumentException
- if the specified meta data instance is not valid- Since:
- 12.1
-
getSupportedImageSuffixes
FOR INTERNAL USE ONLY.
Returns the list of supported image file suffixes.- Returns:
- the list of supported image file suffixes
- Since:
- 12.1
-
getSupportedDocumentSuffixes
FOR INTERNAL USE ONLY.
Returns the list of supported document file suffixes.- Returns:
- the list of supported document file suffixes
- Since:
- 12.1
-