Package com._1c.g5.v8.dt.bsl.ui.contentassist

Class ParametersHoverInfoControl

java.lang.Object
com._1c.g5.v8.dt.bsl.ui.contentassist.ParametersHoverInfoControl
public class ParametersHoverInfoControl extends Object
Class provides methods for creating and showing browser control for hover information about parameters of methods and constructors in Bsl language

  • Field Details

    • WIDTH_IN_CHAR

      public static final int WIDTH_IN_CHAR
      Default width in char of infoControl
      See Also:

    • HEIGHT_IN_CHAR

      public static final int HEIGHT_IN_CHAR
      Default height in char of infoControl
      See Also:

    • BSL_FONT

      public static final String BSL_FONT
      Default font for infoControl
      See Also:

  • Constructor Details

    • ParametersHoverInfoControl

      public ParametersHoverInfoControl(org.eclipse.jface.text.ITextViewer textViewer, BslDocumentationProvider documentationProvider, SyntaxAssistLanguageProvider languageProvider, org.eclipse.ui.services.IServiceLocator serviceLocator)
      Constructor.
      Parameters:
      textViewer - a text viewer for what control is creating. Never null. Should not be disposed
      documentationProvider - a documentation provider for hyperlink resolving, can't be null
      languageProvider - syntax assistant language provider. Never null
      serviceLocator - service locator. Never null

  • Method Details

    • getControl

      public org.eclipse.jface.text.AbstractInformationControl getControl()
      Gets active AbstractInformationControl
      Returns:
      active AbstractInformationControl, can be null if control hasn't been initialized yet

    • dispose

      public void dispose()
      Disposes informational control

    • showPrevIndex

      public void showPrevIndex()
      Shows previous parameter if available in browser

    • showNextIndex

      public void showNextIndex()
      Shows next parameter if available in browser

    • addDisposeListener

      public void addDisposeListener(org.eclipse.swt.events.DisposeListener disposeListener)
      Adds dispose listener.
      Parameters:
      disposeListener - dispose listener to add. Never null

    • removeDisposeListener

      public void removeDisposeListener(org.eclipse.swt.events.DisposeListener disposeListener)
      Removes dispose listener.
      Parameters:
      disposeListener - dispose listener to remove. Never null

    • showToggleDescr

      public void showToggleDescr()
      Shows or hides parameter description in browser

    • showPage

      public void showPage(List<IBslDocumentationContentAssistPage> pages, int subPageIndex, int paramIndex)
      Shows page in the informational control.
      Parameters:
      pages - subpage list. Never null and all elements are never null. Shold be non empty
      subPageIndex - subpage index. Should be >= 0 and < pages size
      paramIndex - index of the parameter. May be < or >= then subpage parameters count, then no parameter will be selected