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

Class CreateHyperLinksFunction

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.AbstractElementFormatFunction

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

All Implemented Interfaces:

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

public class CreateHyperLinksFunction
extends AbstractElementFormatFunction

Deprecated.

add style expressions to the 'href-target' and 'href-window' instead. It is much easier and less confusing.

Adds hyperlinks to all elements with the name specified in 'element'. The link target is read from a specified field. The column referenced by this field should contain URLs or Strings.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CreateHyperLinksFunction()	Deprecated. Default Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	evaluateElement(ReportElement e)	Deprecated.
String	getField()	Deprecated. Returns the field name from where to read the hyper-link target.
String	getTarget()	Deprecated. Returns the target window.
String	getWindowField()	Deprecated. Returns the datarow-field from where to read the target window.
void	setField(String field)	Deprecated. Defines the field name from where to read the hyper-link target.
void	setTarget(String target)	Deprecated. Defines the target window.
void	setWindowField(String windowField)	Deprecated. Defines the datarow-field from where to read the target window.

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

getDependencyLevel, getElement, getInstance, getValue, groupFinished, groupStarted, isExecutable, itemsAdvanced, itemsFinished, itemsStarted, pageFinished, pageStarted, processBand, processFooterBands, processGroupHeaders, processHeaderBands, processRootBand, recordCacheHit, recordCacheMiss, reportCachePerformance, reportDone, reportFinished, reportInitialized, reportStarted, setElement

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

summaryRowSelection

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

clone, getDataRow, 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, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime

Methods inherited from interface org.pentaho.reporting.engine.classic.core.event.ReportListener

summaryRowSelection

Constructor Detail

CreateHyperLinksFunction

public CreateHyperLinksFunction()

Deprecated.

Default Constructor.

Method Detail

getField

public String getField()

Deprecated.

Returns the field name from where to read the hyper-link target.

Returns:

the name of the field.

setField

public void setField(String field)

Deprecated.

Defines the field name from where to read the hyper-link target.

Parameters:

field - a field name.

getTarget

public String getTarget()

Deprecated.

Returns the target window. This property is used if no window field was set. This is only meaningful for HTML exports.

Returns:

the target window string.

setTarget

public void setTarget(String target)

Deprecated.

Defines the target window. This property is used if no window field was set. This is only meaningful for HTML exports.

Parameters:

target - the target window string.

getWindowField

public String getWindowField()

Deprecated.

Returns the datarow-field from where to read the target window. This is only meaningful for HTML exports.

Returns:

the fieldname from where to read the target window string.

setWindowField

public void setWindowField(String windowField)

Deprecated.

Defines the datarow-field from where to read the target window. This is only meaningful for HTML exports.

Parameters:

windowField - the fieldname from where to read the target window string.

evaluateElement

protected boolean evaluateElement(ReportElement e)

Deprecated.

Specified by:

evaluateElement in class AbstractElementFormatFunction