org.eclipse.hyades.ui.editor
Class EditorExtension

java.lang.Object
  org.eclipse.hyades.ui.editor.EditorExtension

All Implemented Interfaces:

java.util.EventListener, org.eclipse.core.runtime.IAdaptable, IEditorExtension, IDisposable, IRefreshable, org.eclipse.ui.ISelectionListener

Deprecated.

The implementation of this class is not based on Eclipse Forms(a.k.a. "flat" look) framework that was made available publically in Eclipse 3.0. If you would like your editor(s) to be built with the Eclipse Forms technology, this is NOT the class to extend. To know more about Eclipse Forms:
Eclipse Forms Programming Guide

public abstract class EditorExtension
extends java.lang.Object
implements IEditorExtension

An abstract implementation of a IEditorExtension. A typical client subclasses this class implementing only the required methods.

The clients must implement the following methods:

1. createPage()
2. doSave(IProgressMonitor)

Constructor Summary

EditorExtension()
Deprecated.

Method Summary

boolean	checkPagesDirtyState() Deprecated. Returns true when the IHyadesEditorPart should check the pages when calculating its dirty state or false when it should only relay on the value returned by this implementor's isDirty() method.
void	dispose() Deprecated. Disposes any resource used by this object.
void	doSaveAs() Deprecated. Saves the contents of this editor extension to another object.
java.lang.Object	getAdapter(java.lang.Class adapter) Deprecated.
IHyadesEditorPart	getHyadesEditorPart() Deprecated. Returns the hyades editor part in which this extension is presented.
java.lang.String	getStatusLineMessage(org.eclipse.jface.viewers.IStructuredSelection structuredSelection) Deprecated. Returns the message to show in the status line.
void	gotoMarker(org.eclipse.core.resources.IMarker marker) Deprecated. Sets the cursor and selection state for this editor extension to the passage defined by the given marker.
void	init(IHyadesEditorPart hyadesEditorPart) Deprecated. Initializes this editor extension with the given IHyadesEditorPart.
boolean	isDirty() Deprecated. Returns whether the contents of this editor extension have changed since the last save operation.
boolean	isSaveAsAllowed() Deprecated. Returns whether the "Save As" operation is supported by this part.
boolean	isSaveOnCloseNeeded() Deprecated. Returns whether the contents of this editor extension should be saved when the editor extension is closed.
boolean	pageActivated(int index) Deprecated. Notifies this editor extension that the page with the given index has been activated.
void	refreshContent(java.lang.Object data) Deprecated. Refreshes this object.
boolean	refreshPages() Deprecated. Returns true if the IHyadesEditorPart should refresh the pages after invoking this implementor's refreshContent(Object) method or false otherwise.
void	selectionChanged(org.eclipse.ui.IWorkbenchPart part, org.eclipse.jface.viewers.ISelection selection) Deprecated.
void	setSelection(org.eclipse.jface.viewers.IStructuredSelection structuredSelection) Deprecated. Sets the current selection for this selection provider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.hyades.ui.editor.IEditorExtension

createPages, doSave, getSelection

Constructor Detail

EditorExtension

public EditorExtension()

Deprecated.

Method Detail

init

public void init(IHyadesEditorPart hyadesEditorPart)
          throws org.eclipse.ui.PartInitException

Deprecated.

Description copied from interface: IEditorExtension

Initializes this editor extension with the given IHyadesEditorPart.

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

Implementors of this method must examine the edited object available at IHyadesEditorPart.getEditorObject() and the editor input to determine if one of them is understood. If not, the implementor must throw a PartInitException

Specified by:

init in interface IEditorExtension

Throws:

org.eclipse.ui.PartInitException - if this editor extension was not initialized successfully

See Also:

org.eclipse.hyades.ui.test.editor.IEditorExtension#init(org.eclipse.hyades.ui.test.editor.IHyadesEditorPart)

getHyadesEditorPart

public IHyadesEditorPart getHyadesEditorPart()

Deprecated.

Description copied from interface: IEditorExtension

Returns the hyades editor part in which this extension is presented.

Specified by:

getHyadesEditorPart in interface IEditorExtension

Returns:

IHyadesEditorPart

See Also:

IEditorExtension.getHyadesEditorPart()

gotoMarker

public void gotoMarker(org.eclipse.core.resources.IMarker marker)

Deprecated.

Description copied from interface: IEditorExtension

Sets the cursor and selection state for this editor extension to the passage defined by the given marker.

Specified by:

gotoMarker in interface IEditorExtension

Parameters:

marker - the marker

See Also:

org.eclipse.hyades.ui.test.editor.IEditorExtension#gotoMarker(org.eclipse.core.resources.IMarker)

checkPagesDirtyState

public boolean checkPagesDirtyState()

Deprecated.

Description copied from interface: IEditorExtension

Returns true when the IHyadesEditorPart should check the pages when calculating its dirty state or false when it should only relay on the value returned by this implementor's isDirty() method.

Specified by:

checkPagesDirtyState in interface IEditorExtension

Returns:

boolean

See Also:

org.eclipse.hyades.ui.test.editor.IEditorExtension#checkPagesDirtyState()

refreshPages

public boolean refreshPages()

Deprecated.

Description copied from interface: IEditorExtension

Returns true if the IHyadesEditorPart should refresh the pages after invoking this implementor's refreshContent(Object) method or false otherwise.

Specified by:

refreshPages in interface IEditorExtension

Returns:

boolean

See Also:

org.eclipse.hyades.ui.test.editor.IEditorExtension#refreshPages()

doSaveAs

public void doSaveAs()

Deprecated.

Description copied from interface: IEditorExtension

Saves the contents of this editor extension 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 IProgressMonitor should be used to indicate progress.

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

Specified by:

doSaveAs in interface IEditorExtension

See Also:

org.eclipse.hyades.ui.test.editor.IEditorExtension#doSaveAs()

isDirty

public boolean isDirty()

Deprecated.

Description copied from interface: IEditorExtension

Returns whether the contents of this editor extension have changed since the last save operation. If this value changes the editor extension must fire a property listener event with PROP_DIRTY.

Specified by:

isDirty in interface IEditorExtension

Returns:

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

See Also:

org.eclipse.hyades.ui.test.editor.IEditorExtension#isDirty()

isSaveAsAllowed

public boolean isSaveAsAllowed()

Deprecated.

Description copied from interface: IEditorExtension

Returns whether the "Save As" operation is supported by this part.

Specified by:

isSaveAsAllowed in interface IEditorExtension

Returns:

true if "Save As" is supported, and false if not supported

See Also:

org.eclipse.hyades.ui.test.editor.IEditorExtension#isSaveAsAllowed()

isSaveOnCloseNeeded

public boolean isSaveOnCloseNeeded()

Deprecated.

Description copied from interface: IEditorExtension

Returns whether the contents of this editor extension should be saved when the editor extension is closed.

Specified by:

isSaveOnCloseNeeded in interface IEditorExtension

Returns:

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

See Also:

org.eclipse.hyades.ui.test.editor.IEditorExtension#isSaveOnCloseNeeded()

dispose

public void dispose()

Deprecated.

Description copied from interface: IDisposable

Disposes any resource used by this object. There are no guarantees that this method is invoked by this object's container or by the Hyades framework.

Specified by:

dispose in interface IDisposable

See Also:

org.eclipse.hyades.ui.test.util.IDisposable#dispose()

refreshContent

public void refreshContent(java.lang.Object data)

Deprecated.

Description copied from interface: IRefreshable

Refreshes this object. The data is an information that may be used during the process such as the tree item that should be refreshed.

Specified by:

refreshContent in interface IRefreshable

See Also:

org.eclipse.hyades.ui.test.util.IRefreshable#refreshContent(java.lang.Object)

setSelection

public void setSelection(org.eclipse.jface.viewers.IStructuredSelection structuredSelection)

Deprecated.

Description copied from interface: IEditorExtension

Sets the current selection for this selection provider.

Specified by:

setSelection in interface IEditorExtension

See Also:

IEditorExtension.setSelection(org.eclipse.jface.viewers.IStructuredSelection)

selectionChanged

public void selectionChanged(org.eclipse.ui.IWorkbenchPart part,
                             org.eclipse.jface.viewers.ISelection selection)

Deprecated.

Specified by:

selectionChanged in interface org.eclipse.ui.ISelectionListener

See Also:

ISelectionListener.selectionChanged(org.eclipse.ui.IWorkbenchPart, org.eclipse.jface.viewers.ISelection)

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapter)

Deprecated.

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

See Also:

IAdaptable.getAdapter(java.lang.Class)

getStatusLineMessage

public java.lang.String getStatusLineMessage(org.eclipse.jface.viewers.IStructuredSelection structuredSelection)

Deprecated.

Description copied from interface: IEditorExtension

Returns the message to show in the status line. If this method returns null the status line won't present any message.

If a subclass requires a more sophisticated use of the status line, it should manipulate the status line direct. The status line can be obtained by getHyadesEditorPart().getEditorSite().getActionBars().getStatusLineManager().

Specified by:

getStatusLineMessage in interface IEditorExtension

Returns:

the status line message

See Also:

IEditorExtension.getStatusLineMessage(org.eclipse.jface.viewers.IStructuredSelection)

pageActivated

public boolean pageActivated(int index)

Deprecated.

Description copied from interface: IEditorExtension

Notifies this editor extension that the page with the given index has been activated. This method is called when the user selects a different tab.

Specified by:

pageActivated in interface IEditorExtension

Returns:

boolean indicating that the Hyades Editor Part selection listeners should be notified.

See Also:

IEditorExtension.pageActivated(int)