TPTP 4.5.0 Testing Tools Project
Internal API Specification

org.eclipse.hyades.test.ui.internal.editor.form.util
Class AbstractDetailForm

java.lang.Object
  extended by org.eclipse.hyades.test.ui.internal.editor.form.util.AbstractDetailForm
All Implemented Interfaces:
java.util.EventListener, IDetailForm, org.eclipse.hyades.ui.util.IDisposable, org.eclipse.swt.events.VerifyListener, org.eclipse.swt.internal.SWTEventListener
Direct Known Subclasses:
LoopDetailForm, TestInvocationDetailForm

public abstract class AbstractDetailForm
extends java.lang.Object
implements org.eclipse.swt.events.VerifyListener, IDetailForm

Abstract default implementation of IDetailForm. This class may be used as a base class for implementing IDetailPage. It provides conveniency methods and stores the "context" property. The "context" property should be set by the subclass, typically in the org.eclipse.hyades.test.ui.editor.form.util.IDetailFormm#createControl(org.eclipse.swt.widgets.Composite, org.eclipse.hyades.test.ui.internal.editor.form.base.FormWidgetFactory, IDetailPageContext) method.


Field Summary
protected  IDetailPageContext context
           
 
Constructor Summary
AbstractDetailForm()
           
 
Method Summary
 void dispose()
          This method may be overriden, and its implementation should include a call to super.dispose().
protected  EditorEclipseForm getEditorForm()
          Returns the form that contains the details page.
 org.eclipse.jface.viewers.IStructuredSelection getStructuredSelection()
          This method should be overriden if the details page provides a non-empty selection.
protected  boolean isReadOnly()
          Returns whether the details page is in a read-only context.
 void selectReveal(org.eclipse.jface.viewers.ISelection selection)
          This method should be overriden if the details page provides a non-empty selection.
 void verifyKey(org.eclipse.swt.events.VerifyEvent event)
          Default implementation that forwards the event to the page's parent.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.swt.events.VerifyListener
verifyText
 
Methods inherited from interface org.eclipse.hyades.test.ui.internal.editor.form.util.IDetailForm
createControl, getInput, setInput
 

Field Detail

context

protected IDetailPageContext context
Constructor Detail

AbstractDetailForm

public AbstractDetailForm()
Method Detail

dispose

public void dispose()
This method may be overriden, and its implementation should include a call to super.dispose().

Specified by:
dispose in interface org.eclipse.hyades.ui.util.IDisposable

getEditorForm

protected EditorEclipseForm getEditorForm()
Returns the form that contains the details page. This method is not meant to be overriden by subclassers.

Returns:

getStructuredSelection

public org.eclipse.jface.viewers.IStructuredSelection getStructuredSelection()
This method should be overriden if the details page provides a non-empty selection.

Specified by:
getStructuredSelection in interface IDetailForm
Returns:
The current selection. If not applicable, or if the selection is empty, returns StructuredSelection.EMPTY.

selectReveal

public void selectReveal(org.eclipse.jface.viewers.ISelection selection)
This method should be overriden if the details page provides a non-empty selection.

Specified by:
selectReveal in interface IDetailForm

isReadOnly

protected boolean isReadOnly()
Returns whether the details page is in a read-only context. This method is not meant to be overriden by subclassers.

Returns:

verifyKey

public void verifyKey(org.eclipse.swt.events.VerifyEvent event)
Default implementation that forwards the event to the page's parent.

See Also:
VerifyKeyListener.verifyKey(org.eclipse.swt.events.VerifyEvent)

TPTP 4.5.0 Testing Tools Project
Internal API Specification