|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a section of properties for a given input.
The lifecycle of an ISection is as follows:
ISection.createControls()
ISection.setInput()
ISection.aboutToBeShown()
ISection.refresh()
ISection.aboutToBeHidden()
ISection.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 ISection.setInput
can be called at any
time between ISection.createControls
and
ISection.dispose
.
When an input change event occurs, such as a tab selection or a workbench selection change, an ISection is sent:
ISection.setInput()
ISection.refresh()
When an part activation event occurs, such as the contributor part activation event, an ISection is sent:
ISection.setInput()
ISection.aboutToBeShown()
ISection.refresh()
ISection.setInput()
ISection.refresh()
This interface should not be extended or implemented. New section instances
should be created using AbstractPropertySection
.
TabbedPropertySheetPage
Method Summary | |
---|---|
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(Composite parent,
TabbedPropertySheetPage 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(IWorkbenchPart part,
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. |
Method Detail |
public void createControls(Composite parent, TabbedPropertySheetPage 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.TabbedPropertySheetPage.getWidgetFactory()
public void setInput(IWorkbenchPart part, ISelection selection)
part
- The active workench part.selection
- The active selection in the workbench part.public void aboutToBeShown()
Since the controls are not visible, the section should wait for the refresh() before updating the section controls.
public void aboutToBeHidden()
public void dispose()
public int getMinimumHeight()
SWT.DEFAULT
indicates that no minimum height is defined.
public boolean shouldUseExtraSpace()
true
if this section would like extra height space.public void refresh()
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.