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.ui.util;
029
030import com.vaadin.ui.Component;
031
032/**
033 * Container wrapping a single UI component.<p>
034 *
035 * This seemingly useless class is used as a typesafe way to add component-valued fields to component classes which use the Vaadin declarative UI mechanism
036 * when you don't want them to be bound automatically to something in the declarative UI HTML file.
037 * We could just use arrays of size 1 instead, but using a custom class is probably easier to understand.
038 *
039 * @param <T> the tpye of the wrapped component
040 */
041public class CmsComponentField<T extends Component> {
042
043    /** The wrapped component. */
044    private T m_value;
045
046    /**
047     * Convenience method for creating a new instance.<p>
048     *
049     * @return the new instance
050     */
051    public static <U extends Component> CmsComponentField<U> newInstance() {
052
053        return new CmsComponentField<U>();
054    }
055
056    /**
057     * Gets the wrapped component.<p>
058     *
059     * @return the wrapped component
060     */
061    public T get() {
062
063        return m_value;
064    }
065
066    /**
067     * Sets the wrapped component.<p>
068     *
069     * @param value the wrapped component
070     */
071    public void set(T value) {
072
073        m_value = value;
074    }
075
076}