Class AbstractPropertySection
- java.lang.Object
-
- org.eclipse.ui.views.properties.tabbed.AbstractPropertySection
-
- All Implemented Interfaces:
ISection
- Direct Known Subclasses:
AbstractOverridableTabListPropertySection,AdvancedPropertySection
public abstract class AbstractPropertySection extends Object implements ISection
An abstract implementation of a section in a tab in the tabbed property sheet page.
-
-
Field Summary
Fields Modifier and Type Field Description static intSTANDARD_LABEL_WIDTHThe standard label width when labels for sections line up on the left hand side of the composite.
-
Constructor Summary
Constructors Constructor Description AbstractPropertySection()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaboutToBeHidden()Notifies the section that its controls are about to be hidden.voidaboutToBeShown()Notifies the section that its controls are about to be shown.voidcreateControls(Composite parent, TabbedPropertySheetPage aTabbedPropertySheetPage)Creates the controls for the section.voiddispose()Dispose this section.intgetMinimumHeight()Returns the minimum height needed by this section.IWorkbenchPartgetPart()ISelectiongetSelection()Get the current workbench selection.TabbedPropertySheetWidgetFactorygetWidgetFactory()Get the widget factory for the property sheet page.voidrefresh()Refresh the contents of the controls displayed in this section.voidsetInput(IWorkbenchPart part, ISelection selection)Notifies the section that the workbench selection has changed.booleanshouldUseExtraSpace()Determine whether this section would like extra height space in case there is some left.
-
-
-
Field Detail
-
STANDARD_LABEL_WIDTH
public static final int STANDARD_LABEL_WIDTH
The standard label width when labels for sections line up on the left hand side of the composite.- See Also:
- Constant Field Values
-
-
Method Detail
-
getWidgetFactory
public TabbedPropertySheetWidgetFactory getWidgetFactory()
Get the widget factory for the property sheet page.- Returns:
- the widget factory.
-
getSelection
public ISelection getSelection()
Get the current workbench selection.- Returns:
- the current workbench selection.
-
getPart
public IWorkbenchPart getPart()
- Returns:
- Returns the part.
-
createControls
public void createControls(Composite parent, TabbedPropertySheetPage aTabbedPropertySheetPage)
Description copied from interface:ISectionCreates the controls for the section.Clients should take advantage of the widget factory provided by the framework to achieve a common look between property sections.
- Specified by:
createControlsin interfaceISection- Parameters:
parent- the parent composite for the section.aTabbedPropertySheetPage- the tabbed property sheet page.- See Also:
TabbedPropertySheetPage.getWidgetFactory()
-
setInput
public void setInput(IWorkbenchPart part, ISelection selection)
Description copied from interface:ISectionNotifies the section that the workbench selection has changed.
-
aboutToBeShown
public void aboutToBeShown()
Description copied from interface:ISectionNotifies the section that its controls are about to be shown. It is expected that sections enable domain related functions in this method, most commonly add listeners.Since the controls are not visible, the section should wait for the refresh() before updating the section controls.
- Specified by:
aboutToBeShownin interfaceISection
-
aboutToBeHidden
public void aboutToBeHidden()
Description copied from interface:ISectionNotifies the section that its controls are about to be hidden. It is expected that sections disable domain related functions in this method, most commonly remove listeners.- Specified by:
aboutToBeHiddenin interfaceISection
-
dispose
public void dispose()
Description copied from interface:ISectionDispose this section.
-
getMinimumHeight
public int getMinimumHeight()
Description copied from interface:ISectionReturns the minimum height needed by this section. A return value ofSWT.DEFAULTindicates that no minimum height is defined.- Specified by:
getMinimumHeightin interfaceISection- Returns:
- the minimum height needed by this section.
-
shouldUseExtraSpace
public boolean shouldUseExtraSpace()
Description copied from interface:ISectionDetermine whether this section would like extra height space in case there is some left. Normally this is true when the section is the last to be displayed on a tab or is the only section on a tab.- Specified by:
shouldUseExtraSpacein interfaceISection- Returns:
trueif this section would like extra height space.
-
-