TPTP 4.4.0 Monitoring Tools Project
Internal API Specification

org.eclipse.tptp.wsdm.tooling.editor.ui.internal
Class AbstractUIPage

java.lang.Object
  extended byorg.eclipse.tptp.wsdm.tooling.editor.ui.internal.AbstractPage
      extended byorg.eclipse.tptp.wsdm.tooling.editor.ui.internal.AbstractUIPage
All Implemented Interfaces:
IPage, org.eclipse.ui.IPropertyListener, IUIPage
Direct Known Subclasses:
OperationPage, OverviewPage, PropertyPage, TopicPage

public abstract class AbstractUIPage
extends AbstractPage
implements IUIPage

Abstract class to handle most of the functionality of a UI page.

See Also:
org.eclipse.tptp.wsdm.tooling.editor.capability.internal.pages.overview.OverviewPage, org.eclipse.tptp.wsdm.tooling.editor.capability.internal.pages.property.PropertyPage, org.eclipse.tptp.wsdm.tooling.editor.capability.internal.pages.operation.OperationPage, org.eclipse.tptp.wsdm.tooling.editor.capability.internal.pages.topic.TopicPage

Field Summary
 
Fields inherited from class org.eclipse.tptp.wsdm.tooling.editor.ui.internal.AbstractPage
_display, _editor, _isDirty
 
Constructor Summary
protected AbstractUIPage(org.eclipse.swt.widgets.Composite parent, AbstractCapabilityEditor editor, java.lang.String name)
          Creates a new object of this class.
 
Method Summary
 void addSection(IPageSection section)
          Add a section to the list of sections.
abstract  void create()
          Creats the page.
 void createSections()
          Creates the sections.
 void enableSections(boolean enabled)
          Enable or disable sections based on parameter passed.
 org.eclipse.swt.widgets.Control getControl()
          Returns the control associated with UI page.
 org.eclipse.ui.forms.widgets.ScrolledForm getForm()
          Returns the ScrolledForm
 java.util.List getSections()
          Returns the list of sections.
 java.lang.String getTitle()
          Returns the title of the form.
 org.eclipse.ui.forms.widgets.FormToolkit getToolkit()
          Returns the FormToolkit.
 void hookAllListeners()
          Initializes all section control listeners.
 void pageChange(int newPageIndex)
          Gives the indication of page change event.
 void propertyChanged(java.lang.Object source, int propId)
          Handle propertyChanged event.
 void refresh()
          Refreshes the UI page.
 void refreshSections()
          Refreshes the sections.
 
Methods inherited from class org.eclipse.tptp.wsdm.tooling.editor.ui.internal.AbstractPage
isDirty, save, setDirty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.tptp.wsdm.tooling.editor.ui.internal.IPage
isDirty, save, setDirty
 

Constructor Detail

AbstractUIPage

protected AbstractUIPage(org.eclipse.swt.widgets.Composite parent,
                         AbstractCapabilityEditor editor,
                         java.lang.String name)
Creates a new object of this class.

Method Detail

addSection

public void addSection(IPageSection section)
Add a section to the list of sections.

Specified by:
addSection in interface IUIPage

getSections

public java.util.List getSections()
Returns the list of sections.

Specified by:
getSections in interface IUIPage

getForm

public org.eclipse.ui.forms.widgets.ScrolledForm getForm()
Returns the ScrolledForm

Specified by:
getForm in interface IUIPage

getTitle

public java.lang.String getTitle()
Returns the title of the form.

Specified by:
getTitle in interface IUIPage

getToolkit

public org.eclipse.ui.forms.widgets.FormToolkit getToolkit()
Returns the FormToolkit.

Specified by:
getToolkit in interface IUIPage

create

public abstract void create()
Description copied from interface: IPage
Creats the page.

Specified by:
create in interface IPage
Specified by:
create in class AbstractPage

createSections

public void createSections()
Creates the sections.

Specified by:
createSections in interface IUIPage

refreshSections

public void refreshSections()
Refreshes the sections.

Specified by:
refreshSections in interface IUIPage

hookAllListeners

public void hookAllListeners()
Initializes all section control listeners.

Specified by:
hookAllListeners in interface IPage
Specified by:
hookAllListeners in class AbstractPage

propertyChanged

public void propertyChanged(java.lang.Object source,
                            int propId)
Handle propertyChanged event.

Specified by:
propertyChanged in interface org.eclipse.ui.IPropertyListener

enableSections

public void enableSections(boolean enabled)
Enable or disable sections based on parameter passed.

Specified by:
enableSections in interface IUIPage

refresh

public void refresh()
Refreshes the UI page.

Specified by:
refresh in interface IPage
Specified by:
refresh in class AbstractPage

getControl

public org.eclipse.swt.widgets.Control getControl()
Returns the control associated with UI page.

Specified by:
getControl in interface IPage

pageChange

public void pageChange(int newPageIndex)
Gives the indication of page change event.

Specified by:
pageChange in interface IPage
Specified by:
pageChange in class AbstractPage

TPTP 4.4.0 Monitoring Tools Project
Internal API Specification