/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun
 * Microsystems, Inc. All Rights Reserved.
 */


package org.netbeans.modules.search;


import org.openide.nodes.Node;
import org.openide.util.actions.NodeAction;
import org.openide.util.HelpCtx;
import org.openide.util.NbBundle;


/**
 * Action which removes FoundNode from search result.
 *
 * @author  Peter Zavadsky
 * @see ResultModel.FoundNode
 */
public class RemoveFromSearchAction extends NodeAction {

    /** Generated serial version UID. */
    static final long serialVersionUID = -7200719415283638136L;
    
    
    /** Gets help context for the action. Implements superclass abstract method.
     * @return the help context for this action */
    public HelpCtx getHelpCtx() {
        return new HelpCtx(RemoveFromSearchAction.class);
    }
    
    /** Gets display name for action. Implements superclass abstract method.
     * @return the name of the action */
    public String getName() {
        return NbBundle.getMessage(
                RemoveFromSearchAction.class,
                "TEXT_LABEL_RemoveFromSearchActionName");               //NOI18N
    }
    
    /** Enables action based on activated nodes. Implements superclass abstract method.
     * @return true if all activated nodes are instance of FoundNode
     * or false otherwise */
    protected boolean enable(Node[] activatedNodes) {
        if (activatedNodes == null || activatedNodes.length == 0) {
            return false;
        }
        
        for (int i = 0; i < activatedNodes.length; i++) {
            if (!(activatedNodes[i] instanceof ResultTreeChildren.FoundNode)) {
                return false;
            }
        }
        
        return true;
    }
    
    /** Performs the action based on the currently activated nodes. Implements superclass abstract method.
     * @param activatedNodes current activated nodes, may be empty but not null */
    protected void performAction(Node[] activatedNodes) {
        if (activatedNodes == null || activatedNodes.length == 0) {
            return;
        }
        
        for (int i = 0; i < activatedNodes.length; i++) {
            if (activatedNodes[i] instanceof ResultTreeChildren.FoundNode) {
                ((ResultTreeChildren.FoundNode) activatedNodes[i])
                .removeFromSearch();
            }
        }
    }
    
}