com.alee.extended.tree.WebExCheckBoxTree Maven / Gradle / Ivy
/*
* 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 {@link UniqueNode} type
* @author Mikle Garin
* @see WebCheckBoxTree
* @see com.alee.laf.tree.WebTreeUI
* @see com.alee.laf.tree.TreePainter
* @see TreeCheckingModel
* @see ExTreeModel
* @see ExTreeDataProvider
*/
public class WebExCheckBoxTree extends WebCheckBoxTree implements FilterableNodes, SortableNodes
{
/**
* Component properties.
*/
public static final String DATA_PROVIDER_PROPERTY = "dataProvider";
public static final String FILTER_PROPERTY = "filter";
public static final String COMPARATOR_PROPERTY = "comparator";
/**
* Tree nodes filter.
*/
@Nullable
protected Filter filter;
/**
* Tree nodes comparator.
*/
@Nullable
protected Comparator comparator;
/**
* Constructs new {@link WebExCheckBoxTree} with sample data.
*/
public WebExCheckBoxTree ()
{
this ( StyleId.auto );
}
/**
* Costructs new {@link WebExCheckBoxTree} with the specified {@link ExTreeDataProvider} as data source.
*
* @param dataProvider {@link ExTreeDataProvider} implementation
*/
public WebExCheckBoxTree ( @Nullable final ExTreeDataProvider dataProvider )
{
this ( StyleId.auto, dataProvider );
}
/**
* Costructs new {@link WebExCheckBoxTree} with the specified {@link ExTreeDataProvider} as data source.
*
* @param dataProvider {@link ExTreeDataProvider} implementation
* @param renderer {@link TreeCellRenderer} implementation, default implementation is used if {@code null} is provided
*/
public WebExCheckBoxTree ( @Nullable final ExTreeDataProvider dataProvider, @Nullable final TreeCellRenderer renderer )
{
this ( StyleId.auto, dataProvider, renderer );
}
/**
* Costructs new {@link WebExCheckBoxTree} with the specified {@link ExTreeDataProvider} as data source.
*
* @param dataProvider {@link ExTreeDataProvider} implementation
* @param editor {@link TreeCellEditor} implementation, default implementation is used if {@code null} is provided
*/
public WebExCheckBoxTree ( @Nullable final ExTreeDataProvider dataProvider, @Nullable final TreeCellEditor editor )
{
this ( StyleId.auto, dataProvider, editor );
}
/**
* Costructs new {@link WebExCheckBoxTree} with the specified {@link ExTreeDataProvider} as data source.
*
* @param dataProvider {@link ExTreeDataProvider} implementation
* @param renderer {@link TreeCellRenderer} implementation, default implementation is used if {@code null} is provided
* @param editor {@link TreeCellEditor} implementation, default implementation is used if {@code null} is provided
*/
public WebExCheckBoxTree ( @Nullable final ExTreeDataProvider dataProvider, @Nullable final TreeCellRenderer renderer,
@Nullable final TreeCellEditor editor )
{
this ( StyleId.auto, dataProvider, renderer, editor );
}
/**
* Constructs new {@link WebExCheckBoxTree} with sample data.
*
* @param id {@link StyleId}
*/
public WebExCheckBoxTree ( @NotNull final StyleId id )
{
this ( id, null, null, null );
}
/**
* Costructs new {@link WebExCheckBoxTree} with the specified {@link ExTreeDataProvider} as data source.
*
* @param id {@link StyleId}
* @param dataProvider {@link ExTreeDataProvider} implementation
*/
public WebExCheckBoxTree ( @NotNull final StyleId id, @Nullable final ExTreeDataProvider dataProvider )
{
this ( id, dataProvider, null, null );
}
/**
* Costructs new {@link WebExCheckBoxTree} with the specified {@link ExTreeDataProvider} as data source.
*
* @param id {@link StyleId}
* @param dataProvider {@link ExTreeDataProvider} implementation
* @param renderer {@link TreeCellRenderer} implementation, default implementation is used if {@code null} is provided
*/
public WebExCheckBoxTree ( @NotNull final StyleId id, @Nullable final ExTreeDataProvider dataProvider,
@Nullable final TreeCellRenderer renderer )
{
this ( id, dataProvider, renderer, null );
}
/**
* Costructs new {@link WebExCheckBoxTree} with the specified {@link ExTreeDataProvider} as data source.
*
* @param id {@link StyleId}
* @param dataProvider {@link ExTreeDataProvider} implementation
* @param editor {@link TreeCellEditor} implementation, default implementation is used if {@code null} is provided
*/
public WebExCheckBoxTree ( @NotNull final StyleId id, @Nullable final ExTreeDataProvider dataProvider,
@Nullable final TreeCellEditor editor )
{
this ( id, dataProvider, null, editor );
}
/**
* Costructs new {@link WebExCheckBoxTree} with the specified {@link ExTreeDataProvider} as data source.
*
* @param id {@link StyleId}
* @param dataProvider {@link ExTreeDataProvider} implementation
* @param renderer {@link TreeCellRenderer} implementation, default implementation is used if {@code null} is provided
* @param editor {@link TreeCellEditor} implementation, default implementation is used if {@code null} is provided
*/
public WebExCheckBoxTree ( @NotNull final StyleId id, @Nullable final ExTreeDataProvider dataProvider,
@Nullable final TreeCellRenderer renderer, @Nullable final TreeCellEditor editor )
{
super ( id, dataProvider != null ? new ExTreeModel ( dataProvider ) : null );
if ( renderer != null )
{
setCellRenderer ( renderer );
}
if ( editor != null )
{
setEditable ( true );
setCellEditor ( editor );
}
}
@NotNull
@Override
public StyleId getDefaultStyleId ()
{
return StyleId.excheckboxtree;
}
@Nullable
@Override
public ExTreeModel getModel ()
{
return ( ExTreeModel ) super.getModel ();
}
@Override
public void setModel ( @Nullable final TreeModel newModel )
{
// Event Dispatch Thread check
WebLookAndFeel.checkEventDispatchThread ();
/**
* Simply ignoring any models that are not {@link ExTreeModel}-based.
* This is a workaround to avoid default model being set in {@link javax.swing.JTree}.
* This way we can prevent any models from being forced on us and avoid unnecessary events and UI updates.
*/
if ( newModel instanceof ExTreeModel )
{
final ExTreeModel old = getModel ();
final ExTreeDataProvider oldDataProvider;
if ( old != null )
{
oldDataProvider = old.getDataProvider ();
old.uninstall ( this );
}
else
{
oldDataProvider = null;
}
final ExTreeModel model = ( ExTreeModel ) newModel;
model.install ( this );
super.setModel ( model );
firePropertyChange ( DATA_PROVIDER_PROPERTY, oldDataProvider, model.getDataProvider () );
}
else if ( newModel != null )
{
throw new NullPointerException ( "Only ExTreeModel implementations can be used for WebExCheckBoxTree" );
}
}
@NotNull
@Override
protected TreeCheckingModel createDefaultCheckingModel ()
{
return new DefaultExTreeCheckingModel> ( this );
}
/**
* Returns {@link ExTreeDataProvider} used by this {@link WebExCheckBoxTree}.
*
* @return {@link ExTreeDataProvider} used by this {@link WebExCheckBoxTree}
*/
@Nullable
public ExTreeDataProvider getDataProvider ()
{
final ExTreeModel model = getModel ();
return model != null ? getModel ().getDataProvider () : null;
}
/**
* Sets {@link ExTreeDataProvider} used by this {@link WebExCheckBoxTree}.
*
* @param dataProvider new {@link ExTreeDataProvider} for this {@link WebExCheckBoxTree}
*/
public void setDataProvider ( @NotNull final ExTreeDataProvider dataProvider )
{
// Event Dispatch Thread check
WebLookAndFeel.checkEventDispatchThread ();
/**
* Initializing new {@link ExTreeModel} based on specified {@link ExTreeDataProvider}.
* This is necessary as the model will keep {@link ExTreeDataProvider} instead of {@link WebExCheckBoxTree}.
*/
setModel ( new ExTreeModel ( dataProvider ) );
}
@Nullable
@Override
public Filter getFilter ()
{
return filter;
}
@Override
public void setFilter ( @Nullable final Filter filter )
{
// Event Dispatch Thread check
WebLookAndFeel.checkEventDispatchThread ();
// Ensure parameter changed
if ( filter != getFilter () )
{
final Filter old = getFilter ();
this.filter = filter;
filter ();
firePropertyChange ( FILTER_PROPERTY, old, filter );
}
}
@Override
public void clearFilter ()
{
setFilter ( null );
}
@Override
public void filter ()
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.filter ();
}
}
@Override
public void filter ( @NotNull final N parent )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.filter ( parent );
}
}
@Override
public void filter ( @NotNull final N parent, final boolean recursively )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.filter ( parent, recursively );
}
}
@Nullable
@Override
public Comparator getComparator ()
{
return comparator;
}
@Override
public void setComparator ( @Nullable final Comparator comparator )
{
// Event Dispatch Thread check
WebLookAndFeel.checkEventDispatchThread ();
// Ensure parameter changed
if ( comparator != getComparator () )
{
final Comparator old = getComparator ();
this.comparator = comparator;
sort ();
firePropertyChange ( COMPARATOR_PROPERTY, old, comparator );
}
}
@Override
public void clearComparator ()
{
setComparator ( null );
}
@Override
public void sort ()
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.sort ();
}
}
@Override
public void sort ( @NotNull final N parent )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.sort ( parent );
}
}
@Override
public void sort ( @NotNull final N parent, final boolean recursively )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.sort ( parent, recursively );
}
}
/**
* Updates nodes sorting and filtering for all loaded nodes.
*/
public void filterAndSort ()
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.filterAndSort ( true );
}
}
/**
* Updates sorting and filtering for the specified node children.
*
* @param parent node to update sorting and filtering for
*/
public void filterAndSort ( @NotNull final N parent )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.filterAndSort ( parent, false );
}
}
/**
* Updates sorting and filtering for the specified node children.
*
* @param parent node to update sorting and filter for
* @param recursively whether should update the whole children structure recursively or not
*/
public void filterAndSort ( @NotNull final N parent, final boolean recursively )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.filterAndSort ( parent, recursively );
}
}
/**
* Sets child nodes for the specified node.
* This method might be used to manually change tree node children without causing any structure corruptions.
*
* @param parent node to process
* @param children new node children
*/
public void setChildNodes ( @NotNull final N parent, @NotNull final List children )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.setChildNodes ( parent, children );
}
}
/**
* Adds child node for the specified node.
* This method might be used to manually change tree node children without causing any structure corruptions.
*
* @param parent node to process
* @param child new node child
*/
public void addChildNode ( @NotNull final N parent, @NotNull final N child )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.addChildNode ( parent, child );
}
}
/**
* Adds child nodes for the specified node.
* This method might be used to manually change tree node children without causing any structure corruptions.
*
* @param parent node to process
* @param children new node children
*/
public void addChildNodes ( @NotNull final N parent, @NotNull final List children )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.addChildNodes ( parent, children );
}
}
/**
* Inserts a list of child nodes into parent node.
* This method might be used to manually change tree node children without causing any structure corruptions.
*
* @param children list of new child nodes
* @param parent parent node
* @param index insert index
*/
public void insertChildNodes ( @NotNull final List children, @NotNull final N parent, final int index )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.insertNodesInto ( children, parent, index );
}
}
/**
* Inserts an array of child nodes into parent node.
* This method might be used to manually change tree node children without causing any structure corruptions.
*
* @param children array of new child nodes
* @param parent parent node
* @param index insert index
*/
public void insertChildNodes ( @NotNull final N[] children, @NotNull final N parent, final int index )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.insertNodesInto ( children, parent, index );
}
}
/**
* Inserts child node into parent node.
* This method might be used to manually change tree node children without causing any structure corruptions.
*
* @param child new child node
* @param parent parent node
* @param index insert index
*/
public void insertChildNode ( @NotNull final N child, @NotNull final N parent, final int index )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.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
*/
public void removeNode ( @NotNull final String nodeId )
{
final N node = findNode ( nodeId );
if ( node != null )
{
removeNode ( node );
}
}
/**
* Removes node from tree structure.
* This method will have effect only if node exists.
*
* @param node node to remove
*/
public void removeNode ( @NotNull final N node )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.removeNodeFromParent ( node );
}
}
/**
* Removes nodes from tree structure.
* This method will have effect only if nodes exist.
*
* @param nodes list of nodes to remove
*/
public void removeNodes ( @NotNull final List nodes )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.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 ( @NotNull final N[] nodes )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.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
*/
@Nullable
public N findNode ( @NotNull final String nodeId )
{
final ExTreeModel model = getModel ();
return model != null ? model.findNode ( nodeId ) : null;
}
/**
* Forces tree node with the specified ID to be updated.
*
* @param nodeId ID of the tree node to be updated
*/
public void updateNode ( @NotNull final String nodeId )
{
updateNode ( findNode ( nodeId ) );
}
/**
* Forces tree node structure with the specified ID to be updated.
*
* @param nodeId ID of the tree node to be updated
*/
public void updateNodeStructure ( @NotNull 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 ( @Nullable final N node )
{
final ExTreeModel model = getModel ();
if ( model != null )
{
model.updateNodeStructure ( node );
}
}
/**
* Reloads selected node children.
*/
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 N node = getNodeForPath ( path );
if ( node != null )
{
// Reloading node children
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
*/
@Nullable
public N reloadNodeUnderPoint ( @NotNull 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
*/
@Nullable
public N reloadNodeUnderPoint ( final int x, final int y )
{
return reloadPath ( getPathForLocation ( x, y ) );
}
/**
* Reloads root node children.
*
* @return reloaded root node
*/
@Nullable
public N 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
*/
@Nullable
public N reloadNode ( @NotNull final String nodeId )
{
return reloadNode ( findNode ( nodeId ) );
}
/**
* Reloads specified node children.
*
* @param node node to reload
* @return reloaded node or null if none reloaded
*/
@Nullable
public N reloadNode ( @Nullable final N node )
{
return reloadNode ( node, false );
}
/**
* Reloads specified node children 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
*/
@Nullable
public N reloadNode ( @Nullable final N node, final boolean select )
{
N reloadedNode = null;
if ( node != null )
{
final TreePath path = getPathForNode ( node );
if ( path != null )
{
performReload ( node, path, select );
reloadedNode = node;
}
}
return reloadedNode;
}
/**
* Reloads node children at the specified path.
*
* @param path path of the node to reload
* @return reloaded node or null if none reloaded
*/
@Nullable
public N reloadPath ( @Nullable final TreePath path )
{
return reloadPath ( path, false );
}
/**
* Reloads node children 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
*/
@Nullable
public N reloadPath ( @Nullable final TreePath path, final boolean select )
{
N reloadedNode = null;
if ( path != null )
{
final N node = getNodeForPath ( path );
if ( node != null )
{
performReload ( node, path, select );
reloadedNode = node;
}
}
return reloadedNode;
}
/**
* 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 ( @NotNull final N node, @NotNull 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 children were not loaded yet this call will cause it to load children
if ( !isExpanded ( path ) )
{
expandPath ( path );
}
// Reload selected node children
// This won't be called if node was not loaded yet since expand would call load before
final ExTreeModel model = getModel ();
if ( model != null )
{
model.reload ( node );
}
}
/**
* Expands node with the specified ID.
*
* @param nodeId ID of the node to expand
*/
public void expandNode ( @NotNull 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 ( @NotNull final List 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 ( @NotNull final List 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 ( @NotNull final List pathNodeIds, final boolean expandLastNode, final boolean selectLastNode )
{
final List ids = CollectionUtils.copy ( pathNodeIds );
for ( int initial = 0; initial < ids.size (); initial++ )
{
final N 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 );
}
break;
}
}
}
/**
* 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 ( @NotNull final N currentNode, @NotNull final List 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 N 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 ( @NotNull final N lastFoundNode, final boolean expandLastNode, final boolean selectLastNode )
{
if ( selectLastNode )
{
setSelectedNode ( lastFoundNode );
}
if ( expandLastNode )
{
expandNode ( lastFoundNode );
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy