public abstract class AbstractEmbeddedResourceRenderer extends Object implements EmbeddedResourceRenderer
Modifier and Type | Field and Description |
---|---|
static String |
TEMPLATE_PATH |
protected static List<String> |
validEmbedTags |
protected static List<String> |
validObjectTags |
protected static List<String> |
validParamTags |
static String |
WRAPPER_TEMPLATE_PATH |
Constructor and Description |
---|
AbstractEmbeddedResourceRenderer() |
Modifier and Type | Method and Description |
---|---|
protected String |
getDefaultHeight()
Returns the default height of the embedded object for when no height is specified.
|
protected String |
getDefaultWidth()
Returns the default width of the embedded object for when no width is specified.
|
protected com.atlassian.xwork.XsrfTokenGenerator |
getXsrfTokenGenerator() |
protected abstract Map<String,Object> |
refineParams(Attachment attachment,
Map<String,Object> properties)
Provides the opportunity for a specialisation to customise any parameters / properties.
|
protected String |
renderEmbeddedObject(EmbeddedObject resource,
Map<String,Object> wrapperContextMap) |
String |
renderResource(EmbeddedObject resource,
com.atlassian.renderer.RenderContext context)
Render the embedded resource to a string.
|
protected Map<String,Object> |
setupObjectProperties(EmbeddedObject emObject,
com.atlassian.renderer.RenderContext context)
Retrieves the attachment from an EmbeddedResource, resolving the absolute URL to the attachment and placing it into a ContextMap for use with Velocity.
|
void |
setXsrfTokenGenerator(com.atlassian.xwork.XsrfTokenGenerator xsrfTokenGenerator) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
matchesType
public static final String TEMPLATE_PATH
public static final String WRAPPER_TEMPLATE_PATH
protected Map<String,Object> setupObjectProperties(EmbeddedObject emObject, com.atlassian.renderer.RenderContext context)
emObject
- the EmbeddedObject objectcontext
- the RenderContextpublic String renderResource(EmbeddedObject resource, com.atlassian.renderer.RenderContext context)
EmbeddedResourceRenderer
renderResource
in interface EmbeddedResourceRenderer
resource
- to be renderedcontext
- of renderprotected String renderEmbeddedObject(EmbeddedObject resource, Map<String,Object> wrapperContextMap)
protected abstract Map<String,Object> refineParams(Attachment attachment, Map<String,Object> properties)
attachment
- the attachment to processproperties
- the parameters to be added to or alteredprotected String getDefaultWidth()
Value will be directly rendered into the HTML.
protected String getDefaultHeight()
Value will be directly rendered into the HTML.
public void setXsrfTokenGenerator(com.atlassian.xwork.XsrfTokenGenerator xsrfTokenGenerator)
protected com.atlassian.xwork.XsrfTokenGenerator getXsrfTokenGenerator()
Copyright © 2003–2015 Atlassian. All rights reserved.