org.jfree.report.function
Class CreateHyperLinksFunction

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

public class CreateHyperLinksFunction
extends AbstractElementFormatFunction

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
CreateHyperLinksFunction()
          Creates an unnamed function.
 
Method Summary
 java.lang.String getField()
           
 java.lang.Object getValue()
          Return the current expression value.
 java.lang.String getWindowField()
           
protected  void processRootBand(Band b)
           
 void setField(java.lang.String field)
           
 void setWindowField(java.lang.String windowField)
           
 
Methods inherited from class org.jfree.report.function.AbstractElementFormatFunction
getElement, groupFinished, groupStarted, itemsAdvanced, pageCanceled, pageFinished, pageRolledBack, pageStarted, reportFinished, reportStarted, setElement
 
Methods inherited from class org.jfree.report.function.AbstractFunction
clone, itemsFinished, itemsStarted, reportDone, reportInitialized
 
Methods inherited from class org.jfree.report.function.AbstractExpression
getDataRow, getDependencyLevel, getInstance, 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

CreateHyperLinksFunction

public CreateHyperLinksFunction()
Creates an unnamed function. Make sure the name of the function is set using AbstractExpression.setName(java.lang.String) before the function is added to the report's function collection.
Method Detail

getValue

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

The value depends (obviously) on the expression implementation.

Returns:
the value of the function.

getField

public java.lang.String getField()

setField

public void setField(java.lang.String field)

getWindowField

public java.lang.String getWindowField()

setWindowField

public void setWindowField(java.lang.String windowField)

processRootBand

protected void processRootBand(Band b)
Overrides:
processRootBand in class AbstractElementFormatFunction