TooltipInfo.java

/*
 * Copyright 2000-2016 Vaadin Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.vaadin.client;

import com.vaadin.shared.ui.ContentMode;
import com.vaadin.shared.util.SharedUtil;

public class TooltipInfo {

    private String title;

    private ContentMode contentMode;

    private String errorMessageHtml;

    // Contains the tooltip's identifier. If a tooltip's contents and this
    // identifier haven't changed, the tooltip won't be updated in subsequent
    // events.
    private Object identifier;

    public TooltipInfo() {
    }

    public TooltipInfo(String tooltip) {
        this(tooltip, ContentMode.PREFORMATTED);
    }

    /**
     * Constructs a new instance using the {@code tooltip} for the title and
     * {@code errorMessage} as a description.
     * 
     * @param tooltip
     *            tooltip title
     * @param errorMessage
     *            error description
     * 
     * @deprecated use {@link #TooltipInfo(String, ContentMode, String)} instead
     */
    @Deprecated
    public TooltipInfo(String tooltip, String errorMessage) {
        this(tooltip, ContentMode.HTML, errorMessage, null);
    }

    /**
     * Constructs a new instance using the {@code tooltip} for the title,
     * {@code errorMessage} as a description and {@code identifier} as its id.
     * 
     * @param tooltip
     *            tooltip title
     * @param errorMessage
     *            error description
     * @param identifier
     * 
     * @deprecated use {@link #TooltipInfo(String, ContentMode, String, Object)}
     *             instead
     */
    @Deprecated
    public TooltipInfo(String tooltip, String errorMessage, Object identifier) {
        this(tooltip, ContentMode.HTML, errorMessage, identifier);
    }

    public TooltipInfo(String tooltip, ContentMode mode) {
        setTitle(tooltip);
        setContentMode(mode);
    }

    public TooltipInfo(String tooltip, ContentMode mode, String errorMessage) {
        this(tooltip, mode, errorMessage, null);
    }

    public TooltipInfo(String tooltip, ContentMode mode, String errorMessage,
            Object identifier) {
        setIdentifier(identifier);
        setTitle(tooltip);
        setContentMode(mode);
        setErrorMessage(errorMessage);
    }

    public void setIdentifier(Object identifier) {
        this.identifier = identifier;
    }

    public Object getIdentifier() {
        return identifier;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getErrorMessage() {
        return errorMessageHtml;
    }

    public void setErrorMessage(String errorMessage) {
        errorMessageHtml = errorMessage;
    }

    public ContentMode getContentMode() {
        return contentMode;
    }

    public void setContentMode(ContentMode contentMode) {
        this.contentMode = contentMode;
    }

    /**
     * Checks is a message has been defined for the tooltip.
     *
     * @return true if title or error message is present, false if both are
     *         empty
     */
    public boolean hasMessage() {
        return (title != null && !title.isEmpty())
                || (errorMessageHtml != null && !errorMessageHtml.isEmpty());
    }

    public boolean equals(TooltipInfo other) {
        return (other != null && SharedUtil.equals(other.title, title)
                && SharedUtil.equals(other.errorMessageHtml, errorMessageHtml)
                && other.identifier == identifier);
    }
}