TPTP 4.2.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.llc.ui.internal.editor
Class CoverageReportEditor

java.lang.Object
  extended byorg.eclipse.core.commands.common.EventManager
      extended byorg.eclipse.ui.part.WorkbenchPart
          extended byorg.eclipse.ui.part.EditorPart
              extended byorg.eclipse.ui.part.MultiPageEditorPart
                  extended byorg.eclipse.ui.forms.editor.FormEditor
                      extended byorg.eclipse.tptp.platform.llc.ui.internal.editor.CoverageReportEditor
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, org.eclipse.ui.IEditorPart, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.dialogs.IPageChangeProvider, org.eclipse.ui.ISaveablePart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.part.IWorkbenchPartOrientation

public class CoverageReportEditor
extends org.eclipse.ui.forms.editor.FormEditor


Field Summary
protected  java.util.List _list
           
protected  java.lang.String _title
           
 
Fields inherited from class org.eclipse.ui.forms.editor.FormEditor
pages
 
Fields inherited from interface org.eclipse.ui.IEditorPart
PROP_DIRTY, PROP_INPUT
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
CoverageReportEditor()
           
 
Method Summary
protected  void addPages()
           
protected  org.eclipse.ui.forms.widgets.FormToolkit createToolkit(org.eclipse.swt.widgets.Display display)
           
 void dispose()
          Invokes the unload method of the monitor resource when the editor is closed and when the user is not in the profiling perspective.
 void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
          Saves the contents of this editor.
 void doSaveAs()
          Saves the contents of this editor to another object.
 java.util.List getList()
           
 java.lang.String getReportTitle()
           
 void gotoMarker(org.eclipse.core.resources.IMarker marker)
          Sets the cursor and selection state for this editor to the passage defined by the given marker.
 void init(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput input)
          Initializes this editor with the given editor site and input.
 boolean isDirty()
          Returns whether the contents of this editor have changed since the last save operation.
 boolean isSaveAsAllowed()
          Returns whether the "save as" operation is supported by this editor.
 boolean isSaveOnCloseNeeded()
          Returns whether the contents of this editor should be saved when the editor is closed.
 void setFocus()
          Asks this part to take focus within the workbench.
 
Methods inherited from class org.eclipse.ui.forms.editor.FormEditor
addPage, addPage, addPage, addPage, addPage, addPage, addPageChangedListener, close, configurePage, createPageContainer, createPages, editorDirtyStateChanged, findPage, getActiveEditor, getActivePageInstance, getCurrentPage, getSelectedPage, getToolkit, pageChange, removePage, removePageChangedListener, selectReveal, setActivePage, setActivePage, setActivePage, updateActionBarContributor
 
Methods inherited from class org.eclipse.ui.part.MultiPageEditorPart
createPartControl, createSite, getActivePage, getAdapter, getContainer, getControl, getEditor, getPageCount, getPageImage, getPageText, handlePropertyChange, setControl, setPageImage, setPageText
 
Methods inherited from class org.eclipse.ui.part.EditorPart
checkSite, getEditorInput, getEditorSite, getTitleToolTip, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName
 
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPropertyListener, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getSite, getTitle, getTitleImage, removePropertyListener, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, removePropertyListener
 

Field Detail

_list

protected java.util.List _list

_title

protected java.lang.String _title
Constructor Detail

CoverageReportEditor

public CoverageReportEditor()
Method Detail

createToolkit

protected org.eclipse.ui.forms.widgets.FormToolkit createToolkit(org.eclipse.swt.widgets.Display display)

addPages

protected void addPages()

doSave

public void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
Saves the contents of this editor.

If the save is successful, the editor fires a property changed event reflecting the new dirty state (PROP_SAVE_NEEDED property).

This method is long-running; progress and cancellation are provided by the given progress monitor.

Parameters:
monitor - the progress monitor

doSaveAs

public void doSaveAs()
Saves the contents of this editor to another object.

Implementors are expected to open a "save as" dialog where the user will be able to select a new name for the contents. After the selection is made, the contents should be saved to that new name. During this operation a ProgressMonitorDialog should be used to indicate progress.

If the save is successful, the editor fires a property changed event reflecting the new dirty state (PROP_SAVE_NEEDED property).


gotoMarker

public void gotoMarker(org.eclipse.core.resources.IMarker marker)
Sets the cursor and selection state for this editor to the passage defined by the given marker.

Parameters:
marker - the marker

init

public void init(org.eclipse.ui.IEditorSite site,
                 org.eclipse.ui.IEditorInput input)
          throws org.eclipse.ui.PartInitException
Initializes this editor with the given editor site and input.

This method is automatically called shortly after part construction; it marks the start of the part's lifecycle. The IWorkbenchPart.dispose method will be called automically at the end of the lifecycle. Clients must not call this method.

Implementors of this method must examine the editor input object type to determine if it is understood. If not, the implementor must throw a PartInitException

Parameters:
site - the editor site
input - the editor input
Throws:
org.eclipse.ui.PartInitException - if this editor was not initialized successfully

isDirty

public boolean isDirty()
Returns whether the contents of this editor have changed since the last save operation. If this value changes the part must fire a property listener event with PROP_DIRTY.

Returns:
true if the contents have been modified and need saving, and false if they have not changed since the last save

isSaveAsAllowed

public boolean isSaveAsAllowed()
Returns whether the "save as" operation is supported by this editor.

Returns:
true if "save as" is supported, and false if "save as" is not supported

isSaveOnCloseNeeded

public boolean isSaveOnCloseNeeded()
Returns whether the contents of this editor should be saved when the editor is closed.

Returns:
true if the contents of the editor should be saved on close, and false if the contents are expendable

setFocus

public void setFocus()
Asks this part to take focus within the workbench.

Clients should not call this method (the workbench calls this method at appropriate times).


dispose

public void dispose()
Invokes the unload method of the monitor resource when the editor is closed and when the user is not in the profiling perspective.


getList

public java.util.List getList()

getReportTitle

public java.lang.String getReportTitle()

TPTP 4.2.0 Platform Project
Internal API Specification