Package com.iizix.event
Class SinkEvent
- java.lang.Object
- com.iizix.event.GEvent
- com.iizix.event.SinkEvent
- All Implemented Interfaces:
IPostEventProcessing
- Direct Known Subclasses:
AssetEvent,JavaClassEvent,JavaMethodEvent,ParentCnrAddedEvent,ParentCnrMoveEvent,ParentCnrNameEvent,ProjectNameEvent,PropCnrFocusEvent,QueryDesignerPropEvent,RefreshEvent,VSReferenceEvent
public abstract class SinkEvent extends GEvent
Abstract class extending the baseGEventto set the event propagation to sinking, i.e. events send from parent to children. Note that sinking events can have a big impact on performance for large property trees.Sinking events are typically used when a parent wishes to inform children of something, or by means of a "messaging system" to let e.g. an event collect information from potential event listeners, a good example would be
QueryReferencesEvent, and ResolveReferencesEvent.- Author:
- Christopher Mindus
Nested Class Summary
Nested classes/interfaces inherited from class com.iizix.event.GEvent
GEvent.Operation
Field Summary
Fields inherited from class com.iizix.event.GEvent
PROP_ADDED, PROP_ATTR_CHANGED, PROP_CNR_ADDED, PROP_CNR_FOCUS, PROP_CNR_MOVED, PROP_CNR_RENAMED, PROP_DESIGNER_ASSET_CHANGED, PROP_DESIGNER_JAVA_CLASS_CHANGED, PROP_DESIGNER_JAVA_METHOD_RENAMED, PROP_DESIGNER_KSTRING, PROP_DESIGNER_VIEWER_UPDATE, PROP_DESIGNER_VS_REFERENCE, PROP_DISPOSED, PROP_FOCUS, PROP_MOVED_FROM, PROP_MOVED_TO, PROP_PROJECT_RENAMED, PROP_QUERY_DESIGNER_PROPS, PROP_REFRESH, PROP_REMOVED, PROP_RENAMED, PROP_REORDERED, PROP_RESOLVE_REFERENCES_DIRECT, PROP_VALUE_CHANGED, REMOTE
Constructor Summary
Constructors Constructor Description SinkEvent(GProp<?> source, int eventID, boolean isRemoteInduced)Constructs the generic sink event with specified originator without progress monitor.SinkEvent(GProp<?> source, int eventID, IPropProgressMonitor monitor)Constructs the generic event sink with specified originator that has a progress monitor and is not remote induced.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GEvent.Operation[]getOperations()Gets the Operations order describing what Operation the property that receives the event should process.Methods inherited from class com.iizix.event.GEvent
addPostProcessor, cancel, consume, getAlternateDestination, getEventID, getEventName, getEventName, getEventTarget, getOperation, getPostProcessors, getSender, getSource, getTrigger, isCancelled, isClearCacheEvent, isConsumed, isEventProcessed, isPropertyChange, isPropertyChange, isPropertyChange, isPropertyChangeIn, isPropertyChangeInTree, isRefreshEvent, isRemoteInduced, isVerifyEvent, paramString, send, send, sendSelf, setInitialProperty, setOperation, setProgressMonitor, toString
Constructor Detail
SinkEvent
public SinkEvent(GProp<?> source, int eventID, boolean isRemoteInduced)
Constructs the generic sink event with specified originator without progress monitor.- Parameters:
source- The source object.eventID- The event ID, seeGEvent.PROP_*.isRemoteInduced- Flag indicating this change is induced from a remote party.- Throws:
java.lang.NullPointerException- If source isnull.
SinkEvent
public SinkEvent(GProp<?> source, int eventID, IPropProgressMonitor monitor)
Constructs the generic event sink with specified originator that has a progress monitor and is not remote induced.- Parameters:
source- The source object.eventID- The event ID, seeGEvent.PROP_*.monitor- The progress monitor, null for none.- Throws:
java.lang.NullPointerException- If souce isnull.
Method Detail
getOperations
public GEvent.Operation[] getOperations()
Gets the Operations order describing what Operation the property that receives the event should process. This Operations order defines that the event will be sinking, i.e. sent from parent to children.The event Operations in order are: SELF, LISTENERS, CHILDREN.
- Specified by:
getOperationsin classGEvent- Returns:
- The order of the Operations, per Event-implementing class dependent, normally a static final array.