Interface IBslModuleEventsLookup

All Known Implementing Classes:
BslModuleEventsLookup

public interface IBslModuleEventsLookup
Performs BSL module event handlers lookup and creation.
  • Method Summary

    Modifier and Type
    Method
    Description
    createHandlerInForm(org.eclipse.xtext.ui.editor.model.IXtextDocument document, org.eclipse.jface.text.ITextViewer viewer, String currentHandlerName, org.eclipse.emf.ecore.EObject eventOwner, Event event, EventItemType itemType, ProcedureParameters procedureParameters)
    Creates handlers for event from Form (called from property sheet).
    createInsertContentProposals(org.eclipse.xtext.ui.editor.model.IXtextDocument document, Event event, ParamSet set, ProcedureParameters procedureParameters, String eventName, boolean isMainItem, boolean isCommandHandler, int offset, boolean isRussian)
    Creates insert content assist proposals.
    org.eclipse.xtext.util.Pair<org.eclipse.jface.text.ITextSelection,Object>
    findHandlerInForm(org.eclipse.xtext.ui.editor.model.IXtextDocument document, String currentHandlerName)
    Finds method by name in form bsl module by handler name from property sheet.
    int
    getPositionOfInsertionEvent(org.eclipse.xtext.ui.editor.model.IXtextDocument document, int offset)
    Defines offset of the inserting Event
    getValidName(org.eclipse.xtext.ui.editor.model.IXtextDocument doc, String methodNamePrefix)
    Deprecated.
    due to naming changes
  • Method Details

    • findHandlerInForm

      org.eclipse.xtext.util.Pair<org.eclipse.jface.text.ITextSelection,Object> findHandlerInForm(org.eclipse.xtext.ui.editor.model.IXtextDocument document, String currentHandlerName)
      Finds method by name in form bsl module by handler name from property sheet.
      Parameters:
      document - actual IXtextDocument, can't be null
      currentHandlerName - searching handler's name, can't be null
      Returns:
      pair, never null, which contains
      • actual selection of the found handler, or empty selection if handler wasn't found
      • resource lock of document, can be null
    • getPositionOfInsertionEvent

      int getPositionOfInsertionEvent(org.eclipse.xtext.ui.editor.model.IXtextDocument document, int offset)
      Defines offset of the inserting Event
      Parameters:
      document - actual IXtextDocument, can't be null
      offset - current cursor offset
      Returns:
      offset of the inserting Event
    • getValidName

      @Deprecated String getValidName(org.eclipse.xtext.ui.editor.model.IXtextDocument doc, String methodNamePrefix)
      Deprecated.
      due to naming changes
      Returns unique method name for Bsl module.
      Parameters:
      doc - actual IXtextDocument, can't be null
      methodNamePrefix - prefix of method name, can't be null
      Returns:
      unique method name for Bsl module, never null
    • createHandlerInForm

      EventHandlerInformation createHandlerInForm(org.eclipse.xtext.ui.editor.model.IXtextDocument document, org.eclipse.jface.text.ITextViewer viewer, String currentHandlerName, org.eclipse.emf.ecore.EObject eventOwner, Event event, EventItemType itemType, ProcedureParameters procedureParameters)
      Creates handlers for event from Form (called from property sheet).
      Parameters:
      document - actual IXtextDocument, can't be null
      viewer - actual ITextViewer, can't be null
      currentHandlerName - searching handler's name, can't be null
      eventOwner - handle event owner, can't be null
      event - handle events, can't be null
      itemType - current EventItemType, cannot be null
      procedureParameters - ProcedureParameters for chosen event, can't be null
      Returns:
      EventHandlerInformation, can't be null
    • createInsertContentProposals

      String createInsertContentProposals(org.eclipse.xtext.ui.editor.model.IXtextDocument document, Event event, ParamSet set, ProcedureParameters procedureParameters, String eventName, boolean isMainItem, boolean isCommandHandler, int offset, boolean isRussian)
      Creates insert content assist proposals.
      Parameters:
      document - actual IXtextDocument, can't be null
      event - handle events, can't be null
      set - param set, can't be null
      procedureParameters - ProcedureParameters can't be null
      eventName - event name, can't be null
      isMainItem - true if event from main item of form, false otherwise
      isCommandHandler - true if event from command of form, false otherwise
      offset - current cursor offset
      isRussian - whether current script variant is russian
      Returns:
      insert content assist proposals, never null