Eclipse Plug-in Developer Guide (Galileo) - FileEditorInputFactory (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.part
Class FileEditorInputFactory


java.lang.Object
  
org.eclipse.ui.part.FileEditorInputFactory

All Implemented Interfaces:: IElementFactory

public class FileEditorInputFactory
extends Object
implements IElementFactory
extends Object
implements IElementFactory

Factory for saving and restoring a FileEditorInput. The stored representation of a FileEditorInput remembers the full path of the file (that is, IFile.getFullPath).

The workbench will automatically create instances of this class as required. It is not intended to be instantiated or subclassed by the client.

Restriction:: This class is not intended to be subclassed by clients.
Restriction:: This class is not intended to be instantiated by clients.

Constructor Summary

FileEditorInputFactory ()
          Creates a new factory.

Method Summary

IAdaptable createElement ( IMemento memento)
          Re-creates and returns an object from the state captured within the given memento.

static String getFactoryId ()
          Returns the element factory id for this class.

static void saveState ( IMemento memento, FileEditorInput input)
          Saves the state of the given file editor input into the given memento.

Methods inherited from class java.lang. Object

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

Constructor Detail

FileEditorInputFactory

public FileEditorInputFactory()

Creates a new factory.

Method Detail

createElement

public 
IAdaptable createElement(
IMemento memento)

Description copied from interface: IElementFactory

Re-creates and returns an object from the state captured within the given memento.

If the result is not null, it should be persistable; that is,

 result.getAdapter(org.eclipse.ui.IPersistableElement.class)

should not return null.

Specified by:: createElement in interface IElementFactory

Parameters:: memento - a memento containing the state for the object
Returns:: an object, or null if the element could not be created

getFactoryId

public static 
String getFactoryId()

Returns the element factory id for this class.

Returns:: the element factory id

saveState

public static void saveState(
IMemento memento,
                             
FileEditorInput input)

Saves the state of the given file editor input into the given memento.

Parameters:: memento - the storage area for element state; input - the file editor input