Eclipse Platform
Release 3.1

org.eclipse.ui.forms
Class SectionPart

java.lang.Object
  extended byorg.eclipse.ui.forms.AbstractFormPart
      extended byorg.eclipse.ui.forms.SectionPart
All Implemented Interfaces:
IFormPart

public class SectionPart
extends AbstractFormPart

Section part implements IFormPart interface based on the Section widget. It can either wrap the widget or create one itself.

Subclasses should extend SectionPart and implement life cycle methods like refresh, commit, setFocus etc. Note that most of these methods are not empty - calling super is required.

Since:
3.0
See Also:
Section

Constructor Summary
SectionPart(Composite parent, FormToolkit toolkit, int style)
          Creates a new section part inside the provided parent and using the provided toolkit.
SectionPart(Section section)
          Creates a new section part based on the provided section.
 
Method Summary
protected  void expansionStateChanged(boolean expanded)
          The section has expanded or collapsed.
protected  void expansionStateChanging(boolean expanding)
          The section is about to expand or collapse.
 Section getSection()
          Returns the section widget used in this part.
protected  void hookListeners()
           
 void setFocus()
          Instructs the section to grab keyboard focus.
 
Methods inherited from class org.eclipse.ui.forms.AbstractFormPart
commit, dispose, getManagedForm, initialize, isDirty, isStale, markDirty, markStale, refresh, setFormInput
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SectionPart

public SectionPart(Section section)
Creates a new section part based on the provided section.

Parameters:
section - the section to use

SectionPart

public SectionPart(Composite parent,
                   FormToolkit toolkit,
                   int style)
Creates a new section part inside the provided parent and using the provided toolkit. The section part will create the section widget.

Parameters:
parent - the parent
toolkit - the toolkit to use
style - the section widget style
Method Detail

hookListeners

protected void hookListeners()

getSection

public Section getSection()
Returns the section widget used in this part.

Returns:
the section widget

expansionStateChanging

protected void expansionStateChanging(boolean expanding)
The section is about to expand or collapse.

Parameters:
expanding - true for expansion, false for collapse.

expansionStateChanged

protected void expansionStateChanged(boolean expanded)
The section has expanded or collapsed.

Parameters:
expanded - true for expansion, false for collapse.

setFocus

public void setFocus()
Instructs the section to grab keyboard focus. The default implementation will transfer focus to the section client. Subclasses may override and transfer focus to some widget in the client.

Specified by:
setFocus in interface IFormPart
Overrides:
setFocus in class AbstractFormPart

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.