/*******************************************************************************
 * Copyright (c) 2000, 2007 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Chris Gross chris.gross@us.ibm.com Bug 107443
 *******************************************************************************/
package org.eclipse.ui.internal;

import org.eclipse.ui.IPlaceholderFolderLayout;

/**
 * This layout is used to define the initial set of placeholders
 * in a placeholder.
 * <p>
 * Views are added to the placeholder by ID. This id is used to identify 
 * a view descriptor in the view registry, and this descriptor is used to 
 * instantiate the IViewPart.
 * </p>
 */
public class PlaceholderFolderLayout implements IPlaceholderFolderLayout {
    private PageLayout pageLayout;

    private ContainerPlaceholder placeholder;

    public PlaceholderFolderLayout(PageLayout pageLayout,
            ContainerPlaceholder folder) {
        super();
        this.placeholder = folder;
        this.pageLayout = pageLayout;
    }

    /**
     * @see IPlaceholderFolderLayout
     */
    public void addPlaceholder(String viewId) {
        if (!pageLayout.checkValidPlaceholderId(viewId)) {
            return;
        }

        // Create the placeholder.
        LayoutPart newPart = new PartPlaceholder(viewId);

        linkPartToPageLayout(viewId, newPart);

        // Add it to the placeholder layout.
        placeholder.add(newPart);
    }

    /**
     * Inform the page layout of the new part created
     * and the placeholder the part belongs to.
     */
    private void linkPartToPageLayout(String viewId, LayoutPart newPart) {
        pageLayout.setRefPart(viewId, newPart);
        // force creation of the view layout rec
        pageLayout.getViewLayoutRec(viewId, true);

        pageLayout.setFolderPart(viewId, placeholder);
        newPart.setContainer(placeholder);
    }

    /* (non-Javadoc)
     * @see org.eclipse.ui.IPlaceholderFolderLayout#getProperty(java.lang.String)
     */
    public String getProperty(String id) {
        LayoutPart folder = placeholder.getRealContainer();
        if (folder instanceof PartStack) {
            PartStack stack = (PartStack)folder;
            return stack.getProperty(id);
        }       
        //throw not supported?
        return null;
    }

    /* (non-Javadoc)
     * @see org.eclipse.ui.IPlaceholderFolderLayout#setProperty(java.lang.String, java.lang.String)
     */
    public void setProperty(String id, String value) {
        LayoutPart folder = placeholder.getRealContainer();
        if (folder instanceof PartStack) {
            PartStack stack = (PartStack)folder;
            stack.setProperty(id,value);
        }       
        //throw not supported?
    }
}