org.gnome.gtk
Class Toolbar

java.lang.Object
  org.freedesktop.bindings.Pointer
      org.freedesktop.bindings.Proxy
          org.gnome.glib.Object
              org.gnome.gtk.Object
                  org.gnome.gtk.Widget
                      org.gnome.gtk.Container
                          org.gnome.gtk.Toolbar

public class Toolbar
extends Container

A Toolbar is a broad horizontal bar with several controls (usually largish graphical buttons) intended to provide a fast and convenient access to operations commonly used in an application.

In most cases, you will want to add some ToolButtons to the Toolbar, but you can also add other elements as well by creating a ToolItem and adding your own customized elements to it.

You can also group related items together by using a SeparatorToolItem to the Toolbar to create a separation between them. Don't overdo that, however - too many separators result in a cluttered appearance.

Note that the actual on screen appearance of the Toolbar is governed by the user's theme and how they have configured Toolbars to appear. The choices of "Text below Icons" (the usual default), "Text beside Icons", "Icons only", and "Text only" are available from the GNOME panel menu at System > Menus & Toolbars which runs the gnome-ui-properties program.

Since:

4.0.4

Author:

Vreixo Formoso, Andrew Cowie

Nested Class Summary

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.ButtonPressEvent, Widget.ButtonReleaseEvent, Widget.EnterNotifyEvent, Widget.ExposeEvent, Widget.FocusInEvent, Widget.FocusOutEvent, Widget.Hide, Widget.KeyPressEvent, Widget.KeyReleaseEvent, Widget.LeaveNotifyEvent, Widget.MapEvent, Widget.PopupMenu, Widget.UnmapEvent, Widget.VisibilityNotifyEvent

Constructor Summary

Toolbar()
Create a new, empty, Toolbar.

Method Summary

void	add(Widget w) Add a child Widget to this Container.
void	insert(ToolItem item, int pos) Insert a ToolItem in the Toolbar at a given position.
void	setOrientation(Orientation orientation) Sets the orientation of the Toolbar on screen.

Methods inherited from class org.gnome.gtk.Container

getChildren, remove, setBorderWidth

Methods inherited from class org.gnome.gtk.Widget

activate, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, getAllocation, getCanDefault, getCanFocus, getHasFocus, getParent, getRequisition, getToplevel, getWindow, grabDefault, grabFocus, hide, modifyBackground, modifyBase, modifyText, setCanDefault, setCanFocus, setSensitive, setSizeRequest, setTooltipMarkup, setTooltipText, show, showAll

Methods inherited from class org.freedesktop.bindings.Pointer

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Toolbar

public Toolbar()

Create a new, empty, Toolbar.

Method Detail

add

public void add(Widget w)

Description copied from class: Container

Add a child Widget to this Container. This works for all the various Container types, of course, but most offer more specialized packing methods that allow you to control the positioning of the Widget being added with greater finesse.

Overrides:

add in class Container

insert

public void insert(ToolItem item,
                   int pos)

Insert a ToolItem in the Toolbar at a given position.

Parameters:

item - The new item to add to the Toolbar.

pos - The position where the new item will be inserted. You can use 0 to prepend the item at the beginning of the Toolbar, or a negative value to append the item at the end.

setOrientation

public void setOrientation(Orientation orientation)

Sets the orientation of the Toolbar on screen.

Horizontal Toolbars are commonly used. Usually you shouldn't use a vertical Toolbar it is more difficult to search for the user to find a specific control. When your application has several Toolbars, however, a vertical orientation can become useful as a technique to make a better usage of the available screen real estate.