AbstractTemplateEditor.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.edit;

import javax.inject.Inject;

import org.xwiki.stability.Unstable;
import org.xwiki.template.TemplateManager;

/**
 * Base class for editors that are based on a template.
 * 
 * @param <D> the type of data that can be edited by this editor
 * @version $Id: 552d6e3f4c8e0771bfca33ab2467939e7f0581b9 $
 * @since 8.2RC1
 */
@Unstable
public abstract class AbstractTemplateEditor<D> extends AbstractEditor<D>
{
    @Inject
    private TemplateManager templates;

    /**
     * @return the path to the template that generates the HTML code that displays the editor
     */
    public abstract String getTemplateName();

    @Override
    public String render() throws EditException
    {
        try {
            return this.templates.render(getTemplateName());
        } catch (Exception e) {
            throw new EditException("Failed to render the editor template.", e);
        }
    }
}