org.eclipse.lemminx.services.format

Class XMLFormatterDocumentNew

java.lang.Object

org.eclipse.lemminx.services.format.XMLFormatterDocumentNew

public class XMLFormatterDocumentNew
extends Object

Experimental XML formatter which generates several text edit to remove, add, update spaces / indent.

Author:

Angelo ZERR

Constructor Summary

Constructors

Constructor and Description
XMLFormatterDocumentNew(DOMDocument xmlDocument, org.eclipse.lsp4j.Range range, SharedSettings sharedSettings, Collection<IFormatterParticipant> formatterParticipants) XML formatter document.

Method Summary

Modifier and Type	Method and Description
List<? extends org.eclipse.lsp4j.TextEdit>	format() Returns a List containing multiple TextEdit, containing the newly formatted changes of an XML document.
List<? extends org.eclipse.lsp4j.TextEdit>	format(DOMDocument document, int start, int end)
void	formatChildren(DOMNode currentDOMNode, XMLFormattingConstraints parentConstraints, int start, int end, List<org.eclipse.lsp4j.TextEdit> edits)
FormatElementCategory	getFormatElementCategory(DOMElement element, XMLFormattingConstraints parentConstraints) Returns the format element category of the given DOM element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLFormatterDocumentNew

public XMLFormatterDocumentNew(DOMDocument xmlDocument,
                               org.eclipse.lsp4j.Range range,
                               SharedSettings sharedSettings,
                               Collection<IFormatterParticipant> formatterParticipants)

XML formatter document.

Method Detail

format

public List<? extends org.eclipse.lsp4j.TextEdit> format()
                                                  throws BadLocationException

Returns a List containing multiple TextEdit, containing the newly formatted changes of an XML document.

Returns:

List containing multiple TextEdit of an XML document.

Throws:

BadLocationException

format

public List<? extends org.eclipse.lsp4j.TextEdit> format(DOMDocument document,
                                                         int start,
                                                         int end)

formatChildren

public void formatChildren(DOMNode currentDOMNode,
                           XMLFormattingConstraints parentConstraints,
                           int start,
                           int end,
                           List<org.eclipse.lsp4j.TextEdit> edits)

getFormatElementCategory

public FormatElementCategory getFormatElementCategory(DOMElement element,
                                                      XMLFormattingConstraints parentConstraints)

Returns the format element category of the given DOM element.

Parameters:

element - the DOM element.

parentConstraints - the parent constraints.

Returns:

the format element category of the given DOM element.