org.gnu.gnome

Class App


public class App
extends Window

The App widget is the main window of a GNOME application. It is a container widget that can hold a single child widget. It also includes facilities for attaching menus, toolbars, a status bar, and widgets that can be docked.

Constructor Summary

App(Handle handle)
App(String appname, String title)
Instantiates a new Application window with the indicated name and title.

Method Summary

void
createMenus(UIInfo[] uiinfos)
Construct a menu bar and attach it to the specified application window.
void
createToolBar(UIInfo[] uiinfos)
Construct a toolbar and attach it to the specified application window.
Widget
error(String error)
Deprecated.
void
fillMenu(MenuShell menuShell, UIInfo[] uiinfos, AccelGroup accelGroup, boolean underline, int position)
Fills the specified MenuShell with items created from the UIInfo array, inserting them from the item number position on.
void
fillToolbar(ToolBar toolbar, UIInfo[] uiinfos, AccelGroup accelGroup)
Fills a ToolBar with the specified UIInfos.
void
flash(String flash)
Deprecated.
AccelGroup
getAccelGroup()
Main accelerator group for this window (hotkeys live here).
static App
getApp(Handle handle)
Internal static factory method to be used by Java-Gnome only.
Widget
getContents()
Returns the contents of the App.
Widget
getDock()
Returns the dock.
MenuBar
getMenuBar()
Returns the menu bar.
String
getName()
Gets the name of the application.
String
getPrefix()
Gets the prefix for gnome-config, which is used to save the layout.
StatusBar
getStatusBar()
Gets the status bar of the application windows.
static Type
getType()
Retrieve the runtime type used by the GLib library.
VBox
getVBox()
From gnome-app.hThe vbox widget that ties them.
void
insertMenu(String path, UIInfo[] uiinfos)
Inserts a menu in the existing app's menu structure right after the item described by path.
void
installAppBarMenuHints(AppBar appBar, UIInfo[] uiinfos)
Activate the menu item hints, displaying in an appbar.
void
installMenuHints(UIInfo[] uiinfos)
Activate the menu item hings, displaying in the statusbar or appbar.
void
installStatusBarMenuHints(StatusBar statusBar, UIInfo[] uiinfos)
Activate the menu item hints, displaying in a statusbar.
boolean
layoutConfig()
If true, the application uses gnome-config to retrieve and save the docking configuration automatically.
void
layoutConfig(boolean enabled)
If true, the application uses gnome-config to retrieve and save the docking configuration automatically.
Widget
message(String message)
Deprecated.
void
removeMenuRange(String path, int start, int numItems)
Removes items from the Menu.
void
removeMenus(String path, int num)
Removes num items from the existing app's menu structure beginning with the item described by path.
void
setContent(Widget contents)
Sets the content area of the application window.
void
setMenuBar(MenuBar menuBar)
Sets the menu bar of the window.
void
setStatusBar(StatusBar statusBar)
Sets the status bar of the application window.
void
setStatusBar(StatusBar statusBar, Container container)
Sets the status bar of the application window, but uses the given container widget rather than creating a new one.
void
setStatusBar(AppBar appBar)
Sets the status bar of the application window.
void
setStatusBar(AppBar appBar, Container container)
Sets the status bar of the application window, but uses the given container widget rather than creating a new one.
void
setToolBar(ToolBar toolBar)
Sets the tool bar of the window.
Widget
warning(String warning)
Deprecated.

Constructor Details

App

public App(Handle handle)

App

public App(String appname,
           String title)
Instantiates a new Application window with the indicated name and title.
Parameters:
appname - The name of the application.
title - The title of the application window. The title can be null, in which case the window's title will not be set.

Method Details

createMenus

public void createMenus(UIInfo[] uiinfos)
Construct a menu bar and attach it to the specified application window.
Parameters:
uiinfos - An array of UIInfo objects that define the menu.

createToolBar

public void createToolBar(UIInfo[] uiinfos)
Construct a toolbar and attach it to the specified application window.
Parameters:
uiinfos - An array of UIInfo objects that define the toolbar.

error

public Widget error(String error)

Deprecated.

Display an important error message in an OK dialog or the status bar.
Parameters:
error - The text to display.
Returns:
The dialog created or null.
See Also:
org.gnu.gtk.MessageDialog

fillMenu

public void fillMenu(MenuShell menuShell,
                     UIInfo[] uiinfos,
                     AccelGroup accelGroup,
                     boolean underline,
                     int position)
Fills the specified MenuShell with items created from the UIInfo array, inserting them from the item number position on. The AccelGroup will be used for all newly created sub menus and servers as the global AccelGroup for all menu item hotkeys.
Parameters:
menuShell -
uiinfos -
accelGroup -
underline -
position -

fillToolbar

public void fillToolbar(ToolBar toolbar,
                        UIInfo[] uiinfos,
                        AccelGroup accelGroup)
Fills a ToolBar with the specified UIInfos.
Parameters:
toolbar -
uiinfos -
accelGroup -

flash

public void flash(String flash)

Deprecated.

Flash a message in the status bar for a few moments. If this app doesn't have a status bar this method will do nothing.
Parameters:
flash - The message to flash.

getAccelGroup

public AccelGroup getAccelGroup()
Main accelerator group for this window (hotkeys live here).
Returns:
The accelorator group.

getApp

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

getContents

public Widget getContents()
Returns the contents of the App.

getDock

public Widget getDock()
Returns the dock.
Returns:
The dock.

getMenuBar

public MenuBar getMenuBar()
Returns the menu bar.
Returns:
The MenuBar.

getName

public String getName()
Gets the name of the application.
Returns:
The name of the application.

getPrefix

public String getPrefix()
Gets the prefix for gnome-config, which is used to save the layout.
Returns:
The prefix for gnome-config.

getStatusBar

public StatusBar getStatusBar()
Gets the status bar of the application windows.
Returns:
The status bar.

getType

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

getVBox

public VBox getVBox()
From gnome-app.hThe vbox widget that ties them.
Returns:
The VBox.

insertMenu

public void insertMenu(String path,
                       UIInfo[] uiinfos)
Inserts a menu in the existing app's menu structure right after the item described by path.
Parameters:
path - The path to the item that preceeds the insertion.
uiinfos - An array of UIInfo objects that describe the menu to be inserted.

installAppBarMenuHints

public void installAppBarMenuHints(AppBar appBar,
                                   UIInfo[] uiinfos)
Activate the menu item hints, displaying in an appbar.
Parameters:
appBar - The AppBar to install the hints.
uiinfos - An array of UIInfo objects that contain the menu items for which the hints will be created.

installMenuHints

public void installMenuHints(UIInfo[] uiinfos)
Activate the menu item hings, displaying in the statusbar or appbar.
Parameters:
uiinfos - An array of UIInfo objects that contain the menu items for which the hints will be created.

installStatusBarMenuHints

public void installStatusBarMenuHints(StatusBar statusBar,
                                      UIInfo[] uiinfos)
Activate the menu item hints, displaying in a statusbar.
Parameters:
statusBar - The StatusBar to install the hints.
uiinfos - An array of UIInfo objects that contain the menu items for which the hints will be created.

layoutConfig

public boolean layoutConfig()
If true, the application uses gnome-config to retrieve and save the docking configuration automatically.
Returns:
True if the docking configuration is to be handled & automatically, else false.

layoutConfig

public void layoutConfig(boolean enabled)
If true, the application uses gnome-config to retrieve and save the docking configuration automatically.
Parameters:
enabled - True if the docking configuration is to be handled automatically, else false.

message

public Widget message(String message)

Deprecated.

Display a simple message in an OK dialog or the status bar. Requires confirmation from the user before it goes away.
Parameters:
message - The text to display.
Returns:
The dialog created or null.
See Also:
org.gnu.gtk.MessageDialog

removeMenuRange

public void removeMenuRange(String path,
                            int start,
                            int numItems)
Removes items from the Menu.
Parameters:
path -
start -
numItems -

removeMenus

public void removeMenus(String path,
                        int num)
Removes num items from the existing app's menu structure beginning with the item described by path.
Parameters:
path - The path to first item to remove.
num - The number of items to remove.

setContent

public void setContent(Widget contents)
Sets the content area of the application window.
Parameters:
contents - The widget that contains the content of the window.

setMenuBar

public void setMenuBar(MenuBar menuBar)
Sets the menu bar of the window.
Parameters:
menuBar - The menu bar to be used for the window.

setStatusBar

public void setStatusBar(StatusBar statusBar)
Sets the status bar of the application window.
Parameters:
statusBar - The status bar to use for the window.

setStatusBar

public void setStatusBar(StatusBar statusBar,
                         Container container)
Sets the status bar of the application window, but uses the given container widget rather than creating a new one.
Parameters:
statusBar - The status bar to use for the window.
container - The container for the status bar.

setStatusBar

public void setStatusBar(AppBar appBar)
Sets the status bar of the application window.
Parameters:
appBar - The app bar to use for the window.

setStatusBar

public void setStatusBar(AppBar appBar,
                         Container container)
Sets the status bar of the application window, but uses the given container widget rather than creating a new one.
Parameters:
appBar - The app bar to use for the window.
container - The container for the status bar.

setToolBar

public void setToolBar(ToolBar toolBar)
Sets the tool bar of the window.
Parameters:
toolBar - The tool bar to be used for the window.

warning

public Widget warning(String warning)

Deprecated.

Display a not-so-important error message in an OK dialog or the status bar.
Parameters:
warning - The text to display.
Returns:
The dialog created or null.
See Also:
org.gnu.gtk.MessageDialog