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.gwt.client.ui.input;
029
030/**
031 * Interface for widgets which can contain a "ghost value".<p>
032 *
033 * A ghost value will be displayed, but not reported when asking the widget for its current value.<p>
034 *
035 * @since 8.0.0
036 */
037public interface I_CmsHasGhostValue {
038
039    /**
040     * Enables or disables ghost mode, if possible.<p>
041     *
042     * @param enable if ghost mode should be enabled, else disabled
043     */
044    void setGhostMode(boolean enable);
045
046    /**
047     * Sets the "ghost value" of the widget and optionally sets it to "ghost mode".<p>
048     *
049     * "Ghost mode" can be used to show the user the value (called "ghost value") which will be used if he
050     * either doesn't choose an option in the widget, or explicitly chooses an "empty" or "default" option.<p>
051     *
052     * @param value the ghost value
053     * @param isGhostMode if true, sets the widget to ghost mode
054     */
055    void setGhostValue(String value, boolean isGhostMode);
056}