|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jrefinery.report.function.AbstractFunction
com.jrefinery.report.function.ReportPropertyFunction
A report function that returns a property that has been set for a report.
There are some properties that are defined for all reports: "report.name" and "report.date".
You can add arbitrary properties to a report using the setProperty method.
Field Summary | |
static java.lang.String |
REPORTPROPERTY_PROPERTY
Deprecated. Literal text for the 'reportProperty' property. |
Fields inherited from interface com.jrefinery.report.function.Expression |
AUTOACTIVATE_PROPERTY |
Constructor Summary | |
ReportPropertyFunction()
Deprecated. Default constructor (intended for use by the SAX handler only). |
|
ReportPropertyFunction(java.lang.String name,
java.lang.String propertyName)
Deprecated. Constructs a new function. |
Method Summary | |
java.lang.String |
getField()
Deprecated. Returns the name of the report property that the function accesses. |
java.lang.Object |
getValue()
Deprecated. Returns the function's value. |
void |
groupFinished(ReportEvent event)
Deprecated. Updates the property value of this function. |
void |
groupStarted(ReportEvent event)
Deprecated. Updates the property value of this function. |
void |
initialize()
Deprecated. Initialises the function. |
void |
itemsAdvanced(ReportEvent event)
Deprecated. Updates the property value of this function. |
void |
itemsFinished(ReportEvent event)
Deprecated. Updates the property value of this function. |
void |
itemsStarted(ReportEvent event)
Deprecated. Updates the property value of this function. |
void |
pageFinished(ReportEvent event)
Deprecated. Updates the property value of this function. |
void |
pageStarted(ReportEvent event)
Deprecated. Updates the property value of this function. |
void |
reportFinished(ReportEvent event)
Deprecated. Updates the property value of this function. |
void |
reportStarted(ReportEvent event)
Deprecated. Updates the property value of this function. |
void |
setField(java.lang.String field)
Deprecated. Sets the name of the report property that the function accesses. |
Methods inherited from class com.jrefinery.report.function.AbstractFunction |
clone, getDataRow, getDependencyLevel, getInstance, getName, getProperties, getProperty, getProperty, isActive, reportDone, reportInitialized, setDataRow, setDependencyLevel, setName, setProperties, setProperty |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String REPORTPROPERTY_PROPERTY
Constructor Detail |
public ReportPropertyFunction()
public ReportPropertyFunction(java.lang.String name, java.lang.String propertyName)
name
- the function name.propertyName
- the property name.Method Detail |
public void reportStarted(ReportEvent event)
reportStarted
in interface ReportListener
reportStarted
in class AbstractFunction
event
- the event.public void reportFinished(ReportEvent event)
reportFinished
in interface ReportListener
reportFinished
in class AbstractFunction
event
- the event.public void pageStarted(ReportEvent event)
pageStarted
in interface ReportListener
pageStarted
in class AbstractFunction
event
- the event.public void pageFinished(ReportEvent event)
pageFinished
in interface ReportListener
pageFinished
in class AbstractFunction
event
- the event.public void groupStarted(ReportEvent event)
groupStarted
in interface ReportListener
groupStarted
in class AbstractFunction
event
- the event.public void groupFinished(ReportEvent event)
groupFinished
in interface ReportListener
groupFinished
in class AbstractFunction
event
- the event.public void itemsAdvanced(ReportEvent event)
itemsAdvanced
in interface ReportListener
itemsAdvanced
in class AbstractFunction
event
- the event.public void itemsStarted(ReportEvent event)
itemsStarted
in interface ReportListener
itemsStarted
in class AbstractFunction
event
- the event.public void itemsFinished(ReportEvent event)
itemsFinished
in interface ReportListener
itemsFinished
in class AbstractFunction
event
- the event.public java.lang.Object getValue()
getValue
in interface Expression
public java.lang.String getField()
I recommend renaming this method getReportPropertyName() (DG);
public void setField(java.lang.String field)
I recommend renaming this method setReportPropertyName() (DG);
field
- The report property name.public void initialize() throws FunctionInitializeException
initialize
in interface Expression
initialize
in class AbstractFunction
FunctionInitializeException
- if the function is not fully initialised.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |