/*
    * Copyright (c) 2001 - 2005 ivata limited.
    * All rights reserved.
    * -----------------------------------------------------------------------------
    * ivata masks may be redistributed under the GNU General public
    * License as published by the Free Software Foundation;
    * version 2 of the License.
    *
    * These programs are free software; you can redistribute them and/or
   * modify them under the terms of the GNU General public License
   * as published by the Free Software Foundation; version 2 of the License.
   *
   * These programs are distributed in the hope that they 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 in the file LICENSE.txt for more
   * details.
   *
   * If you would like a copy of the GNU General public License write to
   *
   * Free Software Foundation, Inc.
   * 59 Temple Place - Suite 330
   * Boston, MA 02111-1307, USA.
   *
   *
   * To arrange commercial support and licensing, contact ivata at
   *                  http://www.ivata.com/contact.jsp
   * -----------------------------------------------------------------------------
   * $Log: JavaScriptWindow.java,v $
   * Revision 1.3  2005/04/09 18:04:18  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.2  2005/03/10 10:28:26  colinmacleod
   * Fixed for tomcat4.
   * Now uses getAttribute and only in page context.
   * (Was findAttribute before.)
   *
   * Revision 1.1  2005/01/06 23:00:31  colinmacleod
   * Moved up a version number.
   * Changed copyright notices to 2005.
   * Updated the documentation:
   *   - started working on multiproject:site docu.
   *   - changed the logo.
   * Added checkstyle and fixed LOADS of style issues.
   * Added separate thirdparty subproject.
   * Added struts (in web), util and webgui (in webtheme) from ivata op.
   *
   * Revision 1.4  2004/12/23 21:01:31  colinmacleod
   * Updated Struts to v1.2.4.
   * Changed base classes to use ivata masks.
   *
   * Revision 1.3  2004/11/12 15:57:21  colinmacleod
   * Removed dependencies on SSLEXT.
   * Moved Persistence classes to ivata masks.
   *
   * Revision 1.2  2004/03/21 21:16:35  colinmacleod
   * Shortened name to ivata op.
   *
   * Revision 1.1.1.1  2004/01/27 20:59:38  colinmacleod
   * Moved ivata op to SourceForge.
   *
   * Revision 1.3  2004/01/19 21:14:23  colin
   * Updated for Struts/SSLEXT v1.10
   *
   * Revision 1.2  2003/10/16 15:43:03  jano
   * Fixes problems with building and some problems with splitting to subprojects
   *
   * Revision 1.1.1.1  2003/10/13 20:49:27  colin
   * Restructured portal into subprojects
   *
   * Revision 1.3  2003/06/10 06:07:18  peter
   * last change was a mistake... changed to normal quotes
   *
   * Revision 1.1  2003/02/24 19:33:33  colin
   * Moved to new subproject.
   *
   * Revision 1.6  2003/02/18 13:13:23  colin
   * reverted to single quotes for pop-ups
   *
   * Revision 1.5  2003/02/18 11:13:15  colin
   * switched double/single quotes
   *
   * Revision 1.4  2003/02/04 17:43:46  colin
   * copyright notice
   *
   * Revision 1.3  2003/01/27 08:19:08  colin
   * updated for SSLEXT
   *
   * Revision 1.2  2003/01/18 20:20:38  colin
   * changed error messages to alerts to make them easier to find.
   *
   * Revision 1.1  2002/06/21 11:58:37  colin
   * restructured com.ivata.mask.jsp into separate
   * sub-categories: format, JavaScript, theme and tree.
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.javascript;
  import java.net.MalformedURLException;
 import java.util.Map;
 import javax.servlet.jsp.PageContext;
 import org.apache.struts.taglib.TagUtils;
 /***
  * <p>
  * <b>IMPORTANT: </b> the code generated by this class uses double quoted
  * strings. That means, if you include the output in an <i>HTML </i> tag
  * attribute, you should use single quotes for the HTML attribute.
  * </p>
  *
  * <p>
  * Creates a new window using JavaScript. To use this class, set the attributes
  * of the window by using the setter methods of this class, then call
  * {@link #toString() toString()}to generate the JavaScript.
  * </p>
  *
  * <p>
  * You must set the URL and the frame name before calling {@link#toString()
  * toString()}.
  * </p>
  *
  * @since ivata masks 0.4 (2002-05-18)
  * @author Colin MacLeod
  * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
  * @version $Revision: 1.3 $
  */
 public final class JavaScriptWindow {
     /***
      * <p>
      * Stores the fame name of the new window.
      * </p>
      */
     private String frameName = null;
     /***
      * <p>
      * Stores whether or not the window has a menu bar. The default setting is
      * <code>false</code>.
      * </p>
      */
     private boolean hasMenuBar = false;
     /***
      * <p>
      * Stores whether or not the window has scroll bars. The default setting is
      * <code>true</code>.
      * </p>
      */
     private boolean hasScrollBars = true;
     /***
      * <p>
      * Stores whether or not the window has a toolbar. The default setting is
      * <code>false</code>.
      * </p>
      */
     private boolean hasToolBar = false;
     /***
      * <p>
      * Stores the height of the window.
      * </p>
      */
     private int height;
     /***
      * <p>
      * Stores whether or not the window can be resized. The default setting is
      * <code>true</code>.
      * </p>
      */
     private boolean isResizable = true;
     /***
      * <p>
      * Set this value to specify the application-specific path (beginning with a
      * '/') which the new window will show.
      * </p>
      */
     private String page = null;
     /***
      * <p>
      * Used to calculate the URL with the <code>SecureRequestUtils</code> from
      * <strong>Struts </strong>.
      * </p>
      */
     private PageContext pageContext = null;
     /***
      * <p>
      * Specifies parameters for the page this window shows.
      * </p>
      *
      * @see TagUtils.getInstance().computeURL
      */
     private Map params = null;
     /***
      * <p>
      * Specifies the name of a <code>java.util.Map</code> instance in the page
      * context which is used to specify parameters for the page this window
      * shows.
      * </p>
      *
      * @see TagUtils.getInstance().computeURL.
      */
     private String paramsName = null;
     /***
      * <p>
      * Stores the width of the window.
      * </p>
      */
     private int width;
     /***
      * <p>
      * Stores the name of a JavaScript object name for the new window.
      * </p>
      */
     private String windowName = null;
     /***
      * Private helper to create a pop-up (alert) window with a message.
      *
      * @param message
      *            message to display in a pop-up window.
      * @return JavaScript for appropriate pop-up.
      */
     private String alertError(final String message) {
         return "alert(\"ERROR in JavaScriptWindow: " + message + "\");";
     }
     /***
      * <p>
      * Get the fame name of the new window.
      * </p>
      *
      * @return the fame name of the new window.
      */
     public String getFrameName() {
         return frameName;
     }
     /***
      * <p>
      * Get whether or not the window has a menu bar. The default setting is
      * <code>false</code>.
      * </p>
      *
      * @return <code>true</code> if the window has a menu bar, otherwise
      *         <code>false</code>.
      */
     public boolean getHasMenuBar() {
         return hasMenuBar;
     }
     /***
      * <p>
      * Get whether or not the window has scroll bars. The default setting is
      * <code>true</code>.
      * </p>
      *
      * @return <code>true</code> if the window has scroll bars, otherwise
      *         <code>false</code>.
      */
     public boolean getHasScrollBars() {
         return hasScrollBars;
     }
     /***
      * <p>
      * Get whether or not the window has a tool bar. The default setting is
      * <code>true</code>.
      * </p>
      *
      * @return <code>true</code> if the window has a tool bar, otherwise
      *         <code>false</code>.
      */
     public boolean getHasToolBar() {
         return hasToolBar;
     }
     /***
      * <p>
      * Get the height of the window.
      * </p>
      *
      * @return the height of the window.
      */
     public int getHeight() {
         return height;
     }
     /***
      * <p>
      * Get whether or not the window can be resized. The default setting is
      * <code>true</code>.
      * </p>
      *
      * @return <code>true</code> if the window has can be resized, otherwise
      *         <code>false</code>.
      */
     public boolean getIsResizable() {
         return isResizable;
     }
     /***
      * <p>
      * Set this value to specify the application-specific path (beginning with a
      * '/') which the new window will show.
      * </p>
      *
      * @return the current value of page.
      */
     public String getPage() {
         return page;
     }
     /***
      * <p>
      * Specifies parameters for the page this window shows.
      * </p>
      *
      * @see TagUtils.getInstance().computeURL
      * @return the current value of parameters.
      */
     public Map getParams() {
         return params;
     }
     /***
      * <p>
      * Specifies the name of a <code>java.util.Map</code> instance in the page
      * context which is used to specify parameters for the page this window
      * shows.
      * </p>
      *
      * @see TagUtils.getInstance().computeURL.
      *
      * @return the current value of paramsName.
      */
     public String getParamsName() {
         return paramsName;
     }
     /***
      * <p>
      * Get the width of the window.
      * </p>
      *
      * @return the width of the window.
      */
     public int getWidth() {
         return width;
     }
     /***
      * <p>
      * Get a JavaScript object name for the new window.
      * </p>
      *
      * @return a JavaScript object name for the new window.
      */
     public String getWindowName() {
         return windowName;
     }
     /***
      * <p>
      * Set the fame name of the new window.
      * </p>
      *
      * @param frameNameParam
      *            the new value of the fame name of the new window.
      */
     public void setFrameName(final String frameNameParam) {
         this.frameName = frameNameParam;
     }
     /***
      * <p>
      * Set whether or not the window has a menu bar. The default setting is
      * <code>false</code>.
      * </p>
      *
      * @param hasMenuBarParam
      *            set to <code>true</code> if the window has a menu bar,
      *            otherwise <code>false</code>.
      */
     public void setHasMenuBar(final boolean hasMenuBarParam) {
         this.hasMenuBar = hasMenuBarParam;
     }
     /***
      * <p>
      * Set whether or not the window has scroll bars. The default setting is
      * <code>true</code>.
      * </p>
      *
      * @param hasScrollBarsParam
      *            set to <code>true</code> if the window has scroll bars,
      *            otherwise <code>false</code>.
      */
     public void setHasScrollBars(final boolean hasScrollBarsParam) {
         this.hasScrollBars = hasScrollBarsParam;
     }
     /***
      * <p>
      * Set whether or not the window has a tool bar. The default setting is
      * <code>true</code>.
      * </p>
      *
      * @param hasToolBarParam
      *            set to <code>true</code> if the window has a tool bar,
      *            otherwise <code>false</code>.
      */
     public void setHasToolBar(final boolean hasToolBarParam) {
         this.hasToolBar = hasToolBarParam;
     }
     /***
      * <p>
      * Set the height of the window. The default setting is <code>450</code>.
      * </p>
      *
      * @param heightParam
      *            the new height of the window.
      */
     public void setHeight(final int heightParam) {
         this.height = heightParam;
     }
     /***
      * <p>
      * Set whether or not the window can be resized. The default setting is
      * <code>true</code>.
      * </p>
      *
      * @param isResizableParam
      *            set to <code>true</code> if the window has can be resized,
      *            otherwise <code>false</code>.
      */
     public void setIsResizable(final boolean isResizableParam) {
         this.isResizable = isResizableParam;
     }
     /***
      * <p>
      * Set this value to specify the application-specific path (beginning with a
      * '/') which the new window will show.
      * </p>
      *
      * @param pageParam
      *            the new value of page.
      */
     public void setPage(final String pageParam) {
         this.page = pageParam;
     }
     /***
      * <p>
      * Set the page context used to calculate the window <i>URL </i>.
      * </p>
      *
      * @param pageContextParam
      *            new value of page context.
      */
     public void setPageContext(final PageContext pageContextParam) {
         this.pageContext = pageContextParam;
     }
     /***
      * <p>
      * Specifies parameters for the page this window shows.
      * </p>
      *
      * @see TagUtils.getInstance().computeURL
      *
      * @param paramsParam
      *            the new value of the parameters.
      */
     public void setParams(final Map paramsParam) {
         this.params = paramsParam;
     }
     /***
      * <p>
      * Specifies the name of a <code>java.util.Map</code> instance in the page
      * context which is used to specify parameters for the page this window
      * shows.
      * </p>
      *
      * @see TagUtils.getInstance().computeURL.
      * @param paramsNameParam
      *            the new value of paramsName.
      */
     public void setParamsName(final String paramsNameParam) {
         this.paramsName = paramsNameParam;
     }
     /***
      * <p>
      * Set the width of the window. The default setting is <code>700</code>.
      * </p>
      *
      * @param widthParam
      *            the new value for the width of the window.
      */
     public void setWidth(final int widthParam) {
         this.width = widthParam;
     }
     /***
      * <p>
      * Set a JavaScript object name for the new window.
      * </p>
      *
      * @param windowNameParam
      *            a JavaScript object name for the new window.
      */
     public void setWindowName(final String windowNameParam) {
         this.windowName = windowNameParam;
     }
     /***
      * <p>
      * Create the JavaScript that makes the window and return it as a string.
      * </p>
      *
      * @return the JavaScript that makes the window.
      */
     public String toString() {
         StringBuffer buffer = new StringBuffer();
         // if the window name was set, begin with that
         if (windowName != null) {
             buffer.append("var ");
             buffer.append(windowName);
             buffer.append(" = ");
         }
         // we need a URL and a frameName
         if (page == null) {
             return alertError("No page parameter was set.");
         }
         if (pageContext == null) {
             return alertError("No pageContext parameter was set.");
         }
         // see if we were specified parameters
         if (paramsName != null) {
             params = (Map) pageContext.findAttribute(paramsName);
         }
         try {
             String uRL = TagUtils.getInstance().computeURL(pageContext, null,
                     null, page, null, null, params, null, false);
             if (frameName == null) {
                 return alertError("No frameName parameter was set.");
             }
             buffer.append("window.open(\"");
             buffer.append(uRL);
             buffer.append("\", \"");
             buffer.append(frameName);
             buffer.append("\", \"toolbar=");
             if (hasToolBar) {
                 buffer.append("yes");
             } else {
                 buffer.append("no");
             }
             buffer.append(",menubar=");
             if (hasMenuBar) {
                 buffer.append("yes");
             } else {
                 buffer.append("no");
             }
             buffer.append(",scrollbars=");
             if (hasScrollBars) {
                 buffer.append("auto");
             } else {
                 buffer.append("no");
             }
             buffer.append(",height=");
             buffer.append(height);
             buffer.append(",width=");
             buffer.append(width);
             buffer.append(",top=200");
             buffer.append(",left=200");
             buffer.append(",resizable=");
             if (isResizable) {
                 buffer.append("yes");
             } else {
                 buffer.append("no");
             }
             buffer.append("\");");
             return buffer.toString();
         } catch (MalformedURLException e) {
             return alertError("Malformed URL: " + e.getMessage());
         }
     }
 }