com.alee.managers.language.updaters.CustomToolTipLanguage Maven / Gradle / Ivy

Go to download
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.managers.language.updaters;

import com.alee.api.jdk.Objects;
import com.alee.managers.language.Language;
import com.alee.managers.language.LanguageState;
import com.alee.managers.language.data.Text;
import com.alee.managers.tooltip.TooltipManager;
import com.alee.managers.tooltip.WebCustomTooltip;

import javax.swing.*;

/**
 * This class provides language updates for custom WebLaF tooltips of any component.
 * This {@link LanguageUpdater} shouldn't be used directly for {@link JToolTip} but instead it is used by {@link ToolTipLU}.
 *
 * @param  component type
 * @author Mikle Garin
 * @see How to use LanguageManager
 * @see com.alee.managers.language.LanguageManager
 */
public class CustomToolTipLanguage extends AbstractToolTipLanguage
{
    /**
     * Custom {@link com.alee.managers.tooltip.WebCustomTooltip}.
     */
    public static final String TYPE = "CUSTOM";

    /**
     * Special marker for {@link JComponent}s where this {@link LanguageUpdater} have added tooltips.
     */
    protected static final String CUSTOM_TOOLTIP_MARKER = "custom.tooltip.marker";

    @Override
    public Class getComponentClass ()
    {
        return WebCustomTooltip.class;
    }

    @Override
    public void update ( final C component, final Language language, final String key, final Object... data )
    {
        // todo Data that is passed in this method cannot be used
        // todo Some new multi-data system is required to do that

        final WebCustomTooltip oldToolTip = ( WebCustomTooltip ) component.getClientProperty ( CUSTOM_TOOLTIP_MARKER );
        final Text toolTipText = getToolTipText ( language, key );
        if ( toolTipText != null )
        {
            if ( oldToolTip == null )
            {
                // Creating custom tooltip
                final WebCustomTooltip customToolTip = TooltipManager.setTooltip ( component, toolTipText.getText () );
                component.putClientProperty ( CUSTOM_TOOLTIP_MARKER, customToolTip );
            }
            else
            {
                // Updating existing tooltip
                oldToolTip.setTooltip ( toolTipText.getText () );
            }
        }
        else if ( oldToolTip != null )
        {
            // Removing old tooltip
            TooltipManager.removeTooltips ( component, oldToolTip );
            component.putClientProperty ( CUSTOM_TOOLTIP_MARKER, null );
        }
    }

    /**
     * Returns custom tooltip {@link Text} or {@code null} if it shouldn't be added.
     *
     * @param language {@link Language}
     * @param key      language key
     * @return custom tooltip {@link Text} or {@code null} if it shouldn't be added
     */
    protected Text getToolTipText ( final Language language, final String key )
    {
        // Checking custom state that has priority
        Text tooltip = language.getText ( key, LanguageState.CUSTOM_TOOLTIP_TEXT );

        // Checking default state if custom state was not detected
        if ( tooltip == null && Objects.equals ( getDefaultToolTipType (), TYPE ) )
        {
            tooltip = language.getText ( key, LanguageState.TOOLTIP_TEXT );
        }

        return tooltip;
    }
}