IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.edit.ui
Interface IManifestEditor

All Superinterfaces:
IAdaptable, IEditorPart, ISaveablePart, IWorkbenchPart

public interface IManifestEditor
extends IEditorPart

This interface provides methods allowing the editor pages to communicate useful information to the editor itself. This interface is not intended to be implemented by clients. Note: This interface is part of an evolving API and is subject to change. It is being made available to early adopters in the hope of soliciting feedback. Such early adopters should understand that any code that uses this API is bound to be broken (repeatedly) as the API changes.


Field Summary
 
Fields inherited from interface org.eclipse.ui.IEditorPart
PROP_DIRTY, PROP_INPUT
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Method Summary
 void fireFileDirtied(boolean dirty)
          This method is a callback for the editor pages, allowing them to let the editor know when they have dirtied or cleaned the file.
 ComposedAdapterFactory getAdapterFactory()
          This method gets a reference to the AdapterFactory, so that pages may construct AdapterFactoryContentProviders and AdapterFactoryLabelProviders.
 Asset getAsset()
          This method retrieves a reference to the Asset being edited, which is here so that clients can edit the Asset externally to the editor.
 EditorActionBarContributor getContributor()
          This method returns the action contributor so that pages can contribute to it.
 boolean getIsReadOnly()
          Determine whether the manifest being edited is read-only.
 
Methods inherited from interface org.eclipse.ui.IEditorPart
getEditorInput, getEditorSite, init
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, createPartControl, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocus
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.eclipse.ui.ISaveablePart
doSave, doSaveAs, isDirty, isSaveAsAllowed, isSaveOnCloseNeeded
 

Method Detail

fireFileDirtied

public void fireFileDirtied(boolean dirty)
This method is a callback for the editor pages, allowing them to let the editor know when they have dirtied or cleaned the file. It should only be necessary to call this if the page has changed something but not committed those changes to the EMF model, since the editor listens to changes to the model.

Parameters:
dirty - indicates what the dirty state should now be.

getContributor

public EditorActionBarContributor getContributor()
This method returns the action contributor so that pages can contribute to it.

Returns:
the editor's action bar contributor

getAdapterFactory

public ComposedAdapterFactory getAdapterFactory()
This method gets a reference to the AdapterFactory, so that pages may construct AdapterFactoryContentProviders and AdapterFactoryLabelProviders.

Returns:
the ComposedAdapterFactory associated with the Asset

getIsReadOnly

public boolean getIsReadOnly()
Determine whether the manifest being edited is read-only. Client pages should call this to determine if they need to disable some controls. The standard behavior of the RAS editor pages is to disable their controls when the file is read-only.

Returns:
true if the manifest file is read-only, false otherwise

getAsset

public Asset getAsset()
This method retrieves a reference to the Asset being edited, which is here so that clients can edit the Asset externally to the editor. Note that this object should be used immediately and discarded, since it is possible for it to become a stale reference (if, for instance, it is deserialized from the source page.

Returns:
the Asset being edited

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.