Interface Folding

foldWidgets

getFoldWidget

getFoldWidgetRange

addFold

• addFold(placeholder, range?): Fold

• Adds a new fold. The new created Fold object or an existing fold object in case the passed in range fits an existing fold exactly.

  Parameters

  • placeholder: string | Fold

  • Optional range: Range

  Returns Fold

addFolds

• addFolds(folds): void

• Parameters

  • folds: Fold[]

  Returns void

expandFold

• expandFold(fold): void

• Parameters

  • fold: Fold

  Returns void

expandFolds

• expandFolds(folds): void

• Parameters

  • folds: Fold[]

  Returns void

foldAll

• foldAll(startRow?, endRow?, depth?, test?): void

• Parameters

  • Optional startRow: number

  • Optional endRow: number

  • Optional depth: number

  • Optional test: Function

  Returns void

foldAllComments

• foldAllComments(): void

• Returns void

foldToLevel

• foldToLevel(level): void

• Parameters

  • level: number

  Returns void

getAllFolds

• getAllFolds(): Fold[]

• Returns all folds in the document

  Returns Fold[]

getCommentFoldRange

• getCommentFoldRange(row, column, dir?): Range

• Parameters

  • row: number

  • column: number

  • Optional dir: number

  Returns Range

getDisplayLine

• getDisplayLine(row, endColumn, startRow, startColumn): string

• Parameters

  • row: number

  • endColumn: number

  • startRow: number

  • startColumn: number

  Returns string

getFoldAt

• getFoldAt(row, column, side?): Fold

• Looks up a fold at a given row/column. Possible values for side: -1: ignore a fold if fold.start = row/column +1: ignore a fold if fold.end = row/column

  Parameters

  • row: number

  • column: number

  • Optional side: number

  Returns Fold

getFoldDisplayLine

• getFoldDisplayLine(foldLine, endRow?, endColumn?, startRow?, startColumn?): string

• Parameters

  • foldLine: FoldLine

  • Optional endRow: number

  • Optional endColumn: number

  • Optional startRow: number

  • Optional startColumn: number

  Returns string

getFoldLine

• getFoldLine(docRow, startFoldLine?): FoldLine

• Parameters

  • docRow: number

  • Optional startFoldLine: FoldLine

  Returns FoldLine

getFoldStringAt

• getFoldStringAt(row, column, trim?, foldLine?): string

• Returns the string between folds at the given position. E.g. foob|arwolrd -> "bar" foobarwol|rd -> "world" foobar<fo|ld>wolrd ->

  where | means the position of row/column

  The trim option determs if the return string should be trimed according to the "side" passed with the trim value:

  E.g. foob|arwolrd -trim=-1> "b" foobarwol|rd -trim=+1> "rld" fo|obarwolrd -trim=00> "foo"

  Parameters

  • row: number

  • column: number

  • Optional trim: number

  • Optional foldLine: FoldLine

  Returns string

getFoldedRowCount

• getFoldedRowCount(first, last): number

• Parameters

  • first: number

  • last: number

  Returns number

getFoldsInRange

• getFoldsInRange(range): Fold[]

• Returns all folds in the given range. Note, that this will return folds

  Parameters

  • range: Range | Ace.Delta

  Returns Fold[]

getFoldsInRangeList

• getFoldsInRangeList(ranges): Fold[]

• Parameters

  • ranges: Range | Range[]

  Returns Fold[]

getNextFoldLine

• getNextFoldLine(docRow, startFoldLine?): FoldLine

• Returns the fold which starts after or contains docRow

  Parameters

  • docRow: number

  • Optional startFoldLine: FoldLine

  Returns FoldLine

getParentFoldRangeData

• getParentFoldRangeData(row, ignoreCurrent?): {
      firstRange?: Range;
      range?: Range;
  }

• Parameters

  • row: number

  • Optional ignoreCurrent: boolean

  Returns {
      firstRange?: Range;
      range?: Range;
  }

  • Optional firstRange?: Range

  • Optional range?: Range

getRowFoldEnd

• getRowFoldEnd(docRow, startFoldRow?): number

• Parameters

  • docRow: number

  • Optional startFoldRow: FoldLine

  Returns number

getRowFoldStart

• getRowFoldStart(docRow, startFoldRow?): number

• Parameters

  • docRow: number

  • Optional startFoldRow: FoldLine

  Returns number

isRowFolded

• isRowFolded(docRow, startFoldRow?): boolean

• Checks if a given documentRow is folded. This is true if there are some folded parts such that some parts of the line is still visible.

  Parameters

  • docRow: number

  • Optional startFoldRow: FoldLine

  Returns boolean

onFoldWidgetClick

• onFoldWidgetClick(row, e): void

• Parameters

  • row: number

  • e: any

  Returns void

removeFold

• removeFold(fold): void

• Parameters

  • fold: Fold

  Returns void

removeFolds

• removeFolds(folds): void

• Parameters

  • folds: Fold[]

  Returns void

setFoldStyle

• setFoldStyle(style): void

• Parameters

  • style: string

  Returns void

toggleFold

• toggleFold(tryToUnfold?): void

• Parameters

  • Optional tryToUnfold: boolean

  Returns void

toggleFoldWidget

• toggleFoldWidget(toggleParent?): void

• Parameters

  • Optional toggleParent: boolean

  Returns void

tokenizerUpdateFoldWidgets

• tokenizerUpdateFoldWidgets(e): void

• Parameters

  • e: any

  Returns void

unfold

• unfold(location?, expandInner?): Fold[]

• Parameters

  • Optional location: number | Range | Range[] | Ace.Point

  • Optional expandInner: boolean

  Returns Fold[]

updateFoldWidgets

• updateFoldWidgets(delta): void

• Parameters

  • delta: Ace.Delta

  Returns void