All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.gwtplatform.mvp.client.HasSlots 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.List;
import java.util.Set;

import com.gwtplatform.mvp.client.presenter.slots.IsSingleSlot;
import com.gwtplatform.mvp.client.presenter.slots.IsSlot;
import com.gwtplatform.mvp.client.presenter.slots.MultiSlot;
import com.gwtplatform.mvp.client.presenter.slots.OrderedSlot;
import com.gwtplatform.mvp.client.presenter.slots.RemovableSlot;
import com.gwtplatform.mvp.client.presenter.slots.Slot;

/**
 * Interface of objects containing slots in which {@link PresenterWidget} can
 * be inserted.
 * 

* Slots are opaque objects and can be of any type. For slots meant to hold * only {@link PresenterWidget}s, you will usually declare an {@link Object} * constant within your presenter class: *

 * public static final Object SLOT_RevealTopBarContent = new Object();
 * 
* For slots in which you want to insert {@link Presenter}s, you must * use a {@link com.google.gwt.event.shared.GwtEvent.Type Type<RevealContentHandler<?>>} * object and annotate it with * {@link com.gwtplatform.mvp.client.annotations.ContentSlot ContentSlot}: *
 * {@literal @}ContentSlot
 * public static final Type<RevealContentHandler<?>> SLOT_RevealMainContent
 *   = new Type<RevealContentHandler<?>>();
 * 
*/ public interface HasSlots { /** * This method adds some content in a specific slot of the {@link Presenter}. * The attached {@link View} should manage this slot when its * {@link View#addToSlot(Object, com.google.gwt.user.client.ui.Widget)} is called. *

* Contrary to the {@link #setInSlot} method, no * {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} is fired, * so {@link PresenterWidget#onReset()} is not invoked. *

* For more details on slots, see {@link HasSlots}. * * @param slot An opaque object identifying which slot this content is being * added into. * @param content The content, a {@link PresenterWidget}. Passing {@code null} * will not add anything. * @deprecated since 1.5. Use {@link #addToSlot(MultiSlot, PresenterWidget)} instead. */ @Deprecated void addToSlot(Object slot, PresenterWidget content); /** * This method clears the content in a specific slot. No * {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} is fired. * The attached {@link View} should manage this slot when its * {@link View#setInSlot(Object, com.google.gwt.user.client.ui.Widget)} is called. It should also clear * the slot when the {@link View#setInSlot(Object, com.google.gwt.user.client.ui.Widget)} method is * called with {@code null} as a parameter. *

* For more details on slots, see {@link HasSlots}. * * @param slot An opaque object identifying which slot to clear. * @deprecated since 1.5. Use {@link #clearSlot(RemovableSlot)} instead. */ @Deprecated void clearSlot(Object slot); /** * This method removes some content in a specific slot of the * {@link Presenter}. No * {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} is fired. * The attached {@link View} should manage this slot when its * {@link View#removeFromSlot(Object, com.google.gwt.user.client.ui.Widget)} is called. *

* For more details on slots, see {@link HasSlots}. * * @param slot An opaque object identifying which slot this content is being * removed from. * @param content The content, a {@link PresenterWidget}. Passing {@code null} * will not remove anything. * @deprecated since 1.5. Use {@link #removeFromSlot(RemovableSlot, PresenterWidget)} instead. */ @Deprecated void removeFromSlot(Object slot, PresenterWidget content); /** * This method sets some content in a specific slot of the {@link Presenter}. * A {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} will be fired * after the top-most visible presenter is revealed, resulting in a call to * {@link PresenterWidget#onReset()}. *

* For more details on slots, see {@link HasSlots}. * * @param slot An opaque object identifying which slot this content is being * set into. The attached view should know what to do with this slot. * @param content The content, a {@link PresenterWidget}. Passing {@code null} * will clear the slot. * @deprecated since 1.5. Use {@link #setInSlot(IsSlot, PresenterWidget)} instead. */ @Deprecated void setInSlot(Object slot, PresenterWidget content); /** * This method sets some content in a specific slot of the {@link Presenter}. * The attached {@link View} should manage this slot when its * {@link View#setInSlot(Object, com.google.gwt.user.client.ui.Widget)} is called. It should also clear the * slot when the {@code setInSlot} method is called with {@code null} as a * parameter. *

* For more details on slots, see {@link HasSlots}. * * @param slot An opaque object identifying which slot this content is being * set into. * @param content The content, a {@link PresenterWidget}. Passing {@code null} * will clear the slot. * @param performReset Pass {@code true} if you want a * {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} to be fired * after the content has been added and this presenter is visible, pass * {@code false} otherwise. * @deprecated since 1.5. Use {@link #setInSlot(IsSlot, PresenterWidget, boolean)} instead. */ @Deprecated void setInSlot(Object slot, PresenterWidget content, boolean performReset); /** * This method adds some content in a specific slot of the {@link Presenter}. * The attached {@link View} should manage this slot when its * {@link View#addToSlot(Object, com.google.gwt.user.client.ui.Widget)} is called. *

* Contrary to the {@link #setInSlot} method, no * {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} is fired, * so {@link PresenterWidget#onReset()} is not invoked. *

* For more details on slots, see {@link HasSlots}. * * @param slot The slot into which the content is being added. * @param child The content, a {@link PresenterWidget}. Passing {@code null} * will not add anything. */ > void addToSlot(MultiSlot slot, T child); /** * This method clears the content in a specific slot. No * {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} is fired. * The attached {@link View} should manage this slot when its * {@link View#setInSlot(Object, com.google.gwt.user.client.ui.Widget)} is called. It should also clear * the slot when the {@link View#setInSlot(Object, com.google.gwt.user.client.ui.Widget)} method is * called with {@code null} as a parameter. *

* For more details on slots, see {@link HasSlots}. * * @param slot The slot to clear. */ void clearSlot(RemovableSlot slot); /** * This method removes some content in a specific slot of the * {@link Presenter}. No * {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} is fired. * The attached {@link View} should manage this slot when its * {@link View#removeFromSlot(Object, com.google.gwt.user.client.ui.Widget)} is called. *

* For more details on slots, see {@link HasSlots}. * * @param slot The slot for which the content is being removed. * @param child The content, a {@link PresenterWidget}. Passing {@code null} * will not remove anything. */ > void removeFromSlot(RemovableSlot slot, T child); /** * This method sets some content in a specific slot of the {@link Presenter}. * A {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} will be fired * after the top-most visible presenter is revealed, resulting in a call to * {@link PresenterWidget#onReset()}. *

* For more details on slots, see {@link HasSlots}. * * @param slot The slot for which the content is being set. * The attached view should know what to do with this slot. * @param child The content, a {@link PresenterWidget}. Passing {@code null} * will clear the slot. */ > void setInSlot(IsSlot slot, T child); /** * This method sets some content in a specific slot of the {@link Presenter}. * The attached {@link View} should manage this slot when its * {@link View#setInSlot(Object, com.google.gwt.user.client.ui.Widget)} is called. It should also clear the * slot when the {@code setInSlot} method is called with {@code null} as a * parameter. *

* For more details on slots, see {@link HasSlots}. * * @param slot The slot for which the content is being set. * @param child The content, a {@link PresenterWidget}. Passing {@code null} * will clear the slot. * @param performReset Pass {@code true} if you want a * {@link com.gwtplatform.mvp.client.proxy.ResetPresentersEvent} to be fired * after the content has been added and this presenter is visible, pass * {@code false} otherwise. */ > void setInSlot(IsSlot slot, T child, boolean performReset); /** * Get the child of SingleSlot. * @param slot - the slot * @return the child of the slot or null if the slot is empty. */ > T getChild(IsSingleSlot slot); /** * Get the children of a slot. * @param slot - the slot * @return the children of the slot. */ > Set getChildren(Slot slot); /** * Get the children of an ordered slot. * @param slot - an ordered slot * @return the children of the slot in a sorted list. */ & Comparable> List getChildren(OrderedSlot slot); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy