sk.stuba.fiit.perconik.eclipse.ui

Class Editors

java.lang.Object

sk.stuba.fiit.perconik.eclipse.ui.Editors

public final class Editors
extends java.lang.Object

Static utility methods pertaining to Eclipse editors.

Since:

1.0

Author:

Pavol Zbell

Method Summary

Modifier and Type	Method and Description
static com.google.common.base.Supplier<org.eclipse.ui.IEditorReference>	activeEditorReferenceSupplier()
static com.google.common.base.Supplier<org.eclipse.ui.IEditorReference>	activeEditorReferenceSupplier(org.eclipse.ui.IWorkbench workbench)
static com.google.common.base.Supplier<org.eclipse.ui.IEditorReference>	activeEditorReferenceSupplier(org.eclipse.ui.IWorkbenchPage page)
static com.google.common.base.Supplier<org.eclipse.ui.IEditorReference>	activeEditorReferenceSupplier(org.eclipse.ui.IWorkbenchWindow window)
static com.google.common.base.Supplier<org.eclipse.ui.IEditorPart>	activeEditorSupplier()
static com.google.common.base.Supplier<org.eclipse.ui.IEditorPart>	activeEditorSupplier(org.eclipse.ui.IWorkbench workbench)
static com.google.common.base.Supplier<org.eclipse.ui.IEditorPart>	activeEditorSupplier(org.eclipse.ui.IWorkbenchPage page)
static com.google.common.base.Supplier<org.eclipse.ui.IEditorPart>	activeEditorSupplier(org.eclipse.ui.IWorkbenchWindow window)
static org.eclipse.ui.IEditorPart	forDocument(org.eclipse.jface.text.IDocument document)
static org.eclipse.ui.IEditorPart	forDocument(org.eclipse.jface.text.IDocument document, boolean restore)
static org.eclipse.ui.IEditorPart	forTextViewer(org.eclipse.jface.text.ITextViewer viewer)
static org.eclipse.ui.IEditorPart	forTextViewer(org.eclipse.jface.text.ITextViewer viewer, boolean restore)
static org.eclipse.ui.IEditorPart	getActiveEditor() Gets the active editor.
static org.eclipse.ui.IEditorPart	getActiveEditor(org.eclipse.ui.IWorkbench workbench) Gets the currently active editor.
static org.eclipse.ui.IEditorPart	getActiveEditor(org.eclipse.ui.IWorkbenchPage page) Gets the currently active editor.
static org.eclipse.ui.IEditorPart	getActiveEditor(org.eclipse.ui.IWorkbenchWindow window) Gets the currently active editor.
static org.eclipse.ui.IEditorReference	getActiveEditorReference() Gets the active editor reference.
static org.eclipse.ui.IEditorReference	getActiveEditorReference(org.eclipse.ui.IWorkbench workbench) Gets the currently active editor reference.
static org.eclipse.ui.IEditorReference	getActiveEditorReference(org.eclipse.ui.IWorkbenchPage page) Gets the currently active editor reference.
static org.eclipse.ui.IEditorReference	getActiveEditorReference(org.eclipse.ui.IWorkbenchWindow window) Gets the currently active editor reference.
static org.eclipse.jface.text.IDocument	getDocument(org.eclipse.ui.IEditorPart editor) Gets the input document from given editor.
static org.eclipse.core.resources.IFile	getFile(org.eclipse.ui.IEditorPart editor)
static org.eclipse.core.resources.IResource	getResource(org.eclipse.ui.IEditorPart editor)
static org.eclipse.jface.text.source.ISourceViewer	getSourceViewer(org.eclipse.ui.IEditorPart editor) Gets the source viewer from given editor.
static org.eclipse.swt.custom.StyledText	getStyledText(org.eclipse.ui.IEditorPart editor) Gets the text widget from given editor.
static org.eclipse.jface.text.ITextViewer	getTextViewer(org.eclipse.ui.IEditorPart editor) Gets the text viewer from given editor.
static org.eclipse.ui.IEditorPart	waitForActiveEditor() Waits for the currently active editor.
static org.eclipse.ui.IEditorPart	waitForActiveEditor(org.eclipse.ui.IWorkbench workbench) Waits for the currently active editor.
static org.eclipse.ui.IEditorPart	waitForActiveEditor(org.eclipse.ui.IWorkbenchPage page) Waits for the currently active editor.
static org.eclipse.ui.IEditorPart	waitForActiveEditor(org.eclipse.ui.IWorkbenchWindow window) Waits for the currently active editor.
static org.eclipse.ui.IEditorReference	waitForActiveEditorReference() Waits for the currently active editor reference.
static org.eclipse.ui.IEditorReference	waitForActiveEditorReference(org.eclipse.ui.IWorkbench workbench) Waits for the currently active editor reference.
static org.eclipse.ui.IEditorReference	waitForActiveEditorReference(org.eclipse.ui.IWorkbenchPage page) Waits for the currently active editor reference.
static org.eclipse.ui.IEditorReference	waitForActiveEditorReference(org.eclipse.ui.IWorkbenchWindow window) Waits for the currently active editor reference.

Methods inherited from class java.lang.Object

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

Method Detail

forTextViewer

public static org.eclipse.ui.IEditorPart forTextViewer(org.eclipse.jface.text.ITextViewer viewer)

forTextViewer

public static org.eclipse.ui.IEditorPart forTextViewer(org.eclipse.jface.text.ITextViewer viewer,
                                                       boolean restore)

forDocument

public static org.eclipse.ui.IEditorPart forDocument(org.eclipse.jface.text.IDocument document)

forDocument

public static org.eclipse.ui.IEditorPart forDocument(org.eclipse.jface.text.IDocument document,
                                                     boolean restore)

activeEditorSupplier

public static com.google.common.base.Supplier<org.eclipse.ui.IEditorPart> activeEditorSupplier()

activeEditorSupplier

public static com.google.common.base.Supplier<org.eclipse.ui.IEditorPart> activeEditorSupplier(@Nullable
                                                                                               org.eclipse.ui.IWorkbenchPage page)

activeEditorSupplier

public static com.google.common.base.Supplier<org.eclipse.ui.IEditorPart> activeEditorSupplier(@Nullable
                                                                                               org.eclipse.ui.IWorkbenchWindow window)

activeEditorSupplier

public static com.google.common.base.Supplier<org.eclipse.ui.IEditorPart> activeEditorSupplier(@Nullable
                                                                                               org.eclipse.ui.IWorkbench workbench)

activeEditorReferenceSupplier

public static com.google.common.base.Supplier<org.eclipse.ui.IEditorReference> activeEditorReferenceSupplier()

activeEditorReferenceSupplier

public static com.google.common.base.Supplier<org.eclipse.ui.IEditorReference> activeEditorReferenceSupplier(@Nullable
                                                                                                             org.eclipse.ui.IWorkbenchPage page)

activeEditorReferenceSupplier

public static com.google.common.base.Supplier<org.eclipse.ui.IEditorReference> activeEditorReferenceSupplier(@Nullable
                                                                                                             org.eclipse.ui.IWorkbenchWindow window)

activeEditorReferenceSupplier

public static com.google.common.base.Supplier<org.eclipse.ui.IEditorReference> activeEditorReferenceSupplier(@Nullable
                                                                                                             org.eclipse.ui.IWorkbench workbench)

getActiveEditor

public static org.eclipse.ui.IEditorPart getActiveEditor()

Gets the active editor.

Returns:

the active editor or null if there is no active editor

getActiveEditor

public static org.eclipse.ui.IEditorPart getActiveEditor(@Nullable
                                                         org.eclipse.ui.IWorkbenchPage page)

Gets the currently active editor.

Parameters:

page - the page, may be null

Returns:

the active editor or null if the page is null or there is no active editor

getActiveEditor

public static org.eclipse.ui.IEditorPart getActiveEditor(@Nullable
                                                         org.eclipse.ui.IWorkbenchWindow window)

Gets the currently active editor.

Parameters:

window - the window, may be null

Returns:

the active editor or null if the window is null or there is no active editor

getActiveEditor

public static org.eclipse.ui.IEditorPart getActiveEditor(@Nullable
                                                         org.eclipse.ui.IWorkbench workbench)

Gets the currently active editor.

Parameters:

workbench - the workbench, may be null

Returns:

the active editor or null if the workbench is null or there is no active editor

getActiveEditorReference

public static org.eclipse.ui.IEditorReference getActiveEditorReference()

Gets the active editor reference.

Returns:

the active editor reference or null if there is no active editor reference

getActiveEditorReference

public static org.eclipse.ui.IEditorReference getActiveEditorReference(@Nullable
                                                                       org.eclipse.ui.IWorkbenchPage page)

Gets the currently active editor reference.

Parameters:

page - the page, may be null

Returns:

the active editor reference or null if the page is null or there is no active editor reference

getActiveEditorReference

public static org.eclipse.ui.IEditorReference getActiveEditorReference(@Nullable
                                                                       org.eclipse.ui.IWorkbenchWindow window)

Gets the currently active editor reference.

Parameters:

window - the window, may be null

Returns:

the active editor reference or null if the window is null or there is no active editor reference

getActiveEditorReference

public static org.eclipse.ui.IEditorReference getActiveEditorReference(@Nullable
                                                                       org.eclipse.ui.IWorkbench workbench)

Gets the currently active editor reference.

Parameters:

workbench - the workbench, may be null

Returns:

the active editor reference or null if the workbench is null or there is no active editor reference

getResource

public static org.eclipse.core.resources.IResource getResource(@Nullable
                                                               org.eclipse.ui.IEditorPart editor)

getFile

public static org.eclipse.core.resources.IFile getFile(@Nullable
                                                       org.eclipse.ui.IEditorPart editor)

getTextViewer

public static org.eclipse.jface.text.ITextViewer getTextViewer(@Nullable
                                                               org.eclipse.ui.IEditorPart editor)

Gets the text viewer from given editor.

Parameters:

editor - the editor, may be null

Returns:

the text viewer or null if the editor is null or there is no text viewer

getSourceViewer

public static org.eclipse.jface.text.source.ISourceViewer getSourceViewer(@Nullable
                                                                          org.eclipse.ui.IEditorPart editor)

Gets the source viewer from given editor.

Parameters:

editor - the editor, may be null

Returns:

the source viewer or null if the editor is null or there is no source viewer

getStyledText

public static org.eclipse.swt.custom.StyledText getStyledText(@Nullable
                                                              org.eclipse.ui.IEditorPart editor)

Gets the text widget from given editor.

Parameters:

editor - the editor, may be null

Returns:

the text widget or null if the editor is null or there is no text widget

getDocument

public static org.eclipse.jface.text.IDocument getDocument(@Nullable
                                                           org.eclipse.ui.IEditorPart editor)

Gets the input document from given editor.

Parameters:

editor - the editor, may be null

Returns:

the document or null if the editor is null or there is no document

waitForActiveEditor

public static org.eclipse.ui.IEditorPart waitForActiveEditor()

Waits for the currently active editor. This method blocks until there is an active editor.

See Also:

getActiveEditor()

waitForActiveEditor

public static org.eclipse.ui.IEditorPart waitForActiveEditor(org.eclipse.ui.IWorkbenchPage page)

Waits for the currently active editor. This method blocks until there is an active editor.

Parameters:

page - the page, can not be null

See Also:

getActiveEditor(IWorkbenchPage)

waitForActiveEditor

public static org.eclipse.ui.IEditorPart waitForActiveEditor(org.eclipse.ui.IWorkbenchWindow window)

Waits for the currently active editor. This method blocks until there is an active editor.

Parameters:

window - the window, can not be null

See Also:

getActiveEditor(IWorkbenchWindow)

waitForActiveEditor

public static org.eclipse.ui.IEditorPart waitForActiveEditor(org.eclipse.ui.IWorkbench workbench)

Waits for the currently active editor. This method blocks until there is an active editor.

Parameters:

workbench - the workbench, can not be null

See Also:

getActiveEditor(IWorkbench)

waitForActiveEditorReference

public static org.eclipse.ui.IEditorReference waitForActiveEditorReference()

Waits for the currently active editor reference. This method blocks until there is an active editor reference.

See Also:

getActiveEditor()

waitForActiveEditorReference

public static org.eclipse.ui.IEditorReference waitForActiveEditorReference(org.eclipse.ui.IWorkbenchPage page)

Waits for the currently active editor reference. This method blocks until there is an active editor reference.

Parameters:

page - the page, can not be null

See Also:

getActiveEditor(IWorkbenchPage)

waitForActiveEditorReference

public static org.eclipse.ui.IEditorReference waitForActiveEditorReference(org.eclipse.ui.IWorkbenchWindow window)

Waits for the currently active editor reference. This method blocks until there is an active editor reference.

Parameters:

window - the window, can not be null

See Also:

getActiveEditor(IWorkbenchWindow)

waitForActiveEditorReference

public static org.eclipse.ui.IEditorReference waitForActiveEditorReference(org.eclipse.ui.IWorkbench workbench)

Waits for the currently active editor reference. This method blocks until there is an active editor reference.

Parameters:

workbench - the workbench, can not be null

See Also:

getActiveEditor(IWorkbench)