Package org.pentaho.reporting.engine.classic.core.elementfactory

Class AbstractContentElementFactory

java.lang.Object

org.pentaho.reporting.engine.classic.core.elementfactory.ElementFactory

org.pentaho.reporting.engine.classic.core.elementfactory.AbstractContentElementFactory

Direct Known Subclasses:

ContentElementFactory, ContentFieldElementFactory, EllipseElementFactory, HorizontalLineElementFactory, RectangleElementFactory, VerticalLineElementFactory

public abstract class AbstractContentElementFactory
extends ElementFactory

The drawable field element factory can be used to create elements that display Drawable elements.

A drawable field expects the named datasource to contain Drawable objects.

Once the desired properties are set, the factory can be reused to create similiar elements.

Author:

Thomas Morgner

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractContentElementFactory()	DefaultConstructor.

Method Summary

Modifier and Type	Method	Description
protected void	applyStyle(ElementStyleSheet style)	Applies the style definition to the elements stylesheet.
Color	getFillColor()
Boolean	getKeepAspectRatio()	Returns whether the generated image element should preserve the original aspect ratio of the image content during scaling.
Boolean	getScale()	Returns, whether the image content should be scaled to fit the complete image element bounds.
Boolean	getShouldDraw()	Returns whether to draw the shape outline on report generation.
Boolean	getShouldFill()	Return whether to fill the shape on report generation.
Stroke	getStroke()	Returns the shapes stroke.
void	setFillColor(Color fillColor)
void	setKeepAspectRatio(Boolean keepAspectRatio)	Defines whether the generated image element should preserve the original aspect ratio of the image content during scaling.
void	setScale(Boolean scale)	Defines, whether the image content should be scaled to fit the complete image element bounds.
void	setShouldDraw(Boolean shouldDraw)	Defines whether to draw the shape outline on report generation.
void	setShouldFill(Boolean shouldFill)	Defines wether to fill the shape on report generation.
void	setStroke(Stroke stroke)	Defines the shapes stroke.

Methods inherited from class org.pentaho.reporting.engine.classic.core.elementfactory.ElementFactory

applyElementName, createElement, getAbsolutePosition, getAvoidPagebreaks, getBackgroundColor, getBooleanValue, getBorderBottomColor, getBorderBottomLeftRadius, getBorderBottomLeftRadiusHeight, getBorderBottomLeftRadiusWidth, getBorderBottomRightRadius, getBorderBottomRightRadiusHeight, getBorderBottomRightRadiusWidth, getBorderBottomStyle, getBorderBottomWidth, getBorderBreakColor, getBorderBreakStyle, getBorderBreakWidth, getBorderColor, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRadius, getBorderRadiusHeight, getBorderRadiusWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderStyle, getBorderTopColor, getBorderTopLeftRadius, getBorderTopLeftRadiusHeight, getBorderTopLeftRadiusWidth, getBorderTopRightRadius, getBorderTopRightRadiusHeight, getBorderTopRightRadiusWidth, getBorderTopStyle, getBorderTopWidth, getBorderWidth, getColor, getDynamicHeight, getFontSmooth, getHeight, getHorizontalAlignment, getHRefTarget, getHRefTitle, getHRefWindow, getLayoutCachable, getMaximumHeight, getMaximumSize, getMaximumWidth, getMinimumHeight, getMinimumSize, getMinimumWidth, getName, getOrphans, getOverflowX, getOverflowY, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPreferredSize, getUseMinChunkWidth, getVerticalAlignment, getVisible, getWidowOrphanOptOut, getWidows, getWidth, getX, getY, setAbsolutePosition, setAvoidPagebreaks, setBackgroundColor, setBorderBottomColor, setBorderBottomLeftRadius, setBorderBottomLeftRadiusHeight, setBorderBottomLeftRadiusWidth, setBorderBottomRightRadius, setBorderBottomRightRadiusHeight, setBorderBottomRightRadiusWidth, setBorderBottomStyle, setBorderBottomWidth, setBorderBreakColor, setBorderBreakStyle, setBorderBreakWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRadius, setBorderRadiusHeight, setBorderRadiusWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopLeftRadius, setBorderTopLeftRadiusHeight, setBorderTopLeftRadiusWidth, setBorderTopRightRadius, setBorderTopRightRadiusHeight, setBorderTopRightRadiusWidth, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setColor, setDynamicHeight, setFontSmooth, setHeight, setHorizontalAlignment, setHRefTarget, setHRefTitle, setHRefWindow, setLayoutCachable, setMaximumHeight, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumWidth, setName, setOrphans, setOverflowX, setOverflowY, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPreferredSize, setUseMinChunkWidth, setVerticalAlignment, setVisible, setWidowOrphanOptOut, setWidows, setWidth, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractContentElementFactory

protected AbstractContentElementFactory()

DefaultConstructor.

Method Detail

getScale

public Boolean getScale()

Returns, whether the image content should be scaled to fit the complete image element bounds.

Returns:

the scale flag of the image element.

setScale

public void setScale(Boolean scale)

Defines, whether the image content should be scaled to fit the complete image element bounds.

Parameters:

scale - the scale flag of the image element.

getKeepAspectRatio

public Boolean getKeepAspectRatio()

Returns whether the generated image element should preserve the original aspect ratio of the image content during scaling. This property has no effect if the image content is not scaled.

Returns:

the keep aspect ratio flag.

setKeepAspectRatio

public void setKeepAspectRatio(Boolean keepAspectRatio)

Defines whether the generated image element should preserve the original aspect ratio of the image content during scaling. This property has no effect if the image content is not scaled.

Parameters:

keepAspectRatio - whether to keep the aspect ratio of the image content during the scaling.

getStroke

public Stroke getStroke()

Returns the shapes stroke. The stroke is used to draw the outline of the shape.

Returns:

the stoke.

setStroke

public void setStroke(Stroke stroke)

Defines the shapes stroke. The stroke is used to draw the outline of the shape.

Parameters:

stroke - the stoke.

getShouldFill

public Boolean getShouldFill()

Return whether to fill the shape on report generation.

Returns:

the should fill flag.

setShouldFill

public void setShouldFill(Boolean shouldFill)

Defines wether to fill the shape on report generation.

Parameters:

shouldFill - the fill flag.

getShouldDraw

public Boolean getShouldDraw()

Returns whether to draw the shape outline on report generation.

Returns:

the draw shape flag.

setShouldDraw

public void setShouldDraw(Boolean shouldDraw)

Defines whether to draw the shape outline on report generation.

Parameters:

shouldDraw - the draw shape flag.

getFillColor

public Color getFillColor()

setFillColor

public void setFillColor(Color fillColor)

applyStyle

protected void applyStyle(ElementStyleSheet style)

Applies the style definition to the elements stylesheet.

Overrides:

applyStyle in class ElementFactory

Parameters:

style - the element stylesheet which should receive the style definition.