org.jfree.report.function
Class PaintDynamicComponentFunction

java.lang.Object
  |
  +--org.jfree.report.function.AbstractExpression
        |
        +--org.jfree.report.function.AbstractFunction
              |
              +--org.jfree.report.function.PaintDynamicComponentFunction

Deprecated. Use the new Component-Element instead. It uses drawables for this job, and therefore the result looks much better.

public class PaintDynamicComponentFunction
extends AbstractFunction
implements java.io.Serializable, PageEventListener

Paints a AWT or Swing Component. The component must be contained in the dataRow.

Author:
Thomas Morgner
See Also:
Serialized Form

Constructor Summary
PaintDynamicComponentFunction()
          Deprecated. DefaultConstructor.
 
Method Summary
 java.lang.String getField()
          Deprecated. Returns the field used by the function.
 Expression getInstance()
          Deprecated. Return a completly separated copy of this function.
 float getScale()
          Deprecated. Gets the scale factor for the created image.
 java.lang.Object getValue()
          Deprecated. Return the current expression value.
 void groupFinished(ReportEvent event)
          Deprecated. Receives notification that a group has finished.
 void groupStarted(ReportEvent event)
          Deprecated. Receives notification that a group has started.
 void itemsAdvanced(ReportEvent event)
          Deprecated. Receives notification that a row of data is being processed.
 void pageCanceled(ReportEvent event)
          Deprecated. Receives notification that a page was canceled by the ReportProcessor.
 void pageFinished(ReportEvent event)
          Deprecated. Receives notification that a page has ended.
 void pageRolledBack(ReportEvent event)
          Deprecated. This event is fired, whenever an automatic pagebreak has been detected and the report state had been reverted to the previous state.
 void pageStarted(ReportEvent event)
          Deprecated. Receives notification that a page has started.
 void reportFinished(ReportEvent event)
          Deprecated. Receives notification that the report has finished.
 void reportInitialized(ReportEvent event)
          Deprecated. Receives notification that report generation initializes the current run.
 void reportStarted(ReportEvent event)
          Deprecated. Receives notification that the report has started.
 void setField(java.lang.String field)
          Deprecated. Sets the field name for the function.
 void setScale(float scale)
          Deprecated. Define a scale factor for the created image.
 
Methods inherited from class org.jfree.report.function.AbstractFunction
clone, itemsFinished, itemsStarted, reportDone
 
Methods inherited from class org.jfree.report.function.AbstractExpression
getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, setActive, setDependencyLevel, setName, setRuntime
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PaintDynamicComponentFunction

public PaintDynamicComponentFunction()
Deprecated. 
DefaultConstructor.
Throws:
java.lang.IllegalStateException - (HeadlessException) if no full AWT is available. This function needs a working layout manager.
Method Detail

getField

public java.lang.String getField()
Deprecated. 
Returns the field used by the function.

The field name corresponds to a column name in the report's TableModel.

Returns:
The field name.

setField

public void setField(java.lang.String field)
Deprecated. 
Sets the field name for the function.

The field name corresponds to a column name in the report's TableModel.

Parameters:
field - the field name (null not permitted).

reportStarted

public void reportStarted(ReportEvent event)
Deprecated. 
Receives notification that the report has started.
Overrides:
reportStarted in class AbstractFunction
Parameters:
event - the event.

reportInitialized

public void reportInitialized(ReportEvent event)
Deprecated. 
Receives notification that report generation initializes the current run.

The event carries a ReportState.Started state. Use this to initialize the report.

Overrides:
reportInitialized in class AbstractFunction
Parameters:
event - The event.

reportFinished

public void reportFinished(ReportEvent event)
Deprecated. 
Receives notification that the report has finished.
Overrides:
reportFinished in class AbstractFunction
Parameters:
event - the event.

pageStarted

public void pageStarted(ReportEvent event)
Deprecated. 
Receives notification that a page has started.
Specified by:
pageStarted in interface PageEventListener
Parameters:
event - the event.

pageFinished

public void pageFinished(ReportEvent event)
Deprecated. 
Receives notification that a page has ended.
Specified by:
pageFinished in interface PageEventListener
Parameters:
event - the event.

pageCanceled

public void pageCanceled(ReportEvent event)
Deprecated. 
Receives notification that a page was canceled by the ReportProcessor. This method is called, when a page was removed from the report after it was generated.
Specified by:
pageCanceled in interface PageEventListener
Parameters:
event - The event.

pageRolledBack

public void pageRolledBack(ReportEvent event)
Deprecated. 
This event is fired, whenever an automatic pagebreak has been detected and the report state had been reverted to the previous state.
Specified by:
pageRolledBack in interface PageEventListener
Parameters:
event -  

groupStarted

public void groupStarted(ReportEvent event)
Deprecated. 
Receives notification that a group has started.
Overrides:
groupStarted in class AbstractFunction
Parameters:
event - the event.

groupFinished

public void groupFinished(ReportEvent event)
Deprecated. 
Receives notification that a group has finished.
Overrides:
groupFinished in class AbstractFunction
Parameters:
event - the event.

itemsAdvanced

public void itemsAdvanced(ReportEvent event)
Deprecated. 
Receives notification that a row of data is being processed.
Overrides:
itemsAdvanced in class AbstractFunction
Parameters:
event - the event.

getValue

public java.lang.Object getValue()
Deprecated. 
Return the current expression value.

The value depends (obviously) on the expression implementation.

Returns:
the value of the function.

setScale

public void setScale(float 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.
Parameters:
scale - the scale factor.

getScale

public float getScale()
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.
Returns:
the scale factor.

getInstance

public Expression getInstance()
Deprecated. 
Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function.
Overrides:
getInstance in class AbstractExpression
Returns:
a copy of this function.