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

Class PaintDynamicComponentFunction

java.lang.Object

org.pentaho.reporting.engine.classic.core.function.AbstractExpression

org.pentaho.reporting.engine.classic.core.function.AbstractFunction

org.pentaho.reporting.engine.classic.core.function.PaintDynamicComponentFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, PageEventListener, ReportListener, Expression, Function

public class PaintDynamicComponentFunction
extends AbstractFunction
implements PageEventListener

Deprecated.

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

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

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PaintDynamicComponentFunction()	Deprecated. DefaultConstructor.

Method Summary

Modifier and Type	Method	Description
String	getField()	Deprecated. Returns the field used by the function.
float	getScale()	Deprecated. Gets the scale factor for the created image.
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	pageFinished(ReportEvent event)	Deprecated. Receives notification that a page has ended.
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(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.pentaho.reporting.engine.classic.core.function.AbstractFunction

itemsFinished, itemsStarted, reportDone, summaryRowSelection

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression

clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime

Constructor Detail

PaintDynamicComponentFunction

public PaintDynamicComponentFunction()

Deprecated.

DefaultConstructor.

Throws:

IllegalStateException - (HeadlessException) if no full AWT is available. This function needs a working layout manager.

Method Detail

getField

public String getField()

Deprecated.

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

Returns:

The field name.

setField

public void setField(String field)

Deprecated.

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

Parameters:

field - the field name.

reportStarted

public void reportStarted(ReportEvent event)

Deprecated.

Receives notification that the report has started.

Specified by:

reportStarted in interface ReportListener

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.

Specified by:

reportInitialized in interface ReportListener

Overrides:

reportInitialized in class AbstractFunction

Parameters:

event - The event.

reportFinished

public void reportFinished(ReportEvent event)

Deprecated.

Receives notification that the report has finished.

Specified by:

reportFinished in interface ReportListener

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.

groupStarted

public void groupStarted(ReportEvent event)

Deprecated.

Receives notification that a group has started.

Specified by:

groupStarted in interface ReportListener

Overrides:

groupStarted in class AbstractFunction

Parameters:

event - the event.

groupFinished

public void groupFinished(ReportEvent event)

Deprecated.

Receives notification that a group has finished.

Specified by:

groupFinished in interface ReportListener

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.

Specified by:

itemsAdvanced in interface ReportListener

Overrides:

itemsAdvanced in class AbstractFunction

Parameters:

event - the event.

getValue

public Object getValue()

Deprecated.

Return the current expression value.

The value depends (obviously) on the expression implementation.

Specified by:

getValue in interface Expression

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.