Formspider APIs


Package api_panel


Field Summary
 varchar2(200)horizontal CONSTANT := bdf_constant.horizontal
           Value: 'H'
 varchar2(255)line_border CONSTANT := bdf_constant.borderline
           Value: 'LineBorder'
 varchar2(200)lowered_bevel_border CONSTANT := bdf_constant.borderloweredbevel
           Value: 'LoweredBevelBorder'
 varchar2(200)lowered_etched_border CONSTANT := bdf_constant.borderloweredetched
           Value: 'LineBorder'
 varchar2(200)raised_bevel_border CONSTANT := bdf_constant.borderraisedbevel
           Value: 'LoweredEtchedBorder'
 varchar2(200)raised_etched_border CONSTANT := bdf_constant.borderraisedetched
           Value: 'RaisedEtchedBorder'
 varchar2(200)titled_border CONSTANT := bdf_constant.bordertitled
           Value: 'TitledBorder'
 varchar2(200)vertical CONSTANT := bdf_constant.vertical
           Value: 'V'

Type Summary
 RECORD t_size(width_nr number, height_nr number)
           Holds panel's preferredWidth and preferredHeight

Method Summary
  addcell(in_panelname_tx IN varchar2, in_xycell_r IN api_layout.t_xycell)
           Adds an XY cell to the panel.
  addcell(in_panelname_tx IN varchar2, in_bordercell_r IN api_layout.t_bordercell)
           Adds a border cell to the panel.
  addcell(in_panelname_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_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_subpanelname_tx IN varchar2)
           Adds the panel to the layout cell in the parent panel.
  addpanel(in_panelname_tx IN varchar2, in_xycell_r IN api_layout.t_xycell, in_subpanelname_tx IN varchar2)
           Creates a new XY layout cell in the panel.
  addpanel(in_panelname_tx IN varchar2, in_bordercell_r IN api_layout.t_bordercell, in_subpanelname_tx IN varchar2)
           Creates a new border layout cell in the panel.
  addpanel(in_panelname_tx IN varchar2, in_rowname_tx IN varchar2, in_tablecell_r IN api_layout.t_tablecell, in_subpanelname_tx IN varchar2)
           Creates a new table layout cell in the panel.
  addrow(in_panelname_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 panel.
  addstyleclass(in_panelname_tx IN varchar2, in_styleclass_tx IN varchar2)
           Adds CSS class to the HTML object of the panel.
  disableall(in_panelname_tx IN varchar2)
           Disables the panel and all the components in it.
  enableall(in_panelname_tx IN varchar2)
           Enables the panel and all the components in it.
 varchar2 getbackgroundcolor(in_panelname_tx IN varchar2)
           Returns the background color of the panel.
 varchar2 getbordertitle(in_panelname_tx IN varchar2)
           Returns the border title of the panel.
 varchar2 getbordertype(in_panelname_tx IN varchar2)
           Returns the border type of the panel.
 api_layout.t_cell getcell(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2)
           Returns the layout cell in the panel.
 api_application.t_object getcellcontent(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2)
           Returns the component inside a layout cell.
 varchar2 getdividerlocation(in_panelname_tx IN varchar2)
           Returns the divider location as a percentage value for the split panel.
 varchar2 getdividerorientation(in_panelname_tx IN varchar2)
           Returns the orientation of the split panel.
 varchar2 getfontcolor(in_panelname_tx IN varchar2)
           Returns the font color of the panel.
 varchar2 getfontfamily(in_panelname_tx IN varchar2)
           Returns the font family of the panel.
 number getfontsize(in_panelname_tx IN varchar2)
           Returns the font size of the panel.
 varchar2 getfontstyle(in_panelname_tx IN varchar2)
           Returns the font style of the panel.
 varchar2 getheightpolicy(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2)
           Returns the height policy of the layout cell.
 number getid(in_panelname_tx IN varchar2)
           Returns the run time ID of the panel.
 api_layout.t_cell getparentcell(in_panelname_tx IN varchar2)
           Returns the layout cell that the panel is in.
 api_layout.t_tablerow getparentrow(in_panelname_tx IN varchar2)
           Returns the table layout row the panel is in.
 api_layout.t_tablerow getparentrow(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2)
           Returns the parent row of the cell in the table layout.
 varchar2 getpreferredheightpolicy(in_panelname_tx IN varchar2)
           Returns the preferred height policy of the panel.
 t_size getpreferredsize(in_panelname_tx IN varchar2)
           Returns the preferred height and width of the panel.
 varchar2 getpreferredwidthpolicy(in_panelname_tx IN varchar2)
           Returns the preferred width policy of the panel.
 varchar2 getprintcolor(in_panelname_tx IN varchar2)
           Returns the color that is used when the panel is printed.
 api_layout.t_tablerow getrow(in_panelname_tx IN varchar2, in_rowname_tx IN varchar2)
           Returns the table layout row.
 varchar2 getstyleclass(in_panelname_tx IN varchar2)
           Gets the CSS class(es) added to the HTML object of the component.
 api_application.t_object getwindow(in_panelname_tx IN varchar2)
           Returns the window the panel is in.
 varchar2 hasstyleclass(in_panelname_tx IN varchar2, in_styleclass_tx IN varchar2)
           Returns Y if the specified class is added to the panel.
 varchar2 iscell(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2)
           Returns whether the a layout cell with the specified name exists.
 varchar2 isprintable(in_panelname_tx IN varchar2)
           Returns whether the panel is printable.
 varchar2 isvisible(in_panelname_tx IN varchar2)
           Returns whether the panel can be seen on the screen.
  print(in_panelname_tx IN varchar2, in_printjob_tx IN varchar2 DEFAULT null)
           Prints panel
  removecell(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2)
           Deletes the layout cell from the panel.
  removepanel(in_panelname_tx IN varchar2, in_subpanelname_tx IN varchar2, in_keeplegacycell_yn IN varchar2 DEFAULT 'Y')
           Removes the panel from the panel.
  removepanel(in_subpanelname_tx IN varchar2)
           Removes the panel from its parent.
  removestyleclass(in_panelname_tx IN varchar2, in_styleclass_tx IN varchar2)
           Removes CSS class from the HTML object of the panel.
  replacepanel(in_panelname_tx IN varchar2, in_oldpanelname_tx IN varchar2, in_newpanelname_tx IN varchar2)
           Replaces an existing panel with another one.
  setbackgroundcolor(in_panelname_tx IN varchar2, in_backgroundcolor_cd IN varchar2)
           Updates background color of the panel.
  setbordertitle(in_panelname_tx IN varchar2, in_title_tx IN varchar2)
           Updates the border title of the panel.
  setbordertype(in_panelname_tx IN varchar2, in_bordertype_cd IN varchar2)
           Updates the border type of the panel.
  setcell(in_panelname_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 panel.
  setcellchildheight(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_childheight_nr IN number)
           Updates height of component which take place in specified TableCell.
  setcellchildwidth(in_panelname_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_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_columnspan_nr IN number)
           Updates the column span of the table layout cell.
  setcelldocking(in_panelname_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_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_halign_cd IN varchar2)
           Updates the horizontal alignment of the table cell.
  setcellheight(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_height_nr IN number)
           Updates the height of the layout cell.
  setcellposition(in_panelname_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_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_positionx_nr IN number)
           Updates the X coordinate of the XY layout cell.
  setcellpositiony(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_positiony_nr IN number)
           Updates the Y coordinate of the XY layout cell.
  setcellrowspan(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_rowspan_nr IN number)
           Updates the row span of the table layout cell.
  setcellvalign(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_valign_cd IN varchar2)
           Updates the vertical align of the table layout cell.
  setcellwidth(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_width_tx IN varchar2)
           Updates the width of the layout cell.
  setdividerlocation(in_panelname_tx IN varchar2, in_dividerlocation_tx IN varchar2)
           Updates the location of the divider of the split panel.
  setdividerorientation(in_panelname_tx IN varchar2, in_dividerorientation_cd IN varchar2)
           Updates the orientation of the divider of a split panel.
  setfontcolor(in_panelname_tx IN varchar2, in_fontcolor_cd IN varchar2)
           Updates the font color of the panel.
  setfontfamily(in_panelname_tx IN varchar2, in_fontfamily_tx IN varchar2)
           Updates font family of the panel
  setfontsize(in_panelname_tx IN varchar2, in_fontsize_nr IN number)
           Updates font size of the panel
  setfontstyle(in_panelname_tx IN varchar2, in_fontstyle_tx IN varchar2)
           Updates font style of the panel
  setheightpolicy(in_panelname_tx IN varchar2, in_cellname_tx IN varchar2, in_heightpolicy_cd IN varchar2)
           Updates the height policy of the layout cell.
  setparentcell(in_panelname_tx IN varchar2, in_cell_r IN api_layout.t_cell, in_index_nr IN number DEFAULT null)
           Updates the layout cell the panel is in.
  setparentrow(in_panelname_tx IN varchar2, in_tablerow_r IN api_layout.t_tablerow, in_index_nr IN number DEFAULT null)
           Updates the table layout row the panel is in.
  setparentrow(in_panelname_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 table layout row the table layout cell is in.
  setpreferredheightpolicy(in_panelname_tx IN varchar2, in_preferredheightpolicy_cd IN varchar2)
           Updates the preferred height policy of the panel.
  setpreferredsize(in_panelname_tx IN varchar2, in_preferredsize_r IN api_panel.t_size)
           Updates the preferred width and height of the panel.
  setpreferredwidthpolicy(in_panelname_tx IN varchar2, in_preferredwidthpolicy_cd IN varchar2)
           Updates the preferred width policy of the panel.
  setprintable(in_panelname_tx IN varchar2, in_printable_yn IN varchar2)
           Updates whether the panel is printable or not.
  setprintcolor(in_panelname_tx IN varchar2, in_printcolor_cd IN varchar2)
           Updates the color the panel uses when it is printed.
  setrow(in_panelname_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 specified row in the table layout.
  setrowheight(in_panelname_tx IN varchar2, in_rowname_tx IN varchar2, in_rowheight_nr IN number)
           Updates the height of the table layout row.
  setstyleclass(in_panelname_tx IN varchar2, in_styleclass_tx IN varchar2)
           Updates the CSS classes for the panel's HTML object.
  setvisible(in_panelname_tx IN varchar2, in_visible_yn IN varchar2)
           Updates the visible attribute of the panel

Field Detail

horizontal

        public varchar2(200) horizontal CONSTANT := bdf_constant.horizontal
Value: 'H'

line_border

        public varchar2(255) line_border CONSTANT := bdf_constant.borderline
Value: 'LineBorder'

lowered_bevel_border

        public varchar2(200) lowered_bevel_border CONSTANT := bdf_constant.borderloweredbevel
Value: 'LoweredBevelBorder'

lowered_etched_border

        public varchar2(200) lowered_etched_border CONSTANT := bdf_constant.borderloweredetched
Value: 'LineBorder'

raised_bevel_border

        public varchar2(200) raised_bevel_border CONSTANT := bdf_constant.borderraisedbevel
Value: 'LoweredEtchedBorder'

raised_etched_border

        public varchar2(200) raised_etched_border CONSTANT := bdf_constant.borderraisedetched
Value: 'RaisedEtchedBorder'

titled_border

        public varchar2(200) titled_border CONSTANT := bdf_constant.bordertitled
Value: 'TitledBorder'

vertical

        public varchar2(200) vertical CONSTANT := bdf_constant.vertical
Value: 'V'

Type Detail

t_size

public RECORD t_size(width_nr number, 
height_nr number)
Holds panel's preferredWidth and preferredHeight
Parameters:
width_nr - Preferred width of the panel
height_nr - Preferred height of the panel


Method Detail

addcell

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


addcell

public  addcell(in_panelname_tx IN varchar2, 
in_bordercell_r IN api_layout.t_bordercell)
Adds a border cell to the panel.
Parameters:
in_panelname_tx - The name of the panel.
in_bordercell_r - The border layout cell to be added to the container.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpaneltype - Raised when panel type is not simple panel.
e_incompitablelayouttype - Raised when the container’s layout is not border layout.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.


addcell

public  addcell(in_panelname_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_panelname_tx - The name of the panel.
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 order the table layout cell appears in the table layout row. This input parameter is only meaningful for table layout cells.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpaneltype - Raised when panel type is not simple panel.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.


addpanel

public  addpanel(in_panelname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_subpanelname_tx IN varchar2)
Adds the panel to the layout cell in the parent panel.
Parameters:
in_panelname_tx - The name of the panel. that contains the layout cell
in_cellname_tx - The name of the layout cell.
in_subpanelname_tx - The name of panel to be placed into the cell
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpaneltype - Raised when panel type is not simple panel.
e_invalidcellname - Raised when the layout cell does not exist.
e_invalidoperation - Raised when value in the in_cellName_tx parameter refers to a table layout row.
e_recursivepanelinclusion - Raised when one of parent panels of the panel is added as subpanel.


addpanel

public  addpanel(in_panelname_tx IN varchar2, 
in_xycell_r IN api_layout.t_xycell,
in_subpanelname_tx IN varchar2)
Creates a new XY layout cell in the panel. Adds the panel to the XY cell.
Parameters:
in_panelname_tx - The name of the panel.
in_xycell_r - The XY layout cell to be added to the container.
in_subpanelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpaneltype - Raised when panel type is not simple panel.
e_incompitablelayouttype - Raised when the container’s layout is not XY layout.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_recursivepanelinclusion - Raised when one of parent panels of the panel is added as subpanel.


addpanel

public  addpanel(in_panelname_tx IN varchar2, 
in_bordercell_r IN api_layout.t_bordercell,
in_subpanelname_tx IN varchar2)
Creates a new border layout cell in the panel. Adds the panel into the cell.
Parameters:
in_panelname_tx - The name of the panel.
in_bordercell_r - The border layout cell to be added to the container.
in_subpanelname_tx - The name of panel
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpaneltype - Raised when panel type is not simple panel.
e_incompitablelayouttype - Raised when the container’s layout is not border layout.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_recursivepanelinclusion - Raised when one of parent panels of the panel is added as subpanel.


addpanel

public  addpanel(in_panelname_tx IN varchar2, 
in_rowname_tx IN varchar2,
in_tablecell_r IN api_layout.t_tablecell,
in_subpanelname_tx IN varchar2)
Creates a new table layout cell in the panel. Adds the panel into the cell.
Parameters:
in_panelname_tx - The name of the panel. containing the tableRow
in_rowname_tx - Name of the row that tableCell will be placed in
in_tablecell_r - The table layout cell to be added to the table layout row.
in_subpanelname_tx - The name of the panel to be placed
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpaneltype - Raised when panel type is not simple panel.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_invalidcellname - Raised when the table layout row does not exist.
e_recursivepanelinclusion - Raised when one of parent panels of the panel is added as subpanel.


addrow

public  addrow(in_panelname_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 panel.
Parameters:
in_panelname_tx - The name of the panel.
in_tablerow_r - The table layout row to be added to the container.
in_index_nr - The order the table layout row appears in the table. This input parameter is only meaningful for table layout rows.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpaneltype - Raised when panel type is not simple panel.
e_incompitablelayouttype - Raised when the container’s layout is not table layout.
e_cellalreadyexists - Rasied when a cell with the same name is already present in the container.
e_invalidinputparameter - Raised when in_tableRow_r.heightPolicy_cd value is invalid.


addstyleclass

public  addstyleclass(in_panelname_tx IN varchar2, 
in_styleclass_tx IN varchar2)
Adds CSS class to the HTML object of the panel. CSS classes should be defined in the CSS file of the application. Application CSS file can be set at IDE application dialog.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
ora-20001 - if the panel cannot be created.
e_xmlhaserror - if the input Panel XML cannot be parsed
e_invalidxml - if the input is not of a known Panel type


disableall

public  disableall(in_panelname_tx IN varchar2)
Disables the panel and all the components in it.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


enableall

public  enableall(in_panelname_tx IN varchar2)
Enables the panel and all the components in it.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getbackgroundcolor

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


getbordertitle

public varchar2 getbordertitle(in_panelname_tx IN varchar2)
Returns the border title of the panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getbordertype

public varchar2 getbordertype(in_panelname_tx IN varchar2)
Returns the border type of the panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getcell

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


getcellcontent

public api_application.t_object getcellcontent(in_panelname_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_panelname_tx - The name of the panel.
in_cellname_tx - The name of the layout cell.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_notsupportedcelltype - Raised when given name with in_cellName_tx belongs to a table layout row.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.


getdividerlocation

public varchar2 getdividerlocation(in_panelname_tx IN varchar2)
Returns the divider location as a percentage value for the split panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getdividerorientation

public varchar2 getdividerorientation(in_panelname_tx IN varchar2)
Returns the orientation of the split panel.

The constants returns from this APi are: HORIZONTAL and VERTICAL.

Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getfontcolor

public varchar2 getfontcolor(in_panelname_tx IN varchar2)
Returns the font color of the panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getfontfamily

public varchar2 getfontfamily(in_panelname_tx IN varchar2)
Returns the font family of the panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getfontsize

public number getfontsize(in_panelname_tx IN varchar2)
Returns the font size of the panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getfontstyle

public varchar2 getfontstyle(in_panelname_tx IN varchar2)
Returns the font style of the panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getheightpolicy

public varchar2 getheightpolicy(in_panelname_tx IN varchar2, 
in_cellname_tx IN varchar2)
Returns the height policy of the layout cell.

The constants defined for the possible values returned from this function are API_Layout.POLICY_DYNAMIC and API_Layout.POLICY_STATIC.

Parameters:
in_panelname_tx - The name of the panel.
in_cellname_tx - The name of the layout cell.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.


getid

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


getparentcell

public api_layout.t_cell getparentcell(in_panelname_tx IN varchar2)
Returns the layout cell that the panel is in.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_noparentcellexists - Raised when the panel does not have a parent layout cell.


getparentrow

public api_layout.t_tablerow getparentrow(in_panelname_tx IN varchar2)
Returns the table layout row the panel is in.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_panelnotundertablecell - Raised when the panel is not in a table layout cell.


getparentrow

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


getpreferredheightpolicy

public varchar2 getpreferredheightpolicy(in_panelname_tx IN varchar2)
Returns the preferred height policy of the panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getpreferredsize

public t_size getpreferredsize(in_panelname_tx IN varchar2)
Returns the preferred height and width of the panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getpreferredwidthpolicy

public varchar2 getpreferredwidthpolicy(in_panelname_tx IN varchar2)
Returns the preferred width policy of the panel.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getprintcolor

public varchar2 getprintcolor(in_panelname_tx IN varchar2)
Returns the color that is used when the panel is printed.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


getrow

public api_layout.t_tablerow getrow(in_panelname_tx IN varchar2, 
in_rowname_tx IN varchar2)
Returns the table layout row.
Parameters:
in_panelname_tx - The name of the panel.
in_rowname_tx - The name of the table layout row.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the table layout row does not exist.


getstyleclass

public varchar2 getstyleclass(in_panelname_tx IN varchar2)
Gets the CSS class(es) added to the HTML object of the component.
Parameters:
in_panelname_tx - The name of the panel.
Returns:
Name of the style class. If multiple classes are added, then a string with class names separated by space character returned. Ex: 'class1 class2 class3'
Throws:
e_invalidpanelname - Raised when the component does not exist in the application.


getwindow

public api_application.t_object getwindow(in_panelname_tx IN varchar2)
Returns the window the panel is in.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


hasstyleclass

public varchar2 hasstyleclass(in_panelname_tx IN varchar2, 
in_styleclass_tx IN varchar2)
Returns Y if the specified class is added to the panel.
Parameters:
in_panelname_tx - The fully name of the panel.
in_styleclass_tx - The name of the CSS class(es). It is possible to check multiple classes at the same time separated by space character. Ex: 'class1 class2 class3'
Throws:
e_invalidpanelname - Raised when the component does not exist in the application.


iscell

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


isprintable

public varchar2 isprintable(in_panelname_tx IN varchar2)
Returns whether the panel is printable.
Parameters:
in_panelname_tx - The name of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


isvisible

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


print

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


removecell

public  removecell(in_panelname_tx IN varchar2, 
in_cellname_tx IN varchar2)
Deletes the layout cell from the panel.
Parameters:
in_panelname_tx - The name of the panel.
in_cellname_tx - The name of the layout cell.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_invalidpaneltype - Raised when panel type is not simple panel.


removepanel

public  removepanel(in_panelname_tx IN varchar2, 
in_subpanelname_tx IN varchar2,
in_keeplegacycell_yn IN varchar2 DEFAULT 'Y')
Removes the panel from the panel.
Parameters:
in_panelname_tx - The name of the panel.
in_subpanelname_tx - The name of the panel to be removed.
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_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpaneltype - Raised when panel type is not simple panel.
e_panelnotfoundonpanel - Raised when the panel does not contain the subPanel to be removed.


removepanel

public  removepanel(in_subpanelname_tx IN varchar2)
Removes the panel from its parent.
Parameters:
in_subpanelname_tx - The name of the panel to be removed.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


removestyleclass

public  removestyleclass(in_panelname_tx IN varchar2, 
in_styleclass_tx IN varchar2)
Removes CSS class from the HTML object of the panel.
Parameters:
in_panelname_tx - The name of the component Panel.
in_styleclass_tx - The name of the CSS class(es). It is possible to remove multiple classes at the same time separated by space character. Ex: 'class1 class2 class3'
Throws:
e_invalidpanelname - Raised when the component does not exist in the application.


replacepanel

public  replacepanel(in_panelname_tx IN varchar2, 
in_oldpanelname_tx IN varchar2,
in_newpanelname_tx IN varchar2)
Replaces an existing panel with another one.
Parameters:
in_panelname_tx - The name of the panel.
in_oldpanelname_tx - The name of removed panel.
in_newpanelname_tx - The name of substitute panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpaneltype - Raised when panel type is not simple panel.
e_recursivepanelinclusion - Raised when one of parent panels of the panel is added as subpanel.


setbackgroundcolor

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

See also:
api_color

setbordertitle

public  setbordertitle(in_panelname_tx IN varchar2, 
in_title_tx IN varchar2)
Updates the border title of the panel.
Parameters:
in_panelname_tx - The name of the panel.
in_title_tx - The new border title of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


setbordertype

public  setbordertype(in_panelname_tx IN varchar2, 
in_bordertype_cd IN varchar2)
Updates the border type of the panel.
Parameters:
in_panelname_tx - The name of the panel.
in_bordertype_cd - The type of the panel border.

Valid Constants for this input variable are: LINE_BORDER, TITLED_BORDER, LOWERED_BEVEL_BORDER, LOWERED_ETCHED_BORDER, RAISED_BEVEL_BORDER, RAISED_ETCHED_BORDER.

Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidbordertype - Raised when in_bordertype_cd value is invalid.


setcell

public  setcell(in_panelname_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 panel.
Parameters:
in_panelname_tx - The name of the panel.
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 the table layout cell appears in the table layout row. This input parameter is only meaningful for table layout cells.
Throws:
e_invalidpanelname - Raised when the panel 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_panelname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_childheight_nr IN number)
Updates height of component which take place in specified TableCell.
Parameters:
in_panelname_tx - The name of the panel.
in_cellname_tx - The name of the layout cell.
in_childheight_nr - Height of the component
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a border layout cell.


setcellchildwidth

public  setcellchildwidth(in_panelname_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_panelname_tx - The name of the panel.
in_cellname_tx - The name of the layout cell.
in_childwidth_nr - Height of the component
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a border layout cell.


setcellcolumnspan

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


setcelldocking

public  setcelldocking(in_panelname_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_panelname_tx - The name of the panel.
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_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a border layout cell.
e_invalidinputparameter - Raised when in_docking_cd value is invalid.


setcellhalign

public  setcellhalign(in_panelname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_halign_cd IN varchar2)
Updates the horizontal alignment of the table cell.
Parameters:
in_panelname_tx - The name of the panel.
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_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.
e_invalidinputparameter - Raised when in_hAlign_cd value is invalid.


setcellheight

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


setcellposition

public  setcellposition(in_panelname_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_panelname_tx - The name of the panel.
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_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a XY layout cell.


setcellpositionx

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


setcellpositiony

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


setcellrowspan

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


setcellvalign

public  setcellvalign(in_panelname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_valign_cd IN varchar2)
Updates the vertical align of the table layout cell.
Parameters:
in_panelname_tx - The name of the panel.
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_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.
e_invalidinputparameter - Raised when in_vAlign_cd value is invalid.


setcellwidth

public  setcellwidth(in_panelname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_width_tx IN varchar2)
Updates the width of the layout cell.
Parameters:
in_panelname_tx - The name of the panel.
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_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidcelltype - Raised when in_cellName_tx refers to a table layout row.
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.


setdividerlocation

public  setdividerlocation(in_panelname_tx IN varchar2, 
in_dividerlocation_tx IN varchar2)
Updates the location of the divider of the split panel.
Parameters:
in_panelname_tx - The name of the panel.
in_dividerlocation_tx - he location of the divider in percentage.This input parameter accepts integer values between 0 and 100.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidpercentagevalue - Raised when the divider location is not an integer value between 0 and 100.


setdividerorientation

public  setdividerorientation(in_panelname_tx IN varchar2, 
in_dividerorientation_cd IN varchar2)
Updates the orientation of the divider of a split panel.
Parameters:
in_panelname_tx - The name of the panel.
in_dividerorientation_cd - The new orientation of the divider.

Valid constants for this input parameter are HORIZONTAL and VERTICAL.

Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidinputparameter - Raised when in_dividerOrientation_cd value is invalid.


setfontcolor

public  setfontcolor(in_panelname_tx IN varchar2, 
in_fontcolor_cd IN varchar2)
Updates the font color of the panel.
Parameters:
in_panelname_tx - The name of the panel.
in_fontcolor_cd - Font color of the panel. Please see API_COLOR for the valid list of values for this input parameter.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcolor - Raised when the input color value is not a valid color.

See also:
api_color

setfontfamily

public  setfontfamily(in_panelname_tx IN varchar2, 
in_fontfamily_tx IN varchar2)
Updates font family of the panel
Parameters:
in_panelname_tx - The name of the panel.
in_fontfamily_tx - Font family of the panel
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


setfontsize

public  setfontsize(in_panelname_tx IN varchar2, 
in_fontsize_nr IN number)
Updates font size of the panel
Parameters:
in_panelname_tx - The name of the panel.
in_fontsize_nr - Font size of the panel
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


setfontstyle

public  setfontstyle(in_panelname_tx IN varchar2, 
in_fontstyle_tx IN varchar2)
Updates font style of the panel
Parameters:
in_panelname_tx - The name of the panel.
in_fontstyle_tx - Font style of the panel
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


setheightpolicy

public  setheightpolicy(in_panelname_tx IN varchar2, 
in_cellname_tx IN varchar2,
in_heightpolicy_cd IN varchar2)
Updates the height policy of the layout cell.

If height policy is dynamic, the layout cell height will increase to show all of its content. If the policy is static then the layout cell’s height will be determined by its height attribute.

Parameters:
in_panelname_tx - The name of the panel.
in_cellname_tx - The name of the layout cell.
in_heightpolicy_cd - The new height policy for the layout cell.

Valid constant for this input variable are API_Layout.POLICY_DYNAMIC, API_Layout.POLICY_STATIC

Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidinputparameter - Raised when in_heightPolicy_cd value is invalid.


setparentcell

public  setparentcell(in_panelname_tx IN varchar2, 
in_cell_r IN api_layout.t_cell,
in_index_nr IN number DEFAULT null)
Updates the layout cell the panel is in.
Parameters:
in_panelname_tx - The name of the panel.
in_cell_r - The new values of the layout cell.
in_index_nr - The order the table layout cell appears in the table. This input parameter is only meaningful for table layout cells.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


setparentrow

public  setparentrow(in_panelname_tx IN varchar2, 
in_tablerow_r IN api_layout.t_tablerow,
in_index_nr IN number DEFAULT null)
Updates the table layout row the panel is in.
Parameters:
in_panelname_tx - The name of the panel.
in_tablerow_r - The new value for the attributes of the table layout row.
in_index_nr - The order the table layout row appears in the table.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_panelnotundertablecell - Raised when the panel is not in a table layout cell.


setparentrow

public  setparentrow(in_panelname_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 table layout row the table layout cell is in.
Parameters:
in_panelname_tx - The name of the panel.
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 the table layout row appears in the table.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidcelltype - Raised when in_cellName_tx does not refer to a table layout cell.


setpreferredheightpolicy

public  setpreferredheightpolicy(in_panelname_tx IN varchar2, 
in_preferredheightpolicy_cd IN varchar2)
Updates the preferred height policy of the panel.
Parameters:
in_panelname_tx - The name of the panel.
in_preferredheightpolicy_cd - The new preferred height policy of the panel.

Valid constants for this input parameter are API_Layout.POLICY_DYNAMIC and API_Layout.POLICY_STATIC.

Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidinputparameter - Raised when in_preferredHeightPolicy_cd value is invalid.


setpreferredsize

public  setpreferredsize(in_panelname_tx IN varchar2, 
in_preferredsize_r IN api_panel.t_size)
Updates the preferred width and height of the panel.
Parameters:
in_panelname_tx - The name of the panel.
in_preferredsize_r - The new preferred width and height of the panel.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


setpreferredwidthpolicy

public  setpreferredwidthpolicy(in_panelname_tx IN varchar2, 
in_preferredwidthpolicy_cd IN varchar2)
Updates the preferred width policy of the panel.
Parameters:
in_panelname_tx - The name of the panel.
in_preferredwidthpolicy_cd - The new preferred width policy of the panel.

Valid constants for this input parameter are API_Layout.POLICY_DYNAMIC and API_Layout.POLICY_STATIC.

Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidinputparameter - Raised when in_preferredWidthPolicy_cd value is invalid.


setprintable

public  setprintable(in_panelname_tx IN varchar2, 
in_printable_yn IN varchar2)
Updates whether the panel is printable or not.
Parameters:
in_panelname_tx - The name of the panel.
in_printable_yn - The new value for the printable attribute.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


setprintcolor

public  setprintcolor(in_panelname_tx IN varchar2, 
in_printcolor_cd IN varchar2)
Updates the color the panel uses when it is printed.
Parameters:
in_panelname_tx - The name of the panel.
in_printcolor_cd - The new color value.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcolor - Raised when the input color value is not a valid color.

See also:
api_color

setrow

public  setrow(in_panelname_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 specified row in the table layout.
Parameters:
in_panelname_tx - The name of the panel.
in_rowname_tx - The name of table row
in_tablerow_r - The new value for the attributes of the table layout row.
in_index_nr - The order the table layout row appears in the table.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the table layout row does not exist.


setrowheight

public  setrowheight(in_panelname_tx IN varchar2, 
in_rowname_tx IN varchar2,
in_rowheight_nr IN number)
Updates the height of the table layout row.
Parameters:
in_panelname_tx - The name of the panel.
in_rowname_tx - The name of the layout cell.
in_rowheight_nr - The new height of the table layout row.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.
e_invalidcellname - Raised when the layout cell does not exist.
e_cellnotfoundonpanel - Raised when the layout cell is not in the panel.
e_invalidcelltype - Raised when in_rowName_tx does not refer to a table layout row.


setstyleclass

public  setstyleclass(in_panelname_tx IN varchar2, 
in_styleclass_tx IN varchar2)
Updates the CSS classes for the panel's HTML object. Unlike the addStyleClass API, any existing style classes on the panel are overwritten CSS classes should be defined in the CSS file of the application. Application CSS file can be set at IDE application dialog.
Parameters:
in_panelname_tx - The name of the panel. Ex: mainPanel
in_styleclass_tx - The name of the CSS class(es). It is possible to add multiple classes at the same time separated by space character. Ex: 'class1 class2 class3'
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


setvisible

public  setvisible(in_panelname_tx IN varchar2, 
in_visible_yn IN varchar2)
Updates the visible attribute of the panel
Parameters:
in_panelname_tx - The name of the panel.
in_visible_yn - The new value of the visible attribute.
Throws:
e_invalidpanelname - Raised when the panel does not exist in the application.


Formspider APIs