Standard Widget Toolkit for GTK 3.125.0 · org.eclipse.swt.custom.ScrolledComposite

A ScrolledComposite provides scrollbars and will scroll its content when the user uses the scrollbars.

There are two ways to use the ScrolledComposite:

Set the size of the control that is being scrolled and the ScrolledComposite will show scrollbars when the contained control can not be fully seen.
The second way imitates the way a browser would work. Set the minimum size of the control and the ScrolledComposite will show scroll bars if the visible area is less than the minimum size of the control and it will expand the size of the control if the visible area is greater than the minimum size. This requires invoking both setMinWidth(), setMinHeight() and setExpandHorizontal(), setExpandVertical().


public static void main (String [] args) {
     Display display = new Display ();
     Color red = display.getSystemColor(SWT.COLOR_RED);
     Color blue = display.getSystemColor(SWT.COLOR_BLUE);
     Shell shell = new Shell (display);
     shell.setLayout(new FillLayout());

     // set the size of the scrolled content - method 1
     final ScrolledComposite sc1 = new ScrolledComposite(shell, SWT.H_SCROLL | SWT.V_SCROLL | SWT.BORDER);
     final Composite c1 = new Composite(sc1, SWT.NONE);
     sc1.setContent(c1);
     c1.setBackground(red);
     GridLayout layout = new GridLayout();
     layout.numColumns = 4;
     c1.setLayout(layout);
     Button b1 = new Button (c1, SWT.PUSH);
     b1.setText("first button");
     c1.setSize(c1.computeSize(SWT.DEFAULT, SWT.DEFAULT));

     // set the minimum width and height of the scrolled content - method 2
     final ScrolledComposite sc2 = new ScrolledComposite(shell, SWT.H_SCROLL | SWT.V_SCROLL | SWT.BORDER);
     sc2.setExpandHorizontal(true);
     sc2.setExpandVertical(true);
     final Composite c2 = new Composite(sc2, SWT.NONE);
     sc2.setContent(c2);
     c2.setBackground(blue);
     layout = new GridLayout();
     layout.numColumns = 4;
     c2.setLayout(layout);
     Button b2 = new Button (c2, SWT.PUSH);
     b2.setText("first button");
     sc2.setMinSize(c2.computeSize(SWT.DEFAULT, SWT.DEFAULT));

     Button add = new Button (shell, SWT.PUSH);
     add.setText("add children");
     final int[] index = new int[]{0};
     add.addListener(SWT.Selection, new Listener() {
         public void handleEvent(Event e) {
             index[0]++;
             Button button = new Button(c1, SWT.PUSH);
             button.setText("button "+index[0]);
             // reset size of content so children can be seen - method 1
             c1.setSize(c1.computeSize(SWT.DEFAULT, SWT.DEFAULT));
             c1.layout();

             button = new Button(c2, SWT.PUSH);
             button.setText("button "+index[0]);
             // reset the minimum width and height so children can be seen - method 2
             sc2.setMinSize(c2.computeSize(SWT.DEFAULT, SWT.DEFAULT));
             c2.layout();
         }
     });

     shell.open ();
     while (!shell.isDisposed ()) {
         if (!display.readAndDispatch ()) display.sleep ();
     }
     display.dispose ();
}

Styles:: H_SCROLL, V_SCROLL

Field Summary

Modifier and Type	Field and Description
pack-priv boolean	alwaysShowScroll
pack-priv Control	content
pack-priv Listener	contentListener
pack-priv boolean	expandHorizontal
pack-priv boolean	expandVertical
pack-priv Listener	filter
pack-priv int	minHeight
pack-priv int	minWidth
pack-priv boolean	showFocusedControl
pack-priv boolean	showNextFocusedControl

Inherited from org.eclipse.swt.widgets.Composite:: embeddedHandle

Constructor Summary

Access	Constructor and Description
public	ScrolledComposite(Composite a widget which will be the parent of the new instance (cannot be null) parent, int the style of widget to construct style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Modifier and Type	Method and Description
pack-priv static int	checkStyle(int style) Hides org.eclipse.swt.widgets.Composite.checkStyle.
pack-priv boolean	contains(Control control)
public boolean	Returns: the Always Show Scrollbars flag value getAlwaysShowScrollBars() Returns the Always Show Scrollbars flag.
public Control	Returns: the control displayed in the content area getContent() Get the content that is being scrolled.
public boolean	Returns: the receiver's horizontal expansion state getExpandHorizontal() Returns `true` if the content control will be expanded to fill available horizontal space.
public boolean	Returns: the receiver's vertical expansion state getExpandVertical() Returns `true` if the content control will be expanded to fill available vertical space.
public int	Returns: the minimum height getMinHeight() Returns the minimum height of the content control.
public int	Returns: the minimum width getMinWidth() Returns the minimum width of the content control.
public Point	Returns: the point in the content that currently appears in the top left corner of the scrolled composite. If no content has been set, this returns (0, 0). getOrigin() Return the point in the content that currently appears in the top left corner of the scrolled composite.
public boolean	Returns: a boolean indicating whether focused child controls are automatically scrolled into the viewport getShowFocusedControl() Returns `true` if the receiver automatically scrolls to a focused child control to make it visible.
pack-priv void	hScroll()
pack-priv boolean	needHScroll(Rectangle contentRect, boolean vVisible)
pack-priv boolean	needVScroll(Rectangle contentRect, boolean hVisible)
public void	setAlwaysShowScrollBars(boolean true to show the scrollbars even when not required, false to show scrollbars only when required show) Set the Always Show Scrollbars flag.
public void	setContent(Control the control to be displayed in the content area content) Set the content that will be scrolled.
public void	setExpandHorizontal(boolean true to expand the content control to fill available horizontal space expand) Configure the ScrolledComposite to resize the content object to be as wide as the ScrolledComposite when the width of the ScrolledComposite is greater than the minimum width specified in setMinWidth.
public void	setExpandVertical(boolean true to expand the content control to fill available vertical space expand) Configure the ScrolledComposite to resize the content object to be as tall as the ScrolledComposite when the height of the ScrolledComposite is greater than the minimum height specified in setMinHeight.
public void	setLayout(Layout the receiver's new layout or null layout) Overrides org.eclipse.swt.widgets.Composite.setLayout. Sets the layout which is associated with the receiver to be the argument which may be null.
public void	setMinHeight(int the minimum height or 0 for default height height) Specify the minimum height at which the ScrolledComposite will begin scrolling the content with the vertical scroll bar.
public void	setMinSize(Point the minimum size or null for the default size size) Specify the minimum width and height at which the ScrolledComposite will begin scrolling the content with the horizontal scroll bar.
public void	setMinSize(int the minimum width or 0 for default width width, int the minimum height or 0 for default height height) Specify the minimum width and height at which the ScrolledComposite will begin scrolling the content with the horizontal scroll bar.
public void	setMinWidth(int the minimum width or 0 for default width width) Specify the minimum width at which the ScrolledComposite will begin scrolling the content with the horizontal scroll bar.
public void	setOrigin(Point the point on the content to appear in the top left corner origin) Scrolls the content so that the specified point in the content is in the top left corner.
public void	setOrigin(int the x coordinate of the content to appear in the top left corner x, int the y coordinate of the content to appear in the top left corner y) Scrolls the content so that the specified point in the content is in the top left corner.
public void	setShowFocusedControl(boolean `true` to show a focused control. show) Configure the receiver to automatically scroll to a focused child control to make it visible.
public void	showControl(Control the control to be shown control) Scrolls the content of the receiver so that the control is visible.
pack-priv void	vScroll()

Field Detail

alwaysShowScroll	back to summary
pack-priv boolean alwaysShowScroll

content	back to summary
pack-priv Control content

contentListener	back to summary
pack-priv Listener contentListener

expandHorizontal	back to summary
pack-priv boolean expandHorizontal

expandVertical	back to summary
pack-priv boolean expandVertical

filter	back to summary
pack-priv Listener filter

minHeight	back to summary
pack-priv int minHeight

minWidth	back to summary
pack-priv int minWidth

showFocusedControl	back to summary
pack-priv boolean showFocusedControl

showNextFocusedControl	back to summary
pack-priv boolean showNextFocusedControl

Constructor Detail

ScrolledComposite back to summary

ScrolledComposite	back to summary
public ScrolledComposite(Composite parent, int style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. The style value is either one of the style constants defined in class `SWT` which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the `int` "\|" operator) two or more of those `SWT` style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses. Parameters parent:Composite a widget which will be the parent of the new instance (cannot be null) style:int the style of widget to construct Exceptions IllegalArgumentException: ERROR_NULL_ARGUMENT - if the parent is null SWTException: ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent See Also `SWT#H_SCROLL`, `SWT#V_SCROLL`, `getStyle()`

public ScrolledComposite(Composite parent, int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters

parent:Composite: a widget which will be the parent of the new instance (cannot be null)
style:int: the style of widget to construct

Exceptions

IllegalArgumentException:

ERROR_NULL_ARGUMENT - if the parent is null