abstract class ScalaFormatter extends HasFormattingPreferences with TypeFormatter with AnnotationFormatter with ExprFormatter with HasHiddenTokenInfo with TemplateFormatter with XmlFormatter with CaseClauseFormatter with CommentFormatter
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- ScalaFormatter
- CommentFormatter
- CaseClauseFormatter
- XmlFormatter
- TemplateFormatter
- HasHiddenTokenInfo
- ExprFormatter
- AnnotationFormatter
- TypeFormatter
- HasFormattingPreferences
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
- new ScalaFormatter()
Type Members
- class StringBuilderExtra extends AnyRef
Abstract Value Members
-
abstract
val
formattingPreferences: IFormattingPreferences
- Definition Classes
- HasFormattingPreferences
-
abstract
def
hiddenPredecessors(token: Token): HiddenTokens
- Definition Classes
- HasHiddenTokenInfo
-
abstract
def
inferredNewlines(token: Token): HiddenTokens
- Definition Classes
- HasHiddenTokenInfo
-
abstract
def
isInferredNewline(token: Token): Boolean
- Definition Classes
- HasHiddenTokenInfo
- abstract val newlineSequence: String
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
alignArguments(parenArguments: ParenArgumentExprs)(implicit formatterState: FormatterState): FormatResult
- Attributes
- protected
- Definition Classes
- ExprFormatter
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
calculateEqualsExprIdLength(equalsExpr: EqualsExpr): Int
- Definition Classes
- ExprFormatter
-
def
calculateParamSectionLengths(param: Param, first: Boolean)(implicit formatterState: FormatterState): Option[ParamSectionLengths]
- Attributes
- protected
- Definition Classes
- ExprFormatter
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
containsNewline(astNode: AstNode): Boolean
- Attributes
- protected
-
def
containsNewline(tokens: List[Token]): Boolean
- Attributes
- protected
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def format(compilationUnit: CompilationUnit)(implicit formatterState: FormatterState = FormatterState()): FormatResult
-
def
format(caseClausesAstNode: CaseClauses)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- CaseClauseFormatter
-
def
format(contents: List[XmlContents])(formatterState: FormatterState, nestedFormatterState: FormatterState): (FormatResult, Boolean)
- returns
format result and whether the contents span multiple lines
- Definition Classes
- XmlFormatter
-
def
format(xmlNonEmpty: XmlNonEmptyElement)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- XmlFormatter
-
def
format(xmlAttribute: XmlAttribute)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- XmlFormatter
-
def
format(xmlEnd: XmlEndTag)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- XmlFormatter
-
def
format(xmlStart: XmlStartTag)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- XmlFormatter
-
def
format(xmlEmpty: XmlEmptyElement)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- XmlFormatter
-
def
format(xmlContent: XmlContents)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- XmlFormatter
-
def
format(xmlExpr: XmlExpr)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- XmlFormatter
-
def
format(template: Template)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- TemplateFormatter
-
def
format(tmplDef: TmplDef)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- TemplateFormatter
-
def
format(import_: ImportClause)(implicit formatterState: FormatterState): FormatResult
- Attributes
- protected
- Definition Classes
- ExprFormatter
-
def
format(funDefOrDcl: FunDefOrDcl)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- ExprFormatter
-
def
format(fullDefOrDcl: FullDefOrDcl)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- ExprFormatter
-
def
format(packageBlock: PackageBlock)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- ExprFormatter
-
def
format(statSeq: StatSeq)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- ExprFormatter
-
def
format(blockExpr: BlockExpr, indent: Boolean)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- ExprFormatter
-
def
format(guard: Guard)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- ExprFormatter
-
def
format(argumentExprs: ArgumentExprs)(implicit formatterState: FormatterState): (FormatResult, FormatterState)
- Definition Classes
- ExprFormatter
-
def
format(anonymousFunction: AnonymousFunction)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- ExprFormatter
-
def
format(expr: Expr)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- ExprFormatter
-
def
format(annotation: Annotation)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- AnnotationFormatter
-
def
format(typeElements: List[TypeElement])(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- TypeFormatter
-
def
format(type_: Type)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- TypeFormatter
-
def
formatNonScaladocComment(comment: HiddenToken, indentLevel: Int): String
Formats a non-Scaladoc comment by trimming trailing whitespace from each line.
Formats a non-Scaladoc comment by trimming trailing whitespace from each line.
- Definition Classes
- CommentFormatter
-
def
formatParamClauses(paramClauses: ParamClauses, doubleIndentParams: Boolean = false)(implicit formatterState: FormatterState): FormatResult
- Definition Classes
- ExprFormatter
-
def
formatScaladocComment(comment: HiddenToken, indentLevel: Int): String
- Definition Classes
- CommentFormatter
-
def
formattedAstNode(ast: AstNode)(astFormatResult: ⇒ FormatResult): String
Converts an AstNode into what it should look like in text after Scalariform has run.
Converts an AstNode into what it should look like in text after Scalariform has run. Useful for calculating the actual length of an scalariform.parser.AstNode after formatting.
- ast
The AST to format and render as a string
- astFormatResult
Should run formatting actions for 'ast'
- returns
Formatted string representation of what the AstNode should look like after Scalariform has run
- Attributes
- protected
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- def getSource(astNode: AstNode): String
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
lastStat(statSeq: StatSeq): Option[(Token, Option[Stat])]
- returns
the last stat of a block which may be wrapped inside of an anonymous function definition
- Definition Classes
- CaseClauseFormatter
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newlineBefore(node: AstNode): Boolean
- Definition Classes
- HasHiddenTokenInfo
-
def
newlineBefore(token: Token): Boolean
- Definition Classes
- HasHiddenTokenInfo
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- implicit def stringBuilder2stringBuilderExtra(builder: StringBuilder): StringBuilderExtra
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def writeTokens(s: String, tokens: List[Token], formatResult: FormatResult, offset: Int = 0): List[TextEdit]