CloseEvent<T> class
Represents a close event.
@param <T> the type being closed
class CloseEvent<T> extends DwtEvent {
/**
* The event type.
*/
static EventType<CloseHandler> TYPE = new EventType<CloseHandler>();
final T target;
final bool autoClosed;
/**
* Creates a new close event.
*
* @param target the target
* @param autoClosed whether it is auto closed
*/
CloseEvent(this.target, this.autoClosed);
EventType<CloseHandler> getAssociatedType() {
return TYPE;
}
/**
* Implemented by subclasses to to invoke their handlers in a type safe
* manner. Intended to be called by [EventBus#fireEvent(Event)] or
* [EventBus#fireEventFromSource(Event, Object)].
*
* @param handler handler
* @see EventBus#dispatchEvent(Event, Object)
*/
void dispatch(CloseHandler<T> handler) {
handler.onClose(this);
}
/**
* Fires a close event on all registered handlers in the handler manager.
*
* @param <T> the target type
* @param source the source of the handlers
* @param target the target
* @param autoClosed was the target closed automatically
*/
static void fire(HasCloseHandlers source, target, [bool autoClosed = false]) {
if (TYPE != null) {
CloseEvent event = new CloseEvent(target, autoClosed);
source.fireEvent(event);
}
}
}
Extends
IEvent<H> > DwtEvent > CloseEvent<T>
Static Properties
EventType<CloseHandler> TYPE #
The event type.
static EventType<CloseHandler> TYPE = new EventType<CloseHandler>()
Static Methods
void fire(HasCloseHandlers source, target, [bool autoClosed = false]) #
Fires a close event on all registered handlers in the handler manager.
@param <T> the target type @param source the source of the handlers @param target the target @param autoClosed was the target closed automatically
static void fire(HasCloseHandlers source, target, [bool autoClosed = false]) {
if (TYPE != null) {
CloseEvent event = new CloseEvent(target, autoClosed);
source.fireEvent(event);
}
}
Constructors
Methods
void assertLive() #
Asserts that the event still should be accessed. All events are considered to be "dead" after their original handler manager finishes firing them. An event can be revived by calling {@link GwtEvent#revive()}.
void assertLive() {
assert (!_dead) ; //: "This event has already finished being processed by its original handler manager, so you can no longer access it";
}
void dispatch(CloseHandler<T> handler) #
Implemented by subclasses to to invoke their handlers in a type safe
manner. Intended to be called by EventBus#fireEvent(Event) or
EventBus#fireEventFromSource(Event, Object).
@param handler handler @see EventBus#dispatchEvent(Event, Object)
void dispatch(CloseHandler<T> handler) {
handler.onClose(this);
}
EventType<CloseHandler> getAssociatedType() #
Object getSource() #
Returns the source for this event. The type and meaning of the source is
arbitrary, and is most useful as a secondary key for handler registration.
(See EventBus#addHandlerToSource, which allows a handler to
register for events of a particular type, tied to a particular source.)
Note that the source is actually set at dispatch time, e.g. via
EventBus#fireEventFromSource(Event, Object).
@return object representing the source of this event
Object getSource() {
assertLive();
return super.getSource();
}
bool isLive() #
Is the event current live?
@return whether the event is live
bool isLive() {
return !_dead;
}
void kill() #
Kill the event. After the event has been killed, users cannot really on its values or functions being available.
void kill() {
_dead = true;
setSource(null);
}
void overrideSource(Object source) #
void overrideSource(Object source) {
super.setSource(source);
}
void revive() #
Revives the event. Used when recycling event instances.
void revive() {
_dead = false;
setSource(null);
}
void setSource(source) #
Set the source that triggered this event. Intended to be called by the EventBus during dispatch.
@param source the source of this event. @see EventBus#fireEventFromSource(Event, Object) @see EventBus#setSourceOfEvent(Event, Object)
void setSource(dynamic source) {
this._source = source;
}