| java.lang.Object java.util.EventObject org.jfree.report.event.ReportEvent
All known Subclasses: org.jfree.report.event.LayoutEvent,
Field Summary | |
final public static int | DEEP_TRAVERSING_EVENT A flag that marks the given event as a deep-traversing event. | final public static int | GROUP_FINISHED The event type constant, that a group finished event is invoked. | final public static int | GROUP_STARTED The event type constant, that a group start event is invoked. | final public static int | ITEMS_ADVANCED The event type constant, that the items advanced event is invoked. | final public static int | ITEMS_FINISHED The event type constant, that the items finished event is invoked. | final public static int | ITEMS_STARTED The event type constant, that the items started event is invoked. | final public static int | PAGE_CANCELED The event type constant, that the page finished event is invoked. | final public static int | PAGE_FINISHED The event type constant, that the page finished event is invoked. | final public static int | PAGE_ROLLEDBACK The event type constant, that the page rollback event is invoked. | final public static int | PAGE_STARTED The event type constant, that the page start event is invoked. | final public static int | POST_GROUP_FOOTER The event type constant, that the post group footer state will be processed. | final public static int | POST_GROUP_HEADER The event type constant, that the post group header state will be processed. | final public static int | PREPARE_EVENT The event type constant, that this event is a prepare event. | final public static int | REPORT_DONE The event type constant, that the report done event is invoked. | final public static int | REPORT_FINISHED The event type constant, that the report finished event is invoked. | final public static int | REPORT_INITIALIZED The event type constant, that the report initialize event is invoked. | final public static int | REPORT_STARTED The event type constant, that the report start event is invoked. |
DEEP_TRAVERSING_EVENT | final public static int DEEP_TRAVERSING_EVENT(Code) | | A flag that marks the given event as a deep-traversing event. This flag is an indicator, that the event did not
originate in this report, so it propably came from a parent or child report.
|
GROUP_FINISHED | final public static int GROUP_FINISHED(Code) | | The event type constant, that a group finished event is invoked.
|
GROUP_STARTED | final public static int GROUP_STARTED(Code) | | The event type constant, that a group start event is invoked.
|
ITEMS_ADVANCED | final public static int ITEMS_ADVANCED(Code) | | The event type constant, that the items advanced event is invoked.
|
ITEMS_FINISHED | final public static int ITEMS_FINISHED(Code) | | The event type constant, that the items finished event is invoked.
|
ITEMS_STARTED | final public static int ITEMS_STARTED(Code) | | The event type constant, that the items started event is invoked.
|
PAGE_CANCELED | final public static int PAGE_CANCELED(Code) | | The event type constant, that the page finished event is invoked.
|
PAGE_FINISHED | final public static int PAGE_FINISHED(Code) | | The event type constant, that the page finished event is invoked.
|
PAGE_ROLLEDBACK | final public static int PAGE_ROLLEDBACK(Code) | | The event type constant, that the page rollback event is invoked.
|
PAGE_STARTED | final public static int PAGE_STARTED(Code) | | The event type constant, that the page start event is invoked.
|
POST_GROUP_FOOTER | final public static int POST_GROUP_FOOTER(Code) | | The event type constant, that the post group footer state will be processed. This event is never fired.
|
POST_GROUP_HEADER | final public static int POST_GROUP_HEADER(Code) | | The event type constant, that the post group header state will be processed. This event is never fired.
|
PREPARE_EVENT | final public static int PREPARE_EVENT(Code) | | The event type constant, that this event is a prepare event. Use this constant in combination with one of the other
event types to specify which kind of event was prepared.
|
REPORT_DONE | final public static int REPORT_DONE(Code) | | The event type constant, that the report done event is invoked.
|
REPORT_FINISHED | final public static int REPORT_FINISHED(Code) | | The event type constant, that the report finished event is invoked.
|
REPORT_INITIALIZED | final public static int REPORT_INITIALIZED(Code) | | The event type constant, that the report initialize event is invoked.
|
REPORT_STARTED | final public static int REPORT_STARTED(Code) | | The event type constant, that the report start event is invoked.
|
ReportEvent | public ReportEvent(ReportState state, int type)(Code) | | Creates a new ReportEvent .
Parameters: state - the current state of the processed report (null not permmitted). Parameters: type - the event type for this event object. |
ReportEvent | public ReportEvent(ReportState state, ReportState originatingState, int type)(Code) | | Creates a new ReportEvent .
Parameters: state - the current state of the processed report (null not permmitted). Parameters: originatingState - the original state that generated the event. Parameters: type - the event type for this event object. |
getLevel | public int getLevel()(Code) | | Returns the current function level.
the function level. |
getOriginatingState | public ReportState getOriginatingState()(Code) | | Returns the originating state. The originating state is the state, that generated the event in the first place. For
master reports this is the same as the event source, for master-reports receiving events from a sub-report, this is
the subreport's report state.
the originating state. |
getReport | public ReportDefinition getReport()(Code) | | Returns the report that generated the event. This is a convenience method that extracts the report from the
report state.
the report. |
getState | public ReportState getState()(Code) | | Returns the ReportState , which is the source of the event.
the state (never null ). |
getType | public int getType()(Code) | | Returns the event type. The type is made up of a combination of several flags.
the event type. |
isDeepTraversing | public boolean isDeepTraversing()(Code) | | Checks, whether the deep-traversing flag is set. An event is deep-traversing, if it did not originate in the
current report.
true, if this is a deep-traversing element, false otherwise. |
isPrepareEvent | public boolean isPrepareEvent()(Code) | | Checks, whether this event is a prepare event. Prepare events are fired before the real event is fired and
sometimes simplify the state-management inside complex functions.
true, if this event is a prepare event, false otherwise. |
|
|