Class/Object

scalariform.formatter

ScalaFormatter

Related Docs: object ScalaFormatter | package formatter

Permalink

abstract class ScalaFormatter extends HasFormattingPreferences with TypeFormatter with AnnotationFormatter with ExprFormatter with HasHiddenTokenInfo with TemplateFormatter with XmlFormatter with CaseClauseFormatter with CommentFormatter

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaFormatter
  2. CommentFormatter
  3. CaseClauseFormatter
  4. XmlFormatter
  5. TemplateFormatter
  6. HasHiddenTokenInfo
  7. ExprFormatter
  8. AnnotationFormatter
  9. TypeFormatter
  10. HasFormattingPreferences
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaFormatter()

    Permalink

Type Members

  1. class StringBuilderExtra extends AnyRef

    Permalink

Abstract Value Members

  1. abstract val formattingPreferences: IFormattingPreferences

    Permalink
    Definition Classes
    HasFormattingPreferences
  2. abstract def hiddenPredecessors(token: Token): HiddenTokens

    Permalink
    Definition Classes
    HasHiddenTokenInfo
  3. abstract def inferredNewlines(token: Token): HiddenTokens

    Permalink
    Definition Classes
    HasHiddenTokenInfo
  4. abstract def isInferredNewline(token: Token): Boolean

    Permalink
    Definition Classes
    HasHiddenTokenInfo
  5. abstract val newlineSequence: String

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def alignArguments(parenArguments: ParenArgumentExprs)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Attributes
    protected
    Definition Classes
    ExprFormatter
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def calculateEqualsExprIdLength(equalsExpr: EqualsExpr): Int

    Permalink
    Definition Classes
    ExprFormatter
  7. def calculateParamSectionLengths(param: Param, first: Boolean)(implicit formatterState: FormatterState): Option[ParamSectionLengths]

    Permalink
    Attributes
    protected
    Definition Classes
    ExprFormatter
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def containsNewline(astNode: AstNode): Boolean

    Permalink
    Attributes
    protected
  10. def containsNewline(tokens: List[Token]): Boolean

    Permalink
    Attributes
    protected
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def format(compilationUnit: CompilationUnit)(implicit formatterState: FormatterState = FormatterState()): FormatResult

    Permalink
  15. def format(caseClausesAstNode: CaseClauses)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    CaseClauseFormatter
  16. def format(contents: List[XmlContents])(formatterState: FormatterState, nestedFormatterState: FormatterState): (FormatResult, Boolean)

    Permalink

    returns

    format result and whether the contents span multiple lines

    Definition Classes
    XmlFormatter
  17. def format(xmlNonEmpty: XmlNonEmptyElement)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    XmlFormatter
  18. def format(xmlAttribute: XmlAttribute)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    XmlFormatter
  19. def format(xmlEnd: XmlEndTag)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    XmlFormatter
  20. def format(xmlStart: XmlStartTag)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    XmlFormatter
  21. def format(xmlEmpty: XmlEmptyElement)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    XmlFormatter
  22. def format(xmlContent: XmlContents)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    XmlFormatter
  23. def format(xmlExpr: XmlExpr)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    XmlFormatter
  24. def format(template: Template)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    TemplateFormatter
  25. def format(tmplDef: TmplDef)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    TemplateFormatter
  26. def format(import_: ImportClause)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Attributes
    protected
    Definition Classes
    ExprFormatter
  27. def format(funDefOrDcl: FunDefOrDcl)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    ExprFormatter
  28. def format(fullDefOrDcl: FullDefOrDcl)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    ExprFormatter
  29. def format(packageBlock: PackageBlock)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    ExprFormatter
  30. def format(statSeq: StatSeq)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    ExprFormatter
  31. def format(blockExpr: BlockExpr, indent: Boolean)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    ExprFormatter
  32. def format(guard: Guard)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    ExprFormatter
  33. def format(argumentExprs: ArgumentExprs)(implicit formatterState: FormatterState): (FormatResult, FormatterState)

    Permalink
    Definition Classes
    ExprFormatter
  34. def format(anonymousFunction: AnonymousFunction)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    ExprFormatter
  35. def format(expr: Expr)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    ExprFormatter
  36. def format(annotation: Annotation)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    AnnotationFormatter
  37. def format(typeElements: List[TypeElement])(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    TypeFormatter
  38. def format(type_: Type)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    TypeFormatter
  39. def formatNonScaladocComment(comment: HiddenToken, indentLevel: Int): String

    Permalink

    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
  40. def formatParamClauses(paramClauses: ParamClauses, doubleIndentParams: Boolean = false)(implicit formatterState: FormatterState): FormatResult

    Permalink
    Definition Classes
    ExprFormatter
  41. def formatScaladocComment(comment: HiddenToken, indentLevel: Int): String

    Permalink
    Definition Classes
    CommentFormatter
  42. def formattedAstNode(ast: AstNode)(astFormatResult: ⇒ FormatResult): String

    Permalink

    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
  43. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  44. def getSource(astNode: AstNode): String

    Permalink
  45. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  46. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  47. def lastStat(statSeq: StatSeq): Option[(Token, Option[Stat])]

    Permalink

    returns

    the last stat of a block which may be wrapped inside of an anonymous function definition

    Definition Classes
    CaseClauseFormatter
  48. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  49. def newlineBefore(node: AstNode): Boolean

    Permalink
    Definition Classes
    HasHiddenTokenInfo
  50. def newlineBefore(token: Token): Boolean

    Permalink
    Definition Classes
    HasHiddenTokenInfo
  51. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  52. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  53. implicit def stringBuilder2stringBuilderExtra(builder: StringBuilder): StringBuilderExtra

    Permalink
  54. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  55. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  56. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. def writeTokens(s: String, tokens: List[Token], formatResult: FormatResult, offset: Int = 0): List[TextEdit]

    Permalink

Inherited from CommentFormatter

Inherited from CaseClauseFormatter

Inherited from XmlFormatter

Inherited from TemplateFormatter

Inherited from HasHiddenTokenInfo

Inherited from ExprFormatter

Inherited from AnnotationFormatter

Inherited from TypeFormatter

Inherited from HasFormattingPreferences

Inherited from AnyRef

Inherited from Any

Ungrouped