Interface IBslModuleTextInsertInfo


public interface IBslModuleTextInsertInfo
Built-in language module information for inserting text into the module;
Implementation(s) additionally can provide information for content wrapping.
  • Method Summary

    Modifier and Type
    Method
    Description
    default int
    Returns text clear length in module or 0 if no clear needed
    getDefaultModuleTextInsertInfo(org.eclipse.xtext.ui.editor.model.IXtextDocument document, int defaultPosition)
    Gets module text insert information by provided document and default position
    int
    Returns insertion position in module;
    If needed clearing before insertion, insertion position equals clear position
    org.eclipse.emf.common.util.URI
    Returns current module or document resource URI
  • Method Details

    • getPosition

      int getPosition()
      Returns insertion position in module;
      If needed clearing before insertion, insertion position equals clear position
      Returns:
      int insertion offset, cannot be negative
    • getResourceURI

      org.eclipse.emf.common.util.URI getResourceURI()
      Returns current module or document resource URI
      Returns:
      URI, cannot be null
    • getClearLength

      default int getClearLength()
      Returns text clear length in module or 0 if no clear needed
      Returns:
      int clear length, cannot be negative
    • getDefaultModuleTextInsertInfo

      static IBslModuleTextInsertInfo getDefaultModuleTextInsertInfo(org.eclipse.xtext.ui.editor.model.IXtextDocument document, int defaultPosition)
      Gets module text insert information by provided document and default position
      Parameters:
      document - target IXtextDocument, cannot be null
      defaultPosition - default position for insertion into IXtextDocument
      Returns:
      implemented IBslModuleTextInsertInfo with text insert information