Package com.intellij.openapi.fileEditor

Class OpenFileDescriptor

java.lang.Object

com.intellij.openapi.fileEditor.OpenFileDescriptor

All Implemented Interfaces:

Navigatable, java.lang.Comparable<OpenFileDescriptor>

public class OpenFileDescriptor
extends java.lang.Object
implements Navigatable, java.lang.Comparable<OpenFileDescriptor>

Allows opening file in editor, optionally at specific line/column position.

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<Editor>	NAVIGATE_IN_EDITOR Tells descriptor to navigate in specific editor rather than file editor in main IDE window.

Constructor Summary

Constructors

Constructor and Description
OpenFileDescriptor(Project project, VirtualFile file)
OpenFileDescriptor(Project project, VirtualFile file, int offset)
OpenFileDescriptor(Project project, VirtualFile file, int logicalLine, int logicalColumn)
OpenFileDescriptor(Project project, VirtualFile file, int logicalLine, int logicalColumn, boolean persistent)

Method Summary

Modifier and Type	Method and Description
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	canNavigateToSource() Indicates whether this instance supports navigation to source (that means some kind of editor).
int	compareTo(OpenFileDescriptor o)
void	dispose()
int	getColumn()
VirtualFile	getFile()
int	getLine()
int	getOffset()
Project	getProject()
RangeMarker	getRangeMarker()
static TextRange	getRangeToUnfoldOnNavigation(Editor editor)
boolean	isUseCurrentWindow()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
void	navigateIn(Editor e)
protected boolean	navigateInAnyFileEditor(Project project, boolean focusEditor)
boolean	navigateInEditor(Project project, boolean requestFocus)
void	setScrollType(ScrollType scrollType)
OpenFileDescriptor	setUseCurrentWindow(boolean search)
protected static void	unfoldCurrentLine(Editor editor)

Methods inherited from class java.lang.Object

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

Field Detail

NAVIGATE_IN_EDITOR

public static final DataKey<Editor> NAVIGATE_IN_EDITOR

Tells descriptor to navigate in specific editor rather than file editor in main IDE window. For example if you want to navigate in editor embedded into modal dialog, you should provide this data.

Constructor Detail

OpenFileDescriptor

public OpenFileDescriptor(Project project,
                          VirtualFile file,
                          int offset)

OpenFileDescriptor

public OpenFileDescriptor(Project project,
                          VirtualFile file,
                          int logicalLine,
                          int logicalColumn)

OpenFileDescriptor

public OpenFileDescriptor(Project project,
                          VirtualFile file,
                          int logicalLine,
                          int logicalColumn,
                          boolean persistent)

OpenFileDescriptor

public OpenFileDescriptor(Project project,
                          VirtualFile file)

Method Detail

getFile

public VirtualFile getFile()

getRangeMarker

public RangeMarker getRangeMarker()

getOffset

public int getOffset()

getLine

public int getLine()

getColumn

public int getColumn()

navigate

public void navigate(boolean requestFocus)

Description copied from interface: Navigatable

Open editor and select/navigate to the object there if possible. Just do nothing if navigation is not possible like in case of a package

Specified by:

navigate in interface Navigatable

Parameters:

requestFocus - true if focus requesting is necessary

navigateInEditor

public boolean navigateInEditor(Project project,
                                boolean requestFocus)

navigateInAnyFileEditor

protected boolean navigateInAnyFileEditor(Project project,
                                          boolean focusEditor)

navigateIn

public void navigateIn(Editor e)

unfoldCurrentLine

protected static void unfoldCurrentLine(Editor editor)

getRangeToUnfoldOnNavigation

public static TextRange getRangeToUnfoldOnNavigation(Editor editor)

canNavigate

public boolean canNavigate()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation of any kind. Usually this method is called to ensure that navigation is possible. Note that it is not called if navigation to source is supported, i.e. Navigatable.canNavigateToSource() returns true. We assume that this method should return true in such case, so implement this method respectively.

Specified by:

canNavigate in interface Navigatable

Returns:

false if navigation is not possible for any reason.

canNavigateToSource

public boolean canNavigateToSource()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation to source (that means some kind of editor). Note that navigation can be supported even if this method returns false. In such cases it is not recommended to do batch navigation for all navigatables available via CommonDataKeys.NAVIGATABLE_ARRAY, because it may lead to opening several modal dialogs. Use OpenSourceUtil.navigate(com.intellij.pom.Navigatable...) to process such arrays correctly.

Specified by:

canNavigateToSource in interface Navigatable

Returns:

false if navigation to source is not possible for any reason.

getProject

public Project getProject()

setUseCurrentWindow

public OpenFileDescriptor setUseCurrentWindow(boolean search)

isUseCurrentWindow

public boolean isUseCurrentWindow()

setScrollType

public void setScrollType(ScrollType scrollType)

dispose

public void dispose()

compareTo

public int compareTo(OpenFileDescriptor o)

Specified by:

compareTo in interface java.lang.Comparable<OpenFileDescriptor>