org.eclipse.xtext.ui.editor
Class XtextReadonlyEditorInput

java.lang.Object
  org.eclipse.core.runtime.PlatformObject
      org.eclipse.xtext.ui.editor.XtextReadonlyEditorInput

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.ui.IEditorInput, org.eclipse.ui.IStorageEditorInput

public class XtextReadonlyEditorInput
extends org.eclipse.core.runtime.PlatformObject
implements org.eclipse.ui.IStorageEditorInput

Author:

Sebastian Zarnekow - Initial contribution and API

Constructor Summary

XtextReadonlyEditorInput(org.eclipse.core.resources.IStorage storage)

Method Summary

boolean	equals(java.lang.Object obj)
boolean	exists() Returns whether the editor input exists.
org.eclipse.jface.resource.ImageDescriptor	getImageDescriptor() Returns the image descriptor for this input.
java.lang.String	getName() Returns the name of this editor input for display purposes.
org.eclipse.ui.IPersistableElement	getPersistable() Returns an object that can be used to save the state of this editor input.
org.eclipse.core.resources.IStorage	getStorage() Returns the underlying IStorage object.
java.lang.String	getToolTipText() Returns the tool tip text for this editor input.
int	hashCode()

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Constructor Detail

XtextReadonlyEditorInput

public XtextReadonlyEditorInput(org.eclipse.core.resources.IStorage storage)

Method Detail

getStorage

public org.eclipse.core.resources.IStorage getStorage()
                                               throws org.eclipse.core.runtime.CoreException

Description copied from interface: org.eclipse.ui.IStorageEditorInput

Returns the underlying IStorage object.

Specified by:

getStorage in interface org.eclipse.ui.IStorageEditorInput

Returns:

an IStorage object.

Throws:

org.eclipse.core.runtime.CoreException - if this method fails

exists

public boolean exists()

Description copied from interface: org.eclipse.ui.IEditorInput

Returns whether the editor input exists.

This method is primarily used to determine if an editor input should appear in the "File Most Recently Used" menu. An editor input will appear in the list until the return value of exists becomes false or it drops off the bottom of the list.

Specified by:

exists in interface org.eclipse.ui.IEditorInput

Returns:

true if the editor input exists; false otherwise

getImageDescriptor

public org.eclipse.jface.resource.ImageDescriptor getImageDescriptor()

Description copied from interface: org.eclipse.ui.IEditorInput

Returns the image descriptor for this input.

Note: although a null return value has never been permitted from this method, there are many known buggy implementations that return null. Clients that need the image for an editor are advised to use IWorkbenchPart.getImage() instead of IEditorInput.getImageDescriptor(), or to recover from a null return value in a manner that records the ID of the problematic editor input. Implementors that have been returning null from this method should pick some other default return value (such as ImageDescriptor.getMissingImageDescriptor()).

Specified by:

getImageDescriptor in interface org.eclipse.ui.IEditorInput

Returns:

the image descriptor for this input; may be null if there is no image.

getName

public java.lang.String getName()

Description copied from interface: org.eclipse.ui.IEditorInput

Returns the name of this editor input for display purposes.

For instance, when the input is from a file, the return value would ordinarily be just the file name.

Specified by:

getName in interface org.eclipse.ui.IEditorInput

Returns:

the name string; never null;

getPersistable

public org.eclipse.ui.IPersistableElement getPersistable()

Description copied from interface: org.eclipse.ui.IEditorInput

Returns an object that can be used to save the state of this editor input.

Specified by:

getPersistable in interface org.eclipse.ui.IEditorInput

Returns:

the persistable element, or null if this editor input cannot be persisted

getToolTipText

public java.lang.String getToolTipText()

Description copied from interface: org.eclipse.ui.IEditorInput

Returns the tool tip text for this editor input. This text is used to differentiate between two input with the same name. For instance, MyClass.java in folder X and MyClass.java in folder Y. The format of the text varies between input types.

Specified by:

getToolTipText in interface org.eclipse.ui.IEditorInput

Returns:

the tool tip text; never null.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object