Neil McErlean 8e9c4f3aa5 RenditionService JS API.
Support for creating a RenditionDefinition from within JavaScript
Support for executing such an ad hoc rendition definition.
ScriptRendtionService now accepts long-form or short-form QNames where applicable.
Replaced "rendering actions" with "rendition definitions" in some javadoc and some private or local variable names.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@19269 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-03-12 21:28:38 +00:00

93 lines
3.1 KiB
Java

/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco 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 3 of the License, or
* (at your option) any later version.
*
* Alfresco 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 Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.rendition.script;
import java.io.Serializable;
import java.util.Map;
import org.alfresco.repo.jscript.ScriptAction;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.rendition.RenderingEngineDefinition;
import org.alfresco.service.cmr.rendition.RenditionDefinition;
import org.alfresco.service.namespace.QName;
import org.mozilla.javascript.Scriptable;
/**
* RenditionDefinition JavaScript Object. This class is a JavaScript-friendly wrapper for
* the {@link RenditionDefinition renditionDefinition} class.
*
* @author Neil McErlean
* @see org.alfresco.service.cmr.rendition.RenditionDefinition
*/
public final class ScriptRenditionDefinition implements Serializable
{
private static final long serialVersionUID = 8132935577891455490L;
private final RenderingEngineDefinition engineDefinition;
private final RenditionDefinition renditionDefinition;
private final ServiceRegistry serviceRegistry;
private final ScriptAction scriptAction;
public ScriptRenditionDefinition(ServiceRegistry serviceRegistry, Scriptable scope,
RenderingEngineDefinition engineDefinition, RenditionDefinition renditionDefinition)
{
this.serviceRegistry = serviceRegistry;
this.engineDefinition = engineDefinition;
this.renditionDefinition = renditionDefinition;
this.scriptAction = new ScriptAction(serviceRegistry, renditionDefinition, engineDefinition);
}
/**
* Returns the name of this rendition definition in prefix:localName format.
*
* @return the name which uniquely identifies this rendition definition.
*/
public String getRenditionName()
{
QName qname = this.renditionDefinition.getRenditionName();
return qname.toPrefixString(serviceRegistry.getNamespaceService());
}
public String getRenderingEngineName()
{
return this.engineDefinition.getName();
}
public Map<String, Serializable> getParameters()
{
return this.scriptAction.getParameters();
}
@Override
public String toString()
{
StringBuilder msg = new StringBuilder();
msg.append(this.getClass().getSimpleName())
.append("[").append(getRenditionName()).append("]");
return msg.toString();
}
RenditionDefinition getRenditionDefinition()
{
return this.renditionDefinition;
}
}