Formspider APIs


Package api_tabbedpanel


Field Summary
 varchar2(200)tabplacement_bottom CONSTANT := bdf_constant.tabplacement_bottom
           Value: 'Bottom'
 varchar2(200)tabplacement_left CONSTANT := bdf_constant.tabplacement_left
           Value: 'Left'
 varchar2(200)tabplacement_right CONSTANT := bdf_constant.tabplacement_right
           Value: 'Right'
 varchar2(200)tabplacement_top CONSTANT := bdf_constant.tabplacement_top
           Value: 'Top'

Method Summary
  addtab(in_tabbedpanelname_tx IN varchar2, in_order_nr IN number, in_tabname_tx IN varchar2, in_title_tx IN varchar2, in_panelname_tx IN varchar2, in_closable_yn IN varchar2 DEFAULT 'N', in_visible_yn IN varchar2 DEFAULT 'Y', in_enabled_yn IN varchar2 DEFAULT 'Y')
           Adds a new tab to the tabbed panel.
 varchar2 getclosedtabname(in_tabbedpanelname_tx IN varchar2)
           Returns the tab name that is closed.
 number getclosedtaborder(in_tabbedpanelname_tx IN varchar2)
           Returns the tab order that is closed.
 varchar2 getcurrenttabname(in_tabbedpanelname_tx IN varchar2)
           Returns the tab that is showing its content in the tabbed panel.
 number getcurrenttaborder(in_tabbedpanelname_tx IN varchar2)
           Returns the order the showing tab.
 number gettaborder(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2)
           Returns the order of the tab.
 varchar2 gettabpanel(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2 DEFAULT null)
           Returns the panel name that tab displays.
 varchar2 gettabplacement(in_tabbedpanelname_tx IN varchar2)
           Returns the positioning of the tabs.
 varchar2 gettabtitle(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2)
           Returns the title of the tab.
 varchar2 istabclosable(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2)
           Returns the closable state of the tab.
 varchar2 istabenabled(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2)
           Returns whether the tab is enabled or not.
 varchar2 istabvisible(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2)
           Returns the display state of the tab.
  removealltabs(in_tabbedpanelname_tx IN varchar2)
           Removes all tabs from the tabbed panel.
  removetab(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2)
           Removes the tab from the tabbed panel.
  setcurrenttab(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2)
           Shows the content of the tab on the screen.
  setcurrenttab(in_tabbedpanelname_tx IN varchar2, in_order_nr IN number)
           Updates current tab of the tabbed panel.
  settabclosable(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2, in_closable_yn IN varchar2)
           Updates the closable state of the tab.
  settabenable(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2, in_enabled_yn IN varchar2)
           Enables, disables the tab.
  settaborder(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2, in_order_nr IN number)
           Updates the order the tab is displayed.
  settabpanel(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2, in_panelname_tx IN varchar2)
           Changes the panel the tab displays.
  settabplacement(in_tabbedpanelname_tx IN varchar2, in_tabplacement_cd IN varchar2)
           Updates the positioning of the tabs.
  settabtitle(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2, in_title_tx IN varchar2)
           Updates the title of the tab.
  settabvisible(in_tabbedpanelname_tx IN varchar2, in_tabname_tx IN varchar2, in_visible_yn IN varchar2)
           Updates the display state of the tab.

Field Detail

tabplacement_bottom

        public varchar2(200) tabplacement_bottom CONSTANT := bdf_constant.tabplacement_bottom
Value: 'Bottom'

tabplacement_left

        public varchar2(200) tabplacement_left CONSTANT := bdf_constant.tabplacement_left
Value: 'Left'

tabplacement_right

        public varchar2(200) tabplacement_right CONSTANT := bdf_constant.tabplacement_right
Value: 'Right'

tabplacement_top

        public varchar2(200) tabplacement_top CONSTANT := bdf_constant.tabplacement_top
Value: 'Top'

Method Detail

addtab

public  addtab(in_tabbedpanelname_tx IN varchar2, 
in_order_nr IN number,
in_tabname_tx IN varchar2,
in_title_tx IN varchar2,
in_panelname_tx IN varchar2,
in_closable_yn IN varchar2 DEFAULT 'N',
in_visible_yn IN varchar2 DEFAULT 'Y',
in_enabled_yn IN varchar2 DEFAULT 'Y')
Adds a new tab to the tabbed panel.
Parameters:
in_tabbedpanelname_tx - The name of the tabbed panel the tab will appear in.
in_order_nr - The order the tab will appear in the tabbed panel.
in_tabname_tx - The name of the tab.
in_title_tx - The title of the tab.
in_panelname_tx - The name of the panel the tab will show.
in_closable_yn - The closable attribute of the tab.
in_visible_yn - The visible attribute of the tab
in_enabled_yn - The enable attribute of the tab
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidpanelname - Raised when the in_panelname_tx references a panel that does not exist.
e_invalidorder - Raised when the tab order is not a positive integer.
e_taborderexists - Raised when the order is already used by another tab in the tabbed panel.
e_nulltaborder - Raised when the in_order_nr parameter is null.
e_nulltabname - Raised when no tab name is specified.
e_tabnameexists - Raised when a tab with the same name already exists.
e_recursivepanelinclusion - Raised when one of parent panels of the panel is added as subpanel.


getclosedtabname

public varchar2 getclosedtabname(in_tabbedpanelname_tx IN varchar2)
Returns the tab name that is closed.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.


getclosedtaborder

public number getclosedtaborder(in_tabbedpanelname_tx IN varchar2)
Returns the tab order that is closed.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.


getcurrenttabname

public varchar2 getcurrenttabname(in_tabbedpanelname_tx IN varchar2)
Returns the tab that is showing its content in the tabbed panel.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_nocurrenttab - Raised when there is no current tab.
e_invalidorder - Raised when the tab order is not a positive integer.


getcurrenttaborder

public number getcurrenttaborder(in_tabbedpanelname_tx IN varchar2)
Returns the order the showing tab.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_nocurrenttab - Raised when there is no current tab.


gettaborder

public number gettaborder(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2)
Returns the order of the tab.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


gettabpanel

public varchar2 gettabpanel(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2 DEFAULT null)
Returns the panel name that tab displays.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab. If it is not provided, current tab will be used.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.
e_nocurrenttab - Raised when tab name attribute is empty and there is no current tab.


gettabplacement

public varchar2 gettabplacement(in_tabbedpanelname_tx IN varchar2)
Returns the positioning of the tabs.

The constants representing the possible values that may be returned from this functions are: TABPLACEMENT_TOP, TABPLACEMENT_BOTTOM, TABPLACEMENT_LEFT, TABPLACEMENT_RIGHT

Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.


gettabtitle

public varchar2 gettabtitle(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2)
Returns the title of the tab.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


istabclosable

public varchar2 istabclosable(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2)
Returns the closable state of the tab.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


istabenabled

public varchar2 istabenabled(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2)
Returns whether the tab is enabled or not.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


istabvisible

public varchar2 istabvisible(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2)
Returns the display state of the tab.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


removealltabs

public  removealltabs(in_tabbedpanelname_tx IN varchar2)
Removes all tabs from the tabbed panel.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.


removetab

public  removetab(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2)
Removes the tab from the tabbed panel.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


setcurrenttab

public  setcurrenttab(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2)
Shows the content of the tab on the screen.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the new current tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.
e_invalidorder - Raised when the tab order is not a positive integer.
e_invisibleordisabledtab - Raised when the tab is invisible or disabled.


setcurrenttab

public  setcurrenttab(in_tabbedpanelname_tx IN varchar2, 
in_order_nr IN number)
Updates current tab of the tabbed panel.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_order_nr - The order of the new current tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.
e_invalidorder - Raised when the tab order is not a positive integer.
e_invisibleordisabledtab - Raised when the tab is invisible or disabled.


settabclosable

public  settabclosable(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2,
in_closable_yn IN varchar2)
Updates the closable state of the tab.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
in_closable_yn - The new value of the enable attribute.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


settabenable

public  settabenable(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2,
in_enabled_yn IN varchar2)
Enables, disables the tab.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
in_enabled_yn - The new value of the enable attribute.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


settaborder

public  settaborder(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2,
in_order_nr IN number)
Updates the order the tab is displayed.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
in_order_nr - The new order of the tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.
e_invalidorder - Raised when the tab order is not a positive integer.
e_taborderexists - Raised when the order is already used by another tab in the tabbed panel.


settabpanel

public  settabpanel(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2,
in_panelname_tx IN varchar2)
Changes the panel the tab displays.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel
in_tabname_tx - The name of the tab.
in_panelname_tx - The name of the panel.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.
e_invalidpanelname - Raished when the in_panelname_tx references a panel that does not exist.
e_invalidorder - Raised when the tab order is not a positive integer.
e_recursivepanelinclusion - Raised when one of parent panels of the panel is added as subpanel.


settabplacement

public  settabplacement(in_tabbedpanelname_tx IN varchar2, 
in_tabplacement_cd IN varchar2)
Updates the positioning of the tabs.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabplacement_cd - The new positioning of the tabs.

The constants for this input parameters are: TABPLACEMENT_TOP, TABPLACEMENT_BOTTOM, TABPLACEMENT_LEFT, TABPLACEMENT_RIGHT

Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidinputparameter - Raised when the in_tabPlacement_cd value is invalid


settabtitle

public  settabtitle(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2,
in_title_tx IN varchar2)
Updates the title of the tab.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
in_title_tx - The title of the tab.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


settabvisible

public  settabvisible(in_tabbedpanelname_tx IN varchar2, 
in_tabname_tx IN varchar2,
in_visible_yn IN varchar2)
Updates the display state of the tab.
Parameters:
in_tabbedpanelname_tx - The name of tabbed panel.
in_tabname_tx - The name of the tab.
in_visible_yn - The new value of the enable attribute.
Throws:
e_invalidtabbedpanelname - Raised when the tabbed panel does not exist.
e_invalidpaneltype - Raised when the panel referenced with in_tabbedPanelName_tx is not a tabbed panel.
e_invalidtabname - Raised when the tab does not exist in the tabbed panel.


Formspider APIs