com.atlassian.confluence.content.render.xhtml.view.excerpt
Interface Excerpter
- All Known Implementing Classes:
- DefaultExcerpter
public interface Excerpter
BLOCK_ELEMENT_SET
static final Set<String> BLOCK_ELEMENT_SET
CONTAINER_ELEMENT_SET
static final Set<String> CONTAINER_ELEMENT_SET
createExcerpt
String createExcerpt(ContentEntityObject contentEntityObject,
String outputType)
throws Exception
- Creates an excerpt of the contentEntityObject without any tags excluded including an implementation specific
number of blocking
- Parameters:
contentEntityObject
- - contentEntityObject to create an excerpt ofoutputType
- - the output type in which to render the content, @see RenderContextOutputType
- Returns:
- a html excerpt of the content entity object
- Throws:
Exception
- - if an excerpt could not be created for this ContentEntityObject
createExcerpt
String createExcerpt(ContentEntityObject contentEntity,
String outputType,
ExcerptConfig config)
throws XMLStreamException,
com.atlassian.plugin.web.renderer.RendererException
- Creates an excerpt of the contentEntityObject excluding any html tags that are in the exclude set.
The number of blocks with content to be included in the excerpt is specified with the maxBlocksForExcerpt
parameter. A block with content is any element with a
- Parameters:
contentEntityObject
- - contentEntityObject to create an excerpt ofoutputType
- - the output type in which to render the content, @see RenderContextOutputTypeconfig
- - a parameter object that allows the content of the excerpt to be customized. @see ExcerptConfig
- Returns:
- a html excerpt of the content entity object
- Throws:
Exception
- - if an excerpt could not be created for this ContentEntityObject
XMLStreamException
com.atlassian.plugin.web.renderer.RendererException
extractImageSrc
List<String> extractImageSrc(String contentHtml,
int numImages)
throws XMLStreamException
- Throws:
XMLStreamException
extractImageThumbnailUris
List<URI> extractImageThumbnailUris(ContentEntityObject contentEntity,
int maxUris)
throws XhtmlException
- Returns the URIs of thumbnails for each of the images attached to the specified content entity.
URIs are returned in order that the images appear in the document. Obviously only URIs for thumbnailable images will be returned.
- Parameters:
contentEntity
- the content entitymaxUris
- the maximum URI's to return
- Returns:
- ordered list of thumbnails URIs
- Throws:
XhtmlException
- if there is an error parsing the contents for image references.
extractImageSrc
List<DataSource> extractImageSrc(ContentEntityObject ceo,
int numImages)
throws XMLStreamException,
XhtmlException
- Throws:
XMLStreamException
XhtmlException
extractImageSrc
List<DataSource> extractImageSrc(ContentEntityObject ceo,
int numImages,
boolean useThumbnails)
throws XMLStreamException,
XhtmlException
- Throws:
XMLStreamException
XhtmlException
Copyright © 2003-2013 Atlassian. All Rights Reserved.