org.eclipse.palamedes.ui.views.gamestate
Interface IGameStatePage

All Superinterfaces:

org.eclipse.ui.part.IPage

All Known Implementing Classes:

GameStatePage, GSPage

public interface IGameStatePage
extends org.eclipse.ui.part.IPage

Marker-style interface for a knowledge base page. This interface defines the minimum requirement for pages within the game state view, namely they must be pages (implement IPage) and provide selections (implement ISelectionProvider).

Access to a game state page begins when an editor is activated. When activation occurs, the game state view will ask the editor for its game state page. This is done by invoking getAdapter(IGameStatePage.class) on the editor. If the editor returns a page, the view then creates the controls for that page (using createControl) and makes the page visible.

Clients may implement this interface from scratch, or subclass the abstract base class GameStatePage.

Note that this interface extends ISelectionProvider. This is no longer required in the case of implementors who also implement IPageBookViewPage (or extend Page) as they are now passed an IPageSite during their initialization and this site can be configured with a selection provider. However to avoid a breaking change 1) this interface will continue to extend ISelectionProvider 2) if an IGameStatePage does not set a selection provider for its site, the GameState will continue to use the page itself for this purpose.

Documentation derived from IContentOutlinePage/Eclipse

See Also:

IContentOutlinePage

Method Summary

Methods inherited from interface org.eclipse.ui.part.IPage

createControl, dispose, getControl, setActionBars, setFocus