com.alee.laf.tree.behavior.TreePathHoverBehavior Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
The newest version!
/*
 * 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.laf.tree.behavior;

import com.alee.extended.behavior.AbstractObjectHoverBehavior;
import com.alee.laf.tree.WebTreeUI;

import javax.swing.*;
import javax.swing.plaf.TreeUI;
import javax.swing.tree.TreePath;
import java.awt.*;

/**
 * Abstract behavior that provides hover events for {@link JTree} paths.
 * For a simple installation and uninstallation you can call {@link #install()} and {@link #uninstall()} methods.
 *
 * @param  component type
 * @author Mikle Garin
 */
public abstract class TreePathHoverBehavior extends AbstractObjectHoverBehavior
{
    /**
     * Constructs behavior for the specified {@link JTree}.
     *
     * @param tree tree into which this behavior is installed
     */
    public TreePathHoverBehavior ( final C tree )
    {
        this ( tree, true );
    }

    /**
     * Constructs behavior for the specified {@link JTree}.
     *
     * @param tree        {@link JTree} into which this behavior is installed
     * @param enabledOnly whether or not behavior should only track hover events when tree is enabled
     */
    public TreePathHoverBehavior ( final C tree, final boolean enabledOnly )
    {
        super ( tree, enabledOnly );
    }

    @Override
    protected TreePath getObjectAt ( final Point location )
    {
        final TreeUI treeUI = component.getUI ();
        final int index;
        if ( treeUI instanceof WebTreeUI )
        {
            // Compute index under point through WebTreeUI methods (to make sure that row selection type was taken into account)
            index = ( ( WebTreeUI ) treeUI ).getExactRowForLocation ( location );
        }
        else
        {
            // Compute index under point through default tree methods
            index = component.getRowForLocation ( location.x, location.y );
        }
        return component.getPathForRow ( index );
    }

    @Override
    protected TreePath getEmptyObject ()
    {
        return null;
    }
}