/*
 * Copyright (C) 2004 NNL Technology AB
 * Visit www.infonode.net for information about InfoNode(R) 
 * products and how to contact NNL Technology AB.
 *
 * This program 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 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, 
 * MA 02111-1307, USA.
 */


// $Id: DockWindowAction.java,v 1.5 2005/12/04 13:46:04 jesper Exp $
package api.infonode.docking.action;

import api.infonode.docking.DockingWindow;
import api.infonode.docking.internalutil.InternalDockingUtil;
import api.infonode.gui.icon.button.DockIcon;

import javax.swing.*;
import java.io.ObjectStreamException;

/**
 * Docks a window using the {@link DockingWindow#dock()} method.
 *
 * @author $Author: jesper $
 * @version $Revision: 1.5 $
 * @since IDW 1.4.0
 */
public class DockWindowAction extends DockingWindowAction {
  private static final long serialVersionUID = 1;

  /**
   * The only instance of this class
   */
  public static final DockWindowAction INSTANCE = new DockWindowAction();

  private static final Icon icon = new DockIcon(InternalDockingUtil.DEFAULT_BUTTON_ICON_SIZE);

  private DockWindowAction() {
  }

  public Icon getIcon() {
    return icon;
  }

  public String getName() {
    return "Dock";
  }

  public boolean isPerformable(DockingWindow window) {
    return window.isDockable() && window.isUndocked();
  }

  public void perform(DockingWindow window) {
    if (isPerformable(window)) {
      window.dock();
    }
  }

  protected Object readResolve() throws ObjectStreamException {
    return INSTANCE;
  }
}
