Deprecated API

Contents

• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Fields

Field and Description
com.atlassian.renderer.RenderedContentStore.BLOCK_TOKEN use TokenType#BLOCK#getTokenMarker()
com.atlassian.renderer.v2.components.TokenRendererComponent.BLOCK_TOKEN_PATTERN_STR since Renderer 6.0 use TokenType#BLOCK#getTokenPatternString
com.atlassian.renderer.RenderedContentStore.INLINE_TOKEN use TokenType#INLINE#getTokenMarker()
com.atlassian.renderer.v2.components.TokenRendererComponent.INLINE_TOKEN_PATTERN_STR since Renderer 6.0 use TokenType#INLINE#getTokenPatternString
com.atlassian.renderer.wysiwyg.WysiwygMacroHelper.MACRO_PADDING_CLASS use DefaultWysiwygConverter#PADDING_CLASS
com.atlassian.renderer.v2.macro.Macro.RAW_PARAMS_KEY since 4.0. This is an old radeox concept. Please discontinue use.
com.atlassian.renderer.wysiwyg.converter.DefaultWysiwygConverter.TEXT_SEPERATOR use #TEXT_SEPARATOR

Deprecated Methods

Method and Description
com.atlassian.renderer.util.UrlUtil.buildNewRelativeUrl(HttpServletRequest, String, String) since 3.12 this is not used. Builds a URL with a new parameter, replacing any existing parameters with that name but maintaining all other parameters. For example /foo.html?name=fred&key=FLINT
com.atlassian.renderer.wysiwyg.WysiwygConverter.convertChildren(Node, Styles, ListContext, boolean, boolean, boolean, boolean, Node) Since 5.0. Use WysiwygConverter.convertChildren(NodeContext) instead.
com.atlassian.renderer.wysiwyg.converter.DefaultWysiwygConverter.convertChildren(Node, Styles, ListContext, boolean, boolean, boolean, boolean, Node) Since 5.0. Use DefaultWysiwygConverter.convertChildren(NodeContext) instead.
com.atlassian.renderer.v2.components.HtmlEscapeRendererComponent.escapeHtml(String, boolean) since 3.12 see HtmlEscaper.escapeAllExceptQuotes(String, boolean)
com.atlassian.renderer.util.UrlUtil.escapeSpecialCharacters(String) since 3.12 use HtmlEscaper.escapeAmpersands(String,boolean) passing 'true' to preserveExistingEntities.
com.atlassian.renderer.wysiwyg.WysiwygConverter.getAttribute(Node, String) As of release 4.1, use NodeUtil.getAttribute(org.w3c.dom.Node, String).
com.atlassian.renderer.wysiwyg.converter.DefaultWysiwygConverter.getAttribute(Node, String) As of release 4.1, use NodeUtil.getAttribute(org.w3c.dom.Node, String).
com.atlassian.renderer.RenderContext.getCharacterEncoding() use GeneralUtil.getCharacterEncoding().
com.atlassian.renderer.RenderContext.getImagePath() use contextPathHolder.getContextPath() + "/images". Get the URL path to the image directory for this rendering. The path to images may be different depending on the context of the rendering: for example, an HTML export will have images in a different place to the online website.
com.atlassian.renderer.wysiwyg.converter.DefaultWysiwygConverter.getMacroInfoHtml(RenderContext, String, int, int) This method seems unused in renderer and will probably be removed in a future version.
com.atlassian.renderer.wysiwyg.converter.DefaultWysiwygConverter.getSep(Node, String, boolean, boolean) Since 5.0. Use DefaultWysiwygConverter.getSeparator(String, NodeContext) instead. This method is quite broken in 6.0 since it does not respect NodeContext.isInHeading().
com.atlassian.renderer.RenderContext.getSiteRoot() use contextPathHolder.getContextPath(). Get the root URL of the site on which the rendering is occurring
com.atlassian.renderer.v2.macro.BaseMacro.isInline() override BaseMacro.getTokenType(java.util.Map, java.lang.String, com.atlassian.renderer.RenderContext) to indicate inline or strict block behaviour. However, for macros to be backwardly compatible they will still need to implement BaseMacro.isInline() too.
com.atlassian.renderer.v2.macro.Macro.isInline() since Renderer 6 (Confluence 3.1) use Macro.getTokenType(java.util.Map, java.lang.String, com.atlassian.renderer.RenderContext) instead, which will by default call this method. However, for macros to be backwardly compatible they will still need to implement Macro.isInline() too.
com.atlassian.renderer.v2.macro.basic.AbstractPanelMacro.writeHeader(RenderContext, StringBuffer, String, String, String, int, String) since 3.5 - use method that takes a titleColor param

Deprecated Constructors

Constructor and Description
com.atlassian.renderer.wysiwyg.NodeContext(Node, Node, Styles, ListContext, boolean, boolean, boolean, boolean) Since 6.0 use NodeContext#Builder to build NodeContexts instead. This constructor does not allow setting the NodeContext.inHeading.