org.eclipse.gmt.umlx.editor
Interface IPageManager

All Known Subinterfaces:
IEditorPageManager
All Known Implementing Classes:
AbstractPageManager, EcorePageManager, EditorPageManager, EMOFPageManager, TextPageManager, TreePageManager, XMLPageManager

public interface IPageManager


Method Summary
 void activate(org.eclipse.core.runtime.IProgressMonitor monitor)
          Activate the page by loading from the core representation.
 java.lang.String cannotDeactivate(org.eclipse.core.runtime.IProgressMonitor monitor)
          Return a non-null reason if deactivate should not occur.
 void deactivate(org.eclipse.core.runtime.IProgressMonitor monitor)
          Deactivate the page by saving to the core representation.
 void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
          Save the page contents to editor input file.
 java.lang.String getCurrentContents()
          Create the current editor-specific content.
 java.lang.String getFileExtension()
          Return the file extension appropriate for temporary files created to support this page.
 java.lang.String getTitle()
          Return the text for the page tab.
 boolean hasContent()
          Return true if the page has been given some initial content.
 boolean hasCopy()
          Return true if there is a local copy to which editing can revert.
 boolean isDirty()
          Return true if any multi-page has been modified.
 boolean isDirtyPage()
          Return true if the page has been modified.
 boolean isPrimary()
          Return true if the page directly edits the file upon which the multi-page editor was opened.
 void postDeactivate()
          On completion of deactivate() release any resources established by cannotDeactivate().
 void refresh()
          Respond to an external change such as a model registry update.
 void saveTo(org.eclipse.core.resources.IFile file, org.eclipse.core.runtime.IProgressMonitor monitor)
          Save the page contents to the specified file.
 void setActive()
          Install the page as the active page.
 

Method Detail

activate

void activate(org.eclipse.core.runtime.IProgressMonitor monitor)
              throws org.eclipse.core.runtime.CoreException,
                     java.io.IOException,
                     org.eclipse.gmt.umlx.alien.mapping.MappingConfigurationException
Activate the page by loading from the core representation.

Throws:
org.eclipse.core.runtime.CoreException
java.io.IOException
org.eclipse.gmt.umlx.alien.mapping.MappingConfigurationException

cannotDeactivate

java.lang.String cannotDeactivate(org.eclipse.core.runtime.IProgressMonitor monitor)
Return a non-null reason if deactivate should not occur. postDeactivate is alwayd invoked to release any resources cached by cannotDeactivate for passing to deactivate.

Parameters:
monitor -
Returns:

deactivate

void deactivate(org.eclipse.core.runtime.IProgressMonitor monitor)
Deactivate the page by saving to the core representation.


doSave

void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
Save the page contents to editor input file.


getCurrentContents

java.lang.String getCurrentContents()
                                    throws java.io.IOException
Create the current editor-specific content.

Throws:
java.io.IOException

getFileExtension

java.lang.String getFileExtension()
Return the file extension appropriate for temporary files created to support this page.


getTitle

java.lang.String getTitle()
Return the text for the page tab.


hasContent

boolean hasContent()
Return true if the page has been given some initial content.


hasCopy

boolean hasCopy()
Return true if there is a local copy to which editing can revert.


isDirty

boolean isDirty()
Return true if any multi-page has been modified.


isDirtyPage

boolean isDirtyPage()
Return true if the page has been modified.


isPrimary

boolean isPrimary()
Return true if the page directly edits the file upon which the multi-page editor was opened.


postDeactivate

void postDeactivate()
On completion of deactivate() release any resources established by cannotDeactivate().


refresh

void refresh()
Respond to an external change such as a model registry update.


saveTo

void saveTo(org.eclipse.core.resources.IFile file,
            org.eclipse.core.runtime.IProgressMonitor monitor)
Save the page contents to the specified file.


setActive

void setActive()
Install the page as the active page.