Klasse AbstractPictureElement

java.lang.Object

com.inet.report.ReportComponent

com.inet.report.Element

com.inet.report.AbstractPictureElement

Alle implementierten Schnittstellen:

BorderProperties, GeneralProperties, HyperlinkProperties, NodeParser, PictureProperties, com.inet.report.ReferenceHolder, Serializable, Cloneable

Bekannte direkte Unterklassen:

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.

Seit:

6.0

Siehe auch:

• Serialisierte Form

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifikator und Typ	Klasse	Beschreibung
static enum	AbstractPictureElement.PictureProps	FOR INTERNAL USE ONLY

Von Klasse geerbte verschachtelte Klassen/Schnittstellen Element

Element.BorderProps, Element.CommonProperties, Element.ElementTypes, Element.HyperlinkProps, Element.StringProps

Feldübersicht

Von Klasse geerbte Felder Element

BOX, CHART, CROSSTAB, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, FORMFIELD, INTERACTIVE_SORTING, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART

Von Schnittstelle geerbte Felder BorderProperties

LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_DOUBLE, LINE_STYLE_SINGLE, NO_LINE

Von Schnittstelle geerbte Felder GeneralProperties

ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT, ALIGN_VERTICAL_BOTTOM, ALIGN_VERTICAL_CENTER, ALIGN_VERTICAL_TOP

Von Schnittstelle geerbte Felder PictureProperties

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

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
Image	createPreviewImage(com.inet.report.encode.PictureMetaData metaData)	Creates a preview image of this picture.
int	getBottomCropping()	Gets the value of the property 'bottom cropping size'.
FormulaField	getCanShrinkFormula()	Returns the formula of the property 'can shrink'.
double	getHeightScalingFactor()	Gets the property 'height scaling factor'.
FormulaField	getImageKeyFormula()	Return the image key formula for this picture.
int	getLeftCropping()	Gets the value of the property 'left cropping size'.
List<FormulaField>	getPropertyFormulas()	Returns a list with all property formulas that are set for this report element.
int	getRightCropping()	Gets the value of the property 'right cropping size'.
int	getScalingOption()	Gets the scaling option which represents the way to scale the source image into its element frame.
static List<String>	getSupportedDocumentSuffixes()	FOR INTERNAL USE ONLY. Returns the list of supported document file suffixes.
static List<String>	getSupportedImageSuffixes()	FOR INTERNAL USE ONLY. Returns the list of supported image file suffixes.
int	getTopCropping()	Gets the value of the property 'top cropping size'.
double	getWidthScalingFactor()	Gets the property 'width scaling factor'.
boolean	isCanShrink()	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	setWidthScalingFactor(double factor)	Sets the property 'width scaling factor'.

Von Klasse geerbte Methoden 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, getVerAlign, getVerAlignFormula, 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, setVerAlign, setVerAlignFormula

Von Klasse geerbte Methoden ReportComponent

addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getStructElem, getSubComponents, getSuppressFormula, getType, getWidth, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, resetReferences, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setStructElem, setSuppress, setSuppressFormula, setWidth, setX, setY

Von Klasse geerbte Methoden Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Von Schnittstelle geerbte Methoden 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

Von Schnittstelle geerbte Methoden GeneralProperties

getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula

Von Schnittstelle geerbte Methoden HyperlinkProperties

getHyperlinkUrl, getHyperlinkUrlFormula, setHyperlinkUrl, setHyperlinkUrlFormula

Von Schnittstelle geerbte Methoden PictureProperties

createPictureMetaData, getCanGrowFormula, getHeight, getHeightRenderingFactor, getHorAlign, getHorAlignFormula, getVerAlign, getVerAlignFormula, getWidth, getWidthRenderingFactor, isCanGrow, setCanGrow, setCanGrowFormula, setHeight, setHorAlignFormula, setVerAlign, setVerAlignFormula, setWidth

Methodendetails

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.

Angegeben von:

setSuppressIfDuplicated in Schnittstelle GeneralProperties

Setzt außer Kraft:

setSuppressIfDuplicated in Klasse Element

Parameter:

newValue - This has no effect.

Seit:

6.0

setSuppressIfDuplicatedFormula

public void setSuppressIfDuplicatedFormula(FormulaField newFormula)

The property 'suppress if duplicated' is not defined for instances of AbstractPictureElement. Setting this property will have no effect.

Angegeben von:

setSuppressIfDuplicatedFormula in Schnittstelle GeneralProperties

Setzt außer Kraft:

setSuppressIfDuplicatedFormula in Klasse Element

Parameter:

newFormula - This has no effect.

Seit:

6.0

setBottomCropping

public void setBottomCropping(int bottomCropping)

Sets the value of the property 'bottom cropping size'.

Angegeben von:

setBottomCropping in Schnittstelle PictureProperties

Parameter:

bottomCropping - The long value of the property 'bottom cropping size'.

getBottomCropping

public int getBottomCropping()

Gets the value of the property 'bottom cropping size'.

Angegeben von:

getBottomCropping in Schnittstelle PictureProperties

Gibt zurück:

The long value of the property 'bottom cropping size'.

setLeftCropping

public void setLeftCropping(int leftCropping)

Sets the value of the property 'left cropping size'.

Angegeben von:

setLeftCropping in Schnittstelle PictureProperties

Parameter:

leftCropping - The value of the property 'left cropping size'.

getLeftCropping

public int getLeftCropping()

Gets the value of the property 'left cropping size'.

Angegeben von:

getLeftCropping in Schnittstelle PictureProperties

Gibt zurück:

The value of the property 'left cropping size'.

setRightCropping

public void setRightCropping(int rightCropping)

Sets the value of the property 'right cropping size'.

Angegeben von:

setRightCropping in Schnittstelle PictureProperties

Parameter:

rightCropping - The long value of the property 'right cropping size'.

getRightCropping

public int getRightCropping()

Gets the value of the property 'right cropping size'.

Angegeben von:

getRightCropping in Schnittstelle PictureProperties

Gibt zurück:

The value of the property 'right cropping size'.

setTopCropping

public void setTopCropping(int topCropping)

Sets the value of the property 'top cropping size'.

Angegeben von:

setTopCropping in Schnittstelle PictureProperties

Parameter:

topCropping - The value of the property 'top cropping size'.

getTopCropping

public int getTopCropping()

Gets the value of the property 'top cropping size'.

Angegeben von:

getTopCropping in Schnittstelle PictureProperties

Gibt zurück:

The long value of the property 'top cropping size'.

setWidthScalingFactor

public void setWidthScalingFactor(double factor)

Sets the property 'width scaling factor'.

Angegeben von:

setWidthScalingFactor in Schnittstelle PictureProperties

Parameter:

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'.

Angegeben von:

getWidthScalingFactor in Schnittstelle PictureProperties

Gibt zurück:

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'.

Angegeben von:

setHeightScalingFactor in Schnittstelle PictureProperties

Parameter:

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'.

Angegeben von:

getHeightScalingFactor in Schnittstelle PictureProperties

Gibt zurück:

The value of the property 'height scaling factor'. I.e. 0.1 means 10%, 5.0 means 500%.

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 the PictureProperties.setHeightScalingFactor(double).

Angegeben von:

getScalingOption in Schnittstelle PictureProperties

Gibt zurück:

An integer values which represents the scale option.

Siehe auch:

• 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 the PictureProperties.setHeightScalingFactor(double).

Angegeben von:

setScalingOption in Schnittstelle PictureProperties

Parameter:

option - An integer, which represents the scaling option.

Siehe auch:

• 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.

Angegeben von:

isCanShrink in Schnittstelle PictureProperties

Gibt zurück:

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.

Angegeben von:

setCanShrink in Schnittstelle PictureProperties

Parameter:

canShrink - If true shrinking to the image size is allowed.

getCanShrinkFormula

public FormulaField 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.

Angegeben von:

getCanShrinkFormula in Schnittstelle PictureProperties

Gibt zurück:

FormulaField The formula of the property 'can grow'.

setCanShrinkFormula

public void setCanShrinkFormula(FormulaField newFormula)

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.

Angegeben von:

setCanShrinkFormula in Schnittstelle PictureProperties

Parameter:

newFormula - The new formula for the property 'can grow'.

getPropertyFormulas

public List<FormulaField> 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 descendant ReportComponent of this one. To get the property formulas for descendant ReportComponent use ReportComponent.getSubComponents()

Setzt außer Kraft:

getPropertyFormulas in Klasse Element

Gibt zurück:

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.

Angegeben von:

setHorAlign in Schnittstelle GeneralProperties

Angegeben von:

setHorAlign in Schnittstelle PictureProperties

Setzt außer Kraft:

setHorAlign in Klasse Element

Parameter:

value - The new value of the property 'horizontal alignment'.

Löst aus:

IllegalArgumentException - when parameter 'value' is none of the four possible horizontal alignments

Seit:

6.0

Siehe auch:

• GeneralProperties.ALIGN_HORIZONTAL_DEFAULT
• GeneralProperties.ALIGN_HORIZONTAL_LEFT
• GeneralProperties.ALIGN_HORIZONTAL_CENTER
• GeneralProperties.ALIGN_HORIZONTAL_RIGHT

getImageKeyFormula

public FormulaField 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.

Angegeben von:

getImageKeyFormula in Schnittstelle PictureProperties

Gibt zurück:

Return the image key formula for this picture.

setImageKeyFormula

public void setImageKeyFormula(FormulaField newFormula)

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.

Angegeben von:

setImageKeyFormula in Schnittstelle PictureProperties

Parameter:

newFormula - the formula containing the image key.

createPreviewImage

public Image createPreviewImage(com.inet.report.encode.PictureMetaData metaData)

Creates a preview image of this picture. The image is scaled and aligned to the properties of this model object only if PictureMetaData.isAutoScaledAndAligned() returns true for this picture format.

Parameter:

metaData - a meta data instance created by PictureProperties.createPictureMetaData()

Gibt zurück:

the created preview image

Löst aus:

IllegalArgumentException - if the specified meta data instance is not valid

Seit:

12.1

getSupportedImageSuffixes

public static List<String> getSupportedImageSuffixes()

FOR INTERNAL USE ONLY.
Returns the list of supported image file suffixes.

Gibt zurück:

the list of supported image file suffixes

Seit:

12.1

getSupportedDocumentSuffixes

public static List<String> getSupportedDocumentSuffixes()

FOR INTERNAL USE ONLY.
Returns the list of supported document file suffixes.

Gibt zurück:

the list of supported document file suffixes

Seit:

12.1