public interface IEEFSection
The lifecycle of an IEEFSection is as follows:
IEEFSection.createControls()
IEEFSection.setInput()
IEEFSection.aboutToBeShown()
IEEFSection.refresh()
IEEFSection.aboutToBeHidden()
IEEFSection.dispose()
Implementors of this class should be aware that a section instance might be reused for different input objects (as
long as they are valid section inputs). It means that IEEFSection.setInput
can be called at any time
between IEEFSection.createControls
and IEEFSection.dispose
.
When an input change event occurs, such as a tab selection or a workbench selection change, an IEEFSection is sent:
IEEFSection.setInput()
IEEFSection.refresh()
When an part activation event occurs, such as the contributor part activation event, an IEEFSection is sent:
IEEFSection.setInput()
IEEFSection.aboutToBeShown()
IEEFSection.refresh()
IEEFSection.setInput()
IEEFSection.refresh()
This interface should not be extended or implemented. New section instances should be created using
AbstractEEFPropertySection
.
ISection
Modifier and Type | Method and Description |
---|---|
void |
aboutToBeHidden()
Notifies the section that its controls are about to be hidden.
|
void |
aboutToBeShown()
Notifies the section that its controls are about to be shown.
|
void |
createControls(org.eclipse.swt.widgets.Composite parent,
EEFTabbedPropertySheetPage tabbedPropertySheetPage)
Creates the controls for the section.
|
void |
dispose()
Dispose this section.
|
int |
getMinimumHeight()
Returns the minimum height needed by this section.
|
void |
refresh()
Refresh the contents of the controls displayed in this section.
|
void |
setInput(org.eclipse.ui.IWorkbenchPart part,
org.eclipse.jface.viewers.ISelection selection)
Notifies the section that the workbench selection has changed.
|
boolean |
shouldUseExtraSpace()
Determine whether this section would like extra height space in case there is some left.
|
void createControls(org.eclipse.swt.widgets.Composite parent, EEFTabbedPropertySheetPage tabbedPropertySheetPage)
Clients should take advantage of the widget factory provided by the framework to achieve a common look between property sections.
parent
- the parent composite for the section.tabbedPropertySheetPage
- the tabbed property sheet page.EEFTabbedPropertySheetPage.getWidgetFactory()
void setInput(org.eclipse.ui.IWorkbenchPart part, org.eclipse.jface.viewers.ISelection selection)
part
- The active workbench part.selection
- The active selection in the workbench part.void aboutToBeShown()
Since the controls are not visible, the section should wait for the refresh() before updating the section controls.
void aboutToBeHidden()
void dispose()
int getMinimumHeight()
SWT.DEFAULT
indicates that no
minimum height is defined.boolean shouldUseExtraSpace()
true
if this section would like extra height space.void refresh()