/*
* 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 <http://www.gnu.org/licenses/>.
*/
package com.alee.extended.tree;
import com.alee.extended.tree.sample.SampleExDataProvider;
import com.alee.extended.tree.sample.SampleTreeCellEditor;
import com.alee.extended.tree.sample.SampleTreeCellRenderer;
import com.alee.laf.tree.UniqueNode;
import com.alee.laf.tree.WebTreeCellEditor;
import com.alee.laf.tree.WebTreeCellRenderer;
import com.alee.utils.CollectionUtils;
import com.alee.utils.compare.Filter;
import javax.swing.tree.TreeModel;
import javax.swing.tree.TreePath;
import java.awt.*;
import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
/**
* This tree is a hybrid of WebCheckBoxTree and WebExTree.
* Checking model from WebCheckBoxTree provides node checking feature.
* ExTreeModel from WebExTree provides tree with structure data.
*
* @author Mikle Garin
*/
public class WebExCheckBoxTree<E extends UniqueNode> extends WebCheckBoxTree<E>
{
/**
* Tree nodes comparator.
*/
protected Comparator<E> comparator;
/**
* Tree nodes filter.
*/
protected Filter<E> filter;
/**
* Constructs sample ex checkbox tree.
*/
public WebExCheckBoxTree ()
{
super ();
// Installing sample data provider
setDataProvider ( new SampleExDataProvider () );
// Tree cell renderer & editor
setCellRenderer ( new SampleTreeCellRenderer () );
setCellEditor ( new SampleTreeCellEditor () );
}
/**
* Costructs ex checkbox tree using data from the custom data provider.
*
* @param dataProvider custom data provider
*/
public WebExCheckBoxTree ( final ExTreeDataProvider dataProvider )
{
super ();
// Installing data provider
setDataProvider ( dataProvider );
// Tree cell renderer & editor
setCellRenderer ( new WebTreeCellRenderer () );
setCellEditor ( new WebTreeCellEditor () );
}
/**
* Returns ex tree data provider.
*
* @return data provider
*/
public ExTreeDataProvider<E> getDataProvider ()
{
final TreeModel model = getModel ();
return model != null && model instanceof ExTreeModel ? getExModel ().getDataProvider () : null;
}
/**
* Changes data provider for this ex tree.
*
* @param dataProvider new data provider
*/
public void setDataProvider ( final ExTreeDataProvider dataProvider )
{
if ( dataProvider != null )
{
final ExTreeDataProvider<E> oldDataProvider = getDataProvider ();
// Updating model
final ExTreeModel<E> model = new ExTreeModel<E> ( this, dataProvider );
setModel ( model );
// Forcing model to cache the whole structure
loadTreeData ( model.getRoot (), model );
firePropertyChange ( TREE_DATA_PROVIDER_PROPERTY, oldDataProvider, dataProvider );
}
}
/**
* Forces model to cache the whole structure so any node can be accessed right away.
* Note that this might take some time in case tree structure is large.
* Though this doesn't force any repaints or other visual updates, so the speed depends only on ExTreeDataProvider.
*/
protected void loadTreeData ( final E node, final ExTreeModel<E> model )
{
final int childCount = model.getChildCount ( node );
for ( int i = 0; i < childCount; i++ )
{
loadTreeData ( model.getChild ( node, i ), model );
}
}
/**
* Returns tree nodes comparator.
*
* @return tree nodes comparator
*/
public Comparator<E> getComparator ()
{
return comparator;
}
/**
* Sets tree nodes comparator.
* Comparator replacement will automatically update all loaded nodes sorting.
*
* @param comparator tree nodes comparator
*/
public void setComparator ( final Comparator<E> comparator )
{
final Comparator<E> oldComparator = this.comparator;
this.comparator = comparator;
final ExTreeDataProvider dataProvider = getDataProvider ();
if ( dataProvider instanceof AbstractExTreeDataProvider )
{
( ( AbstractExTreeDataProvider ) dataProvider ).setChildsComparator ( comparator );
updateSortingAndFiltering ();
}
firePropertyChange ( TREE_COMPARATOR_PROPERTY, oldComparator, comparator );
}
/**
* Removes any applied tree nodes comparator.
*/
public void clearComparator ()
{
setComparator ( null );
}
/**
* Returns tree nodes filter.
*
* @return tree nodes filter
*/
public Filter<E> getFilter ()
{
return filter;
}
/**
* Sets tree nodes filter.
* Comparator replacement will automatically re-filter all loaded nodes.
*
* @param filter tree nodes filter
*/
public void setFilter ( final Filter<E> filter )
{
final Filter<E> oldFilter = this.filter;
this.filter = filter;
final ExTreeDataProvider dataProvider = getDataProvider ();
if ( dataProvider instanceof AbstractExTreeDataProvider )
{
( ( AbstractExTreeDataProvider ) dataProvider ).setChildsFilter ( filter );
updateSortingAndFiltering ();
}
firePropertyChange ( TREE_FILTER_PROPERTY, oldFilter, filter );
}
/**
* Removes any applied tree nodes filter.
*/
public void clearFilter ()
{
setFilter ( null );
}
/**
* Updates nodes sorting and filtering for all loaded nodes.
*/
public void updateSortingAndFiltering ()
{
getExModel ().updateSortingAndFiltering ();
}
/**
* Updates sorting and filtering for the specified node childs.
*/
public void updateSortingAndFiltering ( final E node )
{
getExModel ().updateSortingAndFiltering ( node );
}
/**
* Returns ex tree model.
*
* @return ex tree model
*/
public ExTreeModel<E> getExModel ()
{
return ( ExTreeModel<E> ) getModel ();
}
/**
* Returns whether ex tree model is installed or not.
*
* @return true if ex tree model is installed, false otherwise
*/
public boolean isExModel ()
{
final TreeModel model = getModel ();
return model != null && model instanceof ExTreeModel;
}
/**
* Sets child nodes for the specified node.
* This method might be used to manually change tree node childs without causing any structure corruptions.
*
* @param parent node to process
* @param children new node children
*/
public void setChildNodes ( final E parent, final List<E> children )
{
getExModel ().setChildNodes ( parent, children );
}
/**
* Adds child node for the specified node.
* This method might be used to manually change tree node childs without causing any structure corruptions.
*
* @param parent node to process
* @param child new node child
*/
public void addChildNode ( final E parent, final E child )
{
getExModel ().addChildNodes ( parent, Arrays.asList ( child ) );
}
/**
* Adds child nodes for the specified node.
* This method might be used to manually change tree node childs without causing any structure corruptions.
*
* @param parent node to process
* @param children new node children
*/
public void addChildNodes ( final E parent, final List<E> children )
{
getExModel ().addChildNodes ( parent, children );
}
/**
* Inserts a list of child nodes into parent node.
* This method might be used to manually change tree node childs without causing any structure corruptions.
*
* @param children list of new child nodes
* @param parent parent node
* @param index insert index
*/
public void insertChildNodes ( final List<E> children, final E parent, final int index )
{
getExModel ().insertNodesInto ( children, parent, index );
}
/**
* Inserts an array of child nodes into parent node.
* This method might be used to manually change tree node childs without causing any structure corruptions.
*
* @param children array of new child nodes
* @param parent parent node
* @param index insert index
*/
public void insertChildNodes ( final E[] children, final E parent, final int index )
{
getExModel ().insertNodesInto ( children, parent, index );
}
/**
* Inserts child node into parent node.
* This method might be used to manually change tree node childs without causing any structure corruptions.
*
* @param child new child node
* @param parent parent node
* @param index insert index
*/
public void insertChildNode ( final E child, final E parent, final int index )
{
getExModel ().insertNodeInto ( child, parent, index );
}
/**
* Removes node with the specified ID from tree structure.
* This method will have effect only if node exists.
*
* @param nodeId ID of the node to remove
* @return true if tree structure was changed by the operation, false otherwise
*/
public boolean removeNode ( final String nodeId )
{
return removeNode ( findNode ( nodeId ) );
}
/**
* Removes node from tree structure.
* This method will have effect only if node exists.
*
* @param node node to remove
* @return true if tree structure was changed by the operation, false otherwise
*/
public boolean removeNode ( final E node )
{
final boolean exists = node != null && node.getParent () != null;
if ( exists )
{
getExModel ().removeNodeFromParent ( node );
}
return exists;
}
/**
* Removes nodes from tree structure.
* This method will have effect only if nodes exist.
*
* @param nodes list of nodes to remove
*/
public void removeNodes ( final List<E> nodes )
{
getExModel ().removeNodesFromParent ( nodes );
}
/**
* Removes nodes from tree structure.
* This method will have effect only if nodes exist.
*
* @param nodes array of nodes to remove
*/
public void removeNodes ( final E[] nodes )
{
getExModel ().removeNodesFromParent ( nodes );
}
/**
* Looks for the node with the specified ID in the tree model and returns it or null if it was not found.
*
* @param nodeId node ID
* @return node with the specified ID or null if it was not found
*/
public E findNode ( final String nodeId )
{
return getExModel ().findNode ( nodeId );
}
/**
* Forces tree node with the specified ID to be updated.
*
* @param nodeId ID of the tree node to be updated
*/
public void updateNode ( final String nodeId )
{
updateNode ( findNode ( nodeId ) );
}
/**
* Forces tree node to be updated.
*
* @param node tree node to be updated
*/
public void updateNode ( final E node )
{
getExModel ().updateNode ( node );
// todo Should actually perform this here (but need to improve filter interface methods - add cache clear methods)
// updateSortingAndFiltering ( ( E ) node.getParent () );
}
/**
* Forces tree node structure with the specified ID to be updated.
*
* @param nodeId ID of the tree node to be updated
*/
public void updateNodeStructure ( final String nodeId )
{
updateNodeStructure ( findNode ( nodeId ) );
}
/**
* Forces tree node structure with the specified ID to be updated.
*
* @param node tree node to be updated
*/
public void updateNodeStructure ( final E node )
{
getExModel ().updateNodeStructure ( node );
}
/**
* Reloads selected node childs.
*/
public void reloadSelectedNodes ()
{
// Checking that selection is not empty
final TreePath[] paths = getSelectionPaths ();
if ( paths != null )
{
// Reloading all selected nodes
for ( final TreePath path : paths )
{
// Checking if node is not null and not busy yet
final E node = getNodeForPath ( path );
if ( node != null )
{
// Reloading node childs
performReload ( node, path, false );
}
}
}
}
/**
* Reloads node under the specified point.
*
* @param point point to look for node
* @return reloaded node or null if none reloaded
*/
public E reloadNodeUnderPoint ( final Point point )
{
return reloadNodeUnderPoint ( point.x, point.y );
}
/**
* Reloads node under the specified point.
*
* @param x point X coordinate
* @param y point Y coordinate
* @return reloaded node or null if none reloaded
*/
public E reloadNodeUnderPoint ( final int x, final int y )
{
return reloadPath ( getPathForLocation ( x, y ) );
}
/**
* Reloads root node childs.
*
* @return reloaded root node
*/
public E reloadRootNode ()
{
return reloadNode ( getRootNode () );
}
/**
* Reloads node with the specified ID.
*
* @param nodeId ID of the node to reload
* @return reloaded node or null if none reloaded
*/
public E reloadNode ( final String nodeId )
{
return reloadNode ( findNode ( nodeId ) );
}
/**
* Reloads specified node childs.
*
* @param node node to reload
* @return reloaded node or null if none reloaded
*/
public E reloadNode ( final E node )
{
return reloadNode ( node, false );
}
/**
* Reloads specified node childs and selects it if requested.
*
* @param node node to reload
* @param select whether select the node or not
* @return reloaded node or null if none reloaded
*/
public E reloadNode ( final E node, final boolean select )
{
// Checking that node is not null
if ( node != null )
{
// Reloading node childs
performReload ( node, getPathForNode ( node ), select );
return node;
}
return null;
}
/**
* Reloads node childs at the specified path.
*
* @param path path of the node to reload
* @return reloaded node or null if none reloaded
*/
public E reloadPath ( final TreePath path )
{
return reloadPath ( path, false );
}
/**
* Reloads node childs at the specified path and selects it if needed.
*
* @param path path of the node to reload
* @param select whether select the node or not
* @return reloaded node or null if none reloaded
*/
public E reloadPath ( final TreePath path, final boolean select )
{
// Checking that path is not null
if ( path != null )
{
// Checking if node is not null and not busy yet
final E node = getNodeForPath ( path );
if ( node != null )
{
// Reloading node childs
performReload ( node, path, select );
return node;
}
}
return null;
}
/**
* Performs the actual reload call.
*
* @param node node to reload
* @param path path to node
* @param select whether select the node or not
*/
protected void performReload ( final E node, final TreePath path, final boolean select )
{
// Select node under the mouse
if ( select && !isPathSelected ( path ) )
{
setSelectionPath ( path );
}
// Expand the selected node since the collapsed node will ignore reload call
// In case the node childs were not loaded yet this call will cause it to load childs
if ( !isExpanded ( path ) )
{
expandPath ( path );
}
// Reload selected node childs
// This won't be called if node was not loaded yet since expand would call load before
if ( node != null )
{
getExModel ().reload ( node );
}
}
/**
* Expands node with the specified ID.
*
* @param nodeId ID of the node to expand
*/
public void expandNode ( final String nodeId )
{
expandNode ( findNode ( nodeId ) );
}
/**
* Expands path using the specified node path IDs.
* IDs are used to find real nodes within the expanded roots.
* Be aware that operation might stop even before reaching the end of the path if something unexpected happened.
*
* @param pathNodeIds node path IDs
*/
public void expandPath ( final List<String> pathNodeIds )
{
expandPath ( pathNodeIds, true, true );
}
/**
* Expands path using the specified node path IDs.
* IDs are used to find real nodes within the expanded roots.
* Be aware that operation might stop even before reaching the end of the path if something unexpected happened.
*
* @param pathNodeIds node path IDs
* @param expandLastNode whether should expand last found path node or not
*/
public void expandPath ( final List<String> pathNodeIds, final boolean expandLastNode )
{
expandPath ( pathNodeIds, expandLastNode, true );
}
/**
* Expands path using the specified node path IDs.
* IDs are used to find real nodes within the expanded roots.
* Be aware that operation might stop even before reaching the end of the path if something unexpected happened.
*
* @param pathNodeIds node path IDs
* @param expandLastNode whether should expand last found path node or not
* @param selectLastNode whether should select last found path node or not
*/
public void expandPath ( final List<String> pathNodeIds, final boolean expandLastNode, final boolean selectLastNode )
{
final List<String> ids = CollectionUtils.copy ( pathNodeIds );
for ( int initial = 0; initial < ids.size (); initial++ )
{
final E initialNode = findNode ( ids.get ( initial ) );
if ( initialNode != null )
{
for ( int i = 0; i <= initial; i++ )
{
ids.remove ( i );
}
if ( ids.size () > 0 )
{
expandPathImpl ( initialNode, ids, expandLastNode, selectLastNode );
}
return;
}
}
}
/**
* Performs a single path node expansion.
* Be aware that operation might stop even before reaching the end of the path if something unexpected happened.
*
* @param currentNode last reached node
* @param leftToExpand node path IDs left for expansion
* @param expandLastNode whether should expand last found path node or not
* @param selectLastNode whether should select last found path node or not
*/
protected void expandPathImpl ( final E currentNode, final List<String> leftToExpand, final boolean expandLastNode,
final boolean selectLastNode )
{
// There is still more to load
if ( leftToExpand.size () > 0 )
{
// Expanding already loaded node
expandNode ( currentNode );
// Retrieving next node
final E nextNode = findNode ( leftToExpand.get ( 0 ) );
leftToExpand.remove ( 0 );
// If node exists continue expanding path
if ( nextNode != null )
{
expandPathImpl ( nextNode, leftToExpand, expandLastNode, selectLastNode );
}
else
{
expandPathEndImpl ( currentNode, expandLastNode, selectLastNode );
}
}
else
{
expandPathEndImpl ( currentNode, expandLastNode, selectLastNode );
}
}
/**
* Finishes async tree path expansion.
*
* @param lastFoundNode last found path node
* @param expandLastNode whether should expand last found path node or not
* @param selectLastNode whether should select last found path node or not
*/
protected void expandPathEndImpl ( final E lastFoundNode, final boolean expandLastNode, final boolean selectLastNode )
{
if ( selectLastNode )
{
setSelectedNode ( lastFoundNode );
}
if ( expandLastNode )
{
expandNode ( lastFoundNode );
}
}
}