public abstract class AbstractToolView extends AbstractControlFactory implements ToolView
ToolView
s.
Clients should use this class a base class for their tool view implementations.
Modifier | Constructor and Description |
---|---|
protected |
AbstractToolView() |
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(PropertyChangeListener listener) |
void |
addPropertyChangeListener(String propertyName,
PropertyChangeListener listener) |
void |
componentClosed()
The default implementation does nothing.
|
void |
componentFocusGained()
The default implementation does nothing.
|
void |
componentFocusLost()
The default implementation does nothing.
|
void |
componentHidden()
The default implementation does nothing.
|
void |
componentOpened()
The default implementation does nothing.
|
void |
componentShown()
The default implementation does nothing.
|
void |
dispose()
The default implementation does nothing.
|
PageComponentContext |
getContext()
Gets the actual tool window component as part of the application's main frame window.
|
PageComponentDescriptor |
getDescriptor()
Gets the descriptor.
|
Icon |
getIcon() |
String |
getId()
Gets the tool window identifier.
|
Container |
getPaneControl()
Gets the content pane of this tool window's part.
|
Window |
getPaneWindow()
Gets the first
Window ancestor of this tool window's content pane, or
null if it is (currently) not contained inside a Window . |
com.bc.ceres.swing.selection.SelectionContext |
getSelectionContext()
Gets the current selection context, if any.
|
String |
getTitle() |
boolean |
isVisible()
Returns whether the toolview is visible.
|
protected void |
registerLocalCommandExecutors(PageComponentContext context)
Template method called once when this view is initialized.
|
void |
removePropertyChangeListener(PropertyChangeListener listener) |
void |
removePropertyChangeListener(String propertyName,
PropertyChangeListener listener) |
void |
setContext(PageComponentContext context)
Sets the tool window's context.
|
void |
setDescriptor(PageComponentDescriptor descriptor)
Sets the descriptor.
|
void |
setTitle(String title)
Sets the actual window title which may be different from what
PageComponentDescriptor.getTitle() returns. |
createControl, createControlIfNecessary, getControl, isControlCreated, isSingleton, setSingleton
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getControl
public PageComponentDescriptor getDescriptor()
PageComponent
getDescriptor
in interface PageComponent
PageComponent.setDescriptor(PageComponentDescriptor)
public final void setDescriptor(PageComponentDescriptor descriptor)
PageComponent
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 PageComponent.setContext(org.esa.beam.framework.ui.application.PageComponentContext)
method.
setDescriptor
in interface PageComponent
descriptor
- the descriptorPageComponent.getDescriptor()
public PageComponentContext getContext()
getContext
in interface PageComponent
setContext(PageComponentContext)
method
or null
if the too window has not yet been initialised.public final void setContext(PageComponentContext context)
Clients may override this method in order configure their tool window.
However, after calling this method,
getContext()
shall return the same context
.
Clients must not call this method directly, it is called only once by the framework after a PageComponentContext
has been created for this tool window.
setContext
in interface PageComponent
context
- The tool window part.public String getId()
getId
in interface PageComponent
public String getTitle()
getTitle
in interface PageComponent
public Icon getIcon()
getIcon
in interface PageComponent
public void addPropertyChangeListener(PropertyChangeListener listener)
addPropertyChangeListener
in interface com.bc.ceres.binding.PropertyChangeEmitter
public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
addPropertyChangeListener
in interface com.bc.ceres.binding.PropertyChangeEmitter
public void removePropertyChangeListener(PropertyChangeListener listener)
removePropertyChangeListener
in interface com.bc.ceres.binding.PropertyChangeEmitter
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
removePropertyChangeListener
in interface com.bc.ceres.binding.PropertyChangeEmitter
protected void registerLocalCommandExecutors(PageComponentContext context)
context
- the view contextpublic void dispose()
Clients shall not call this method directly.
dispose
in interface PageComponent
public Container getPaneControl()
public Window getPaneWindow()
Window
ancestor of this tool window's content pane, or
null
if it is (currently) not contained inside a Window
.Window
ancestor, or null
.public void setTitle(String title)
PageComponentDescriptor.getTitle()
returns.title
- The window's title.public void componentOpened()
Clients shall not call this method directly.
componentOpened
in interface PageComponent
public void componentClosed()
Clients shall not call this method directly.
componentClosed
in interface PageComponent
public void componentShown()
Clients shall not call this method directly.
componentShown
in interface PageComponent
public void componentHidden()
Clients shall not call this method directly.
componentHidden
in interface PageComponent
public void componentFocusGained()
Clients shall not call this method directly.
componentFocusGained
in interface PageComponent
public void componentFocusLost()
Clients shall not call this method directly.
componentFocusLost
in interface PageComponent
public com.bc.ceres.swing.selection.SelectionContext getSelectionContext()
getSelectionContext
in interface PageComponent
null
if none exists.public boolean isVisible()
Copyright © 2002–2014 Brockmann Consult GmbH. All rights reserved.