|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
org.pentaho.reporting.engine.classic.core.event.ReportEvent
public class ReportEvent
Represents a report event.
Includes information whichReportState
generated the event.
Field Summary | |
---|---|
static int |
ARTIFICIAL_EVENT_CODE
|
static int |
CROSSTABBING
Crosstab marker flag. |
static int |
CROSSTABBING_COL
|
static int |
CROSSTABBING_OTHER
|
static int |
CROSSTABBING_ROW
|
static int |
CROSSTABBING_TABLE
|
static int |
DEEP_TRAVERSING_EVENT
A flag that marks the given event as a deep-traversing event. |
static int |
GROUP_FINISHED
The event type constant, that a group finished event is invoked. |
static int |
GROUP_STARTED
The event type constant, that a group start event is invoked. |
static int |
ITEMS_ADVANCED
The event type constant, that the items advanced event is invoked. |
static int |
ITEMS_FINISHED
The event type constant, that the items finished event is invoked. |
static int |
ITEMS_STARTED
The event type constant, that the items started event is invoked. |
static int |
NO_PARENT_PASSING_EVENT
|
static int |
PAGE_CANCELED
Deprecated. No longer used. |
static int |
PAGE_FINISHED
The event type constant, that the page finished event is invoked. |
static int |
PAGE_ROLLEDBACK
Deprecated. No longer used. |
static int |
PAGE_STARTED
The event type constant, that the page start event is invoked. |
static int |
POST_GROUP_FOOTER
Deprecated. No longer used. |
static int |
POST_GROUP_HEADER
Deprecated. No longer used. |
static int |
REPORT_DONE
The event type constant, that the report done event is invoked. |
static int |
REPORT_FINISHED
The event type constant, that the report finished event is invoked. |
static int |
REPORT_INITIALIZED
The event type constant, that the report initialize event is invoked. |
static int |
REPORT_STARTED
The event type constant, that the report start event is invoked. |
Constructor Summary | |
---|---|
ReportEvent(ReportState state,
int type)
Creates a new ReportEvent . |
|
ReportEvent(ReportState state,
ReportState originatingState,
int type)
Creates a new ReportEvent . |
Method Summary | |
---|---|
DataRow |
getDataRow()
Returns the currently assigned dataRow for this event. |
int |
getLevel()
Returns the current function level. |
ReportState |
getOriginatingState()
Returns the originating state. |
ReportDefinition |
getReport()
Returns the report that generated the event. |
ReportState |
getState()
Returns the ReportState , which is the source of the event. |
int |
getType()
Returns the event type. |
boolean |
isDeepTraversing()
Checks whether the deep-traversing flag is set. |
static String |
translateStateCode(int code)
|
Methods inherited from class java.util.EventObject |
---|
getSource, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int REPORT_INITIALIZED
public static final int PAGE_STARTED
public static final int REPORT_STARTED
public static final int GROUP_STARTED
public static final int ITEMS_STARTED
public static final int ITEMS_ADVANCED
public static final int ITEMS_FINISHED
public static final int GROUP_FINISHED
public static final int REPORT_FINISHED
public static final int REPORT_DONE
public static final int PAGE_FINISHED
public static final int PAGE_CANCELED
public static final int POST_GROUP_FOOTER
public static final int POST_GROUP_HEADER
public static final int PAGE_ROLLEDBACK
public static final int CROSSTABBING
public static final int CROSSTABBING_TABLE
public static final int CROSSTABBING_OTHER
public static final int CROSSTABBING_ROW
public static final int CROSSTABBING_COL
public static final int DEEP_TRAVERSING_EVENT
public static final int NO_PARENT_PASSING_EVENT
public static final int ARTIFICIAL_EVENT_CODE
Constructor Detail |
---|
public ReportEvent(ReportState state, int type)
ReportEvent
.
state
- the current state of the processed report (null
not permmitted).type
- the event type for this event object.public ReportEvent(ReportState state, ReportState originatingState, int type)
ReportEvent
.
state
- the current state of the processed report (null
not permmitted).originatingState
- the original state that generated the event.type
- the event type for this event object.Method Detail |
---|
public int getType()
public ReportState getState()
ReportState
, which is the source of the event.
null
).public ReportState getOriginatingState()
public ReportDefinition getReport()
This is a convenience method that extracts the report from the report state.
public DataRow getDataRow()
DataRow
is used to access the fields of the DataSource
and other functions and expressions within the current row of the report.
public int getLevel()
public boolean isDeepTraversing()
public static String translateStateCode(int code)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |