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

All Superinterfaces:

com.bc.ceres.binding.PropertyChangeEmitter

All Known Subinterfaces:

DocViewDescriptor, ToolViewDescriptor

All Known Implementing Classes:

DefaultToolViewDescriptor

public interface PageComponentDescriptor
extends com.bc.ceres.binding.PropertyChangeEmitter

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

Field Summary

static String	PROPERTY_KEY_DESCRIPTION
static String	PROPERTY_KEY_HELP_ID
static String	PROPERTY_KEY_LARGE_ICON
static String	PROPERTY_KEY_MAXIMIZABLE
static String	PROPERTY_KEY_SMALL_ICON
static String	PROPERTY_KEY_TAB_TITLE
static String	PROPERTY_KEY_TITLE

Method Summary

PageComponent	createPageComponent()
String	getDescription()
String	getHelpId()
String	getId()
Icon	getLargeIcon()
Dimension	getPreferredSize()
Icon	getSmallIcon()
String	getTabTitle()
String	getTitle()
boolean	isEnabled()
boolean	isMaximizable()
boolean	isVisible()
void	setDescription(String description)
void	setEnabled(boolean state)
void	setHelpId(String helpId)
void	setLargeIcon(Icon icon)
void	setMaximizable(boolean state)
void	setPreferredSize(Dimension preferredSize)
void	setSmallIcon(Icon icon)
void	setTabTitle(String tabTitle)
void	setTitle(String title)
void	setVisible(boolean state)

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

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Field Detail

PROPERTY_KEY_TITLE

static final String PROPERTY_KEY_TITLE

See Also:

Constant Field Values

PROPERTY_KEY_TAB_TITLE

static final String PROPERTY_KEY_TAB_TITLE

See Also:

Constant Field Values

PROPERTY_KEY_DESCRIPTION

static final String PROPERTY_KEY_DESCRIPTION

See Also:

Constant Field Values

PROPERTY_KEY_SMALL_ICON

static final String PROPERTY_KEY_SMALL_ICON

See Also:

Constant Field Values

PROPERTY_KEY_LARGE_ICON

static final String PROPERTY_KEY_LARGE_ICON

See Also:

Constant Field Values

PROPERTY_KEY_MAXIMIZABLE

static final String PROPERTY_KEY_MAXIMIZABLE

See Also:

Constant Field Values

PROPERTY_KEY_HELP_ID

static final String PROPERTY_KEY_HELP_ID

See Also:

Constant Field Values

Method Detail

createPageComponent

PageComponent createPageComponent()

getId

String getId()

getHelpId

String getHelpId()

Returns:

The help identifier.

setHelpId

void setHelpId(String helpId)

Parameters:

helpId - The help identifier.

getTitle

String getTitle()

Returns:

The window title.

setTitle

void setTitle(String title)

Parameters:

title - The window title.

getTabTitle

String getTabTitle()

Returns:

The window tab-title.

setTabTitle

void setTabTitle(String tabTitle)

Parameters:

tabTitle - The window tab-title.

getDescription

String getDescription()

Returns:

The window description.

setDescription

void setDescription(String description)

Parameters:

description - The window description.

getSmallIcon

Icon getSmallIcon()

Returns:

The small window icon or null if not set.

getLargeIcon

Icon getLargeIcon()

Returns:

The large window icon or null if not set.

setSmallIcon

void setSmallIcon(Icon icon)

Parameters:

icon - The small window icon or null if not set.

setLargeIcon

void setLargeIcon(Icon icon)

Parameters:

icon - The large window icon or null if not set.

isVisible

boolean isVisible()

Returns:

true if the window is visible, false otherwise.

setVisible

void setVisible(boolean state)

Parameters:

state - true if the window shall become visible, false otherwise.

isEnabled

boolean isEnabled()

Returns:

true if the window is enabled, false otherwise.

setEnabled

void setEnabled(boolean state)

Parameters:

state - true if the window is enabled, false otherwise.

isMaximizable

boolean isMaximizable()

Returns:

true if the window is maximizable, false otherwise.

setMaximizable

void setMaximizable(boolean state)

Parameters:

state - true if the window is maximizable, false otherwise.

getPreferredSize

Dimension getPreferredSize()

Returns:

The preferred size.

setPreferredSize

void setPreferredSize(Dimension preferredSize)

Parameters:

preferredSize - The preferred size.