Formspider APIs


Package api_popupmenu


Method Summary
  createmenu(in_popupmenuname_tx IN varchar2, in_menu_xml IN xmldom.domdocument, in_parentmenuname_tx IN varchar2 DEFAULT null, in_index_nr IN number DEFAULT null)
           Create a menu in the pop up menu.
  createmenuitem(in_popupmenuname_tx IN varchar2, in_menuitem_xml IN xmldom.domdocument, in_parentmenuname_tx IN varchar2 DEFAULT null, in_index_nr IN number DEFAULT null)
           Create a menu item in the pop up menu.
  createpopupmenu(in_popupmenuname_tx IN varchar2, in_popupmenu_xml IN xmldom.domdocument)
           Creates new pop up menu.
  createseparator(in_popupmenuname_tx IN varchar2, in_separator_xml IN xmldom.domdocument, in_parentmenuname_tx IN varchar2 DEFAULT null, in_index_nr IN number DEFAULT null)
           Creates a seperator in the pop up menu.
  deletemenu(in_popupmenudotmenuname_tx IN varchar2)
           Deletes the menu from the pop up menu.
  deletemenuitem(in_popupmenudotmenuitemname_tx IN varchar2)
           Deletes the menu item from the menu.
  deletepopupmenu(in_popupmenuname_tx IN varchar2)
           Deletes the pop up menu.
  deleteseparator(in_popupmenudotseparator_tx IN varchar2)
           Deletes the separator item from the menu.
 varchar2 getclickedmenuitem(in_popupmenuname_tx IN varchar2)
           Returns the menu item name the user clicked.
 varchar2 getmenuitemlabel(in_popupmenudotmenuitemname_tx IN varchar2)
           Returns the label of the menu item.
 number getmenuitemorder(in_popupmenudotmenuitemname_tx IN varchar2)
           Returns the order of the menu item in the menu.
 varchar2 getmenuitemtooltip(in_popupmenudotmenuitemname_tx IN varchar2)
           Returns the tool tip of the menu item.
 varchar2 ismenuitemenabled(in_popupmenudotmenuitemname_tx IN varchar2)
           Returns whether the menu item is enabled.
 varchar2 ismenuitemvisible(in_popupmenudotmenuitemname_tx IN varchar2)
           Returns whether the menu item can be seen.
  setmenu(in_popupmenudotmenuname_tx IN varchar2, in_menu_xml IN xmldom.domdocument, in_index_nr IN number DEFAULT null)
           Updates the contents of the menu.
  setmenuitem(in_popupmenudotmenuitemname_tx IN varchar2, in_menuitem_xml IN xmldom.domdocument, in_index_nr IN number DEFAULT null)
           Updates the properties of the menu item.
  setmenuitemenabled(in_popupmenudotmenuitemname_tx IN varchar2, in_enabled_yn IN varchar2)
           Enables, disables the menu item.
  setmenuitemlabel(in_popupmenudotmenuitemname_tx IN varchar2, in_label_tx IN varchar2)
           Updates the menu item label.
  setmenuitemorder(in_popupmenudotmenuitemname_tx IN varchar2, in_index_nr IN number)
           Updates the order the menu item appears.
  setmenuitemtooltip(in_popupmenudotmenuitemname_tx IN varchar2, in_tooltip_tx IN varchar2)
           Updates the menu item tool tip.
  setmenuitemvisible(in_popupmenudotmenuitemname_tx IN varchar2, in_visible_yn IN varchar2)
           Shows, hides menu item.
  setpopupmenu(in_popupmenuname_tx IN varchar2, in_popupmenu_xml IN xmldom.domdocument)
           Updates the content of the pop up menu.
  setseparator(in_popupmenudotseparator_tx IN varchar2, in_separator_xml IN xmldom.domdocument, in_index_nr IN number DEFAULT null)
           Updates the attributes of the separator.
  show(in_popupmenuname_tx IN varchar2, in_position_r IN api_graphics.t_point)
           Displays the pop up menu.

Method Detail

createmenu

public  createmenu(in_popupmenuname_tx IN varchar2, 
in_menu_xml IN xmldom.domdocument,
in_parentmenuname_tx IN varchar2 DEFAULT null,
in_index_nr IN number DEFAULT null)
Create a menu in the pop up menu.
Parameters:
in_popupmenuname_tx - The name of the pop up menu.
in_menu_xml - The definition of the menu as XML.
in_parentmenuname_tx - The name of the parent menu.
in_index_nr - The order value of the menu.
Throws:
e_invalidxml - Raised when the input XML does not define a menu.
e_xmlhaserror - Raised when the input XML has syntax errors.
e_invalidpopupmenuname - Raised when the pop up menu does not exist in the application.
e_menuexists - Raised when the input XML contains a menu with a name that already exists.
e_menuitemexists - Raised when the input XML contains a menu item with a name that already exists.
e_separatorexists - Raised when the input XML contains a separator with a name that already exists.
e_invalidindex - Raised when the index vale is not a positive integer.
e_invalidmenuitemname - Raised when the parent menu does not exist in the pop up menu.


createmenuitem

public  createmenuitem(in_popupmenuname_tx IN varchar2, 
in_menuitem_xml IN xmldom.domdocument,
in_parentmenuname_tx IN varchar2 DEFAULT null,
in_index_nr IN number DEFAULT null)
Create a menu item in the pop up menu.
Parameters:
in_popupmenuname_tx - The name of the pop up menu.
in_menuitem_xml - The definition of the menu item as XML.
in_parentmenuname_tx - The name of the parent menu.
in_index_nr - The order value of the menu item.
Throws:
e_invalidxml - Raised when the input XML does not define a menu item.
e_xmlhaserror - Raised when the input XML has syntax errors.
e_invalidpopupmenuname - Raised when the pop up menu does not exist in the application.
e_menuitemexists - Raised when the input XML contains a menu item with a name that already exists.
e_invalidindex - Raised when the index vale is not a positive integer.


createpopupmenu

public  createpopupmenu(in_popupmenuname_tx IN varchar2, 
in_popupmenu_xml IN xmldom.domdocument)
Creates new pop up menu.
Parameters:
in_popupmenuname_tx - The name of the pop up menu.
in_popupmenu_xml - The definition of the pop up menu in XML format.
Throws:
e_invalidxml - Raised when the input XML does not define a pop up menu.
e_xmlhaserror - Raised when the input XML has syntax errors.
e_popupmenuexists - Raised when a popup menu with the same name already exists.
e_menuexists - Raised when the input XML contains a menu with a name that already exists.
e_menuitemexists - Raised when the input XML contains a menu item with a name that already exists.
e_separatorexists - Raised when the input XML contains a separator with a name that already exists.


createseparator

public  createseparator(in_popupmenuname_tx IN varchar2, 
in_separator_xml IN xmldom.domdocument,
in_parentmenuname_tx IN varchar2 DEFAULT null,
in_index_nr IN number DEFAULT null)
Creates a seperator in the pop up menu.
Parameters:
in_popupmenuname_tx - The name of the pop up menu.
in_separator_xml - The definition of the separator as XML.
in_parentmenuname_tx - The name of the parent menu.
in_index_nr - The order value of the separator.
Throws:
e_invalidxml - Raised when the input XML does not define a separator.
e_xmlhaserror - Raised when the input XML has syntax errors.
e_invalidpopupmenuname - Raised when the pop up menu does not exist in the application.
e_separatorexists - Raised when the input XML contains a separator with a name that already exists.
e_invalidindex - Raised when the index vale is not a positive integer.


deletemenu

public  deletemenu(in_popupmenudotmenuname_tx IN varchar2)
Deletes the menu from the pop up menu.
Parameters:
in_popupmenudotmenuname_tx - Fully qualified name of the menu in popupMenuName.menuName format. Ex: popupMenu1.menu1.
Throws:
e_invalidmenuitemname - Raised when the menu does not exist in the application.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuName_tx parameter is in incorrect format.


deletemenuitem

public  deletemenuitem(in_popupmenudotmenuitemname_tx IN varchar2)
Deletes the menu item from the menu.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the application.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


deletepopupmenu

public  deletepopupmenu(in_popupmenuname_tx IN varchar2)
Deletes the pop up menu.
Parameters:
in_popupmenuname_tx - The name of the pop up menu.
Throws:
e_invalidpopupmenuname - Raised when the pop up menu does not exist in the application.


deleteseparator

public  deleteseparator(in_popupmenudotseparator_tx IN varchar2)
Deletes the separator item from the menu.
Parameters:
in_popupmenudotseparator_tx - Fully qualified name of the separator in popupMenuName.separatorName format. Ex: popupMenu1.separator1.
Throws:
e_invalidmenuitemname - Raised when the separator does not exist in the application.
e_invalidinputformat - Raised when the value of the in_popupMenuDotseparator_tx parameter is in incorrect format.


getclickedmenuitem

public varchar2 getclickedmenuitem(in_popupmenuname_tx IN varchar2)
Returns the menu item name the user clicked.
Parameters:
in_popupmenuname_tx - The name of the pop up menu.
Throws:
e_invalidpopupmenuname - Raised when the pop up menu does not exist in the application.


getmenuitemlabel

public varchar2 getmenuitemlabel(in_popupmenudotmenuitemname_tx IN varchar2)
Returns the label of the menu item.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item name is invalid.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


getmenuitemorder

public number getmenuitemorder(in_popupmenudotmenuitemname_tx IN varchar2)
Returns the order of the menu item in the menu.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the application.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


getmenuitemtooltip

public varchar2 getmenuitemtooltip(in_popupmenudotmenuitemname_tx IN varchar2)
Returns the tool tip of the menu item.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item name is invalid.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


ismenuitemenabled

public varchar2 ismenuitemenabled(in_popupmenudotmenuitemname_tx IN varchar2)
Returns whether the menu item is enabled.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item name is invalid.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


ismenuitemvisible

public varchar2 ismenuitemvisible(in_popupmenudotmenuitemname_tx IN varchar2)
Returns whether the menu item can be seen.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1.
Throws:
e_invalidmenuitemname - Raised when the menu item name is invalid.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


setmenu

public  setmenu(in_popupmenudotmenuname_tx IN varchar2, 
in_menu_xml IN xmldom.domdocument,
in_index_nr IN number DEFAULT null)
Updates the contents of the menu.
Parameters:
in_popupmenudotmenuname_tx - Fully qualified name of the menu in popupMenuName.menuName format. Ex: popupMenu1.menu1.
in_menu_xml - The definition of the menu as XML.
in_index_nr - The order value of the menu.
Throws:
e_invalidxml - Raised when the input XML does not define a menu.
e_xmlhaserror - Raised when the input XML has syntax errors.
e_invalidpopupmenuname - Raised when the pop up menu does not exist in the application.
e_menuexists - Raised when the input XML contains a menu with a name that already exists.
e_menuitemexists - Raised when the input XML contains a menu item with a name that already exists.
e_separatorexists - Raised when the input XML contains a separator with a name that already exists.
e_invalidindex - Raised when the index vale is not a positive integer.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuName_tx parameter is in incorrect format.


setmenuitem

public  setmenuitem(in_popupmenudotmenuitemname_tx IN varchar2, 
in_menuitem_xml IN xmldom.domdocument,
in_index_nr IN number DEFAULT null)
Updates the properties of the menu item.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1
in_menuitem_xml - The definition of the menu item as XML.
in_index_nr - The order value of the menu item.
Throws:
e_invalidxml - Raised when the input XML does not define a menu item.
e_xmlhaserror - Raised when the input XML has syntax errors.
e_invalidpopupmenuname - Raised when the pop up menu does not exist in the application.
e_menuitemexists - Raised when the input XML contains a menu item with a name that already exists.
e_invalidindex - Raised when the index vale is not a positive integer.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


setmenuitemenabled

public  setmenuitemenabled(in_popupmenudotmenuitemname_tx IN varchar2, 
in_enabled_yn IN varchar2)
Enables, disables the menu item.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1.
in_enabled_yn - The new value of the enabled attribute.
Throws:
e_invalidmenuitemname - Raised when the menu item name is invalid.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


setmenuitemlabel

public  setmenuitemlabel(in_popupmenudotmenuitemname_tx IN varchar2, 
in_label_tx IN varchar2)
Updates the menu item label.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1.
in_label_tx - New Value of label attribute
Throws:
e_invalidmenuitemname - Raised when the menu item name is invalid.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


setmenuitemorder

public  setmenuitemorder(in_popupmenudotmenuitemname_tx IN varchar2, 
in_index_nr IN number)
Updates the order the menu item appears.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1
in_index_nr - New order valeu for menuITem
Throws:
e_invalidmenuitemname - Raised when the menu item does not exist in the application.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


setmenuitemtooltip

public  setmenuitemtooltip(in_popupmenudotmenuitemname_tx IN varchar2, 
in_tooltip_tx IN varchar2)
Updates the menu item tool tip.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1.
in_tooltip_tx - New value of tooltip attribute.
Throws:
e_invalidmenuitemname - Raised when the menu item name is invalid.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


setmenuitemvisible

public  setmenuitemvisible(in_popupmenudotmenuitemname_tx IN varchar2, 
in_visible_yn IN varchar2)
Shows, hides menu item.
Parameters:
in_popupmenudotmenuitemname_tx - Fully qualified name of the menu item in popupMenuName.menuItemName format. Ex: popupMenu1.menuItem1.
in_visible_yn - The new value of the enabled attribute.
Throws:
e_invalidmenuitemname - Raised when the menu item name is invalid.
e_invalidinputformat - Raised when the value of the in_popupMenuDotMenuItemName_tx parameter is in incorrect format.


setpopupmenu

public  setpopupmenu(in_popupmenuname_tx IN varchar2, 
in_popupmenu_xml IN xmldom.domdocument)
Updates the content of the pop up menu.
Parameters:
in_popupmenuname_tx - The name of the pop up menu.
in_popupmenu_xml - PopupMenu xml it should be in xml domDocument
Throws:
e_invalidxml - Raised when the input XML does not define a pop up menu.
e_xmlhaserror - Raised when the input XML has syntax errors.
e_menuexists - Raised when the input XML contains a menu with a name that already exists.
e_menuitemexists - Raised when the input XML contains a menu item with a name that already exists.
e_separatorexists - Raised when the input XML contains a separator with a name that already exists.


setseparator

public  setseparator(in_popupmenudotseparator_tx IN varchar2, 
in_separator_xml IN xmldom.domdocument,
in_index_nr IN number DEFAULT null)
Updates the attributes of the separator.
Parameters:
in_popupmenudotseparator_tx - Fully qualified name of the separator in popupMenuName.separatorName format. Ex: popupMenu1.separator1.
in_separator_xml - The definition of the separator as XML.
in_index_nr - The order value of the separator.
Throws:
e_invalidxml - Raised when the input XML does not define a separator.
e_xmlhaserror - Raised when the input XML has syntax errors.
e_invalidpopupmenuname - Raised when the pop up menu does not exist in the application.
e_separatorexists - Raised when the input XML contains a separator with a name that already exists.
e_invalidindex - Raised when the index vale is not a positive integer.
e_invalidinputformat - Raised when the value of the in_popupMenuDotseparator_tx parameter is in incorrect format.


show

public  show(in_popupmenuname_tx IN varchar2, 
in_position_r IN api_graphics.t_point)
Displays the pop up menu.
Parameters:
in_popupmenuname_tx - The name of the pop up menu.
in_position_r - The X and Y positions the pop up menu is displayed.
Throws:
e_invalidpopupmenuname - Raised when the pop up menu does not exist in the application.


Formspider APIs