org.wicketstuff.jasperreports.EmbeddedJRReport.java Source code

Introduction

Here is the source code for org.wicketstuff.jasperreports.EmbeddedJRReport.java

Source

/*
 * $Id$
 * $Revision$ $Date$
 *
 * ==============================================================================
 * Licensed 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.wicketstuff.jasperreports;

import org.apache.wicket.IResourceListener;
import org.apache.wicket.Page;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.html.WebComponent;
import org.apache.wicket.request.handler.resource.ResourceRequestHandler;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.request.resource.ResourceReference;

/**
 * Component for embedding a jasper report in a page. This component must be attached to an
 * <object> tag. If you don't want to embed the report, but have a link to it instead, use
 * {@link ResourceReference}.
 * 
 * @author <a href="mailto:evanchooly@gmail.com">Justin Lee</a>
 */
public final class EmbeddedJRReport extends WebComponent implements IResourceListener {
    private static final long serialVersionUID = 1L;

    private final JRResource resource;

    /**
     * Construcxt.
     * 
     * @param componentID
     *            component componentID
     * @param resource
     *            the resource
     */
    public EmbeddedJRReport(String componentID, JRResource resource) {
        super(componentID);
        this.resource = resource;
    }

    /**
     * @see org.apache.wicket.IResourceListener#onResourceRequested()
     */
    public void onResourceRequested() {
        PageParameters pageParams = null;
        final Page page = findPage();
        if (page != null)
            pageParams = page.getPageParameters();

        ResourceRequestHandler reqh = new ResourceRequestHandler(resource, pageParams);

        reqh.respond(getRequestCycle());
    }

    /**
     * Make sure we work only with object tags
     * 
     * @param tag
     *            tag applied to component.
     * @see org.apache.wicket.Component#onComponentTag(org.apache.wicket.markup.ComponentTag)
     */
    @Override
    protected void onComponentTag(ComponentTag tag) {
        if (!"object".equalsIgnoreCase(tag.getName())) {
            findMarkupStream().throwMarkupException("Component " + getId()
                    + " must be applied to a tag of type 'object' not " + tag.toUserDebugString());
        }
        tag.put("data", getResponse().encodeURL(urlFor(IResourceListener.INTERFACE, null)));
        tag.put("type", resource.getContentType());
        super.onComponentTag(tag);
    }
}