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
Adjustment
objects.
For Widgets that lack native scrolling support the
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
Adjustment
for details on how to determine the position of the
layout.
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.
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.
- 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.
- getType in interface Bin
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.
- 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.
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.
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.
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.
type
- The type of shadow to draw.
setVAdjustment
public void setVAdjustment(Adjustment vadj)
Sets the vertical Scrollbar's Adjustment.
vadj
- The vertical Adjustment.