|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.swt.custom.ScrolledComposite
org.eclipse.ui.forms.widgets.SharedScrolledComposite
org.eclipse.ui.forms.widgets.ScrolledForm
ScrolledForm is a control that is capable of scrolling an instance of the Form class. It should be created in a parent that will allow it to use all the available area (for example, a shell, a view or an editor).
Children of the form should typically be created using FormToolkit to match the appearance and behaviour. When creating children, use a form body as a parent by calling 'getBody()' on the form instance. Example:
FormToolkit toolkit = new FormToolkit(parent.getDisplay()); ScrolledForm form = toolkit.createScrolledForm(parent); form.setText("Sample form"); form.getBody().setLayout(new GridLayout()); toolkit.createButton(form.getBody(), "Checkbox", SWT.CHECK);
No layout manager has been set on the body. Clients are required to set the desired layout manager explicitly.
Although the class is not final, it is not expected to be be extended.
Field Summary |
Fields inherited from class org.eclipse.swt.widgets.Control |
handle |
Constructor Summary | |
ScrolledForm(Composite parent)
|
|
ScrolledForm(Composite parent,
int style)
Creates the form control as a child of the provided parent. |
Method Summary | |
Image |
getBackgroundImage()
Returns the optional background image of this form. |
Composite |
getBody()
Returns the container that occupies the body of the form (the form area below the title). |
Form |
getForm()
Returns the instance of the form owned by the scrolled form. |
String |
getText()
Returns the title text that will be rendered at the top of the form. |
IToolBarManager |
getToolBarManager()
Returns the tool bar manager that is used to manage tool items in the form's title area. |
void |
reflow(boolean flushCache)
Recomputes the body layout and form scroll bars. |
void |
setBackground(Color bg)
Sets the background color of the form. |
void |
setBackgroundImage(Image backgroundImage)
Sets the optional background image to be rendered behind the title starting at the position 0,0. |
void |
setContent(Control c)
The form sets the content widget. |
void |
setForeground(Color fg)
Sets the foreground color of the form. |
void |
setMenu(Menu menu)
Passes the menu to the body. |
void |
setText(String text)
Sets the text to be rendered at the top of the form above the body as a title. |
void |
updateToolBar()
Updates the local tool bar manager if used. |
Methods inherited from class org.eclipse.ui.forms.widgets.SharedScrolledComposite |
setFocus, setFont |
Methods inherited from class org.eclipse.swt.custom.ScrolledComposite |
computeSize, getAlwaysShowScrollBars, getContent, getOrigin, layout, setAlwaysShowScrollBars, setExpandHorizontal, setExpandVertical, setLayout, setMinHeight, setMinSize, setMinSize, setMinWidth, setOrigin, setOrigin |
Methods inherited from class org.eclipse.swt.widgets.Composite |
checkSubclass, getChildren, getLayout, getTabList, layout, setTabList |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
computeTrim, getClientArea, getHorizontalBar, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ScrolledForm(Composite parent)
public ScrolledForm(Composite parent, int style)
parent
- the parent widgetMethod Detail |
public void setMenu(Menu menu)
setMenu
in class Control
menu
- public String getText()
public void setForeground(Color fg)
setForeground
in class SharedScrolledComposite
fg
- the new foreground colorpublic void setBackground(Color bg)
setBackground
in class SharedScrolledComposite
bg
- the new background colorpublic final void setContent(Control c)
setContent
in class SharedScrolledComposite
public void setText(String text)
text
- the title textpublic Image getBackgroundImage()
public void setBackgroundImage(Image backgroundImage)
backgroundImage
- The backgroundImage to set.public IToolBarManager getToolBarManager()
public void updateToolBar()
public void reflow(boolean flushCache)
reflow
in class SharedScrolledComposite
flushCache
- if true , drop any cached layout information and
compute new one.public Composite getBody()
public Form getForm()
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.