Package com.iizix.event
Class RefreshEvent
- java.lang.Object
- com.iizix.event.GEvent
- com.iizix.event.SinkEvent
- com.iizix.event.RefreshEvent
- All Implemented Interfaces:
IPostEventProcessing
public class RefreshEvent extends SinkEvent
Event indicating a refresh is required of a certain type, e.g. change of language code.- Author:
- Christopher Mindus
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RefreshEvent.Type
The refresh types.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 RefreshEvent(GProp<?> source, IClientSessionGyro clientGyro, RefreshEvent.Type type)
Constructs a new sinking refresh event of the specified type.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IClientSessionGyro
getClientSessionGyro()
The client session that caused the refresh.RefreshEvent.Type
getType()
Gets the refresh type.boolean
isRefreshEvent()
Returns true if this is a refresh event.protected java.lang.StringBuilder
paramString(java.lang.StringBuilder buf)
Returns the parameter string representing the state of this event.Methods inherited from class com.iizix.event.SinkEvent
getOperations
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, isRemoteInduced, isVerifyEvent, send, send, sendSelf, setInitialProperty, setOperation, setProgressMonitor, toString
Constructor Detail
RefreshEvent
public RefreshEvent(GProp<?> source, IClientSessionGyro clientGyro, RefreshEvent.Type type)
Constructs a new sinking refresh event of the specified type.- Parameters:
source
- The source property causing the change.clientGyro
- The client session that caused the refresh.type
- The refresh type.- Throws:
java.lang.NullPointerException
- If type is null.- See Also:
GEvent
Method Detail
getClientSessionGyro
public IClientSessionGyro getClientSessionGyro()
The client session that caused the refresh.- Returns:
- The client session gyro, or null if not from a client session.
getType
public RefreshEvent.Type getType()
Gets the refresh type.- Returns:
- The type of refresh.
isRefreshEvent
public boolean isRefreshEvent()
Returns true if this is a refresh event.- Overrides:
isRefreshEvent
in classGEvent
- Returns:
- true if this is a RefreshEvent: always true.
paramString
protected java.lang.StringBuilder paramString(java.lang.StringBuilder buf)
Returns the parameter string representing the state of this event. This string is useful for debugging. Super classes adds extra information to the string by preceding it with a comma followed by the extra information.- Overrides:
paramString
in classGEvent
- Parameters:
buf
- The StringBuilder to append the string to.- Returns:
- The StringBuilder, i.e. the
buf
input parameter.