org.eclipse.lsp4j

Class ShowDocumentParams

java.lang.Object

org.eclipse.lsp4j.ShowDocumentParams

public class ShowDocumentParams
extends java.lang.Object

Params to show a document.

Since 3.16.0

Constructor Summary

Constructors

Constructor and Description
ShowDocumentParams()
ShowDocumentParams(java.lang.String uri)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getExternal() Indicates to show the resource in an external program.
Range	getSelection() An optional selection range if the document is a text document.
java.lang.Boolean	getTakeFocus() An optional property to indicate whether the editor showing the document should take focus or not.
java.lang.String	getUri() The document uri to show.
int	hashCode()
void	setExternal(java.lang.Boolean external) Indicates to show the resource in an external program.
void	setSelection(Range selection) An optional selection range if the document is a text document.
void	setTakeFocus(java.lang.Boolean takeFocus) An optional property to indicate whether the editor showing the document should take focus or not.
void	setUri(java.lang.String uri) The document uri to show.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShowDocumentParams

public ShowDocumentParams()

ShowDocumentParams

public ShowDocumentParams(java.lang.String uri)

Method Detail

getUri

@Pure
public java.lang.String getUri()

The document uri to show.

setUri

public void setUri(java.lang.String uri)

The document uri to show.

getExternal

@Pure
public java.lang.Boolean getExternal()

Indicates to show the resource in an external program. To show for example https://www.eclipse.org/ in the default WEB browser set to true.

setExternal

public void setExternal(java.lang.Boolean external)

Indicates to show the resource in an external program. To show for example https://www.eclipse.org/ in the default WEB browser set to true.

getTakeFocus

@Pure
public java.lang.Boolean getTakeFocus()

An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.

setTakeFocus

public void setTakeFocus(java.lang.Boolean takeFocus)

An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.

getSelection

@Pure
public Range getSelection()

An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.

setSelection

public void setSelection(Range selection)

An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.

toString

@Pure
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

@Pure
public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class java.lang.Object