Package com.atlassian.confluence.content.render.xhtml

Interface Summary

Interface	Description
ConversionContext
ElementIdCreator	Implemented by a class that can create id's for Elements suitable for use in the context of a particular ConversionContext.
ElementTransformer	An interface implemented by an object that will handle a StartElement or EndElement and transform it in some manner.
FormatConverter	Provides a convenient service for transforming to and from the storage format into the editor and view formats.
HtmlToXmlConverter	Convert a String supplied in HTML to well formed XML that can be handled by an XML parser.
LinkRenderer	Allows links to content to be rendered without exposing our marshalling architecture.
Marshaller<T>	Responsible for marshalling an XML fragment.
MarshallingFactory<T>	An interface describing a factory capable of returning a Marshaller or Unmarshaller suitable for particular usages.
MarshallingRegistry	Gets Marshallers and Unmarshallers, so you don't have to wire them yaself.
RenderedContentCleaner	Responsible for cleaning supplied HTML content into a form that is balanced and free of any insecure markup.
Renderer	Render from Confluence storage format to XHTML for viewing or editing.
RenderingEventPublisher	Publishes events related to the rendering process.
StaxStreamMarshaller<T>	Marshals the specified object to a StAX stream.
StorageFormatCleaner	Responsible for cleaning supplied XML content into a form that is balanced and free of any insecure markup.
Streamable	Represents some data that may be streamed out to a writer.
TransformationDateFormats	A class that provides DateFormats used to format and parse dates when transforming between Confluence formats (such as editor and storage formats).
Unmarshaller<T>	Responsible for unmarshalling an XML fragment.
XhtmlCleaner	Deprecated. since 5.1.4 See StorageFormatCleaner and RenderedContentCleaner instead.
XmlEntityExpander
XMLEventFactoryProvider	This exists to provide a 'safe' way to access {@see XMLEventFactory}, without it there may be weird classloader issues.
XmlEventReaderFactory	Factory to create event readers over different types of Confluence XML (namely editor and storage XML).
XmlOutputFactory	This was introduced mainly because XMLOutputFactory is an abstract class :(
XmlOutputFactoryProvider	An interface for the XmlOutputFactoryProvider.
XmlStreamWriterCallback
XmlStreamWriterTemplate

Class Summary

Class	Description
BatchedRenderRequest	A request to render one or more storage-fragment strings with a given ConversionContext.
ConfluenceXMLEventWriter	This "Confluence" implementation of XMLEventWriter was introduced primarily to deal with STAX-58.
ConfluenceXmlOutputFactory	This "Confluence" implementation of XmlOutputFactory was introduced primarily to deal with STAX-58.
ContentExcerptUtils	Defines common functions that obtain excerpts of content (e.g.
ConversionContextOutputDeviceType
ConversionContextPropertyName	The set of property names used to access ConversionContext properties.
DefaultConversionContext	A non-thread safe implementation of the ConversionContext suitable for use in the single threaded XHTML output process.
DefaultEditorFormatService
DefaultFormatConverter
DefaultHtmlToXmlConverter
DefaultLinkRenderer
DefaultMarshallingRegistry
DefaultRenderer	Implementation outputting XHTML suitable for display in browsers.
DefaultStorageFormatService	Deprecated, for removal: This API element is subject to removal in a future version. since 8.6
DefaultXhtmlContent
DefaultXmlEntityExpander
DefaultXMLEventFactoryProvider
DefaultXmlEventReaderFactory
DefaultXmlOutputFactoryProvider	Default implementation of the XmlOutputFactoryProvider interface.
DefaultXmlStreamWriterTemplate	Encapsulates the boiler plate around creating a stream writer.
DelegateXmlOutputFactory	This class acts as an adapter between the StAX XMLOutputFactory abstract class and the Confluence XmlOutputFactory interface.
DelegatingLinkMarshaller
DeviceTypeAwareRenderer	A renderer which is aware of the registration of DeviceTypeRendererComponentModuleDescriptor within the system and will keep track of these modules.
DummyRenderingEventPublisher	Dummy implementation of RenderingEventPublisher
ElementTransformingXmlEventReader	An XMLEventReader that can be configured with multiple ElementTransformers potentially changing the start and end elements returned by the reader.
EmbeddedImageConstants
ForwardingXmlEventReader	Class delegates all calls to an {code}XMLEventReader{code} passed to the constructor.
HtmlElementIdCreator	A non-thread safe class used to create HTML ids within a render 'context'.
IllegalAttributeFilter	Removes illegal XML attributes.
ImageAttributeParser	A class encapsulating the commonality in parsing the attributes on an img or ac:image tag.
ImageAttributeWriter	A class encapsulating the commonality in marshalling the attributes for an image in view, edit and storage.
JsonUtils
MarshallingFragmentTransformer<T>	Lazily resolves the marshaller and unmarshaller to use for transforming objects of the specified type.
Namespace	Represents an XML namespace.
PluggableTransformerChain	A Transformer which passes the input through a series of other transformers provided by enabled plugins' TransformerModuleDescriptors, in addition to a set of defaults transformers.
PolicyConfiguredCleaner	A thread safe xhtml/html/xml Cleaner which is configured via a policy file classpath resource.
ResettableXmlEventReader	Not thread-safe.
StaxUtils
StorageFormatCleaner.AppliedRuleDescription	A description of a rule that was applied during the cleaning of content.
StorageFormatCleaner.Result	The complete results of a clean up operation.
Streamables	Convenience class for common operations to construct or convert Streamable instances.
TextExtractingXmlFragmentEventReader	Class wraps another {code}XmlEventReader{code} to extract text from the XML that has been read.
ThreadLocalTransformationDateFormats	Serves date formats from thread local storage to avoid synchronisation.
TransformerChain	Takes an ordered list of transfomers and runs each of them serially, passing the transformation output of one transformer as input into the next.
TransformerWeight
UnmarshalMarshalFragmentTransformer<T>	A FragmentTransformer that transforms by unmarshalling and then re-marshalling the fragment.
XhtmlCleaner.AppliedRuleDescription	Deprecated. since 5.1.4 See StorageFormatCleaner instead.
XhtmlCleaner.Result	Deprecated. since 5.1.4 See StorageFormatCleaner instead.
XhtmlConstants
XhtmlConstants.Attribute
XhtmlFragmentTimeoutEvent	An event sent when a XhtmlTimeoutException occurs when rendering a fragment.
XhtmlMacroTimeoutEvent	An event sent when a XhtmlTimeoutException occurs when rendering a Macro.
XmlAttributeEncodingFilter	A Cyberneko filter to cope with a common mistake made by plugin developers in Confluence.
XmlFragmentBodyEventReader	Exposes the events of the body of a fragment, but does not include any events for the start and end tags of the fragment.
XmlFragmentEventReader	Exposes the events of the body of a fragment including the start and end element of the fragment.
XmlOutputFactoryFactoryBean	Deprecated. since 7.20 See ConfluenceXmlOutputFactory

Enum Summary

Enum	Description
ConversionContextOutputType	XHTML Successor to RenderContextOutputType.
MacroBodyType	Represents a macro body type used in macro transformation.
MarshallingType	The type of a Marshaller or Unmarshaller.

Exception Summary

Exception	Description
XhtmlException
XhtmlParsingException
XhtmlTimeoutException	A checked exception indicating that an Xhtml Conversion has exceeded its allocated time limit.