/*******************************************************************************
 * Copyright (c) 2001, 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.wst.ws.internal.explorer.platform.perspective;

import org.eclipse.wst.ws.internal.explorer.platform.constants.*;
import org.eclipse.wst.ws.internal.explorer.platform.util.*;

import javax.servlet.http.*;

import java.util.*;

// A class for representing toolbar tools.
public abstract class Tool
{
  protected ToolManager toolManager_;
  private String enabledImageLink_;
  private String highlightedImageLink_;
  private String alt_;
  protected int toolId_;
  protected byte toolType_;

  public Tool(ToolManager toolManager,String enabledImageLink,String highlightedImageLink,String alt,byte toolType)
  {
    toolManager_ = toolManager;
    enabledImageLink_ = enabledImageLink;
    highlightedImageLink_ = highlightedImageLink;
    alt_ = alt;
    toolId_ = toolManager_.addTool(this);
    toolType_ = toolType;
  }

  public abstract String getSelectToolActionHref(boolean forHistory);

  public String getSelectToolActionTarget()
  {
    return FrameNames.PERSPECTIVE_WORKAREA;
  }

  private final void generateOnMouseValue(StringBuffer value,HttpServletResponse response,String fullImageLink)
  {
    value.append("src='").append(response.encodeURL(fullImageLink)).append('\'');
  }

  public String renderTool(HttpServletResponse response,Controller controller)
  {
    Hashtable jsImageProperties = new Hashtable();
    StringBuffer propertyValue = new StringBuffer();
    String fullEnabledImageLink = controller.getPathWithContext(enabledImageLink_);
    generateOnMouseValue(propertyValue,response,fullEnabledImageLink);
    int propertyValueLength = propertyValue.length();
    jsImageProperties.put("class","normal");
    jsImageProperties.put("onMouseOut",propertyValue.append(";mouseout(this)").toString());
    propertyValue.delete(propertyValueLength,propertyValue.length());
    jsImageProperties.put("onMouseUp",propertyValue.append(";mouseup(this)").toString());
    propertyValue.setLength(0);
    generateOnMouseValue(propertyValue,response,controller.getPathWithContext(highlightedImageLink_));
    propertyValueLength = propertyValue.length();
    jsImageProperties.put("onMouseOver",propertyValue.append(";mouseover(this)").toString());
    propertyValue.delete(propertyValueLength,propertyValue.length());
    jsImageProperties.put("onMouseDOwn",propertyValue.append(";mousedown(this)").toString());

    String imageTag = HTMLUtils.getHTMLImageTag(response,fullEnabledImageLink,alt_,"16","16",jsImageProperties);
    return HTMLUtils.getHTMLLinkTag(response,controller.getPathWithContext(getSelectToolActionHref(false)),getSelectToolActionTarget(),null,imageTag,null);
  }

  public final ToolManager getToolManager()
  {
    return toolManager_;
  }

  public final int getToolId()
  {
    return toolId_;
  }

  public final byte getToolType()
  {
    return toolType_;
  }
  
  public final String getEnabledImageLink()
  {
    return enabledImageLink_;
  }
  
  public final String getHighlightedImageLink()
  {
    return highlightedImageLink_;
  }
  
  public final String getAltText()
  {
    return alt_;
  }

  public abstract String getFormLink();
  public abstract String getActionLink();
}