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

Class BslContentAssistBrowserInput

java.lang.Object

org.eclipse.jface.internal.text.html.BrowserInput

org.eclipse.jface.internal.text.html.BrowserInformationControlInput

org.eclipse.xtext.ui.editor.hover.html.XtextBrowserInformationControlInput

com._1c.g5.v8.dt.internal.bsl.ui.browserscommon.BslBrowserInformationControlInput

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

public class BslContentAssistBrowserInput
extends BslBrowserInformationControlInput

A content assistant browser input class.

Constructor Summary

Constructors

Constructor	Description
BslContentAssistBrowserInput(BslContentAssistBrowserInput previous, int subPageIndex, int paramIndex, boolean showDescr, List<IBslDocumentationContentAssistPage> pages)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected String	getContentHtml()	Gets content html.
protected String	getHeadingContentHtml()	Gets heading content html.
String	getInputName()
boolean	getShowDescription()	Gets whether the input is showing description.
protected int	getSize()	Gets pages size.
String	getUri()	Gets uri string of the current subpage.
Version	getVersion()	Gets current page platform version.
protected IBslDocumentationViewPage	getViewPage()	Gets associated view page.
void	setShowDescription(boolean showDescription)	Sets the input should to show description or no.

Methods inherited from class com._1c.g5.v8.dt.internal.bsl.ui.browserscommon.BslBrowserInformationControlInput

addStyleToHtml, getHtml, getIndex, getNext, hideNext, restoreNext, setIndex

Methods inherited from class org.eclipse.xtext.ui.editor.hover.html.XtextBrowserInformationControlInput

getElement, getInputElement, getLeadingImageWidth

Methods inherited from class org.eclipse.jface.internal.text.html.BrowserInformationControlInput

toString

Methods inherited from class org.eclipse.jface.internal.text.html.BrowserInput

getPrevious

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BslContentAssistBrowserInput

public BslContentAssistBrowserInput(BslContentAssistBrowserInput previous,
 int subPageIndex,
 int paramIndex,
 boolean showDescr,
 List<IBslDocumentationContentAssistPage> pages)

Constructor.

Parameters:

previous - previous history input. May be null if it it a first history input

subPageIndex - index of subpage. Subpages are signatures usually. Should be >= 0 and < pages list size

paramIndex - index of the parameter. May be < or >= then subpage parameters count, then no content assistant parameter is selected

showDescr - true if need to show description false otherwise

pages - subpage list. Never null and all elements never null. Should be non empty

Method Details

getInputName

public String getInputName()

Overrides:

getInputName in class org.eclipse.xtext.ui.editor.hover.html.XtextBrowserInformationControlInput

getShowDescription

public boolean getShowDescription()

Gets whether the input is showing description.

Returns:

true if the input is showing description false otherwise

setShowDescription

public void setShowDescription(boolean showDescription)

Sets the input should to show description or no.

getUri

public String getUri()

Gets uri string of the current subpage.

Returns:

uri. May be null

getVersion

public Version getVersion()

Description copied from class: BslBrowserInformationControlInput

Gets current page platform version.

Specified by:

getVersion in class BslBrowserInformationControlInput

Returns:

platform version. May be null if no subpage opened

getSize

protected int getSize()

Description copied from class: BslBrowserInformationControlInput

Gets pages size.

Specified by:

getSize in class BslBrowserInformationControlInput

Returns:

size of the page group. Always >= 0

getHeadingContentHtml

protected String getHeadingContentHtml()

Description copied from class: BslBrowserInformationControlInput

Gets heading content html. This content will be in the top of the page directly if BslBrowserInformationControlInput.getSize() <= 1 and wiil be in right of subpage counter if BslBrowserInformationControlInput.getSize() > 1. Should be contains only string html nodes.

Specified by:

getHeadingContentHtml in class BslBrowserInformationControlInput

Returns:

heading content html text. Never null

getContentHtml

protected String getContentHtml()

Description copied from class: BslBrowserInformationControlInput

Gets content html. This content will be immedately after heading line.

Specified by:

getContentHtml in class BslBrowserInformationControlInput

Returns:

content html text. Never null

getViewPage

protected IBslDocumentationViewPage getViewPage()

Description copied from class: BslBrowserInformationControlInput

Gets associated view page.

Specified by:

getViewPage in class BslBrowserInformationControlInput

Returns:

view page. May be null