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 Summary
Fields Modifier and Type Field Description static String
BSL_FONT
Default font forinfoControl
static int
HEIGHT_IN_CHAR
Default height in char ofinfoControl
static int
WIDTH_IN_CHAR
Default width in char ofinfoControl
-
Constructor Summary
Constructors Constructor Description ParametersHoverInfoControl(BslDocumentationProvider documentation)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
dispose()
Disposes browser controlorg.eclipse.jface.text.AbstractInformationControl
getControl()
Gets active browserAbstractInformationControl
String
getInfoString(String returnTypeStr)
Returns content for browser which contains description of current parametervoid
initInfoControl(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Initializes browser for actualITextViewer
void
setInput(String info)
Sets browser's contentvoid
showControlInfo(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Shows browser controlvoid
showControlInfo(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr, List<org.eclipse.xtext.util.Pair<BslDocumentationProvider.DocumentContent.ParamContent,String>> params, Version version)
Shows browser controlvoid
showNextIndex(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Shows next parameter if available in browservoid
showPrevIndex(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Shows previous parameter if available in browservoid
showToggleDescr(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Shows or hides parameter description in browser
-
-
-
Field Detail
-
WIDTH_IN_CHAR
public static final int WIDTH_IN_CHAR
Default width in char ofinfoControl
- See Also:
- Constant Field Values
-
HEIGHT_IN_CHAR
public static final int HEIGHT_IN_CHAR
Default height in char ofinfoControl
- See Also:
- Constant Field Values
-
BSL_FONT
public static final String BSL_FONT
Default font forinfoControl
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ParametersHoverInfoControl
public ParametersHoverInfoControl(BslDocumentationProvider documentation)
Constructor- Parameters:
documentation
- actualBslDocumentationProvider
, can't benull
-
-
Method Detail
-
getControl
public org.eclipse.jface.text.AbstractInformationControl getControl()
Gets active browserAbstractInformationControl
- Returns:
- active browser
AbstractInformationControl
, can benull
if browser hasn't been initialized yet
-
dispose
public void dispose()
Disposes browser control
-
getInfoString
public String getInfoString(String returnTypeStr)
Returns content for browser which contains description of current parameter- Parameters:
returnTypeStr
- string of return types corresponding to method, can benull
- Returns:
- string content for browser, can be
null
-
initInfoControl
public void initInfoControl(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Initializes browser for actualITextViewer
- Parameters:
viewer
- actualITextViewer
, can't benull
returnTypeStr
- string of return types corresponding to method, can benull
-
showPrevIndex
public void showPrevIndex(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Shows previous parameter if available in browser- Parameters:
viewer
- actualITextViewer
, can't benull
returnTypeStr
- string of return types corresponding to method, can benull
-
showNextIndex
public void showNextIndex(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Shows next parameter if available in browser- Parameters:
viewer
- actualITextViewer
, can't benull
returnTypeStr
- string of return types corresponding to method, can benull
-
showToggleDescr
public void showToggleDescr(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Shows or hides parameter description in browser- Parameters:
viewer
- actualITextViewer
, can't benull
returnTypeStr
- string of return types corresponding to method, can benull
-
showControlInfo
public void showControlInfo(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr, List<org.eclipse.xtext.util.Pair<BslDocumentationProvider.DocumentContent.ParamContent,String>> params, Version version)
Shows browser control- Parameters:
viewer
- actualITextViewer
, can't benull
returnTypeStr
- string of return types corresponding to method, can benull
version
- current version of 1C:Enterprise, can benull
params
- list of available parameters, can't benull
-
showControlInfo
public void showControlInfo(org.eclipse.jface.text.ITextViewer viewer, String returnTypeStr)
Shows browser control- Parameters:
viewer
- actualITextViewer
, can't benull
returnTypeStr
- string of return types corresponding to method, can benull
-
setInput
public void setInput(String info)
Sets browser's content- Parameters:
info
- content to display in browser, can benull
-
-