org.alfresco.repo.rendition.executer
Class HTMLRenderingEngine
java.lang.Object
org.alfresco.repo.action.CommonResourceAbstractBase
org.alfresco.repo.action.ParameterizedItemAbstractBase
org.alfresco.repo.action.executer.ActionExecuterAbstractBase
org.alfresco.repo.rendition.executer.AbstractRenderingEngine
org.alfresco.repo.rendition.executer.HTMLRenderingEngine
- All Implemented Interfaces:
- ActionExecuter, org.springframework.beans.factory.BeanNameAware
public class HTMLRenderingEngine
- extends AbstractRenderingEngine
This class provides a way to turn documents supported by the
ContentService
standard transformers into basic, clean
HTML.
The HTML that is produced probably isn't going to be suitable
for direct web publishing, as it's likely going to be too
basic. Instead, it should be simple and clean HTML, suitable
for being the basis of some web-friendly HTML once edited
/ further transformed.
- Since:
- 3.4
Field Summary |
static java.lang.String |
NAME
|
static java.lang.String |
PARAM_BODY_CONTENTS_ONLY
This optional parameter, when set to true, causes only the
contents of the HTML body to be written out as the rendition. |
static java.lang.String |
PARAM_IMAGES_SAME_FOLDER
This optional parameter, when set to true, causes any embedded
images to be written into the same folder as the html, with
a name prefix. |
Fields inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine |
CONTENT_READER_NOT_FOUND_MESSAGE, contentService, mimetypeMap, nodeService, PARAM_ENCODING, PARAM_MIME_TYPE, PARAM_PLACEHOLDER_RESOURCE_PATH, PARAM_RUN_AS, PARAM_SOURCE_CONTENT_PROPERTY, PARAM_TARGET_CONTENT_PROPERTY, PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE |
Methods inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine |
addParameterDefinitions, checkActionIsRenditionDefinition, checkParameterValues, checkSourceNodeExists, createActionDefinition, executeImpl, executeImpl, executeRenditionImpl, getCheckedParam, getDefaultRenditionContentProp, getDefaultRenditionNodeType, getParamDisplayLabel, getParamWithDefault, getRenditionContentProperty, getTargetEncoding, getTargetMimeType, notifyCallbackOfException, notifyCallbackOfResult, resolveRenditionLocation, setBehaviourFilter, setContentService, setDefaultRenditionContentProp, setDefaultRenditionNodeType, setMimetypeMap, setNodeService, setRenditionLocationResolver, setRenditionService, switchToFinalRenditionNode, tagSourceNodeAsRenditioned, throwWrappedException |
Methods inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase |
execute, getActionDefinition, getIgnoreLock, getQueueName, getTrackStatus, init, setApplicableTypes, setBaseNodeService, setIgnoreLock, setLockService, setPublicAction, setQueueName, setTrackStatus |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
PARAM_BODY_CONTENTS_ONLY
public static final java.lang.String PARAM_BODY_CONTENTS_ONLY
- This optional parameter, when set to true, causes only the
contents of the HTML body to be written out as the rendition.
By default, the whole of the HTML document is used.
- See Also:
- Constant Field Values
PARAM_IMAGES_SAME_FOLDER
public static final java.lang.String PARAM_IMAGES_SAME_FOLDER
- This optional parameter, when set to true, causes any embedded
images to be written into the same folder as the html, with
a name prefix.
By default, images are placed into a sub-folder.
- See Also:
- Constant Field Values
NAME
public static final java.lang.String NAME
- See Also:
- Constant Field Values
HTMLRenderingEngine
public HTMLRenderingEngine()
getParameterDefinitions
protected java.util.Collection getParameterDefinitions()
- Description copied from class:
AbstractRenderingEngine
- Supplies the list of parameters required by this rendering engine.
- Overrides:
getParameterDefinitions
in class AbstractRenderingEngine
- Returns:
setTikaConfig
public void setTikaConfig(org.apache.tika.config.TikaConfig tikaConfig)
- Injects the TikaConfig to use
- Parameters:
tikaConfig
- The Tika Config to use
render
protected void render(AbstractRenderingEngine.RenderingContext context)
- Specified by:
render
in class AbstractRenderingEngine
Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.