com.gwtplatform.mvp.client.PopupViewWithUiHandlers 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;
import com.google.web.bindery.event.shared.EventBus;
import com.gwtplatform.mvp.client.view.PopupPositioner;
/**
* Base class for a {@link PopupView} that implements the {@link HasUiHandlers}
* interface. You should always call {@link #setUiHandlers(UiHandlers)} from your
* presenter 's constructor.
*
* Important! Never call {@link #getUiHandlers()} inside your constructor
* since the {@link UiHandlers} are not yet set.
*
* @param Your {@link UiHandlers} interface type.
*/
public abstract class PopupViewWithUiHandlers extends
PopupViewImpl implements HasUiHandlers {
private C uiHandlers;
/**
* The {@link PopupViewWithUiHandlers} class uses the {@link EventBus} to listen to
* {@link com.gwtplatform.mvp.client.proxy.NavigationEvent} in order to automatically
* close when this event is fired, if desired. See
* {@link #setAutoHideOnNavigationEventEnabled(boolean)} for details.
*
* @param eventBus The {@link EventBus}.
*/
public PopupViewWithUiHandlers(EventBus eventBus) {
super(eventBus);
}
/**
* @param eventBus The {@link EventBus}.
* @param positioner The {@link PopupPositioner} used to position the popup onReveal();
*
* @see com.gwtplatform.mvp.client.view.CenterPopupPositioner
* @see com.gwtplatform.mvp.client.view.RelativeToWidgetPopupPositioner
* @see com.gwtplatform.mvp.client.view.TopLeftPopupPositioner
*/
protected PopupViewWithUiHandlers(EventBus eventBus, PopupPositioner positioner) {
super(eventBus, positioner);
}
/**
* Access the {@link UiHandlers} associated with this {@link View}.
*
* Important! Never call {@link #getUiHandlers()} inside your constructor
* since the {@link UiHandlers} are not yet set.
*
* @return The {@link UiHandlers}, or {@code null} if they are not yet set.
*/
protected C getUiHandlers() {
return uiHandlers;
}
@Override
public void setUiHandlers(C uiHandlers) {
this.uiHandlers = uiHandlers;
}
}