org.gnu.gtk

Class ScrolledWindow

public class ScrolledWindow extends Bin

A ScrolledWindow is a Bin subclass; it's a container that accepts a single child widget. ScrolledWindow adds scrollbars to the child widget and optionally draws a beveled frame around the child widget.

The ScrolledWindow works in two ways. Some Widgets have native scrolling support; these widgets have "slots" for {@link Adjustment} objects.

For Widgets that lack native scrolling support the {@link Viewport} Widget acts as an adaptor class, implementing scrollability for child Widgets that lack their own scrolling capability.

If a Widget has native scrolling capabilities it can be added with the add method. If a Widget does not, you must first add the Widget to a Viewport and then add the Viewport to the ScrolledWindow. The convenience method addWithViewport does exactly this, so you can ignore the presence of the Viewport.

The position of the scrollbars is controlled by the scroll adjustments. See {@link Adjustment} for details on how to determine the position of the layout.

Constructor Summary
ScrolledWindow(Adjustment hadj, Adjustment vadj)
Create a new ScrolledWindow object.
ScrolledWindow()
Creates a new ScrolledWindow object.
ScrolledWindow(Handle handle)
Construct a ScrolledWindow using a handle to a native resource.
Method Summary
voidaddWithViewport(Widget child)
Used to add children without native scrolling capability.
AdjustmentgetHAdjustment()
Returns the horizontal Scrollbar's Adjustment.
HScrollBargetHScrollBar()
Return the horizontal ScrollBar.
static ScrolledWindowgetScrolledWindow(Handle handle)
Internal static factory method to be used by Java-Gnome only.
static TypegetType()
Retrieve the runtime type used by the GLib library.
AdjustmentgetVAdjustment()
Returns the vertical Scrollbar's Adjustment.
VScrollBargetVScrollBar()
Return the vertical ScrollBar.
voidsetHAdjustment(Adjustment hadj)
Sets the horizontal Scrollbar's Adjustment.
voidsetPlacement(CornerType windowPlacement)
Determines the location of the child widget with respect to the scrollbars.
voidsetPolicy(PolicyType hScrollBarPolicy, PolicyType vScrollBarPolicy)
Sets the scrollbar policy for the horizontal and vertical scrollbars.
voidsetShadowType(ShadowType type)
Changes the type of shadow drawn around the contents of the ScrolledWindow.
voidsetVAdjustment(Adjustment vadj)
Sets the vertical Scrollbar's Adjustment.

Constructor Detail

ScrolledWindow

public ScrolledWindow(Adjustment hadj, Adjustment vadj)
Create a new ScrolledWindow object. The two arguments are the ScrolledWindow's Adjustments; these will be shared with the scrollbars and the child widgets to keep the bars in sync with the child.

Parameters: hadj The horizontal Adjustment. vadj The vertical Adjustment.

ScrolledWindow

public ScrolledWindow()
Creates a new ScrolledWindow object. This constuctor generates {@link Adjustment}s automatically.

ScrolledWindow

public ScrolledWindow(Handle handle)
Construct a ScrolledWindow using a handle to a native resource.

Method Detail

addWithViewport

public void addWithViewport(Widget child)
Used to add children without native scrolling capability. This is simply a convenience method, it is equivalent to adding the unscrollable child to a Viewport, then adding the Viewport to the ScrolledWindow.

Parameters: child The Widget to add to the ScrolledWindow.

getHAdjustment

public Adjustment getHAdjustment()
Returns the horizontal Scrollbar's Adjustment. This can be used to connect the horizontal Scrollbar to the child Widget's horizontal scroll functionality.

Returns: The horizontal Scrollbar's Adjustment.

getHScrollBar

public HScrollBar getHScrollBar()
Return the horizontal ScrollBar.

getScrolledWindow

public static ScrolledWindow getScrolledWindow(Handle handle)
Internal static factory method to be used by Java-Gnome only.

getType

public static Type getType()
Retrieve the runtime type used by the GLib library.

getVAdjustment

public Adjustment getVAdjustment()
Returns the vertical Scrollbar's Adjustment. This can be used to connect the vertical Scrollbar to the child Widget's vertical scroll functionality.

Returns: The vertical Scrollbar's Adjustment.

getVScrollBar

public VScrollBar getVScrollBar()
Return the vertical ScrollBar.

setHAdjustment

public void setHAdjustment(Adjustment hadj)
Sets the horizontal Scrollbar's Adjustment.

Parameters: hadj The horizontal Adjustment.

setPlacement

public void setPlacement(CornerType windowPlacement)
Determines the location of the child widget with respect to the scrollbars. The default is CORNER_TOP_LEFT, meaning the child is in the top left, with the scrollbar underneath and to the right.

Parameters: windowPlacement The placement for the child widget.

setPolicy

public void setPolicy(PolicyType hScrollBarPolicy, PolicyType vScrollBarPolicy)
Sets the scrollbar policy for the horizontal and vertical scrollbars. The policy determines when the scrollbar should appear.

Parameters: hScrollBarPolicy The policy for the horizontal ScrollBar. vScrollBarPolicy The policy for the vertical ScrollBar.

setShadowType

public void setShadowType(ShadowType type)
Changes the type of shadow drawn around the contents of the ScrolledWindow.

Parameters: type The type of shadow to draw.

setVAdjustment

public void setVAdjustment(Adjustment vadj)
Sets the vertical Scrollbar's Adjustment.

Parameters: vadj The vertical Adjustment.