com.gwtplatform.mvp.client.proxy.PlaceRequestInternalEvent Maven / Gradle / Ivy
/**
* Copyright 2011 ArcBees Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.gwtplatform.mvp.client.proxy;
import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HasHandlers;
/**
* This event is fired by the {@link PlaceManager} whenever a new place is
* requested, either by history navigation or directly.
*
* Important! You should never fire that event directly. Instead, build a
* {@link PlaceRequest} and pass it to one of the following methods:
*
* - {@link PlaceManager#revealPlace(PlaceRequest)}
* - {@link PlaceManager#revealRelativePlace(PlaceRequest)}
* - {@link PlaceManager#revealRelativePlace(PlaceRequest, int)}
*
*
* @author David Peterson
* @author Philippe Beaudoin
*/
class PlaceRequestInternalEvent extends GwtEvent {
private static Type TYPE;
/**
* Fires a {@link PlaceRequestInternalEvent}
* into a source that has access to an {@com.google.web.bindery.event.shared.EventBus}.
*
* Important! You should not fire that event directly, see
* {@link PlaceRequestInternalEvent} for more details.
*
* @param source The source that fires this event ({@link HasHandlers}).
* @param request The request.
* @param updateBrowserHistory {@code true} If the browser URL should be updated, {@code false}
* otherwise.
*/
public static void fire(HasHandlers source, PlaceRequest request, boolean updateBrowserHistory) {
source.fireEvent(new PlaceRequestInternalEvent(request, updateBrowserHistory));
}
public static Type getType() {
if (TYPE == null) {
TYPE = new Type();
}
return TYPE;
}
private boolean authorized = true;
/**
* The handled flag can let others know when the event has been handled.
* Handlers should call {@link setHandled()} as soon as they figure they are
* be responsible for this event. Handlers should not process this event if
* {@link isHandled()} return {@code true}.
*/
private boolean handled;
private final PlaceRequest request;
private final boolean updateBrowserHistory;
public PlaceRequestInternalEvent(PlaceRequest request, boolean updateBrowserHistory) {
this.request = request;
this.updateBrowserHistory = updateBrowserHistory;
}
@Override
public Type getAssociatedType() {
return getType();
}
public PlaceRequest getRequest() {
return request;
}
/**
* Checks if the user was authorized to see the page.
*
* @return {@code true} if the user was authorized. {@code false} otherwise.
*/
public boolean isAuthorized() {
return authorized;
}
/**
* Checks if the event was handled. If it was, then it should not be processed
* further.
*
* @return {@code true} if the event was handled. {@code false} otherwise.
*/
public boolean isHandled() {
return handled;
}
public boolean shouldUpdateBrowserHistory() {
return updateBrowserHistory;
}
/**
* Indicates that the event was handled and that other handlers should not
* process it.
*/
public void setHandled() {
handled = true;
}
/**
* Indicates that the event was handled but that the user was not authorized
* to view the request page.
*/
public void setUnauthorized() {
authorized = false;
}
@Override
protected void dispatch(PlaceRequestInternalHandler handler) {
handler.onPlaceRequest(this);
}
}