Class EclipseJavascriptFormatterService
java.lang.Object
de.funfried.netbeans.plugins.external.formatter.javascript.base.AbstractJavascriptFormatterService
de.funfried.netbeans.plugins.external.formatter.javascript.eclipse.EclipseJavascriptFormatterService
- All Implemented Interfaces:
FormatterService
Eclipse implementation of the
AbstractJavascriptFormatterService
.- Author:
- bahlef
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreateOptionsPanel
(Project project) Creates and returns theFormatterOptionsPanel
for this formatter which will be displayed in the overall options dialog underneath this formatters selection.getContinuationIndentSize
(Document document) Returns the continuation indent size configured for the givenDocument
, ornull
if it should not affect the editor behavior.Retruns the display name of this formatter implementation.protected FormatJob
getFormatJob
(StyledDocument document, Pair<Integer, Integer> changedElement) Returns theFormatJob
.getId()
Retruns the unique identifier of this formatter implementation.getIndentSize
(Document document) Returns the indent size configured for the givenDocument
, ornull
if it should not affect the editor behavior.getRightMargin
(Document document) Returns the right margin (position of the red line in the editor) configured for the givenDocument
, ornull
if it should not affect the editor behavior.getSpacesPerTab
(Document document) Returns the spaces per tab configured for the givenDocument
, ornull
if it should not affect the editor behavior.isExpandTabToSpaces
(Document document) Returns the expand tab to spaces flag configured for the givenDocument
, ornull
if it should not affect the editor behavior.organizeImports
(StyledDocument document, boolean afterFixImports) Organizes the imports of the givenStyledDocument
.Methods inherited from class de.funfried.netbeans.plugins.external.formatter.javascript.base.AbstractJavascriptFormatterService
format, getSupportedMimeTypes
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface de.funfried.netbeans.plugins.external.formatter.FormatterService
canHandle
-
Field Details
-
ID
The ID of this formatter service.- See Also:
-
-
Constructor Details
-
EclipseJavascriptFormatterService
public EclipseJavascriptFormatterService()
-
-
Method Details
-
getDisplayName
Retruns the display name of this formatter implementation.- Returns:
- the display name of this formatter implementation
-
getId
Retruns the unique identifier of this formatter implementation.- Returns:
- the unique identifier of this formatter implementation
-
createOptionsPanel
Creates and returns theFormatterOptionsPanel
for this formatter which will be displayed in the overall options dialog underneath this formatters selection.- Parameters:
project
- theProject
if the panel which is created is used to modify project specific settings, otherwisenull
- Returns:
- the
FormatterOptionsPanel
for this formatter, ornull
if there are no options a user could make for this formatter
-
getContinuationIndentSize
Returns the continuation indent size configured for the givenDocument
, ornull
if it should not affect the editor behavior. -
getIndentSize
Returns the indent size configured for the givenDocument
, ornull
if it should not affect the editor behavior. -
getRightMargin
Returns the right margin (position of the red line in the editor) configured for the givenDocument
, ornull
if it should not affect the editor behavior. -
getFormatJob
Returns theFormatJob
.- Specified by:
getFormatJob
in classAbstractJavascriptFormatterService
- Parameters:
document
- theStyledDocument
which should be formattedchangedElement
- an optional range as aPair
object defining the offsets which should be formatted
-
getSpacesPerTab
Returns the spaces per tab configured for the givenDocument
, ornull
if it should not affect the editor behavior. -
isExpandTabToSpaces
Returns the expand tab to spaces flag configured for the givenDocument
, ornull
if it should not affect the editor behavior. -
organizeImports
@CheckForNull public Boolean organizeImports(StyledDocument document, boolean afterFixImports) throws BadLocationException Organizes the imports of the givenStyledDocument
.- Parameters:
document
- theStyledDocument
afterFixImports
-true
if this method was called after fixing imports, otherwisefalse
- Returns:
true
if the imports have been reorganized, if something went wrong it will returnfalse
, if it wasn't executed, e.g. because it is not activated through its configuration, it will returnnull
- Throws:
BadLocationException
- if something goes wrong while applying the reorganized imports code
-