001// Copyright 2004, 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry.contrib.link;
016
017import org.apache.hivemind.service.BodyBuilder;
018import org.apache.tapestry.IRequestCycle;
019import org.apache.tapestry.PageRenderSupport;
020import org.apache.tapestry.TapestryUtils;
021import org.apache.tapestry.components.ILinkComponent;
022import org.apache.tapestry.engine.ILink;
023import org.apache.tapestry.link.DefaultLinkRenderer;
024
025/**
026 * This renderer emits javascript to launch the link in a window.
027 * 
028 * @author David Solis
029 * @since 3.0.1
030 */
031public class PopupLinkRenderer extends DefaultLinkRenderer
032{
033
034    private String _windowName;
035
036    private String _features;
037
038    public PopupLinkRenderer()
039    {
040    }
041
042    /**
043     * Initializes the name and features for javascript window.open function.
044     * 
045     * @param windowName
046     *            the window name
047     * @param features
048     *            the window features
049     */
050    public PopupLinkRenderer(String windowName, String features)
051    {
052        _windowName = windowName;
053        _features = features;
054    }
055
056    /**
057     * @see DefaultLinkRenderer#constructURL(org.apache.tapestry.engine.ILink, String,
058     *      org.apache.tapestry.IRequestCycle)
059     */
060    protected String constructURL(ILinkComponent component, IRequestCycle cycle)
061    {
062        if (cycle.isRewinding())
063            return null;
064
065        String anchor = component.getAnchor();
066        ILink link = component.getLink(cycle);
067
068        String url = link.getURL(anchor, true);
069
070        PageRenderSupport support = TapestryUtils.getPageRenderSupport(cycle, component);
071
072        String functionName = support.getUniqueString("popup_window");
073
074        BodyBuilder builder = new BodyBuilder();
075
076        builder.addln("function {0}()", functionName);
077        builder.begin();
078        builder.addln(
079                "var newWindow = window.open({0}, {1}, {2});",
080                TapestryUtils.enquote(url),
081                TapestryUtils.enquote(getWindowName()),
082                TapestryUtils.enquote(getFeatures()));
083        builder.addln("newWindow.focus();");
084        builder.end();
085
086        support.addBodyScript(builder.toString());
087
088        return "javascript:" + functionName + "();";
089    }
090
091    public String getWindowName()
092    {
093        return _windowName;
094    }
095
096    public void setWindowName(String windowName)
097    {
098        _windowName = windowName;
099    }
100
101    public String getFeatures()
102    {
103        return _features;
104    }
105
106    public void setFeatures(String features)
107    {
108        _features = features;
109    }
110}