public class ScrolledForm extends SharedScrolledComposite
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.
Constructor and Description |
---|
ScrolledForm(Composite parent) |
ScrolledForm(Composite parent,
int style)
Creates the form control as a child of the provided parent.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Image |
getImage()
Returns the title image that will be rendered to the left of the title.
|
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 |
setImage(Image image)
Sets the image to be rendered to the left of the title.
|
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.
|
isDelayedReflow, layout, setDelayedReflow, setExpandHorizontal, setExpandVertical, setFocus, setFont
getAlwaysShowScrollBars, getContent, getExpandHorizontal, getExpandVertical, getMinHeight, getMinWidth, getOrigin, setAlwaysShowScrollBars, setLayout, setMinHeight, setMinSize, setMinSize, setMinWidth, setOrigin, setOrigin
changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, setBackgroundMode, setLayoutDeferred, setTabList
computeTrim, getClientArea, getHorizontalBar, getVerticalBar
addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBounds, setBounds, setCapture, setCursor, setEnabled, setLayoutData, setLocation, setLocation, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
public ScrolledForm(Composite parent)
public ScrolledForm(Composite parent, int style)
parent
- the parent widgetpublic void setMenu(Menu menu)
public String getText()
public Image getImage()
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
c
- the control to be displayed in the content areapublic void setText(String text)
text
- the title textpublic void setImage(Image image)
image
- the title image or null
for no image.public Image getBackgroundImage()
getBackgroundImage
in class Control
public void setBackgroundImage(Image backgroundImage)
setBackgroundImage
in class Control
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()
Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.