org.wicketstuff.IQuickReuseStrategy Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2012 Vineet Semwal
 * 
 * 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 org.wicketstuff;

import org.apache.wicket.markup.repeater.IItemFactory;
import org.apache.wicket.markup.repeater.IItemReuseStrategy;
import org.apache.wicket.markup.repeater.Item;
import org.apache.wicket.model.IModel;

import java.util.Iterator;

/**
 * Interface for item reuse strategies.
 * 

 * Notice: Child items will be rendered in the order they are provided by the returned
 * iterator, so it is important that the strategy preserve this order
 * 
 * 
 * depending on use any new reuse strategy can be created ,few ready-made strategies for QuickView are 

 * 

 * 1) {@link DefaultQuickReuseStrategy}
 * 

 * 

 * 2) {@link QuickReuseIfModelsEqualStrategy}
 * 

 * 

 * 3) {@link ItemsNavigationStrategy}
 * 

 * 
 * 4) {@link ReuseAllStrategy}
 *
 * @author Vineet Semwal
 */
public interface IQuickReuseStrategy extends IItemReuseStrategy {

    /**
     * Returns an iterator over items that will be added to the view without re-rendering the QuickView
     *
     * @param         type of Item
     * @param startIndex index from where new items will be added
     * @param factory    implementation of IItemFactory
     * @param newModels  iterator over models for items
     * @return iterator over items that will be added
     */
     Iterator> addItems(int startIndex, IItemFactory factory, Iterator> newModels);


    /**
     * tells whether reuse strategy support addition of items to view without re-rendering QuickView
     *
     * @return boolean
     */
    boolean isPartialUpdatesSupported();


    /**
     * page to be created on render  if page is zero then the current page rendered is reconstructed
     */
    long getPageCreatedOnRender();

}