AttachEvent class
class AttachEvent extends DwtEvent {
/**
* The event type.
*/
static EventType<AttachEventHandler> TYPE = new EventType<AttachEventHandler>();
bool _attached;
/**
* Construct a new [AttachEvent].
*
* @param attached true if the source has been attached
*/
AttachEvent(this._attached);
EventType<AttachEventHandler> 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(AttachEventHandler handler) {
handler.onAttachOrDetach(this);
}
/**
* Fires an {@link AttachEvent} on all registered handlers in the handler
* source.
*
* @param <S> The handler source type
* @param source the source of the handlers
* @param attached whether to announce an attach or detach
*/
static void fire(HasAttachHandlers source, bool attached) {
if (TYPE != null) {
AttachEvent event = new AttachEvent(attached);
source.fireEvent(event);
}
}
}
Extends
IEvent<H> > DwtEvent > AttachEvent
Static Properties
EventType<AttachEventHandler> TYPE #
The event type.
static EventType<AttachEventHandler> TYPE = new EventType<AttachEventHandler>()
Static Methods
void fire(HasAttachHandlers source, bool attached) #
Fires an {@link AttachEvent} on all registered handlers in the handler source.
@param <S> The handler source type @param source the source of the handlers @param attached whether to announce an attach or detach
static void fire(HasAttachHandlers source, bool attached) {
if (TYPE != null) {
AttachEvent event = new AttachEvent(attached);
source.fireEvent(event);
}
}
Constructors
new AttachEvent(bool _attached) #
Construct a new AttachEvent.
@param attached true if the source has been attached
AttachEvent(this._attached);
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(AttachEventHandler 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(AttachEventHandler handler) {
handler.onAttachOrDetach(this);
}
EventType<AttachEventHandler> 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;
}