/*
 * Copyright (c) 2011, grossmann
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * * Neither the name of the jo-widgets.org nor the
 *   names of its contributors may be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL jo-widgets.org BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */

package org.jowidgets.api.model.item;

public interface IContainerItemModel extends IToolBarItemModel {

    /**
     * Gets the content creator for this model. The content creator is responsible to add the content (e.G. IControl) to
     * its container.
     * 
     * The method createContent(IContainer container) will be invoked when this model will be assigned to an toolbar.
     * The method containerDisposed(IContainer container) will be invoked after the model was removed from an toolbar.
     * 
     * Remark: If controls in the different toolbars should be synchronized, the content creator is responsible for that.
     * 
     * @return The content creator for this model.
     */
    IContainerContentCreator getContentCreator();

    /**
     * Sets the content creator for this model.
     * 
     * @param contentCreator The content creator to set.
     */
    void setContentCreator(IContainerContentCreator contentCreator);

    /**
     * Makes a deep copy of the item.
     * Registered listeners on items won't be copied.
     * 
     * @return A new instance that is a clone of this instance
     */
    @Override
    IContainerItemModel createCopy();

}