Formspider APIs


Package api_accordionpanel


Field Summary
 varchar2(200)collapsed CONSTANT := bdf_constant.accordiontypecollapsed
           Constant for the collapsed state of the accordion panel.
 varchar2(200)expanded CONSTANT := bdf_constant.accordiontypeexpanded
           Constant for the expanded state of the accordion panel.
 varchar2(200)expandiconpositionleft CONSTANT := bdf_constant.expandiconpositionleft
           Constant for the expand icon position of the accordion panel.
 varchar2(200)expandiconpositionright CONSTANT := bdf_constant.expandiconpositionright
           Constant for the expand icon position of the accordion panel.

Method Summary
  addaccordion(in_accordionpanelname_tx IN varchar2, in_order_nr IN number, in_accordionname_tx IN varchar2, in_title_tx IN varchar2, in_panelname_tx IN varchar2)
           Adds new accordion to the accordion panel.
  collapseaccordion(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Collapses the specified accordion in the panel.
  expandaccordion(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Expands the specified accordion in the panel.
 varchar2 getaccordionheaderbgcolor(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Returns the header background color of the accordion.
 number getaccordionheaderheight(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Returns the header height of the accordion.
 number getaccordionheight(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Returns the height of the accordion.
 number getaccordionorder(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Returns the order of the accordion is displayed in the accordion panel.
 varchar2 getaccordionstate(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Returns whether the accordion is COLLAPSED or EXPANDED.
 varchar2 getaccordiontitle(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Returns the title of the accordion.
 number getcollapsedaccordion(in_accordionpanelname_tx IN varchar2)
           Returns the order of the last accordion that is collapsed either by the user or by an API call.
 number getexpandedaccordion(in_accordionpanelname_tx IN varchar2)
           Returns the order of the last accordion that is expanded either by the user or by an API call.
 varchar2 getexpandiconposition(in_accordionpanelname_tx IN varchar2)
           Returns expand icon position of the accordion panel.
 varchar2 getheightallocationpolicy(in_accordionpanelname_tx IN varchar2)
           Returns height allocation policy of the specified accordion panel.
 varchar2 isaccordionenabled(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Returns the enable state of the specified accordion.
 varchar2 isaccordionheadervisible(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Returns the display state of the accordion header.
 varchar2 ismultiexpand(in_accordionpanelname_tx IN varchar2)
           Returns the multi expand state of the accordion panel.
 varchar2 isresizable(in_accordionpanelname_tx IN varchar2)
           Returns the resizable state of the accordion panel.
  removeaccordion(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2)
           Removes the specified accordion from the accordion panel.
  removeallaccordions(in_accordionpanelname_tx IN varchar2)
           Removes all accordions from the specified accordion panel.
  setaccordionenable(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2, in_enabled_yn IN varchar2)
           Updates the enable state of the specified accordion.
  setaccordionheaderbgcolor(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2, in_backgroundcolor_cd IN varchar2)
           Updates the header background color of the specified accordion.
  setaccordionheaderheight(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2, in_headerheight_nr IN number)
           Updates the header height of the accordion.
  setaccordionheadervisible(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2, in_headervisible_yn IN varchar2)
           Updates the visibility state of the accordion header.
  setaccordionheight(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2, in_height_nr IN number)
           Updates the height of the specified accordion.
  setaccordionorder(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2, in_order_nr IN number)
           Updates the order the accordion appears in the accordion panel.
  setaccordionpanel(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2, in_panelname_tx IN varchar2)
           Changes the panel shown by the accordion.
  setaccordiontitle(in_accordionpanelname_tx IN varchar2, in_accordionname_tx IN varchar2, in_title_tx IN varchar2)
           Updates the title of the accordion.
  setexpandiconposition(in_accordionpanelname_tx IN varchar2, in_expandiconposition_cd IN varchar2)
           Updates expand icon position of the specified accordion panel.
  setheightallocationpolicy(in_accordionpanelname_tx IN varchar2, in_heightallocationpolicy_tx IN varchar2)
           Updates expand icon position of the specified accordion panel.
  setmultiexpand(in_accordionpanelname_tx IN varchar2, in_multiexpand_yn IN varchar2)
           Updates the multi expand of the specified accordion panel.
  setresizable(in_accordionpanelname_tx IN varchar2, in_resizable_yn IN varchar2)
           Updates the resizable of the specified accordion panel.

Field Detail

collapsed

        public varchar2(200) collapsed CONSTANT := bdf_constant.accordiontypecollapsed
Constant for the collapsed state of the accordion panel.

Value: 'Collapsed'


expanded

        public varchar2(200) expanded CONSTANT := bdf_constant.accordiontypeexpanded
Constant for the expanded state of the accordion panel.

Value: 'Expanded'


expandiconpositionleft

        public varchar2(200) expandiconpositionleft CONSTANT := bdf_constant.expandiconpositionleft
Constant for the expand icon position of the accordion panel.

Value: 'Left'


expandiconpositionright

        public varchar2(200) expandiconpositionright CONSTANT := bdf_constant.expandiconpositionright
Constant for the expand icon position of the accordion panel.

Value: 'Right'


Method Detail

addaccordion

public  addaccordion(in_accordionpanelname_tx IN varchar2, 
in_order_nr IN number,
in_accordionname_tx IN varchar2,
in_title_tx IN varchar2,
in_panelname_tx IN varchar2)
Adds new accordion to the accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_order_nr - The position of the new accordion.
in_accordionname_tx - Name of the accordion.
in_title_tx - The title of the accordion.
in_panelname_tx - The name of the panel that will be placed inside the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidpanelname - Raised when the specified panel name does not exist in the application.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidaccordionorder - Raised when the specified order is not valid.
e_accordionorderexists - Raised when the order passed to the API is already used in the accordion panel by another accordion.
e_nullaccordionorder - Raised when no order is specified for the new accordion.
e_nullaccordionname - Raised when no name is specified for the new accordion.
e_accordionnameexists - Raised when the new accordion name already exists in the accordion panel.
e_recursivepanelinclusion - Raised when one of parent panels of the panel is added as subpanel.


collapseaccordion

public  collapseaccordion(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Collapses the specified accordion in the panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


expandaccordion

public  expandaccordion(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Expands the specified accordion in the panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


getaccordionheaderbgcolor

public varchar2 getaccordionheaderbgcolor(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Returns the header background color of the accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.


getaccordionheaderheight

public number getaccordionheaderheight(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Returns the header height of the accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.


getaccordionheight

public number getaccordionheight(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Returns the height of the accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.


getaccordionorder

public number getaccordionorder(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Returns the order of the accordion is displayed in the accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.


getaccordionstate

public varchar2 getaccordionstate(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Returns whether the accordion is COLLAPSED or EXPANDED.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


getaccordiontitle

public varchar2 getaccordiontitle(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Returns the title of the accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


getcollapsedaccordion

public number getcollapsedaccordion(in_accordionpanelname_tx IN varchar2)
Returns the order of the last accordion that is collapsed either by the user or by an API call.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


getexpandedaccordion

public number getexpandedaccordion(in_accordionpanelname_tx IN varchar2)
Returns the order of the last accordion that is expanded either by the user or by an API call.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


getexpandiconposition

public varchar2 getexpandiconposition(in_accordionpanelname_tx IN varchar2)
Returns expand icon position of the accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


getheightallocationpolicy

public varchar2 getheightallocationpolicy(in_accordionpanelname_tx IN varchar2)
Returns height allocation policy of the specified accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


isaccordionenabled

public varchar2 isaccordionenabled(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Returns the enable state of the specified accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.


isaccordionheadervisible

public varchar2 isaccordionheadervisible(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Returns the display state of the accordion header.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.


ismultiexpand

public varchar2 ismultiexpand(in_accordionpanelname_tx IN varchar2)
Returns the multi expand state of the accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


isresizable

public varchar2 isresizable(in_accordionpanelname_tx IN varchar2)
Returns the resizable state of the accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


removeaccordion

public  removeaccordion(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2)
Removes the specified accordion from the accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


removeallaccordions

public  removeallaccordions(in_accordionpanelname_tx IN varchar2)
Removes all accordions from the specified accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


setaccordionenable

public  setaccordionenable(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2,
in_enabled_yn IN varchar2)
Updates the enable state of the specified accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
in_enabled_yn - The new value of the enabled attribute. Set to Y to enable the accordion, set to N to disable it.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidinputparameter - Raised when the value for the in_enabled_yn is not Y or N.


setaccordionheaderbgcolor

public  setaccordionheaderbgcolor(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2,
in_backgroundcolor_cd IN varchar2)
Updates the header background color of the specified accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
in_backgroundcolor_cd - Header background color of the accordion
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidcolor - Raised when the color is not valid.

See also:
api_color

setaccordionheaderheight

public  setaccordionheaderheight(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2,
in_headerheight_nr IN number)
Updates the header height of the accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
in_headerheight_nr - Header height of the accordion
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.


setaccordionheadervisible

public  setaccordionheadervisible(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2,
in_headervisible_yn IN varchar2)
Updates the visibility state of the accordion header.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
in_headervisible_yn - New visibility state of accordion
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidinputparameter - Raised when the value for the in_headervisible_yn is not Y or N.


setaccordionheight

public  setaccordionheight(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2,
in_height_nr IN number)
Updates the height of the specified accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
in_height_nr - Height of the accordion
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.


setaccordionorder

public  setaccordionorder(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2,
in_order_nr IN number)
Updates the order the accordion appears in the accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
in_order_nr - Order of the accordion
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_accordionorderexists - Raised when the new order specified for the accordion is already used by another accordion in the accordion panel.
e_invalidaccordionorder - Raised when the order specified for the accordion is not a valid value.


setaccordionpanel

public  setaccordionpanel(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2,
in_panelname_tx IN varchar2)
Changes the panel shown by the accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
in_panelname_tx - The name of the panel to be placed inside the accordion
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidpanelname - Raised when the specified panel name does not exist in the application.
e_recursivepanelinclusion - Raised when one of parent panels of the panel is added as subpanel.


setaccordiontitle

public  setaccordiontitle(in_accordionpanelname_tx IN varchar2, 
in_accordionname_tx IN varchar2,
in_title_tx IN varchar2)
Updates the title of the accordion.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_accordionname_tx - Name of the accordion.
in_title_tx - The new title for the accordion.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidaccordionname - Raised when the supplied accordion name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


setexpandiconposition

public  setexpandiconposition(in_accordionpanelname_tx IN varchar2, 
in_expandiconposition_cd IN varchar2)
Updates expand icon position of the specified accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_expandiconposition_cd - New expand icon position of the accordion panel
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidinputparameter - Raised when the value for the in_expandIconPosition_cd is not EXPANDEDICONPOSITIONLEFT or EXPANDEDICONPOSITIONRIGHT.


setheightallocationpolicy

public  setheightallocationpolicy(in_accordionpanelname_tx IN varchar2, 
in_heightallocationpolicy_tx IN varchar2)
Updates expand icon position of the specified accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


setmultiexpand

public  setmultiexpand(in_accordionpanelname_tx IN varchar2, 
in_multiexpand_yn IN varchar2)
Updates the multi expand of the specified accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_multiexpand_yn - New multi expand state of the accordion panel
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.
e_invalidinputparameter - Raised when the value for the in_multiExpand_yn is not Y or N.


setresizable

public  setresizable(in_accordionpanelname_tx IN varchar2, 
in_resizable_yn IN varchar2)
Updates the resizable of the specified accordion panel.
Parameters:
in_accordionpanelname_tx - Name of the accordion panel.
in_resizable_yn - New resizable state of the accordion panel
Throws:
e_invalidaccordionpanelname - Raised when the supplied accordion panel name is invalid.
e_invalidpaneltype - Raised if the API is called for a panel that is not an accordionPanel.


Formspider APIs