SalesPoint Framework v3.1

sale.events
Class FormSheetEvent

java.lang.Object
  extended byjava.util.EventObject
      extended bysale.events.FormSheetEvent
All Implemented Interfaces:
Serializable

public class FormSheetEvent
extends EventObject

An EventObject describing a FormSheet that was set or closed at a Display.

Since:
v2.0
Author:
Steffen Zschaler
See Also:
FormSheet, Display, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
FormSheetEvent(Display src, FormSheet fs, boolean fExplicit)
          Create a new FormSheetEvent.
 
Method Summary
 FormSheet getFormSheet()
          Get the affected FormSheet.
 boolean isExplicit()
          Was the event caused by a direct call to the originating method or indirectly?
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FormSheetEvent

public FormSheetEvent(Display src,
                      FormSheet fs,
                      boolean fExplicit)
Create a new FormSheetEvent.

Parameters:
src - the Display originating the event.
fs - the FormSheet that was affected by the event.
fExplicit - was the event caused by a direct call to the originating method or indirectly?
Method Detail

getFormSheet

public FormSheet getFormSheet()
Get the affected FormSheet.

Override:
Never

isExplicit

public boolean isExplicit()
Was the event caused by a direct call to the originating method or indirectly?

formSheetSet events are always considered explicit. In contrast, formSheetRemoved events are explicit only if they were originated as the consequence of a call to closeFormSheet or setFormSheet (null). FormSheet removals that were caused by setting another FormSheet are not considered explicit.

Override:
Never

SalesPoint Framework v3.1