com.alkacon.geranium.client.ui.input.ErrorWidget 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;

import com.alkacon.geranium.client.ui.css.I_InputLayoutBundle;
import com.alkacon.geranium.client.ui.css.I_LayoutBundle;
import com.alkacon.geranium.client.util.ClientStringUtil;
import com.alkacon.geranium.client.util.FadeAnimation;

import com.google.gwt.user.client.Command;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.Label;

/**
 * Helper class for displaying errors.
 */
public class ErrorWidget extends Composite {

    /** The internal label that displays the error message. */
    private Label m_label;

    /**
     * Creates a new instance.

     */
    public ErrorWidget() {

        m_label = createErrorLabel();
        initWidget(m_label);
        setText(null);
    }

    /**
     * Creates the a new error label.

     * 
     * @return a label with the appropriate style for  an error label
     */
    private static Label createErrorLabel() {

        Label label = new Label();
        label.addStyleName(I_LayoutBundle.INSTANCE.generalCss().cornerAll());
        label.addStyleName(I_InputLayoutBundle.INSTANCE.inputCss().error());
        return label;
    }

    /**
     * Returns true if a error message is set.

     * 
     * @return true if a error message is set
     */
    public boolean hasError() {

        return ClientStringUtil.isNotEmptyOrWhitespaceOnly(m_label.getText());
    }

    /**
     * Sets the text for the error message.

     * 
     * If the text parameter is null, the error message will be hidden.
     * @param text
     */
    public void setText(final String text) {

        setErrorVisible(false);
        m_label.setText(text);
    }

    /**
     * Hides the error.

     */
    protected void hideError() {

        if (hasError()) {
            FadeAnimation.fadeOut(m_label.getElement(), new Command() {

                /**
                 * @see com.google.gwt.user.client.Command#execute()
                 */
                public void execute() {

                    setErrorVisible(false);
                }
            }, 300);
        }
    }

    /**
     * Sets the visibility of the error label.

     * 
     * @param visible true if the error should be visible
     */
    protected void setErrorVisible(boolean visible) {

        m_label.setVisible(visible);
    }

    /**
     * Shows the error.
     */
    protected void showError() {

        if (hasError()) {
            m_label.getElement().getStyle().clearDisplay();
            FadeAnimation.fadeIn(m_label.getElement(), new Command() {

                /**
                 * @see com.google.gwt.user.client.Command#execute()
                 */
                public void execute() {

                    // noop
                }
            }, 300);
        }
    }
}