org.pentaho.reporting.engine.classic.core.elementfactory
Class ResourceFieldElementFactory

java.lang.Object
  org.pentaho.reporting.engine.classic.core.elementfactory.ElementFactory
      org.pentaho.reporting.engine.classic.core.elementfactory.TextElementFactory
          org.pentaho.reporting.engine.classic.core.elementfactory.TextFieldElementFactory
              org.pentaho.reporting.engine.classic.core.elementfactory.ResourceFieldElementFactory

public class ResourceFieldElementFactory
extends TextFieldElementFactory

A factory to define ResourceFieldElements. ResourceField translate their content using a ResourceBundle instance.

Author:

Thomas Morgner

Constructor Summary

ResourceFieldElementFactory()
Default Constructor.

Method Summary

Element	createElement() Creates the resource field element based on the set properties.
static Element	createResourceElement(String name, Rectangle2D bounds, Color color, ElementAlignment alignment, ElementAlignment valignment, FontDefinition font, String nullValue, String resourceBase, String field) Deprecated. Use a more fine-grained approach to define this element by using the element-factory directly.
String	getResourceBase() Returns the base name of the resource bundle used to translate the content later.
void	setResourceBase(String resourceBase) Defines the base name of the resource bundle used to translate the content later.

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

createStringElement, createStringElement, getFieldname, getFormula, getNullString, setFieldname, setFormula, setNullString

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

getBold, getEmbedFont, getEncoding, getFontName, getFontSize, getItalic, getLineHeight, getMaximumLetterSpacing, getMinimumLetterSpacing, getOptimumLetterSpacing, getReservedLiteral, getStrikethrough, getTrimTextContent, getUnderline, getVerticalTextAlignment, getWhitespaceCollapse, getWrap, getWrapText, setBold, setEmbedFont, setEncoding, setFontName, setFontSize, setItalic, setLineHeight, setMaximumLetterSpacing, setMinimumLetterSpacing, setOptimumLetterSpacing, setReservedLiteral, setStrikethrough, setTrimTextContent, setUnderline, setVerticalTextAlignment, setWhitespaceCollapse, setWrap, setWrapText

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

getAbsolutePosition, getAvoidPagebreaks, getBackgroundColor, 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, 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, setWidows, setWidth, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceFieldElementFactory

public ResourceFieldElementFactory()

Default Constructor.

Method Detail

getResourceBase

public String getResourceBase()

Returns the base name of the resource bundle used to translate the content later.

Returns:

the resource bundle name of the element.

setResourceBase

public void setResourceBase(String resourceBase)

Defines the base name of the resource bundle used to translate the content later.

Parameters:

resourceBase - the resource bundle name of the element.

createElement

public Element createElement()

Creates the resource field element based on the set properties.

Overrides:

createElement in class TextFieldElementFactory

Returns:

the generated element.

See Also:

ElementFactory.createElement()

createResourceElement

public static Element createResourceElement(String name,
                                            Rectangle2D bounds,
                                            Color color,
                                            ElementAlignment alignment,
                                            ElementAlignment valignment,
                                            FontDefinition font,
                                            String nullValue,
                                            String resourceBase,
                                            String field)

Deprecated. Use a more fine-grained approach to define this element by using the element-factory directly.

creates a ResourceElement. ResourceElements resolve their value using a java.util.ResourceBundle.

Parameters:

name - the name of the element (null allowed)

bounds - the element's bounds

color - the text color of the element

alignment - the element's horizontal text alignment

valignment - the element's vertical text alignment

font - the elements font

nullValue - the text used when the value of this element is null

field - the field in the datamodel to retrieve values from

resourceBase - the classname/basename of the assigned resource bundle

Returns:

the created ResourceElement