Eclipse Plug-in Developer Guide (Galileo) - IPageChangeProvider (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.dialogs
Interface IPageChangeProvider

All Known Implementing Classes:: FormEditor, MultiPageEditorPart, PreferenceDialog, SharedHeaderFormEditor, WizardDialog

Minimal interface to a page change provider. Used for dialogs which can switch between multiple pages.

Method Summary

void addPageChangedListener ( IPageChangedListener listener)
          Adds a listener for page changes in this page change provider.

Object getSelectedPage ()
          Returns the currently selected page in the dialog.

void removePageChangedListener ( IPageChangedListener listener)
          Removes the given page change listener from this page change provider.

Method Detail


Object getSelectedPage()

Returns the currently selected page in the dialog.

Returns:: the selected page in the dialog or null if none is selected. The type may be domain specific. In the JFace provided dialogs this will be an instance of IDialogPage.

void addPageChangedListener(
IPageChangedListener listener)

Adds a listener for page changes in this page change provider. Has no effect if an identical listener is already registered.

void removePageChangedListener(
IPageChangedListener listener)

Removes the given page change listener from this page change provider. Has no effect if an identical listener is not registered.