public interface PageComponent extends ControlFactory, com.bc.ceres.binding.PropertyChangeEmitter
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.
Modifier and Type | Method and Description |
---|---|
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.
|
getControl
String getId()
PageComponentDescriptor getDescriptor()
setDescriptor(PageComponentDescriptor)
void setDescriptor(PageComponentDescriptor 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.
descriptor
- the descriptorgetDescriptor()
PageComponentContext getContext()
setContext(PageComponentContext)
method.void setContext(PageComponentContext 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.
context
- The page component's context.void dispose()
Clients must not call this method directly.
void componentOpened()
void componentClosed()
void componentShown()
void componentHidden()
void componentFocusGained()
void componentFocusLost()
String getTitle()
Icon getIcon()
com.bc.ceres.swing.selection.SelectionContext getSelectionContext()
null
if none exists.Copyright © 2002–2014 Brockmann Consult GmbH. All rights reserved.