net.sf.genuine.organizer.internal
Class Item

java.lang.Object
  net.sf.genuine.organizer.internal.Item

Direct Known Subclasses:

MenuItem, ToolBarButton

class Item

extends java.lang.Object

Base class for all objects that are used by the MenuBarBuilder and the ToolBarBuilder. It reads XML configuration that contains information about a item that is placed on the menu bar or on the tool bar.

Author:

Tim Wellhausen

Constructor Summary

(package private)	Item() Empty
(package private)	Item(org.jdom.Element itemElement) Reads all information from the given XML element
(package private)	Item(Module module, org.jdom.Element itemElement) Takes a item element and a reference to the module.

Method Summary

protected GenuineAction	getAction() Returns the action instance that is referred to by this objects id by retrieving it from the module.
protected java.lang.String	getBehindOfItemId() This menu item may have declared to be put behind another menu item.
protected java.lang.String	getId() Returns the menu item's id.
protected java.lang.String	getInFrontOfItemId() This menu item may have declared to be put in front of another menu item.
protected boolean	isSeparatorBehind() Returns true if a separator should appear behind this menu item.
protected boolean	isSeparatorInFront() Returns true if a separator should appear in front of this menu item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Item

Item()

Empty

Item

Item(org.jdom.Element itemElement)
throws ConfigurationException

Reads all information from the given XML element

Item

Item(Module module,
     org.jdom.Element itemElement)
throws ConfigurationException

Takes a item element and a reference to the module.

Method Detail

getId

protected java.lang.String getId()

Returns the menu item's id.

isSeparatorInFront

protected boolean isSeparatorInFront()

Returns true if a separator should appear in front of this menu item.

isSeparatorBehind

protected boolean isSeparatorBehind()

Returns true if a separator should appear behind this menu item.

getInFrontOfItemId

protected java.lang.String getInFrontOfItemId()

This menu item may have declared to be put in front of another menu item. If that is the case this method returns the id of the other menu item, otherwise null.

getBehindOfItemId

protected java.lang.String getBehindOfItemId()

This menu item may have declared to be put behind another menu item. If that is the case this method returns the id of the other menu item, otherwise null.

getAction

protected GenuineAction getAction()
                           throws ConfigurationException

Returns the action instance that is referred to by this objects id by retrieving it from the module.

Throws:

ConfigurationException