com.ibm.ftt.ui.resources.core.editor
Class EditorOpener

java.lang.Object
  extended by com.ibm.ftt.ui.resources.core.editor.EditorOpener
All Implemented Interfaces:
IEditorOpener

public class EditorOpener
extends Object
implements IEditorOpener

EditorOpener can be used to open resources in an edit session.

The EditorOpener class is intended to handle all known resource types by delegating to the appropriate IEditorOpener. Caller should invoke this class instead of the resource type specific IEditorOpener implementations directly.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 org.eclipse.ui.IEditorPart browse(Object resource)
          Opens the specified resource in read only mode.
 boolean canBrowse(Object resource)
          Returns whether the resource can be browsed or not
static EditorOpener getInstance()
          Returns the singleton instance of the EditorOpener class
 org.eclipse.ui.IEditorPart gotoLine(Object resource, int lineNumber, int charStart, int charEnd)
          Opens the resource and goes to the specified line, highlighting the section from charStart to charEnd.
 org.eclipse.ui.IEditorPart open(Object resource)
          Opens an edit session for the specified resource.
 org.eclipse.ui.IEditorPart open(Object resource, org.eclipse.ui.IEditorDescriptor editorDescriptor)
          Opens an edit session for the specified resource using the specified editor.
 org.eclipse.ui.IEditorPart view(Object resource)
          Opens the specified resource in edit mode without locking the file
 

Field Detail

COPY_RIGHT

public static final String COPY_RIGHT
See Also:
Constant Field Values
Method Detail

getInstance

public static EditorOpener getInstance()
Returns the singleton instance of the EditorOpener class

Returns:
the singleton EditorOpener object

open

public org.eclipse.ui.IEditorPart open(Object resource)
                                throws Exception
Description copied from interface: IEditorOpener
Opens an edit session for the specified resource. The default editor will be used.

Specified by:
open in interface IEditorOpener
Parameters:
resource - resource to open
Returns:
the IEditorPart used to open the resource or null if the resource could not be opened.
Throws:
Exception - if the resource cannot be opened.

view

public org.eclipse.ui.IEditorPart view(Object resource)
                                throws Exception
Description copied from interface: IEditorOpener
Opens the specified resource in edit mode without locking the file

Specified by:
view in interface IEditorOpener
Parameters:
resource - resource to view
Returns:
the IEditorPart used to view the resource or null if the resource could not be opened.
Throws:
Exception - if the resource cannot be viewed

open

public org.eclipse.ui.IEditorPart open(Object resource,
                                       org.eclipse.ui.IEditorDescriptor editorDescriptor)
                                throws Exception
Description copied from interface: IEditorOpener
Opens an edit session for the specified resource using the specified editor.

Specified by:
open in interface IEditorOpener
Parameters:
resource - resource to open
editorDescriptor - descriptor object for the editor to use
Returns:
the IEditorPart used to open the resource or null if the resource could not be opened.
Throws:
Exception - if the resource cannot be opened.

browse

public org.eclipse.ui.IEditorPart browse(Object resource)
                                  throws Exception
Description copied from interface: IEditorOpener
Opens the specified resource in read only mode.

Specified by:
browse in interface IEditorOpener
Parameters:
resource - resource to browse
Returns:
the IEditorPart used to browse the resource or null if the resource could not be browsed.
Throws:
Exception - if the resource cannot be browsed

gotoLine

public org.eclipse.ui.IEditorPart gotoLine(Object resource,
                                           int lineNumber,
                                           int charStart,
                                           int charEnd)
                                    throws Exception
Description copied from interface: IEditorOpener
Opens the resource and goes to the specified line, highlighting the section from charStart to charEnd.

Specified by:
gotoLine in interface IEditorOpener
Parameters:
resource - resource to open
lineNumber - line number to go to (line 1 is the first line)
charStart - start of the highlighted section (char 0 is the first character)
charEnd - end of the highlighted section (char 0 is the first character)
Returns:
the IEditorPart used to open the resource or null if the resource could not be opened.
Throws:
Exception - if goto line operation fails

canBrowse

public boolean canBrowse(Object resource)
Description copied from interface: IEditorOpener
Returns whether the resource can be browsed or not

Specified by:
canBrowse in interface IEditorOpener
Parameters:
resource - resource to check for browse
Returns:
true if the resource can be browsed, or false if not.