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

All Superinterfaces:

PageComponentDescriptor, com.bc.ceres.binding.PropertyChangeEmitter

public interface DocViewDescriptor
extends PageComponentDescriptor

Metadata about a view; a view descriptor is effectively a singleton view definition. A descriptor also acts as a factory which produces new instances of a given view when requested, typically by a requesting application page. A view descriptor can also produce a command which launches a view for display on the page within the current active window.

Author:

Marco Peters (original by Keith Donald of Spring RCP project)

Field Summary

Fields inherited from interface org.esa.beam.framework.ui.application.PageComponentDescriptor

PROPERTY_KEY_DESCRIPTION, PROPERTY_KEY_HELP_ID, PROPERTY_KEY_LARGE_ICON, PROPERTY_KEY_MAXIMIZABLE, PROPERTY_KEY_SMALL_ICON, PROPERTY_KEY_TAB_TITLE, PROPERTY_KEY_TITLE

Method Summary

Command

createOpenViewCommand(ApplicationPage applicationPage) Create a command that when executed, will attempt to open the page component described by this descriptor in the provided application window.

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

createPageComponent, getDescription, getHelpId, getId, getLargeIcon, getPreferredSize, getSmallIcon, getTabTitle, getTitle, isEnabled, isMaximizable, isVisible, setDescription, setEnabled, setHelpId, setLargeIcon, setMaximizable, setPreferredSize, setSmallIcon, setTabTitle, setTitle, setVisible

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

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Method Detail

createOpenViewCommand

Command createOpenViewCommand(ApplicationPage applicationPage)

Create a command that when executed, will attempt to open the page component described by this descriptor in the provided application window.

Parameters:

applicationPage - The application page.

Returns:

The show page component command.