com.alee.extended.tree.SortableNodes 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.extended.tree;

import javax.swing.tree.TreeNode;
import java.util.Comparator;

/**
 * Interface for any element containing sortable structure of {@link TreeNode}s.
 *
 * @param  {@link TreeNode} type
 * @author Mikle Garin
 */
public interface SortableNodes
{
    /**
     * Returns {@link Comparator} used for {@link TreeNode}s.
     *
     * @return {@link Comparator} used for {@link TreeNode}s
     */
    public Comparator getComparator ();

    /**
     * Sets {@link Comparator} for {@link TreeNode}s.
     * Changing this {@link Comparator} will automatically update sorting for all {@link TreeNode}s that have children.
     *
     * @param comparator {@link Comparator} for {@link TreeNode}s
     */
    public void setComparator ( Comparator comparator );

    /**
     * Uninstalls {@link Comparator} used for {@link TreeNode}s.
     */
    public void clearComparator ();

    /**
     * Updates {@link TreeNode}s sorting for all existing nodes.
     */
    public void sort ();

    /**
     * Updates {@link TreeNode}s sorting for the specified {@link TreeNode} children.
     *
     * @param node {@link TreeNode} to update children sorting for
     */
    public void sort ( N node );

    /**
     * Updates {@link TreeNode}s sorting for the specified {@link TreeNode} children.
     *
     * @param node        {@link TreeNode} to update children sorting for
     * @param recursively whether should update the whole children structure recursively or not
     */
    public void sort ( N node, boolean recursively );
}