/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.markup.html.link;
import org.apache.wicket.IPageMap;
import org.apache.wicket.RequestCycle;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.MarkupStream;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.util.string.Strings;
/**
* A simple anchor link (<a href="http://url">) pointing to any URL.
* Usually this is used for links to destinations outside of Wicket.
*
* @author Juergen Donnerstag
*/
public class ExternalLink extends WebMarkupContainer
{
private static final long serialVersionUID = 1L;
/** the href attribute. */
private final IModel href;
/** this links' label. */
private final IModel label;
private boolean contextRelative = false;
/**
* The popup specification. If not-null, a javascript on-click event handler
* will be generated that opens a new window using the popup properties.
*/
private PopupSettings popupSettings = null;
/**
* Constructor.
*
* @param id
* See Component
* @param href
* the href attribute to set
* @param label
* the label (body)
*/
public ExternalLink(final String id, final String href, final String label)
{
super(id);
this.href = (href != null ? new Model(href) : null);
this.label = (label != null ? new Model(label) : null);
}
/**
* Constructor.
*
* @param id
* The name of this component
* @param href
* the href attribute to set
*/
public ExternalLink(final String id, final String href)
{
this(id, href, null);
}
/**
* Constructor.
*
* @param id
* See Component
* @param href
* the href attribute to set
* @param label
* the label (body)
*/
public ExternalLink(final String id, final IModel href, final IModel label)
{
super(id);
this.href = wrap(href);
this.label = wrap(label);
}
/**
* Constructor.
*
* @param id
* The name of this component
* @param href
* the href attribute to set
*/
public ExternalLink(final String id, final IModel href)
{
this(id, href, null);
}
/**
* Gets the popup specification. If not-null, a javascript on-click event
* handler will be generated that opens a new window using the popup
* properties.
*
* @return the popup specification.
*/
public final PopupSettings getPopupSettings()
{
return popupSettings;
}
/**
* Sets the popup specification. If not-null, a javascript on-click event
* handler will be generated that opens a new window using the popup
* properties.
*
* @param popupSettings
* the popup specification.
* @return This
*/
public final ExternalLink setPopupSettings(final PopupSettings popupSettings)
{
this.popupSettings = popupSettings;
return this;
}
/**
* Processes the component tag.
*
* @param tag
* Tag to modify
* @see org.apache.wicket.Component#onComponentTag(org.apache.wicket.markup.ComponentTag)
*/
protected void onComponentTag(ComponentTag tag)
{
super.onComponentTag(tag);
if (href != null)
{
Object hrefValue = href.getObject();
if (hrefValue != null)
{
String url = hrefValue.toString();
if (contextRelative)
{
if (url.length() > 0 && url.charAt(0) == '/')
{
url = url.substring(1);
}
url = RequestCycle.get().getRequest().getRelativePathPrefixToContextRoot() + url;
}
// if the tag is an anchor proper
if (tag.getName().equalsIgnoreCase("a") || tag.getName().equalsIgnoreCase("link")
|| tag.getName().equalsIgnoreCase("area"))
{
// generate the href attribute
tag.put("href", Strings.replaceAll(url, "&", "&"));
// Add any popup script
if (popupSettings != null)
{
// NOTE: don't encode to HTML as that is not valid
// JavaScript
tag.put("onclick", popupSettings.getPopupJavaScript());
}
}
else
{
// generate a popup script by asking popup settings for one
if (popupSettings != null)
{
popupSettings.setTarget("'" + url + "'");
String popupScript = popupSettings.getPopupJavaScript();
tag.put("onclick", popupScript);
}
else
{
// or generate an onclick JS handler directly
tag.put("onclick", "window.location.href='" + url + "';");
}
}
}
if (popupSettings != null)
{
IPageMap popupPageMap = popupSettings.getPageMap(this);
if (popupPageMap != null)
{
tag.put("target", popupPageMap.getName());
}
}
}
}
/**
* Handle the container's body.
*
* @param markupStream
* The markup stream
* @param openTag
* The open tag for the body
* @see org.apache.wicket.Component#onComponentTagBody(org.apache.wicket.markup.MarkupStream,
* org.apache.wicket.markup.ComponentTag)
*/
protected void onComponentTagBody(MarkupStream markupStream, ComponentTag openTag)
{
this.checkComponentTag(openTag, "a");
if ((label != null) && (label.getObject() != null))
{
replaceComponentTagBody(markupStream, openTag, getModelObjectAsString(label.getObject()));
}
else
{
super.onComponentTagBody(markupStream, openTag);
}
}
/**
* @return True if this link is automatically prepended with ../ to make it
* relative to the context root.
*/
public boolean isContextRelative()
{
return contextRelative;
}
/**
* Set to true if this link should be automatically prepended with ../ to
* make it relative to the context root.
*
* @param contextRelative
* @return This for chaining
*/
public ExternalLink setContextRelative(boolean contextRelative)
{
this.contextRelative = contextRelative;
return this;
}
}