Difference between revisions of "FAQ How do I open an editor on something that is not a file?"

From Eclipsepedia

Jump to: navigation, search
 
m
Line 1: Line 1:
Most editors will accept as input either an <tt>IFileEditorInput</tt> or an  
+
Most editors will accept as input either an <tt>IFileEditorInput</tt> or an <tt>IStorageEditorInput</tt>.  The former can be used only for opening files in the workspace, but the latter can be used to open a stream of bytes from anywhere. If you want to open a file on a database object, remote file, or  other data source, <tt>IStorage</tt> is the way to go.  The only downside is that this is a read-only input type, so you can use it only for viewing a file, not editing it. To use this approach, implement <tt>IStorage</tt> so that it returns the bytes for the file you want to display.  Here is an <tt>IStorage</tt> that returns the contents of a string:
<tt>IStorageEditorInput</tt>.  The former can be used only for opening files in the  
+
 
workspace, but the latter can be used to open a stream of bytes from anywhere.
+
If you want to open a file on a database object, remote file, or  other data
+
source, <tt>IStorage</tt> is the way to go.  The only downside is that this is
+
a read-only input type, so you can use it only for viewing a file, not editing it.
+
To use this approach, implement <tt>IStorage</tt> so that it returns the bytes
+
for the file you want to display.  Here is an <tt>IStorage</tt> that returns the contents
+
of a string:
+
 
<pre>
 
<pre>
 
   class StringStorage extends PlatformObject  
 
   class StringStorage extends PlatformObject  
Line 24: Line 17:
 
   }
 
   }
 
</pre>
 
</pre>
The class extends <tt>PlatformObject</tt> to inherit the standard implementation of
 
<tt>IAdaptable</tt>, which <tt>IStorage</tt> extends.  The <tt>getName</tt>
 
and <tt>getFullPath</tt> methods can  return <tt>null</tt> if they are not
 
needed.  In this case, we&#146;ve  implemented <tt>getName</tt>
 
to return the first five characters of the string.
 
  
 +
The class extends <tt>PlatformObject</tt> to inherit the standard implementation of <tt>IAdaptable</tt>, which <tt>IStorage</tt> extends.  The <tt>getName</tt> and <tt>getFullPath</tt> methods can  return <tt>null</tt> if they are not needed.  In this case, we've implemented <tt>getName</tt> to return the first five characters of the string.
 +
 +
The next step is to create an <tt>IStorageEditorInput</tt> implementation that returns your <tt>IStorage</tt> object:
  
The next step is to create an <tt>IStorageEditorInput</tt> implementation
 
that returns your <tt>IStorage</tt> object:
 
 
<pre>
 
<pre>
 
   class StringInput extends PlatformObject  
 
   class StringInput extends PlatformObject  
Line 53: Line 42:
 
</pre>
 
</pre>
  
 +
Again, many of the methods here are optional.  The <tt>getPersistable</tt> method is used for implementing persistence of your editor input, so the platform can automatically restore your editor on start-up.  Here, we've implemented the bare essentials: the editor name, and a tool tip.
  
Again, many of the methods here are optional.  The <tt>getPersistable</tt> method
+
The final step is to open an editor with this input.  This snippet opens the platform's default text editor on a given string:
is used for implementing persistence of your editor input, so the platform can
+
automatically restore your editor on start-up.  Here, we&#146;ve
+
implemented the
+
bare essentials: the editor name, and a tool tip.
+
  
 
The final step is to open an editor with this input.  This snippet opens
 
the platform&#146;s default text editor on a given string:
 
 
<pre>
 
<pre>
 
   IWorkbenchWindow window = ...;
 
   IWorkbenchWindow window = ...;
Line 73: Line 56:
 
</pre>
 
</pre>
  
<hr><font size=-2>This FAQ was originally published in [http://www.eclipsefaq.org Official Eclipse 3.0 FAQs]. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1.0].</font>
+
== See Also: ==
 +
*[[FAQ How do I open an editor programmatically?]]
 +
*[[FAQ How do I open an editor on a file outside the workspace?]]
 +
 
 +
{{Template:FAQ_Tagline}}

Revision as of 20:04, 29 May 2006

Most editors will accept as input either an IFileEditorInput or an IStorageEditorInput. The former can be used only for opening files in the workspace, but the latter can be used to open a stream of bytes from anywhere. If you want to open a file on a database object, remote file, or other data source, IStorage is the way to go. The only downside is that this is a read-only input type, so you can use it only for viewing a file, not editing it. To use this approach, implement IStorage so that it returns the bytes for the file you want to display. Here is an IStorage that returns the contents of a string:

   class StringStorage extends PlatformObject 
    implements IStorage {
      private String string;
      StringStorage(String input) {this.string = input;}
      public InputStream getContents() throws CoreException {
         return new ByteArrayInputStream(string.getBytes());
      }
      public IPath getFullPath() {return null;}
      public String getName() {
         int len = Math.min(5, string.length());
         return string.substring(0, len).concat("...");
      }
      public boolean isReadOnly() {return true;}
   }

The class extends PlatformObject to inherit the standard implementation of IAdaptable, which IStorage extends. The getName and getFullPath methods can return null if they are not needed. In this case, we've implemented getName to return the first five characters of the string.

The next step is to create an IStorageEditorInput implementation that returns your IStorage object:

   class StringInput extends PlatformObject 
    implements IStorageEditorInput {
      private IStorage storage;
      StringInput(IStorage storage) {this.storage = storage;}
      public boolean exists() {return true;}
      public ImageDescriptor getImageDescriptor() {return null;}
      public String getName() {
         return storage.getName();
      }
      public IPersistableElement getPersistable() {return null;}
      public IStorage getStorage() {
         return storage;
      }
      public String getToolTipText() {
         return "String-based file: " + storage.getName();
      }
   }

Again, many of the methods here are optional. The getPersistable method is used for implementing persistence of your editor input, so the platform can automatically restore your editor on start-up. Here, we've implemented the bare essentials: the editor name, and a tool tip.

The final step is to open an editor with this input. This snippet opens the platform's default text editor on a given string:

   IWorkbenchWindow window = ...;
   String string = "This is the text file contents";
   IStorage storage = new StringStorage(string);
   IStorageEditorInput input = new StringInput(storage);
   IWorkbenchPage page = window.getActivePage();
   if (page != null)
      page.openEditor(input, "org.eclipse.ui.DefaultTextEditor");

See Also:


This FAQ was originally published in Official Eclipse 3.0 FAQs. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the Eclipse Public License v1.0.