001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.ade.containerpage.client.ui;
029
030import org.opencms.gwt.client.ui.CmsList;
031import org.opencms.gwt.client.ui.CmsListItem;
032import org.opencms.gwt.client.ui.CmsScrollPanel;
033
034import com.google.gwt.user.client.ui.Composite;
035
036/**
037 * Base class for clipboard tabs.<p>
038 */
039public abstract class A_CmsClipboardTab extends Composite {
040
041    /**
042     * Adds an item to the list.<p>
043     *
044     * @param item the item to add
045     */
046    public void addListItem(CmsListItem item) {
047
048        getList().add(item);
049    }
050
051    /**
052     * Clears the list.<p>
053     */
054    public void clearList() {
055
056        getList().clear();
057    }
058
059    /**
060     * Returns the item list.<p>
061     *
062     * @return the item list
063     */
064    public abstract CmsList<CmsListItem> getList();
065
066    /**
067     * Returns the height required by the tab content.<p>
068     *
069     * @return the tab content height
070     */
071    public int getRequiredHeight() {
072
073        return getList().getElement().getClientHeight() + 17;
074    }
075
076    /**
077     * Returns the scroll panel.<p>
078     *
079     * @return the scroll panel
080     */
081    public abstract CmsScrollPanel getScrollPanel();
082
083    /**
084     * Replaces the item with the same id if present.<p>
085     *
086     * @param item the new item
087     */
088    public void replaceItem(CmsListItem item) {
089
090        CmsListItem oldItem = getList().getItem(item.getId());
091        if (oldItem != null) {
092            int index = getList().getWidgetIndex(oldItem);
093            getList().removeItem(oldItem);
094            if (index >= getList().getWidgetCount()) {
095                getList().addItem(item);
096            } else {
097                getList().insertItem(item, index);
098            }
099        }
100    }
101}