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

Class BslHoverBrowserInput

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.hover.BslHoverBrowserInput

public class BslHoverBrowserInput
extends BslBrowserInformationControlInput

A browser input for Built-in language editor hover browser.

Constructor Summary

Constructors

Constructor	Description
BslHoverBrowserInput(BslHoverBrowserInput previous, BslDocumentationPageGroup<? extends IBslDocumentationHoverPage> pageGroup, int index)	Constructor.

Method Summary

Modifier and Type	Method	Description
Version	getActualVersion()	Gets actual page version.
protected String	getContentHtml()	Gets content html.
protected String	getHeadingContentHtml()	Gets heading content html.
IBslDocumentationHoverPage	getHoverPage()	Gets hover page.
String	getInputName()
String	getSearchQuery()	Gets search query.
protected int	getSize()	Gets pages size.
Version	getVersion()	Gets current page platform version.
IBslDocumentationViewPage	getViewPage()	Gets page.

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

BslHoverBrowserInput

public BslHoverBrowserInput(BslHoverBrowserInput previous,
 BslDocumentationPageGroup<? extends IBslDocumentationHoverPage> pageGroup,
 int index)

Constructor.

Parameters:

previous - history previous input, can't be null

pageGroup - hover page group, can't be null

index - initial index of displayed hover page in index. Should be >= 0 and < pageGroup size.

Method Details

getActualVersion

public Version getActualVersion()

Gets actual page version.

Returns:

version. Never null

getInputName

public String getInputName()

Overrides:

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

getViewPage

public IBslDocumentationViewPage getViewPage()

Gets page.

Specified by:

getViewPage in class BslBrowserInformationControlInput

Returns:

page. May be null if no pages

getSearchQuery

public String getSearchQuery()

Gets search query.

Returns:

search query. May be null

getHoverPage

public IBslDocumentationHoverPage getHoverPage()

Gets hover page.

Returns:

hover page. Never 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