com.remedy.arsys.api
Class CharMenuItemInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.CharMenuItemInfo

All Implemented Interfaces:

java.lang.Cloneable

public class CharMenuItemInfo

extends java.lang.Object

implements java.lang.Cloneable

Each CharMenuItemInfo represents an individual menu item of a list menu. In this context, a menu item can be a value (a leaf-level item) or another menu (a top- or intermediate-level item).

Constructor Summary

CharMenuItemInfo(NameID label, CharMenuInfo childMenu)

CharMenuItemInfo(NameID label, java.lang.String menuItem)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
java.lang.Object	getContents() Returns value associated with the menu item.
NameID	getLabel() Returns label that identifies the menu item.
int	getType() Returns the type of character menu item.
int	hashCode() This method can be used to populate a hash table.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CharMenuItemInfo

public CharMenuItemInfo(NameID label,
                        java.lang.String menuItem)

CharMenuItemInfo

public CharMenuItemInfo(NameID label,
                        CharMenuInfo childMenu)

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class java.lang.Object

getType

public int getType()

Returns the type of character menu item. You can return the following constant values:

• 0 -- No menu item (Constants.AR_MENU_TYPE_NONE).
• 1 -- Leaf-level menu item (Constants.AR_MENU_TYPE_VALUE).
• 2 -- Top- or intermediate-level menu item (Constants.AR_MENU_TYPE_MENU).

getLabel

public NameID getLabel()

Returns label that identifies the menu item.

getContents

public java.lang.Object getContents()

Returns value associated with the menu item. For leaf-level items, the definition is a string containing the item text. For top- or intermediate-level items, the definition is a pointer to a child menu.

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality. The result is true if and only if the argument is not null, is of same type and represents the same content.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

This method can be used to populate a hash table. Implicitly used method to test equality of objects.

Overrides:

hashCode in class java.lang.Object