Formspider APIs


Package api_dialog


Method Summary
  addcell(in_dialogname_tx IN varchar2, in_xycell_r IN api_layout.t_xycell)
           Adds an XY cell to the dialog.
  addcell(in_dialogname_tx IN varchar2, in_bordercell_r IN api_layout.t_bordercell)
           Adds a border cell to the dialog.
  addcell(in_dialogname_tx IN varchar2, in_rowname_tx IN varchar2, in_tablecell_r IN api_layout.t_tablecell, in_index_nr IN number DEFAULT null)
           Adds a table cell to the table row.
  addpanel(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_panelname_tx IN varchar2)
           Adds the panel to the layout cell in the dialog.
  addpanel(in_dialogname_tx IN varchar2, in_xycell_r IN api_layout.t_xycell, in_panelname_tx IN varchar2)
           Creates a new XY layout cell in the dialog.
  addpanel(in_dialogname_tx IN varchar2, in_bordercell_r IN api_layout.t_bordercell, in_panelname_tx IN varchar2)
           Creates a new border layout cell in the dialog.
  addpanel(in_dialogname_tx IN varchar2, in_rowname_tx IN varchar2, in_tablecell_r IN api_layout.t_tablecell, in_panelname_tx IN varchar2)
           Creates a new table layout cell in the dialog.
  addrow(in_dialogname_tx IN varchar2, in_tablerow_r IN api_layout.t_tablerow, in_index_nr IN number DEFAULT null)
           Adds a row to the table layout of the dialog.
 varchar2 getbackgroundcolor(in_dialogname_tx IN varchar2)
           Returns the background color of the dialog.
 api_layout.t_cell getcell(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2)
           Returns the layout cell in the dialog.
 api_application.t_object getcellcontent(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2)
           Returns the component inside a layout cell.
 number getheight(in_dialogname_tx IN varchar2)
           Returns the height of the dialog.
 varchar2 gethorizontalscrollbarenable(in_dialogname_tx IN varchar2)
           Returns whether this horizontal scrollbar is enabled.
 varchar2 gethorizontalscrollbarvisible(in_dialogname_tx IN varchar2)
           Returns visibility state of the horizontal scrollbar of dialog
 number getid(in_dialogname_tx IN varchar2)
           Returns the run time ID of the dialog.
 api_graphics.t_point getlocation(in_dialogname_tx IN varchar2)
           Returns the position of the dialog on the screen.
 api_layout.t_tablerow getparentrow(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2)
           Returns the parent row of the cell in the table layout.
 api_layout.t_tablerow getrow(in_dialogname_tx IN varchar2, in_rowname_tx IN varchar2)
           Returns the table layout row.
 varchar2 gettitle(in_dialogname_tx IN varchar2)
           Returns the title of the dialog.
 varchar2 getverticalscrollbarenable(in_dialogname_tx IN varchar2)
           Returns whether the horizontal scroll bar of the dialog is enabled.
 varchar2 getverticalscrollbarvisible(in_dialogname_tx IN varchar2)
           Returns visibility state of the vertical scrollbar of dialog
 api_graphics.t_point getviewportposition(in_dialogname_tx IN varchar2)
           Returns the coordinates of dialog's viewport.
 number getwidth(in_dialogname_tx IN varchar2)
           Returns the width of the dialog.
 varchar2 iscell(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2)
           Returns whether the a layout cell with the specified name exists.
 varchar2 isclosable(in_dialogname_tx IN varchar2)
           Returns whether the dialog can be closed by the user.
 varchar2 isfocused(in_dialogname_tx IN varchar2)
           Returns whether the dialog has the focus.
 varchar2 ismodal(in_dialogname_tx IN varchar2)
           Returns whether the dialog is modal.
 varchar2 isresizable(in_dialogname_tx IN varchar2)
           Returns whether the user can resize the dialog.
 varchar2 isvisible(in_dialogname_tx IN varchar2)
           Returns whether the dialog can be seen on the screen.
  print(in_dialogname_tx IN varchar2, in_printjob_tx IN varchar2 DEFAULT null)
           Prints the dialog.
  removecell(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2)
           Deletes the layout cell from the dialog.
  removemenubar(in_dialogname_tx IN varchar2)
           Removes the menu bar from the dialog.
  removepanel(in_dialogname_tx IN varchar2, in_panelname_tx IN varchar2, in_keeplegacycell_yn IN varchar2 DEFAULT 'Y')
           Removes the panel from the dialog.
  replacepanel(in_dialogname_tx IN varchar2, in_oldpanelname_tx IN varchar2, in_newpanelname_tx IN varchar2)
           Replaces a panel with another one in a dialog’s layout cell.
  requestfocus(in_dialogname_tx IN varchar2)
           Attempts to bring the focus to the dialog.
  setbackgroundcolor(in_dialogname_tx IN varchar2, in_backgroundcolor_cd IN varchar2)
           Updates background color of the dialog
  setcell(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_cell_r IN api_layout.t_cell, in_index_nr IN number DEFAULT null)
           Updates the layout cell in the dialog.
  setcellchildheight(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_childheight_nr IN number)
           Updates height of panel which take place in specified TableCell
  setcellchildwidth(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_childwidth_nr IN number)
           Updates width of panel which take place in specified TableCell.
  setcellcolumnspan(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_columnspan_nr IN number)
           Updates the column span of the table layout cell in a dialog.
  setcelldocking(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_docking_cd IN varchar2)
           Updates the docking of the border layout cell in a dialog.
  setcellhalign(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_halign_cd IN varchar2)
           Updates the horizontal alignment of the table layout cell.
  setcellheight(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_height_nr IN number)
           Updates the height of the layout cell.
  setcellposition(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_positionx_nr IN number, in_positiony_nr IN number)
           Updates the coordinates of the XY layout cell.
  setcellpositionx(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_positionx_nr IN number)
           Updates the X coordinate of the XY layout cell.
  setcellpositiony(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_positiony_nr IN number)
           Updates the Y coordinate of the XY layout cell.
  setcellrowspan(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_rowspan_nr IN number)
           Updates the row span of the table layout cell.
  setcellvalign(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_valign_cd IN varchar2)
           Updates the vertical align of the table layout cell.
  setcellwidth(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_width_tx IN varchar2)
           Updates the width of the layout cell.
  setclosable(in_dialogname_tx IN varchar2, in_closable_yn IN varchar2)
           Updates the background color of the dialog.
  setheight(in_dialogname_tx IN varchar2, in_height_nr IN varchar2)
           Updates the height of the dialog.
  sethorizontalscrollbarenable(in_dialogname_tx IN varchar2, in_enable_yn IN varchar2)
           Enables or disables the horizontal scroll bar.
  sethorizontalscrollbarvisible(in_dialogname_tx IN varchar2, in_visible_yn IN varchar2)
           Updates the visibility of the horizontal scroll bar of the dialog.
  setlocation(in_dialogname_tx IN varchar2, in_location_r IN api_graphics.t_point)
           Updates the coordinates of the dialog on the screen.
  setmenubar(in_dialogname_tx IN varchar2, in_menubarname_tx IN varchar2 DEFAULT null)
           Assigns a menu bar to the dialog.
  setmodal(in_dialogname_tx IN varchar2, in_modal_yn IN varchar2)
           Updates the modality of the dialog.
  setparentrow(in_dialogname_tx IN varchar2, in_cellname_tx IN varchar2, in_tablerow_r IN api_layout.t_tablerow, in_index_nr IN number DEFAULT null)
           Updates the parent row of a table layout cell.
  setresizable(in_dialogname_tx IN varchar2, in_resizable_yn IN varchar2)
           Updates whether the dialog can be resized by the user.
  setrow(in_dialogname_tx IN varchar2, in_rowname_tx IN varchar2, in_tablerow_r IN api_layout.t_tablerow, in_index_nr IN number DEFAULT null)
           Updates the row height of the table layout.
  setrowheight(in_dialogname_tx IN varchar2, in_rowname_tx IN varchar2, in_rowheight_nr IN number)
           Updates the height of the table layout row.
  settitle(in_dialogname_tx IN varchar2, in_title_tx IN varchar2)
           Updates the title of the dialog.
  setverticalscrollbarenable(in_dialogname_tx IN varchar2, in_enable_yn IN varchar2)
           Enables or disables the vertical scroll bar of the dialog.
  setverticalscrollbarvisible(in_dialogname_tx IN varchar2, in_visible_yn IN varchar2)
           Hides or shows the vertical scroll bar of the dialog.
  setviewportposition(in_dialogname_tx IN varchar2, in_viewportposition_r IN api_graphics.t_point)
           Updates the coordinates of the dialog’s viewport.
  setvisible(in_dialogname_tx IN varchar2, in_visible_yn IN varchar2, in_viewportposition_r IN api_graphics.t_point DEFAULT null)
           Hides or shows the dialog.
  setwidth(in_dialogname_tx IN varchar2, in_width_nr IN varchar2)
           Updates the width of the dialog.

Method Detail

addcell

public  addcell(in_dialogname_tx IN varchar2, 
in_xycell_r IN api_layout.t_xycell)
Adds an XY cell to the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_xycell_r - The XY layout cell to be added to the container.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_incompatiblelayouttype - Raised when the container’s layout is not XY layout.


addcell

public  addcell(in_dialogname_tx IN varchar2, 
in_bordercell_r IN api_layout.t_bordercell)
Adds a border cell to the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_bordercell_r - The border layout cell to be added to the container.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_incompatiblelayouttype - Raised when the container’s layout is not Border layout.


addcell

public  addcell(in_dialogname_tx IN varchar2, 
in_rowname_tx IN varchar2,
in_tablecell_r IN api_layout.t_tablecell,
in_index_nr IN number DEFAULT null)
Adds a table cell to the table row.
Parameters:
in_dialogname_tx - The name of the dialog.
in_rowname_tx - The name of the row the cell will be added.
in_tablecell_r - The table layout cell to be added to the table layout row.
in_index_nr - The column order of the cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_invalidcelltype - Raised when in_rowName_tx does not refer to a table layout row.


addpanel

public  addpanel(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_panelname_tx IN varchar2)
Adds the panel to the layout cell in the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_panelname_tx - The name of the panel.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidoperation - Raised when value in the in_cellName_tx parameter refers to a table layout row.


addpanel

public  addpanel(in_dialogname_tx IN varchar2, 
in_xycell_r IN api_layout.t_xycell,
in_panelname_tx IN varchar2)
Creates a new XY layout cell in the dialog. Adds the panel to the XY cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_xycell_r - The XY layout cell to be added to the container.
in_panelname_tx - The name of the panel.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_invalidpanelname - Raised when the panel does not exist in the application.
e_incompatiblelayouttype - Raised when the container’s layout is not XY layout.

heightPolicy_cd attribute not suported for dialog cell


addpanel

public  addpanel(in_dialogname_tx IN varchar2, 
in_bordercell_r IN api_layout.t_bordercell,
in_panelname_tx IN varchar2)
Creates a new border layout cell in the dialog. Adds the panel into the cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_bordercell_r - The border layout cell to be added to the container.
in_panelname_tx - The name of the panel.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_invalidpanelname - Raised when the panel does not exist in the application.
e_incompatiblelayouttype - Raised when the container’s layout is not Border layout.

heightPolicy_cd attribute not suported for dialog cell


addpanel

public  addpanel(in_dialogname_tx IN varchar2, 
in_rowname_tx IN varchar2,
in_tablecell_r IN api_layout.t_tablecell,
in_panelname_tx IN varchar2)
Creates a new table layout cell in the dialog. Adds the panel into the cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_rowname_tx - Name of the cell that tableCell will be added.
in_tablecell_r - The table layout cell to be added to the table layout row.
in_panelname_tx - The name of the panel.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidrowname - Raised when the layout row does not exist.


addrow

public  addrow(in_dialogname_tx IN varchar2, 
in_tablerow_r IN api_layout.t_tablerow,
in_index_nr IN number DEFAULT null)
Adds a row to the table layout of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_tablerow_r - The table layout row to be added to the container.
in_index_nr - Indicates at what order the row is going to appear in the container.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_incompatiblelayouttype - Raised when the container’s layout is not Table layout.


getbackgroundcolor

public varchar2 getbackgroundcolor(in_dialogname_tx IN varchar2)
Returns the background color of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


getcell

public api_layout.t_cell getcell(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2)
Returns the layout cell in the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.


getcellcontent

public api_application.t_object getcellcontent(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2)
Returns the component inside a layout cell.

This API does not work for table layout rows because table layout rows do not contain components.

Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of cell inside the diaolg
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_notsupportedcelltype - Raised when the supplied layout cell is a table layout row.


getheight

public number getheight(in_dialogname_tx IN varchar2)
Returns the height of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


gethorizontalscrollbarenable

public varchar2 gethorizontalscrollbarenable(in_dialogname_tx IN varchar2)
Returns whether this horizontal scrollbar is enabled.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


gethorizontalscrollbarvisible

public varchar2 gethorizontalscrollbarvisible(in_dialogname_tx IN varchar2)
Returns visibility state of the horizontal scrollbar of dialog
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


getid

public number getid(in_dialogname_tx IN varchar2)
Returns the run time ID of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


getlocation

public api_graphics.t_point getlocation(in_dialogname_tx IN varchar2)
Returns the position of the dialog on the screen.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


getparentrow

public api_layout.t_tablerow getparentrow(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2)
Returns the parent row of the cell in the table layout.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.
e_invalidcellname - Raised when the layout cell does not exist.


getrow

public api_layout.t_tablerow getrow(in_dialogname_tx IN varchar2, 
in_rowname_tx IN varchar2)
Returns the table layout row.
Parameters:
in_dialogname_tx - The name of the dialog.
in_rowname_tx - The name of the table layout row.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidrowname - Raised when the layout row does not exist.


gettitle

public varchar2 gettitle(in_dialogname_tx IN varchar2)
Returns the title of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


getverticalscrollbarenable

public varchar2 getverticalscrollbarenable(in_dialogname_tx IN varchar2)
Returns whether the horizontal scroll bar of the dialog is enabled.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


getverticalscrollbarvisible

public varchar2 getverticalscrollbarvisible(in_dialogname_tx IN varchar2)
Returns visibility state of the vertical scrollbar of dialog
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


getviewportposition

public api_graphics.t_point getviewportposition(in_dialogname_tx IN varchar2)
Returns the coordinates of dialog's viewport.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


getwidth

public number getwidth(in_dialogname_tx IN varchar2)
Returns the width of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


iscell

public varchar2 iscell(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2)
Returns whether the a layout cell with the specified name exists.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


isclosable

public varchar2 isclosable(in_dialogname_tx IN varchar2)
Returns whether the dialog can be closed by the user.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


isfocused

public varchar2 isfocused(in_dialogname_tx IN varchar2)
Returns whether the dialog has the focus.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


ismodal

public varchar2 ismodal(in_dialogname_tx IN varchar2)
Returns whether the dialog is modal.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


isresizable

public varchar2 isresizable(in_dialogname_tx IN varchar2)
Returns whether the user can resize the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


isvisible

public varchar2 isvisible(in_dialogname_tx IN varchar2)
Returns whether the dialog can be seen on the screen.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


print

public  print(in_dialogname_tx IN varchar2, 
in_printjob_tx IN varchar2 DEFAULT null)
Prints the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_printjob_tx - The name of the print job. Defaults to null.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


removecell

public  removecell(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2)
Deletes the layout cell from the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.


removemenubar

public  removemenubar(in_dialogname_tx IN varchar2)
Removes the menu bar from the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


removepanel

public  removepanel(in_dialogname_tx IN varchar2, 
in_panelname_tx IN varchar2,
in_keeplegacycell_yn IN varchar2 DEFAULT 'Y')
Removes the panel from the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_panelname_tx - The name of the panel.
in_keeplegacycell_yn - Determines whether the keep the empty layout cell in the layout once the panel in it is removed. Defaults to Y.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidpanelname - Raised when the panel does not exist in the application.
e_panelnotfoundondialog - Raised when the panel is not in the dialog.


replacepanel

public  replacepanel(in_dialogname_tx IN varchar2, 
in_oldpanelname_tx IN varchar2,
in_newpanelname_tx IN varchar2)
Replaces a panel with another one in a dialog’s layout cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_oldpanelname_tx - The name of the panel to be removed from the layout cell.
in_newpanelname_tx - The name of the panel to be placed to the layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidpanelname - Raised when old panel or new panel does not exist in the application.


requestfocus

public  requestfocus(in_dialogname_tx IN varchar2)
Attempts to bring the focus to the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setbackgroundcolor

public  setbackgroundcolor(in_dialogname_tx IN varchar2, 
in_backgroundcolor_cd IN varchar2)
Updates background color of the dialog
Parameters:
in_dialogname_tx - The name of the dialog.
in_backgroundcolor_cd - Background color of the dialog. Please see API_COLOR for the valid list of values for this input parameter.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcolor - Raised when the input color value is not a valid color.

See also:
api_color

setcell

public  setcell(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_cell_r IN api_layout.t_cell,
in_index_nr IN number DEFAULT null)
Updates the layout cell in the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_cell_r - The new value for the attributes of the layout cell.
in_index_nr - The order of the table layout cell. Applies only to table layout cells.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_widthparameternotnumber - Raised when the layout cell width is not a number. The % sign at the end of a numeric value is only accepted for table layout cells.
e_invalidwidthparameter - Raised when the width value is not valid.


setcellchildheight

public  setcellchildheight(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_childheight_nr IN number)
Updates height of panel which take place in specified TableCell
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_childheight_nr - Height of the component
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.


setcellchildwidth

public  setcellchildwidth(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_childwidth_nr IN number)
Updates width of panel which take place in specified TableCell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_childwidth_nr - Height of the component
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.


setcellcolumnspan

public  setcellcolumnspan(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_columnspan_nr IN number)
Updates the column span of the table layout cell in a dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_columnspan_nr - The new column span value of the table layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.
e_invalidcellname - Raised when the layout cell does not exist.


setcelldocking

public  setcelldocking(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_docking_cd IN varchar2)
Updates the docking of the border layout cell in a dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_docking_cd - The new docking value of the border layout cell.

The valid list of values for this input parameter is: api_layout.DOCKING_CENTER, api_layout.DOCKING_NORTH, api_layout.DOCKING_SOUTH, api_layout.DOCKING_WEST, api_layout.DOCKING_EAST.

Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a border layout cell.
e_invalidcellname - Raised when the layout cell does not exist.
e_invalidinputparameter - Raised when in_docking_cd value is invalid.


setcellhalign

public  setcellhalign(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_halign_cd IN varchar2)
Updates the horizontal alignment of the table layout cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_halign_cd - The new value of the horizontal alignment of the table layout cell.

The valid list of values for this input parameter is: api_layout.ALIGN_CENTER, api_layout.ALIGN_LEFT, api_layout.ALIGN_RIGHT, api_layout.ALIGN_FULL.

Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.
e_invalidcellname - Raised when the layout cell does not exist.
e_invalidinputparameter - Raised when in_hAlign_cd value is invalid.


setcellheight

public  setcellheight(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_height_nr IN number)
Updates the height of the layout cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_height_nr - The new height of the layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx refers to a table layout row.
e_invalidcellname - Raised when the layout cell does not exist.


setcellposition

public  setcellposition(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_positionx_nr IN number,
in_positiony_nr IN number)
Updates the coordinates of the XY layout cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_positionx_nr - The new X coordinate of the layout cell.
in_positiony_nr - The new Y coordinate of the layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a XY layout cell.
e_invalidcellname - Raised when the layout cell does not exist.


setcellpositionx

public  setcellpositionx(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_positionx_nr IN number)
Updates the X coordinate of the XY layout cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_positionx_nr - The new X coordinate of the layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a XY layout cell.
e_invalidcellname - Raised when the layout cell does not exist.


setcellpositiony

public  setcellpositiony(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_positiony_nr IN number)
Updates the Y coordinate of the XY layout cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_positiony_nr - The new Y coordinate of the layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a XY layout cell.
e_invalidcellname - Raised when the layout cell does not exist.


setcellrowspan

public  setcellrowspan(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_rowspan_nr IN number)
Updates the row span of the table layout cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_rowspan_nr - The new row span value of the table layout cell.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.
e_invalidcellname - Raised when the layout cell does not exist.


setcellvalign

public  setcellvalign(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_valign_cd IN varchar2)
Updates the vertical align of the table layout cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_valign_cd - The new vertical alignment of the table layout cell.

The valid values for this input parameter are: api_layout.ALIGN_CENTER, api_layout.ALIGN_TOP, api_layout.ALIGN_BOTTOM, api_layout.ALIGN_FULL.

Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.
e_invalidcellname - Raised when the layout cell does not exist.
e_invalidinputparameter - Raised when in_vAlign_cd value is invalid.


setcellwidth

public  setcellwidth(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_width_tx IN varchar2)
Updates the width of the layout cell.
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_width_tx - The new width of the layout cell. For XY layout cells and border layout cells the width must be a number. For table layout cells the width may be a number or a percentage.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx refers to a table layout row.
e_invalidcellname - Raised when the layout cell does not exist.
e_widthparameternotnumber - Raised when the layout cell width is not a number. The % sign at the end of a numeric value is only accepted for table layout cells.
e_invalidwidthparameter - Raised when the width value is not valid.


setclosable

public  setclosable(in_dialogname_tx IN varchar2, 
in_closable_yn IN varchar2)
Updates the background color of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_closable_yn - The new value of the closable attribute.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setheight

public  setheight(in_dialogname_tx IN varchar2, 
in_height_nr IN varchar2)
Updates the height of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_height_nr - The new height of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


sethorizontalscrollbarenable

public  sethorizontalscrollbarenable(in_dialogname_tx IN varchar2, 
in_enable_yn IN varchar2)
Enables or disables the horizontal scroll bar.
Parameters:
in_dialogname_tx - The name of the dialog.
in_enable_yn - The new value of the enable attribute. Please not that JavaScript does not support disabled scroll bars. Therefore any disabled scroll bars are hidden by Formspider.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


sethorizontalscrollbarvisible

public  sethorizontalscrollbarvisible(in_dialogname_tx IN varchar2, 
in_visible_yn IN varchar2)
Updates the visibility of the horizontal scroll bar of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_visible_yn - The new value of the visible attribute.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setlocation

public  setlocation(in_dialogname_tx IN varchar2, 
in_location_r IN api_graphics.t_point)
Updates the coordinates of the dialog on the screen.
Parameters:
in_dialogname_tx - The name of the dialog.
in_location_r - The new position of the dialog on the screen.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setmenubar

public  setmenubar(in_dialogname_tx IN varchar2, 
in_menubarname_tx IN varchar2 DEFAULT null)
Assigns a menu bar to the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_menubarname_tx - The name of the menu bar to be attached to the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidmenubarname - Raised when the menu bar does not exist in the application.


setmodal

public  setmodal(in_dialogname_tx IN varchar2, 
in_modal_yn IN varchar2)
Updates the modality of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_modal_yn - The new modality value of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setparentrow

public  setparentrow(in_dialogname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_tablerow_r IN api_layout.t_tablerow,
in_index_nr IN number DEFAULT null)
Updates the parent row of a table layout cell. Please note that the heightPolicy_cd attribute not supported for layout cells in dialogs
Parameters:
in_dialogname_tx - The name of the dialog.
in_cellname_tx - The name of the layout cell.
in_tablerow_r - The new value for the attributes of the table layout row.
in_index_nr - The order of the row in the table layout.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.
e_invalidcellname - Raised when the layout cell does not exist.


setresizable

public  setresizable(in_dialogname_tx IN varchar2, 
in_resizable_yn IN varchar2)
Updates whether the dialog can be resized by the user.
Parameters:
in_dialogname_tx - The name of the dialog.
in_resizable_yn - The new resizable value of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setrow

public  setrow(in_dialogname_tx IN varchar2, 
in_rowname_tx IN varchar2,
in_tablerow_r IN api_layout.t_tablerow,
in_index_nr IN number DEFAULT null)
Updates the row height of the table layout.
Parameters:
in_dialogname_tx - The name of the dialog.
in_rowname_tx - The name of the table layout row.
in_tablerow_r - The new value for the attributes of the table layout row.
in_index_nr - The order of the table layout row
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidrowname - Raised when the layout row does not exist.


setrowheight

public  setrowheight(in_dialogname_tx IN varchar2, 
in_rowname_tx IN varchar2,
in_rowheight_nr IN number)
Updates the height of the table layout row.
Parameters:
in_dialogname_tx - The name of the dialog.
in_rowname_tx - The name of the table layout row.
in_rowheight_nr - The new height of the table layout row.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_invalidcelltype - Raised when in_rowName_tx does not refer to a table layout row.
e_invalidrowname - Raised when the layout cell does not exist.


settitle

public  settitle(in_dialogname_tx IN varchar2, 
in_title_tx IN varchar2)
Updates the title of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_title_tx - The new title of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setverticalscrollbarenable

public  setverticalscrollbarenable(in_dialogname_tx IN varchar2, 
in_enable_yn IN varchar2)
Enables or disables the vertical scroll bar of the dialog.

Please not that JavaScript does not support disabled scroll bars. Therefore any disabled scroll bars are hidden by Formspider.

Parameters:
in_dialogname_tx - The name of the dialog.
in_enable_yn - The new value of the enable attribute.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setverticalscrollbarvisible

public  setverticalscrollbarvisible(in_dialogname_tx IN varchar2, 
in_visible_yn IN varchar2)
Hides or shows the vertical scroll bar of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_visible_yn - The new value of the visible attribute.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setviewportposition

public  setviewportposition(in_dialogname_tx IN varchar2, 
in_viewportposition_r IN api_graphics.t_point)
Updates the coordinates of the dialog’s viewport.
Parameters:
in_dialogname_tx - The name of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.
e_nullviewportposition - Raised when the new view position parameter values are null.


setvisible

public  setvisible(in_dialogname_tx IN varchar2, 
in_visible_yn IN varchar2,
in_viewportposition_r IN api_graphics.t_point DEFAULT null)
Hides or shows the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_visible_yn - The new visibility value of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


setwidth

public  setwidth(in_dialogname_tx IN varchar2, 
in_width_nr IN varchar2)
Updates the width of the dialog.
Parameters:
in_dialogname_tx - The name of the dialog.
in_width_nr - The new width of the dialog.
Throws:
e_invaliddialogname - Raised when the dialog does not exist in the application.


Formspider APIs