Package com.intellij.psi.impl.source.codeStyle

Class FormatCommentsProcessor

java.lang.Object

com.intellij.psi.impl.source.codeStyle.FormatCommentsProcessor

All Implemented Interfaces:

PreFormatProcessor

public class FormatCommentsProcessor
extends java.lang.Object
implements PreFormatProcessor

Field Summary

Fields inherited from interface com.intellij.psi.impl.source.codeStyle.PreFormatProcessor

EP_NAME

Constructor Summary

Constructors

Constructor and Description
FormatCommentsProcessor()

Method Summary

Modifier and Type	Method and Description
TextRange	process(ASTNode element, TextRange range) Callback to be invoked before formatting.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.impl.source.codeStyle.PreFormatProcessor

changesWhitespacesOnly

Constructor Detail

FormatCommentsProcessor

public FormatCommentsProcessor()

Method Detail

process

public TextRange process(ASTNode element,
                         TextRange range)

Description copied from interface: PreFormatProcessor

Callback to be invoked before formatting. Implementation is allowed to do the following:

 

   

     return not given text range but adjusted one. E.g. we want to reformat a field at a java class but 
     have 'align field in columns' settings on. That's why the range should be expanded in order to
     cover all fields group;
   
   

     another use-case might be target PSI file/document modification (e.g. change words case). The only requirement here
     is that given element stays valid;
   
 
 

Note: the callback might expect to be called for every injected root at the target formatting context.

Specified by:

process in interface PreFormatProcessor

Parameters:

element - target element which contents can be adjusted if necessary

range - target range within the given element

Returns:

range recommended to use for further processing