PHeaderPanel.java

/*
 * Copyright (c) 2011 PonySDK
 *  Owners:
 *  Luciano Broussal  <luciano.broussal AT gmail.com>
 *	Mathieu Barbier   <mathieu.barbier AT gmail.com>
 *	Nicolas Ciaravola <nicolas.ciaravola.pro AT gmail.com>
 *
 *  WebSite:
 *  http://code.google.com/p/pony-sdk/
 *
 * 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.ponysdk.core.ui.basic;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import com.ponysdk.core.model.ServerToClientModel;
import com.ponysdk.core.model.WidgetType;
import com.ponysdk.core.ui.model.ServerBinaryModel;

/**
 * A panel that includes a header (top), footer (bottom), and content (middle)
 * area. The header and footer areas resize naturally. The content area is
 * allocated all of the remaining space between the header and footer area.
 */
public class PHeaderPanel extends PPanel {

    private PWidget header;
    private PWidget content;
    private PWidget footer;

    protected PHeaderPanel() {
    }

    public void resize() {
        saveUpdate(writer -> writer.write(ServerToClientModel.RESIZE));
    }

    @Override
    protected WidgetType getWidgetType() {
        return WidgetType.HEADER_PANEL;
    }

    public PWidget getContentWidget() {
        return content;
    }

    public void setContentWidget(final PWidget child) {
        child.removeFromParent();
        adopt(child);
        content = child;
        saveAdd(child.getID(), ID, new ServerBinaryModel(ServerToClientModel.INDEX, 1));
    }

    public PWidget getFooterWidget() {
        return footer;
    }

    public void setFooterWidget(final PWidget child) {
        child.removeFromParent();
        adopt(child);
        footer = child;
        saveAdd(child.getID(), ID, new ServerBinaryModel(ServerToClientModel.INDEX, 2));
    }

    public PWidget getHeaderWidget() {
        return header;
    }

    public void setHeaderWidget(final PWidget child) {
        child.removeFromParent();
        adopt(child);
        header = child;
        saveAdd(child.getID(), ID, new ServerBinaryModel(ServerToClientModel.INDEX, 0));
    }

    @Override
    public boolean remove(final PWidget child) {
        if (child.getParent() != this) return false;

        orphan(child);

        if (child == content) {
            content = null;
            child.saveRemove(child.getID(), ID);
            return true;
        } else if (child == header) {
            header = null;
            child.saveRemove(child.getID(), ID);
            return true;
        } else if (child == footer) {
            footer = null;
            child.saveRemove(child.getID(), ID);
            return true;
        } else {
            return false;
        }
    }

    @Override
    public void add(final PWidget w) {
        // Add widgets in the order that they appear.
        if (header == null) {
            setHeaderWidget(w);
        } else if (content == null) {
            setContentWidget(w);
        } else if (footer == null) {
            setFooterWidget(w);
        } else {
            throw new IllegalStateException("HeaderPanel already contains header, content, and footer widgets.");
        }
    }

    @Override
    public Iterator<PWidget> iterator() {
        final List<PWidget> widgets = new ArrayList<>();
        if (header != null) widgets.add(header);
        if (content != null) widgets.add(content);
        if (footer != null) widgets.add(footer);
        return widgets.iterator();
    }

}