PlaceChangeEvent class
Event thrown when the user has reached a new location in the app.
class PlaceChangeEvent extends DwtEvent {
/**
* A singleton instance of Type.
*/
static EventType<PlaceChangeEventHandler> TYPE = new EventType<PlaceChangeEventHandler>();
Place _newPlace;
/**
* Constructs a PlaceChangeEvent for the given {@link Place}.
*
* @param _newPlace a {@link Place} instance
*/
PlaceChangeEvent(this._newPlace);
EventType<PlaceChangeEventHandler> getAssociatedType() {
return TYPE;
}
/**
* Return the new {@link Place}.
*
* @return a {@link Place} instance
*/
Place getNewPlace() {
return _newPlace;
}
void dispatch(PlaceChangeEventHandler handler) {
handler.onPlaceChange(this);
}
}
Extends
IEvent<H> > DwtEvent > PlaceChangeEvent
Static Properties
EventType<PlaceChangeEventHandler> TYPE #
A singleton instance of Type.
static EventType<PlaceChangeEventHandler> TYPE = new EventType<PlaceChangeEventHandler>()
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(PlaceChangeEventHandler handler) #
Implemented by subclasses 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(PlaceChangeEventHandler handler) {
handler.onPlaceChange(this);
}
EventType<PlaceChangeEventHandler> getAssociatedType() #
Place getNewPlace() #
Return the new {@link Place}.
@return a {@link Place} instance
Place getNewPlace() {
return _newPlace;
}
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;
}