com.gwtplatform.mvp.client.ViewImpl 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 java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.google.gwt.event.logical.shared.AttachEvent;
import com.google.gwt.event.logical.shared.AttachEvent.Handler;
import com.google.gwt.user.client.ui.HasOneWidget;
import com.google.gwt.user.client.ui.HasWidgets;
import com.google.gwt.user.client.ui.InsertPanel;
import com.google.gwt.user.client.ui.IsWidget;
import com.google.gwt.user.client.ui.Widget;
import com.gwtplatform.mvp.client.presenter.slots.IsSingleSlot;
import com.gwtplatform.mvp.client.presenter.slots.OrderedSlot;
import com.gwtplatform.mvp.client.presenter.slots.Slot;
/**
* A simple implementation of {@link View} that simply disregard every call to {@link #setInSlot(Object, IsWidget)},
* {@link #addToSlot(Object, IsWidget)}, and {@link #removeFromSlot(Object, IsWidget)}.
*
* Feel free not to inherit from this if you need another base class (such as {@link
* com.google.gwt.user.client.ui.Composite Composite}), but you will have to define the above methods.
*
* * Important call {@link #initWidget(IsWidget)} in your {@link View}'s constructor.
*/
public abstract class ViewImpl implements View {
private final Map oneWidgetSlots = new HashMap();
private final Map hasWidgetSlots = new HashMap();
private final Map, List>>> orderedSlots
= new HashMap, List>>>();
private Widget widget;
@SuppressWarnings("unchecked")
@Override
public void addToSlot(Object slot, IsWidget content) {
if (hasWidgetSlots.containsKey(slot)) {
if (orderedSlots.containsKey(slot)) {
List>> list = orderedSlots.get(slot);
list.add((Comparable>) content);
Collections.sort(list);
int index = Collections.binarySearch(list, (Comparable>) content);
InsertPanel insertPanel = (InsertPanel) hasWidgetSlots.get(slot);
insertPanel.insert(content.asWidget(), index);
} else {
hasWidgetSlots.get(slot).add(content.asWidget());
}
}
}
@Override
public void removeFromSlot(Object slot, IsWidget content) {
if (oneWidgetSlots.containsKey(slot)) {
if (oneWidgetSlots.get(slot).getWidget() == content.asWidget()) {
oneWidgetSlots.get(slot).setWidget(null);
}
} else if (hasWidgetSlots.containsKey(slot)) {
hasWidgetSlots.get(slot).remove(content.asWidget());
if (orderedSlots.containsKey(slot)) {
orderedSlots.get(slot).remove(content);
}
}
}
@SuppressWarnings("unchecked")
@Override
public void setInSlot(Object slot, IsWidget content) {
if (oneWidgetSlots.containsKey(slot)) {
oneWidgetSlots.get(slot).setWidget(content);
} else if (hasWidgetSlots.containsKey(slot)) {
hasWidgetSlots.get(slot).clear();
if (content != null) {
hasWidgetSlots.get(slot).add(content.asWidget());
}
if (orderedSlots.containsKey(slot)) {
orderedSlots.get(slot).clear();
if (content != null) {
orderedSlots.get(slot).add((Comparable>) content);
}
}
}
}
@Override
public Widget asWidget() {
if (widget == null) {
throw new NullPointerException("widget cannot be null, you should call ViewImpl.initWidget() before.");
}
return widget;
}
/**
* Link a {@link IsSingleSlot} sub-type to a container. The container must implement either {@link HasOneWidget} or
* {@link HasWidgets}. Here we accept {@code Object} to prevent the hassle of of casting {@code container} if it
* implements both interfaces.
*
* {@link HasOneWidget} has checked first.
*
* @param slot the slot
* @param container the container must implement {@link HasOneWidget}.
*
* @throws IllegalArgumentException if {@code container} implements neither of {@link HasOneWidget} or {@link
* HasWidgets}.
*/
protected void bindSlot(IsSingleSlot slot, Object container) {
internalBindSlot(slot, container);
}
/**
* Link a {@link Slot} to a container.
*
* @param slot the slot
* @param container the container must implement HasWidgets.
*/
protected void bindSlot(Slot slot, HasWidgets container) {
internalBindSlot(slot, container);
}
/**
* Link an {@link OrderedSlot} to a container.
*
* @param slot the slot
* @param container the container must implement {@link HasWidgets} & {@link InsertPanel}.
*/
protected void bindSlot(OrderedSlot slot, T container) {
orderedSlots.put(slot, new ArrayList>>());
hasWidgetSlots.put(slot, container);
}
protected void initWidget(IsWidget widget) {
if (this.widget != null) {
throw new IllegalStateException("ViewImpl.initWidget() may only be called once.");
} else if (widget == null) {
throw new NullPointerException("widget cannot be null");
}
this.widget = widget.asWidget();
asWidget().addAttachHandler(new Handler() {
@Override
public void onAttachOrDetach(AttachEvent event) {
if (event.isAttached()) {
onAttach();
} else {
onDetach();
}
}
});
}
/**
* Method called after the view is attached to the DOM.
*
* You should override this method to perform any ui related initialization that needs to be done after that the
* view is attached and that the presenter doesn't have to be aware of (attach event handlers for instance)
*/
protected void onAttach() {
}
/**
* Method called after the view is detached to the DOM.
*
* You should override this method to release any resources created directly or indirectly during the call to {@link
* #onAttach()}
*/
protected void onDetach() {
}
private void internalBindSlot(Object slot, Object container) {
if (container instanceof HasOneWidget) {
oneWidgetSlots.put(slot, (HasOneWidget) container);
} else if (container instanceof HasWidgets) {
hasWidgetSlots.put(slot, (HasWidgets) container);
} else {
throw new IllegalArgumentException("Containers must implement either HasOneWidget or HasWidgets.");
}
}
}