* Reorders children within the child Widget array. Assists with z-order

     * operations on child Widgets.

     *

     * Child Widgets of parent are reordered in Array per the provided List of 

     * Integer

     *  

     * @param permutation List<Integer> consisting of new order. Each array slot

     * contains Integer value pointing to the old Objects index

     */

    public final void orderChildren(List<Integer> permutation) {

        assert permutation != null;

        if (parentWidget == null)

            return;

        List<Widget> widgets = parentWidget.children;

        assert permutation.size() == widgets.size();

        List<Widget> newOrder = new ArrayList<Widget>();

        for ( int j = 0 ; j < widgets.size(); j++) {

          Integer oldIndex = permutation.get(j);

          newOrder.add(widgets.get(oldIndex.intValue()));

        }

        widgets.clear();

        widgets.addAll(newOrder);

        revalidate ();

        parentWidget.revalidate ();

    }

    /**

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.api.visual.widget;

import java.util.ArrayList;

import java.util.List;

/**

 * Added support methods for a given Widget

 * 

 * @author cpalmer

 */

public final class WidgetSupport {

    private WidgetSupport() {

    }

    /**

     * Brings the widget 1 slot backward in the parent Widget child array. 

     * Means: the widget is moving towards the first child in the list of children 

     * of the parent widget.

     * @param parentWidget Widget that contains Widget childWidget

     * @param childWidget Widget that is sent backwards in the list of children

     */

    public static final void bringBackward (Widget parentWidget,Widget childWidget) {

        if (parentWidget == null)

            return;

        List<Widget> children = parentWidget.getChildren();

        int i = children.indexOf (childWidget);

        if (i <= 0)

            return;

       List<Integer> permutation = new ArrayList<Integer>();

       for ( int j = 0; j < children.size() ; j++ ) {

         permutation.add(Integer.valueOf(j));

       }

       permutation.add(i-1,permutation.remove(i));

       childWidget.orderChildren(permutation);

    }

    /**

     * Brings the widget 1 slot forward in the parent Widget child array. 

     * Means: the widget is moving towards the last child in the list of children 

     * of the parent widget.

     * @param parentWidget Widget that contains Widget childWidget

     * @param childWidget Widget that is brought forward in the list of children

     */

    public static final void bringForward (Widget parentWidget,Widget childWidget) {

        List<Widget> children = parentWidget.getChildren();

        int i = children.indexOf (childWidget);

        if (i < 0 || i == (children.size()-1) )

            return;

        List<Integer> permutation = new ArrayList<Integer>();

        for ( int j = 0; j < children.size() ; j++ ) {

          permutation.add(Integer.valueOf(j));

        }

        permutation.add(i+1,permutation.remove(i));

        childWidget.orderChildren(permutation);

    }

}