Formspider APIs


Package api_menubar


Method Summary
  createmenu(in_menubarname_tx IN varchar2, in_menu_xml IN xmldom.domdocument, in_parentmenuname_tx IN varchar2 DEFAULT null, in_index_nr IN number DEFAULT null)
           Creates a new menu in a menu bar.
  createmenubar(in_menubarname_tx IN varchar2, in_menubar_xml IN xmldom.domdocument)
           Creates a new menu bar.
  createmenuitem(in_menubarname_tx IN varchar2, in_menuitem_xml IN xmldom.domdocument, in_parentmenuname_tx IN varchar2, in_index_nr IN number DEFAULT null)
           Creates a new menu item in a menu.
  createseparator(in_menubarname_tx IN varchar2, in_separator_xml IN xmldom.domdocument, in_parentmenuname_tx IN varchar2, in_index_nr IN number DEFAULT null)
           Creates a new seperator item in a menu
  deletemenu(in_menubardotmenuname_tx IN varchar2)
           Deletes the menu from the menu bar.
  deletemenubar(in_menubarname_tx IN varchar2)
           Deletes the menu bar from application.
  deletemenuitem(in_menubardotmenuitemname_tx IN varchar2)
           Deletes the menu item from the menu.
  deleteseparator(in_menubardotseparatorname_tx IN varchar2)
           Deletes the separator item from the menu.
 varchar2 getclickedmenuitem(in_menubarname_tx IN varchar2)
           Returns the menu item clicked with the mouse.
 varchar2 getmenuitemlabel(in_menubardotmenuitemname_tx IN varchar2)
           Returns the label of the menu item.
 number getmenuitemorder(in_menubardotmenuitemname_tx IN varchar2)
           Returns the order of the menu item.
 varchar2 getmenuitemtooltip(in_menubardotmenuitemname_tx IN varchar2)
           Returns the tool tip of the menu item.
 varchar2 ismenuitemenabled(in_menubardotmenuitemname_tx IN varchar2)
           Returns whether the menu item is enabled.
 varchar2 ismenuitemvisible(in_menubardotmenuitemname_tx IN varchar2)
           Returns the visibility state of the menu item.
  setmenu(in_menubardotmenuname_tx IN varchar2, in_menu_xml IN xmldom.domdocument, in_index_nr IN number DEFAULT null)
           Updates the content of the menu.
  setmenubar(in_menubarname_tx IN varchar2, in_menubar_xml IN xmldom.domdocument)
           Updates the content of the menu bar.
  setmenuitem(in_menubardotmenuitemname_tx IN varchar2, in_menuitem_xml IN xmldom.domdocument, in_index_nr IN number DEFAULT null)
           Updates the menu item.
  setmenuitemenabled(in_menubardotmenuitemname_tx IN varchar2, in_enabled_yn IN varchar2)
           Enables or disables the menu item.
  setmenuitemlabel(in_menubardotmenuitemname_tx IN varchar2, in_label_tx IN varchar2)
           Updates the label of the menu item.
  setmenuitemorder(in_menubardotmenuitemname_tx IN varchar2, in_index_nr IN number)
           Updates the order the menu item appears in the menu.
  setmenuitemtooltip(in_menubardotmenuitemname_tx IN varchar2, in_tooltip_tx IN varchar2)
           Updates the tool tip of the menu item.
  setmenuitemvisible(in_menubardotmenuitemname_tx IN varchar2, in_visible_yn IN varchar2)
           Hides or shows the menu item.
  setseparator(in_menubardotseparatorname_tx IN varchar2, in_separator_xml IN xmldom.domdocument, in_index_nr IN number DEFAULT null)
           Updates the separator.

Method Detail

createmenu

public  createmenu(in_menubarname_tx IN varchar2, 
in_menu_xml IN xmldom.domdocument,
in_parentmenuname_tx IN varchar2 DEFAULT null,
in_index_nr IN number DEFAULT null)
Creates a new menu in a menu bar.
Parameters:
in_menubarname_tx - The name of the menu bar.
in_menu_xml - The definition of the menu in XML.
in_parentmenuname_tx - The name of the parent menu, if this menu is going to be used as a sub menu of another one.
in_index_nr - The order the menu will appear in the menu bar.
Throws:
e_invalidxml - Raised when the in_menu_xml value is not a valid definition of a menu.
e_xmlhaserror - Raised when the menu XML is not well formed.
e_invalidmenubarname - Raised when the menu bar does not exist in the application.
e_menuexists - Raised when a menu with the same name already exists.
e_menuitemexists - Raised when a menu item with the same name already exists.
e_separatorexists - Raised when a seperator with the same name already exists.
e_invalidindex - Raised when the the index value is not a positive natural number.
e_invalidmenuitemname - Raised when the parent menu does not exist in the menu bar.


createmenubar

public  createmenubar(in_menubarname_tx IN varchar2, 
in_menubar_xml IN xmldom.domdocument)
Creates a new menu bar.
Parameters:
in_menubarname_tx - The new of the menu bar.
in_menubar_xml - The definition of the menu bar in XML.
Throws:
e_invalidxml - Raised when the in_menubar_xml value is not a valid definition of a menu bar.
e_xmlhaserror - Raised when the menu bar XML is not well formed.
e_menubarexists - Raised when a menu bar with the same name already exists.
e_menuexists - Raised when a menu with the same name already exists.
e_menuitemexists - Raised when a menu item with the same name already exists.
e_separatorexists - Raised when a seperator with the same name already exists.


createmenuitem

public  createmenuitem(in_menubarname_tx IN varchar2, 
in_menuitem_xml IN xmldom.domdocument,
in_parentmenuname_tx IN varchar2,
in_index_nr IN number DEFAULT null)
Creates a new menu item in a menu.
Parameters:
in_menubarname_tx - The name of the menu bar.
in_menuitem_xml - The definition of the menu item in XML.
in_parentmenuname_tx - The name of the parent menu.
in_index_nr - The order the menu item will appear in the menu.
Throws:
e_invalidxml - Raised when the in_menuitem_xml value is not a valid definition of a menu item.
e_xmlhaserror - Raised when the menu item XML is not well formed.
e_invalidmenubarname - Raised when the menu bar does not exist in the application.
e_menuitemexists - Raised when a menu item with the same name already exists.
e_invalidindex - Raised when the the index value is not a positive natural number.


createseparator

public  createseparator(in_menubarname_tx IN varchar2, 
in_separator_xml IN xmldom.domdocument,
in_parentmenuname_tx IN varchar2,
in_index_nr IN number DEFAULT null)
Creates a new seperator item in a menu
Parameters:
in_menubarname_tx - The name of the menu bar.
in_separator_xml - The definition of the seperator in XML.
in_parentmenuname_tx - The name of the parent menu.
in_index_nr - The order the separator will appear in the menu.
Throws:
e_invalidxml - Raised when the seperator value is not a valid definition of a seperator.
e_xmlhaserror - Raised when the seperator XML is not well formed.
e_invalidmenubarname - Raised when the menu bar does not exist in the application.
e_separatorexists - Raised when a seperator with the same name already exists.
e_invalidindex - Raised when the the index value is not a positive natural number.


deletemenu

public  deletemenu(in_menubardotmenuname_tx IN varchar2)
Deletes the menu from the menu bar.
Parameters:
in_menubardotmenuname_tx - The fully qualified name of the menu in menuBarName.menuName format. Ex: mainMenuBar.menu1.
Throws:
e_invalidmenuitemname - Raised when the menu does not exist in the application.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuName_tx parameter is in incorrect format.


deletemenubar

public  deletemenubar(in_menubarname_tx IN varchar2)
Deletes the menu bar from application.
Parameters:
in_menubarname_tx - The name of the menu bar.
Throws:
e_invalidmenubarname - If given menuBar name is not found


deletemenuitem

public  deletemenuitem(in_menubardotmenuitemname_tx IN varchar2)
Deletes the menu item from the menu.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the application.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


deleteseparator

public  deleteseparator(in_menubardotseparatorname_tx IN varchar2)
Deletes the separator item from the menu.
Parameters:
in_menubardotseparatorname_tx - The fully qualified name of the separator in menuBarName.separatorName format. Ex: mainMenuBar.separator1.
Throws:
e_invalidmenuitemname - Raised when the separator does not exist in the application.
e_invalidinputformat - Raised when the value of the in_menuBarDotSeparatorName_tx parameter is in incorrect format.


getclickedmenuitem

public varchar2 getclickedmenuitem(in_menubarname_tx IN varchar2)
Returns the menu item clicked with the mouse.
Parameters:
in_menubarname_tx - The name of the menu bar.
Throws:
e_invalidmenubarname - Raised when the menu bar does not exist in the application.


getmenuitemlabel

public varchar2 getmenuitemlabel(in_menubardotmenuitemname_tx IN varchar2)
Returns the label of the menu item.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the menu bar.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


getmenuitemorder

public number getmenuitemorder(in_menubardotmenuitemname_tx IN varchar2)
Returns the order of the menu item.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the application.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


getmenuitemtooltip

public varchar2 getmenuitemtooltip(in_menubardotmenuitemname_tx IN varchar2)
Returns the tool tip of the menu item.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the menu bar.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


ismenuitemenabled

public varchar2 ismenuitemenabled(in_menubardotmenuitemname_tx IN varchar2)
Returns whether the menu item is enabled.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the menu bar.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


ismenuitemvisible

public varchar2 ismenuitemvisible(in_menubardotmenuitemname_tx IN varchar2)
Returns the visibility state of the menu item.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the menu bar.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


setmenu

public  setmenu(in_menubardotmenuname_tx IN varchar2, 
in_menu_xml IN xmldom.domdocument,
in_index_nr IN number DEFAULT null)
Updates the content of the menu.
Parameters:
in_menubardotmenuname_tx - The fully qualified name of the menu in menuBarName.menuName format. Ex: mainMenuBar.menu1.
in_menu_xml - The definition of the menu in XML.
in_index_nr - The order the menu will appear in the menu bar.
Throws:
e_invalidxml - Raised when the in_menu_xml value is not a valid definition of a menu.
e_xmlhaserror - Raised when the menu XML is not well formed.
e_invalidmenubarname - Raised when the menu bar does not exist in the application.
e_menuexists - Raised when a menu with the same name already exists.
e_menuitemexists - Raised when a menu item with the same name already exists.
e_separatorexists - Raised when a seperator with the same name already exists.
e_invalidindex - Raised when the the index value is not a positive natural number.
e_invalidmenuitemname - Raised when the menu does not exist in the application.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuName_tx parameter is in incorrect format.


setmenubar

public  setmenubar(in_menubarname_tx IN varchar2, 
in_menubar_xml IN xmldom.domdocument)
Updates the content of the menu bar.
Parameters:
in_menubarname_tx - The name of the menu bar.
in_menubar_xml - The definition of the menu bar in XML.
Throws:
e_invalidxml - Raised when the in_menubar_xml value is not a valid definition of a menu bar.
e_xmlhaserror - Raised when the menu bar XML is not well formed.
e_menuexists - Raised when a menu with the same name already exists.
e_menuitemexists - Raised when a menu item with the same name already exists.
e_separatorexists - Raised when a seperator with the same name already exists.


setmenuitem

public  setmenuitem(in_menubardotmenuitemname_tx IN varchar2, 
in_menuitem_xml IN xmldom.domdocument,
in_index_nr IN number DEFAULT null)
Updates the menu item.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
in_menuitem_xml - The definition of the menu item in XML.
in_index_nr - The order the menu item will appear in the menu.
Throws:
e_invalidxml - Raised when the in_menuItem_xml value is not a valid definition of a menu item.
e_xmlhaserror - Raised when the menu item XML is not well formed.
e_invalidmenubarname - Raised when the menu bar does not exist in the application.
e_menuitemexists - Raised when a menu item with the same name already exists.
e_invalidindex - Raised when the the index value is not a positive natural number.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


setmenuitemenabled

public  setmenuitemenabled(in_menubardotmenuitemname_tx IN varchar2, 
in_enabled_yn IN varchar2)
Enables or disables the menu item.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
in_enabled_yn - The new value of the enabled attribute.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the menu bar.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


setmenuitemlabel

public  setmenuitemlabel(in_menubardotmenuitemname_tx IN varchar2, 
in_label_tx IN varchar2)
Updates the label of the menu item.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
in_label_tx - The new value of the label.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the menu bar.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


setmenuitemorder

public  setmenuitemorder(in_menubardotmenuitemname_tx IN varchar2, 
in_index_nr IN number)
Updates the order the menu item appears in the menu.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
in_index_nr - The new order of the menu item.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the application.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


setmenuitemtooltip

public  setmenuitemtooltip(in_menubardotmenuitemname_tx IN varchar2, 
in_tooltip_tx IN varchar2)
Updates the tool tip of the menu item.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
in_tooltip_tx - New value of tooltip attribute.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the menu bar.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


setmenuitemvisible

public  setmenuitemvisible(in_menubardotmenuitemname_tx IN varchar2, 
in_visible_yn IN varchar2)
Hides or shows the menu item.
Parameters:
in_menubardotmenuitemname_tx - The fully qualified name of the menu item in menuBarName.menuItemName format. Ex: mainMenuBar.menuItem1.
in_visible_yn - The new value of the visible attribute.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the menu bar.
e_invalidinputformat - Raised when the value of the in_menuBarDotMenuItemName_tx parameter is in incorrect format.


setseparator

public  setseparator(in_menubardotseparatorname_tx IN varchar2, 
in_separator_xml IN xmldom.domdocument,
in_index_nr IN number DEFAULT null)
Updates the separator.
Parameters:
in_menubardotseparatorname_tx - The fully qualified name of the seperator in menuBarName.separatorName format. Ex: mainMenuBar.separator1.
in_separator_xml - The definition of the seperator in XML.
in_index_nr - The order the separator will appear in the menu.
Throws:
e_invalidxml - Raised when the seperator value is not a valid definition of a seperator.
e_xmlhaserror - Raised when the seperator XML is not well formed.
e_invalidmenubarname - Raised when the menu bar does not exist in the application.
e_separatorexists - Raised when a seperator with the same name already exists.
e_invalidindex - Raised when the the index value is not a positive natural number.
e_invalidinputformat - Raised when the value of the in_menuBarDotSeparatorName_tx parameter is in incorrect format.


Formspider APIs