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,LoggingAwareExecuter,org.springframework.beans.factory.Aware,org.springframework.beans.factory.BeanNameAware
@Deprecated public class HTMLRenderingEngine extends AbstractRenderingEngine
Deprecated.The RenditionService is being replace by the simpler async RenditionService2.This class provides a way to turn documents supported by theContentServicestandard 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
- Author:
- Nick Burch
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine
AbstractRenderingEngine.RenderingContext
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringNAMEDeprecated.static java.lang.StringPARAM_BODY_CONTENTS_ONLYDeprecated.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.StringPARAM_IMAGES_SAME_FOLDERDeprecated.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
actionTrackingService, CONTENT_READER_NOT_FOUND_MESSAGE, contentService, DEFAULT_RUN_AS_NAME, mimetypeMap, namespaceService, 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
-
Fields inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase
actionDefinition, applicableTypes, publicAction
-
Fields inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase
adhocPropertiesAllowed, DISPLAY_LABEL, runtimeActionService
-
Fields inherited from class org.alfresco.repo.action.CommonResourceAbstractBase
name
-
Fields inherited from interface org.alfresco.repo.action.executer.ActionExecuter
PARAM_RESULT
-
-
Constructor Summary
Constructors Constructor Description HTMLRenderingEngine()Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected java.util.Collection<ParameterDefinition>getParameterDefinitions()Deprecated.Supplies the list of parameters required by this rendering engine.protected voidrender(AbstractRenderingEngine.RenderingContext context)Deprecated.voidsetTikaConfig(org.apache.tika.config.TikaConfig tikaConfig)Deprecated.Injects the TikaConfig to use-
Methods inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine
addParameterDefinitions, checkActionIsRenditionDefinition, checkParameterValues, checkSourceNodeExists, createActionDefinition, executeImpl, executeImpl, executeRenditionImpl, getCheckedParam, getDefaultRenditionContentProp, getDefaultRenditionNodeType, getExecutionSummary, getParamDisplayLabel, getParamWithDefault, getRenditionContentProperty, getTargetEncoding, getTargetMimeType, notifyCallbackOfException, notifyCallbackOfResult, resolveRenditionLocation, setActionTrackingService, setBehaviourFilter, setContentService, setDefaultRenditionContentProp, setDefaultRenditionNodeType, setMimetypeMap, setNamespaceService, setNodeService, setRenditionLocationResolver, setRenditionService, switchToFinalRenditionNode, tagSourceNodeAsRenditioned, throwWrappedException
-
Methods inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase
execute, getActionDefinition, getIgnoreLock, getQueueName, getTrackStatus, init, isApplicableType, onLogException, setApplicableTypes, setBaseNodeService, setDictionaryService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatus
-
Methods inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase
checkMandatoryProperties, getAdhocPropertiesAllowed, getDescriptionKey, getLocalizedParameterDefinitions, getParamDisplayLabel, getParameterDefintions, getTitleKey, setAdhocPropertiesAllowed, setLocales, setRuntimeActionService, toString
-
Methods inherited from class org.alfresco.repo.action.CommonResourceAbstractBase
setBeanName
-
-
-
-
Field Detail
-
PARAM_BODY_CONTENTS_ONLY
public static final java.lang.String PARAM_BODY_CONTENTS_ONLY
Deprecated.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
Deprecated.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
Deprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
getParameterDefinitions
protected java.util.Collection<ParameterDefinition> getParameterDefinitions()
Deprecated.Description copied from class:AbstractRenderingEngineSupplies the list of parameters required by this rendering engine.- Overrides:
getParameterDefinitionsin classAbstractRenderingEngine
-
setTikaConfig
public void setTikaConfig(org.apache.tika.config.TikaConfig tikaConfig)
Deprecated.Injects the TikaConfig to use- Parameters:
tikaConfig- The Tika Config to use
-
render
protected void render(AbstractRenderingEngine.RenderingContext context)
Deprecated.- Specified by:
renderin classAbstractRenderingEngine
-
-