org.gnu.gtk
Class ItemFactory

java.lang.Object
  |
  +--org.gnu.glib.GObject
        |
        +--org.gnu.gtk.GtkObject
              |
              +--org.gnu.gtk.ItemFactory

public class ItemFactory

extends GtkObject

Constructor Summary

ItemFactory(Type containerType, java.lang.String path, AccelGroup accelGroup)
Create a new ItemFactory object.

Method Summary

void	createItem(ItemFactoryEntry entry) Create an item for entry.
void	createItems(ItemFactoryEntry[] entries) Create the items from the entries.
void	deleteEntries(ItemFactoryEntry[] entries) Delete the menu items which were created from the entries by the item factory.
void	deleteEntry(ItemFactoryEntry entry) Delete the menu item that was created from entry by the item factory.
void	deleteItem(java.lang.String path) Delete the menu item that was created for path by the item factory.
static ItemFactory	fromWidget(Widget widget) Obtain the item factory from which a widget was created.
Widget	getItem(java.lang.String path) Obtain the menu item that corresponds to path.
static Type	getType() Retrieve the runtime type used by the GLib library.
Widget	getWidget(java.lang.String path) Obtain the widget that corresponds to path.
void	popup(int x, int y, int mouseButton) Pops up the menu constructed with the item factory.

Methods inherited from class org.gnu.gtk.GtkObject

destroy

Methods inherited from class org.gnu.glib.GObject

addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, equals, getData, getHandle, removeEventHandler, setData

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ItemFactory

public ItemFactory(Type containerType,
                   java.lang.String path,
                   AccelGroup accelGroup)

Create a new ItemFactory object.

Parameters:

containerType - The type of menu to create. It can be a MenuBar, a Menu, or an OptionMenu.

path - The factory path of the new item factory, a string of the form "".

accelGroup - A AccelGroup to which the accelerators to the menu items will be added, or null to create a new one.

Method Detail

fromWidget

public static ItemFactory fromWidget(Widget widget)

Obtain the item factory from which a widget was created.

Parameters:

widget - The widget to use for the search.

createItem

public void createItem(ItemFactoryEntry entry)

Create an item for entry.

Parameters:

entry - The IconFactoryEntry to create an item for.

createItems

public void createItems(ItemFactoryEntry[] entries)

Create the items from the entries.

Parameters:

entries - An array of IconFactoryEntry objects that describe the menus to be created.

deleteItem

public void deleteItem(java.lang.String path)

Delete the menu item that was created for path by the item factory.

Parameters:

path - The path to the item to delete.

deleteEntry

public void deleteEntry(ItemFactoryEntry entry)

Delete the menu item that was created from entry by the item factory.

Parameters:

entry - The Entry to delete.

deleteEntries

public void deleteEntries(ItemFactoryEntry[] entries)

Delete the menu items which were created from the entries by the item factory.

Parameters:

entries - The entries to delete.

getItem

public Widget getItem(java.lang.String path)

Obtain the menu item that corresponds to path.

Parameters:

path - The path to the menu item.

Returns:

The menu item for the given path or null if path doesn't exist.

getWidget

public Widget getWidget(java.lang.String path)

Obtain the widget that corresponds to path.

Parameters:

path - The path to the widget

Returns:

The widget for the given path or null if path doesn't exist.

popup

public void popup(int x,
                  int y,
                  int mouseButton)

Pops up the menu constructed with the item factory.

Parameters:

x - The x coordinate for the popup menu

y - The y coordinate for the popup menu

mouseButton - The mouse button which was pressed. These values are defined in MouseEvent.

getType

public static Type getType()

Retrieve the runtime type used by the GLib library.