org.esa.beam.framework.ui.application
Interface PageComponent

All Superinterfaces:

ControlFactory, com.bc.ceres.binding.PropertyChangeEmitter

All Known Subinterfaces:

DocView, ToolView

All Known Implementing Classes:

AbstractLayerToolView, AbstractToolView, ColorManipulationToolView, DensityPlotToolView, GcpManagerToolView, GeoCodingToolView, HistogramPlotToolView, InformationToolView, LayerEditorToolView, LayerManagerToolView, MaskManagerToolView, MaskToolView, MaskViewerToolView, NavigationToolView, PinManagerToolView, PixelInfoToolView, PlacemarkEditorToolView, PlacemarkManagerToolView, ProductsToolView, ProfilePlotToolView, ScatterPlotToolView, SpectrumToolView, StatisticsToolView, TileCacheDiagnosisToolView, WorldMapToolView

public interface PageComponent
extends ControlFactory, com.bc.ceres.binding.PropertyChangeEmitter

A page component is displayed within an area on the page associated with an application window. There can be multiple components per page; a single page component can only be displayed once on a single page.

Components instances encapsulate the creation of and access to the visual presentation of the underlying control. A component's descriptor -- which is effectively a singleton -- can be asked to instantiate new instances of a single page component for display within an application with multiple windows. In other words, a single page component instance is never shared between windows.

This interface is intended to be implemented by clients. However, the preferred way to implement this interface is via the AbstractToolView, since the actual interface may change in the future.

Author:

Norman Fomferra (original by Keith Donald of Spring RCP project)

Method Summary

void	componentClosed()
void	componentFocusGained()
void	componentFocusLost()
void	componentHidden()
void	componentOpened()
void	componentShown()
void	dispose() Frees all resources allocated by this page component.
PageComponentContext	getContext() Gets the page component's context.
PageComponentDescriptor	getDescriptor() Gets the descriptor.
Icon	getIcon()
String	getId() Gets the page component identifier.
com.bc.ceres.swing.selection.SelectionContext	getSelectionContext() Gets the current selection context, if any.
String	getTitle()
void	setContext(PageComponentContext context) Initialises this page component with the given context.
void	setDescriptor(PageComponentDescriptor descriptor) Sets the descriptor.

Methods inherited from interface org.esa.beam.framework.ui.application.ControlFactory

getControl

Methods inherited from interface com.bc.ceres.binding.PropertyChangeEmitter

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Method Detail

getId

String getId()

Gets the page component identifier.

Returns:

The page component identifier.

getDescriptor

PageComponentDescriptor getDescriptor()

Gets the descriptor.

Returns:

the descriptor

See Also:

setDescriptor(PageComponentDescriptor)

setDescriptor

void setDescriptor(PageComponentDescriptor descriptor)

Sets the descriptor.

Clients must not call this method directly. It is called only once by the framework after a PageComponentContext has been created and before the framework calls the setContext(org.esa.beam.framework.ui.application.PageComponentContext) method.

Parameters:

descriptor - the descriptor

See Also:

getDescriptor()

getContext

PageComponentContext getContext()

Gets the page component's context.

Returns:

The the page component's context instance as passed into the setContext(PageComponentContext) method.

setContext

void setContext(PageComponentContext context)

Initialises this page component with the given context.

Clients must not call this method directly. It is called only once by the framework after a PageComponentContext has been created and before the framework calls the ControlFactory.getControl() method in order to let the client get or create the user interface.

Implementors shall store the given tool context instance and let the getContext() method return it.

Parameters:

context - The page component's context.

dispose

void dispose()

Frees all resources allocated by this page component.

Clients must not call this method directly.

componentOpened

void componentOpened()

componentClosed

void componentClosed()

componentShown

void componentShown()

componentHidden

void componentHidden()

componentFocusGained

void componentFocusGained()

componentFocusLost

void componentFocusLost()

getTitle

String getTitle()

getIcon

Icon getIcon()

getSelectionContext

com.bc.ceres.swing.selection.SelectionContext getSelectionContext()

Gets the current selection context, if any.

Returns:

The current selection context, or null if none exists.

Since:

BEAM 4.7