org.jfree.report.elementfactory
Class ResourceFieldElementFactory

java.lang.Object
  extended byorg.jfree.report.elementfactory.ElementFactory
      extended byorg.jfree.report.elementfactory.TextElementFactory
          extended byorg.jfree.report.elementfactory.TextFieldElementFactory
              extended byorg.jfree.report.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 TextElement createResourceElement(java.lang.String name, java.awt.geom.Rectangle2D bounds, java.awt.Color color, ElementAlignment alignment, ElementAlignment valignment, FontDefinition font, java.lang.String nullValue, java.lang.String resourceBase, java.lang.String field)
          creates a ResourceElement.
 java.lang.String getResourceBase()
          Returns the base name of the resource bundle used to translate the content later.
 void setResourceBase(java.lang.String resourceBase)
          Defines the base name of the resource bundle used to translate the content later.
 
Methods inherited from class org.jfree.report.elementfactory.TextFieldElementFactory
createStringElement, createStringElement, getFieldname, getNullString, setFieldname, setNullString
 
Methods inherited from class org.jfree.report.elementfactory.TextElementFactory
applyStyle, getBold, getColor, getEmbedFont, getEncoding, getFontName, getFontSize, getHorizontalAlignment, getItalic, getLineHeight, getReservedLiteral, getStrikethrough, getTrimTextContent, getUnderline, getVerticalAlignment, setBold, setColor, setEmbedFont, setEncoding, setFontName, setFontSize, setHorizontalAlignment, setItalic, setLineHeight, setReservedLiteral, setStrikethrough, setTrimTextContent, setUnderline, setVerticalAlignment
 
Methods inherited from class org.jfree.report.elementfactory.ElementFactory
applyElementName, getAbsolutePosition, getDynamicHeight, getMaximumSize, getMinimumSize, getName, getPreferredSize, setAbsolutePosition, setDynamicHeight, setMaximumSize, setMinimumSize, setName, setPreferredSize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceFieldElementFactory

public ResourceFieldElementFactory()
Default Constructor.

Method Detail

getResourceBase

public java.lang.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(java.lang.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.
Throws:
java.lang.IllegalStateException - if the fieldname is not defined.
See Also:
ElementFactory.createElement()

createResourceElement

public static TextElement createResourceElement(java.lang.String name,
                                                java.awt.geom.Rectangle2D bounds,
                                                java.awt.Color color,
                                                ElementAlignment alignment,
                                                ElementAlignment valignment,
                                                FontDefinition font,
                                                java.lang.String nullValue,
                                                java.lang.String resourceBase,
                                                java.lang.String field)
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