org.netbeans.spi.viewmodel.ReorderableTreeModel Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.spi.viewmodel;
/**
* Data model for tree that supports reordering
* of child nodes. The created {@link org.openide.nodes.Node} will contain
* an implementation of {@link org.openide.nodes.Index} in it's lookup
* if {@link #canReorder(java.lang.Object)} returns true.
*
* When used together with {@link DnDNodeModel}, children can be reordered
* by Drag and Drop.
*
* @author Martin Entlicher
* @since 1.25
*/
public interface ReorderableTreeModel extends TreeModel {
/**
* Provide if this model implementation can reorder children nodes.
* @param parent The parent node of children that are test for reorder
* @return true if this model can handle reordering of children,
* false otherwise
* @throws UnknownTypeException if this model implementation is not
* able to decide the reorder capability for given node type
*/
public boolean canReorder(Object parent) throws UnknownTypeException;
/**
* Reorder children nodes with a given permutation.
* @param parent The parent node of children that are being reordered
* @param perm permutation with the length of current child nodes. The permutation
* lists the new positions of the original nodes, that is, for nodes
* [A,B,C,D] and permutation [0,3,1,2], the final
* order would be [A,C,D,B].
* @throws IllegalArgumentException if the permutation is not valid
* @throws UnknownTypeException if this model implementation is not
* able to perform the reorder for given node type
*/
public void reorder(Object parent, int[] perm) throws UnknownTypeException;
}