com.alkacon.geranium.client.ui.input.I_HasGhostValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geranium-client Show documentation

A GWT UI framework. This component is used as a part of OpenCms, an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 2.1

Show newest version

/*
 * This library is part of Geranium -
 * an open source UI library for GWT.
 *
 * Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)-
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package com.alkacon.geranium.client.ui.input;

/**
 * Interface for widgets which can contain a "ghost value".
 * 
 * A ghost value will be displayed, but not reported when asking the widget for its current value.

 */
public interface I_HasGhostValue {

    /**
     * Enables or disables ghost mode, if possible.

     * 
     * @param enable if ghost mode should be enabled, else disabled 
     */
    void setGhostMode(boolean enable);

    /**
     * Sets the "ghost value" of the widget and optionally sets it to "ghost mode".

     * 
     * "Ghost mode" can be used to show the user the value (called "ghost value") which will be used if he 
     * either doesn't choose an option in the widget, or explicitly chooses an "empty" or "default" option.
     * 
     * @param value the ghost value 
     * @param isGhostMode if true, sets the widget to ghost mode 
     */
    void setGhostValue(String value, boolean isGhostMode);
}