org.jfree.report.function: public class: PaintComponentFunction

org.jfree.report.function
public class: PaintComponentFunction [javadoc | source]

java.lang.Object
   org.jfree.report.function.AbstractExpression
      org.jfree.report.function.AbstractFunction
         org.jfree.report.function.PaintComponentFunction

All Implemented Interfaces:
Function, Expression, Serializable

Deprecated! Use - the new Component-Element instead. It uses drawables for this job, and therefore the result looks much better. This method does no longer work, as it depended on implementation details that are no longer in use.

Paints a AWT or Swing Component, fitting the component into the element bounds. The component must be contained in the dataRow.

In an headless environment this function wont work and will always return null.

author: Thomas - Morgner

Constructor:
public PaintComponentFunction() { if (PaintComponentFunction.isHeadless() == false) { peerSupply = new Frame(); peerSupply.setLayout(new BorderLayout()); } this.scale = 1; } DefaultConstructor.

Constructor:

 public PaintComponentFunction() {
      
    if (PaintComponentFunction.isHeadless() == false)
    {
      peerSupply = new Frame();
      peerSupply.setLayout(new BorderLayout());
    }
    this.scale = 1;
}

DefaultConstructor.

Method from org.jfree.report.function.PaintComponentFunction Summary:
getElement, getField, getInstance, getScale, getValue, isHeadless, setElement, setField, setScale

Methods from org.jfree.report.function.AbstractFunction:
groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportInitialized, reportStarted

Methods from org.jfree.report.function.AbstractExpression:
clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jfree.report.function.PaintComponentFunction Detail:
public String getElement() { return element; } Deprecated! Returns the element used by the function. The element name corresponds to a element in the report. The element name must be unique, as the first occurence of the element is used.
public String getField() { return field; } Deprecated! Returns the field used by the function. The field name corresponds to a column name in the report's data-row.
public Expression getInstance() { final PaintComponentFunction pc = (PaintComponentFunction) super.getInstance(); if (PaintComponentFunction.isHeadless() == false) { pc.peerSupply = new Frame(); pc.peerSupply.setLayout(new BorderLayout()); } return pc; } Deprecated! Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function.
public float getScale() { return scale; } Deprecated! Gets the scale factor for the created image. Using a higher scale factor will produce better results. A scale factor of 2 will double the resolution. A scale factor of 1 will create 72 dpi images.
public Object getValue() { return null; } Deprecated! Return the current expression value. The value depends (obviously) on the expression implementation.
protected static boolean isHeadless() { return "true".equals(JFreeReportBoot.getInstance().getGlobalConfig().getConfigProperty ("java.awt.headless", "false")); } Deprecated! Tests, whether the report generation is executed in an headless environment.
public void setElement(String field) { if (field == null) { throw new NullPointerException(); } this.element = field; } Deprecated! Sets the element name for the function. The element name corresponds to a element in the report. The element name must be unique, as the first occurence of the element is used.
public void setField(String field) { this.field = field; } Deprecated! Sets the field name for the function. The field name corresponds to a column name in the report's data-row.
public void setScale(float scale) { this.scale = scale; } Deprecated! Define a scale factor for the created image. Using a higher scale factor will produce better results. A scale factor of 2 will double the resolution. A scale factor of 1 will create 72 dpi images.

Method from org.jfree.report.function.PaintComponentFunction Detail:

 public String getElement() {
    return element;
}

Deprecated!

The element name corresponds to a element in the report. The element name must be unique, as the first occurence of the element is used.

 public String getField() {
    return field;
}

Deprecated!

Returns the field used by the function. The field name corresponds to a column name in the report's data-row.

 public Expression getInstance() {
    final PaintComponentFunction pc = (PaintComponentFunction) super.getInstance();
    if (PaintComponentFunction.isHeadless() == false)
    {
      pc.peerSupply = new Frame();
      pc.peerSupply.setLayout(new BorderLayout());
    }
    return pc;
}

Deprecated!

Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function.

 public float getScale() {
    return scale;
}

Deprecated!

Gets the scale factor for the created image. Using a higher scale factor will produce better results. A scale factor of 2 will double the resolution. A scale factor of 1 will create 72 dpi images.

 public Object getValue() {
    return null;
}

Deprecated!

The value depends (obviously) on the expression implementation.

 protected static boolean isHeadless() {
    return "true".equals(JFreeReportBoot.getInstance().getGlobalConfig().getConfigProperty
        ("java.awt.headless", "false"));
}

Deprecated!

Tests, whether the report generation is executed in an headless environment.

 public  void setElement(String field) {
    if (field == null)
    {
      throw new NullPointerException();
    }
    this.element = field;
}

Deprecated!

The element name corresponds to a element in the report. The element name must be unique, as the first occurence of the element is used.

 public  void setField(String field) {
    this.field = field;
}

Deprecated!

Sets the field name for the function. The field name corresponds to a column name in the report's data-row.

 public  void setScale(float scale) {
    this.scale = scale;
}

Deprecated!

Define a scale factor for the created image. Using a higher scale factor will produce better results. A scale factor of 2 will double the resolution. A scale factor of 1 will create 72 dpi images.