TPTP 4.3.0 Testing Tools Project
Public API Specification

org.eclipse.hyades.test.ui.editor.form.util
Class EditorForm

java.lang.Object
  extended byorg.eclipse.hyades.test.ui.internal.editor.form.base.AbstractForm
      extended byorg.eclipse.hyades.test.ui.internal.editor.form.base.AbstractSectionForm
          extended byorg.eclipse.hyades.test.ui.internal.editor.form.base.SectionForm
              extended byorg.eclipse.hyades.test.ui.internal.editor.form.base.ScrollableSectionForm
                  extended byorg.eclipse.hyades.test.ui.editor.form.util.EditorForm
All Implemented Interfaces:
java.util.EventListener, org.eclipse.hyades.ui.util.IDisposable, org.eclipse.hyades.test.ui.internal.editor.form.base.IForm, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.ui.part.ISetSelectionTarget, org.eclipse.swt.events.PaintListener, org.eclipse.swt.internal.SWTEventListener
Direct Known Subclasses:
TestCasesForm, TestContextOverview

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 EditorForm
extends org.eclipse.hyades.test.ui.internal.editor.form.base.ScrollableSectionForm
implements org.eclipse.hyades.ui.util.IDisposable, org.eclipse.ui.part.ISetSelectionTarget

Since:
3.0.0

Nested Class Summary
protected static class EditorForm.ArgByReference
          Deprecated.  
 
Field Summary
 
Fields inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.SectionForm
heightHint, widthHint
 
Fields inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractSectionForm
H_SCROLL_INCREMENT, sections, V_SCROLL_INCREMENT
 
Fields inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractForm
factory, headingBackground, headingForeground, headingImage, headingText, headingVisible, titleFont
 
Constructor Summary
EditorForm()
          Deprecated.  
EditorForm(BaseEditorExtension baseEditorExtension, WidgetFactory widgetFactory)
          Deprecated. Constructor for EditorForm
 
Method Summary
 boolean activated()
          Deprecated.  
protected  org.eclipse.swt.widgets.Composite createColumn(org.eclipse.swt.widgets.Composite parent)
          Deprecated. Creates a composite that corresponds to the a column in the given parent.
 org.eclipse.swt.widgets.Control createControl()
          Deprecated. Creates the control using the attributes of the editor extension specified in the constructor.
protected abstract  void createEditorFormContents(org.eclipse.swt.widgets.Composite parent)
          Deprecated. Creates the contents of this editor form.
protected  void createFormClient(org.eclipse.swt.widgets.Composite parent)
          Deprecated.  
 void dispose()
          Deprecated.  
 BaseEditorExtension getBaseEditorExtension()
          Deprecated. Returns the base editor extension that is presenting this composite.
 org.eclipse.jface.viewers.ISelection getCurrentSelection()
          Deprecated.  
protected  org.eclipse.jface.action.IStatusLineManager getStatusLineManager()
          Deprecated. Returns the editor's status line manager or null if the manager is not provided.
 WidgetFactory getWidgetFactory()
          Deprecated. Returns the widget factory.
 void init(BaseEditorExtension baseEditorExtension, WidgetFactory widgetFactory)
          Deprecated.  
abstract  void load()
          Deprecated. Subclasses should load the persited values in the controls in this method.
 void selectReveal(org.eclipse.jface.viewers.ISelection selection)
          Deprecated.  
 void updateTitle()
          Deprecated. Updates this editor form title.
 
Methods inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.ScrollableSectionForm
createControl, createParent, isScrollable, isVerticalFit, setScrollable, setVerticalFit, update, updateScrollBars, updateScrolledComposite
 
Methods inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.SectionForm
getControl, getTitleHeight, paintControl, propertyChange, setHeadingText, setHeadingVisible
 
Methods inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractSectionForm
canPaste, commitChanges, doGlobalAction, ensureVisible, ensureVisible, getControlLocation, getFocusControl, initialize, registerSection, scrollHorizontal, scrollPage, scrollVertical, setFocus, unregisterSection, updatePageIncrement
 
Methods inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractForm
canPerformDirectly, expandTo, getFactory, getHeadingBackground, getHeadingForeground, getHeadingImage, getHeadingText, isHeadingVisible, setHeadingBackground, setHeadingForeground, setHeadingImage, updateHyperlinkColors
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EditorForm

public EditorForm(BaseEditorExtension baseEditorExtension,
                  WidgetFactory widgetFactory)
Deprecated. 
Constructor for EditorForm

Parameters:
widgetFactory -

EditorForm

public EditorForm()
Deprecated. 
Method Detail

init

public void init(BaseEditorExtension baseEditorExtension,
                 WidgetFactory widgetFactory)
Deprecated. 

dispose

public void dispose()
Deprecated. 
Specified by:
dispose in interface org.eclipse.hyades.ui.util.IDisposable
See Also:
org.eclipse.update.ui.forms.internal.IForm#dispose()

updateTitle

public void updateTitle()
Deprecated. 
Updates this editor form title.


createControl

public org.eclipse.swt.widgets.Control createControl()
Deprecated. 
Creates the control using the attributes of the editor extension specified in the constructor.

Returns:
Control

selectReveal

public void selectReveal(org.eclipse.jface.viewers.ISelection selection)
Deprecated. 
Specified by:
selectReveal in interface org.eclipse.ui.part.ISetSelectionTarget
See Also:
ISetSelectionTarget.selectReveal(org.eclipse.jface.viewers.ISelection)

getWidgetFactory

public WidgetFactory getWidgetFactory()
Deprecated. 
Returns the widget factory.

Returns:
WidgetFactory

getBaseEditorExtension

public BaseEditorExtension getBaseEditorExtension()
Deprecated. 
Returns the base editor extension that is presenting this composite.

Returns:
BaseEditorExtension

createFormClient

protected void createFormClient(org.eclipse.swt.widgets.Composite parent)
Deprecated. 
See Also:
org.eclipse.update.ui.forms.internal.SectionForm#createFormClient(org.eclipse.swt.widgets.Composite)

createEditorFormContents

protected abstract void createEditorFormContents(org.eclipse.swt.widgets.Composite parent)
Deprecated. 
Creates the contents of this editor form.

Parameters:
parent -

load

public abstract void load()
Deprecated. 
Subclasses should load the persited values in the controls in this method. The goal is to provide a common behavior for the editor forms.


createColumn

protected org.eclipse.swt.widgets.Composite createColumn(org.eclipse.swt.widgets.Composite parent)
Deprecated. 
Creates a composite that corresponds to the a column in the given parent.

Parameters:
parent -
Returns:
Composite

getStatusLineManager

protected org.eclipse.jface.action.IStatusLineManager getStatusLineManager()
Deprecated. 
Returns the editor's status line manager or null if the manager is not provided.

Returns:
IStatusLineManager

activated

public boolean activated()
Deprecated. 

getCurrentSelection

public org.eclipse.jface.viewers.ISelection getCurrentSelection()
Deprecated. 

TPTP 4.3.0 Testing Tools Project
Public API Specification