Formspider APIs


Package api_component


Field Summary
 varchar2(200)file_format_xls CONSTANT := bdf_constant.fileformatxls
           Value: 'xls'
 varchar2(200)file_format_xlsx CONSTANT := bdf_constant.fileformatxlsx
           Value: 'xlsx'
 varchar2(200)scrollbar_always CONSTANT := bdf_constant.always
           Value: 'Always'
 varchar2(200)scrollbar_never CONSTANT := bdf_constant.never
           Value: 'Never'
 varchar2(200)scrollbar_when_needed CONSTANT := bdf_constant.whenneeded
           Value: 'WhenNeeded'
 varchar2(200)select_multiple CONSTANT := bdf_constant.selectmultiple
           Value: 'SelectMultiple'
 varchar2(200)select_one CONSTANT := bdf_constant.selectone
           Value: 'SelectOne'

Type Summary
 RECORD t_font(fontsize_nr number, fontcolor_cd varchar2(4000), fontfamily_tx varchar2(255), fontstyle_tx varchar2(255))
           Record type for the Font object.
 table OF number INDEX BY binary_integer tt_selectedrows()
           Table type to hold the selected row OID’s in a grid component.
 table OF varchar2(4000) INDEX BY binary_integer tt_selectedvalues()
           Table type to hold the selected values in a list component.

Method Summary
  addstyleclass(in_paneldotcomponentname_tx IN varchar2, in_styleclass_tx IN varchar2)
           Adds CSS class to the HTML object of the component.
  clearfileuploaduifield(in_paneldotcomponentname_tx IN varchar2)
           Erases the value in the text field of the file upload component which points to the file to be uploaded.
  cleargridinteractions(in_paneldotcomponentname_tx IN varchar2)
           Clears sort, filters and functions of the grid component.
  clearuploadedfile(in_paneldotcomponentname_tx IN varchar2, in_clearfileuploaduifield_yn IN varchar2 DEFAULT 'Y')
           Erases the uploaded file from the file upload component or the datasource the file upload component is bound to.
 varchar2 getbackgroundcolor(in_paneldotcomponentname_tx IN varchar2)
           Returns the background color the the component
 varchar2 getbrowserwindowname(in_paneldotcomponentname_tx IN varchar2)
           Returns the browser window name of the component.
 varchar2 getclickedgridcolumnname(in_paneldotcomponentname_tx IN varchar2)
           Returns the name of the grid column clicked by the user.
 varchar2 getdatasource(in_paneldotcomponentname_tx IN varchar2)
           Gets the datasource of specified component.
 t_font getfont(in_paneldotcomponentname_tx IN varchar2)
           Returns the Font object of the component.
 varchar2 getfontcolor(in_paneldotcomponentname_tx IN varchar2)
           Returns the font color of the component.
 varchar2 getfontfamily(in_paneldotcomponentname_tx IN varchar2)
           Returns the font family of the component.
 number getfontsize(in_paneldotcomponentname_tx IN varchar2)
           Returns the font size of the component.
 varchar2 getfontstyle(in_paneldotcomponentname_tx IN varchar2)
           Returns the font style of the component.
 varchar2 getgridcolumnlabel(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Deprecated. Use getGridHeaderLabel instead.
 varchar2 getgridcolumnwidth(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns the width of the grid column.
 varchar2 getgridheaderbackgroundcolor(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns the background color of the grid column header.
 varchar2 getgridheaderfontcolor(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns the font color of the grid column header.
 varchar2 getgridheaderfontfamily(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns the font family of the grid column header.
 varchar2 getgridheaderfontsize(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns the font size of the grid column header.
 varchar2 getgridheaderfontstyle(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns the font style of the grid column header.
 varchar2 getgridheaderlabel(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns the label of the grid column header.
 varchar2 getgridheadertextalignment(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns the text alignment value of the grid column header.
 varchar2 getgridscrollbarpolicy(in_paneldotcomponentname_tx IN varchar2)
           Returns the behavior model of the grid scroll bar.
 clob getgridstate(in_paneldotcomponentname_tx IN varchar2)
           Gets the state of the Grid.
 varchar2 geticon(in_paneldotcomponentname_tx IN varchar2)
           Returns the icon path of the component.
 number getid(in_paneldotcomponentname_tx IN varchar2)
           Returns the run time ID of the component.
 varchar2 getlabel(in_paneldotcomponentname_tx IN varchar2)
           Returns the label value of the component.
 varchar2 getlistdatasource(in_paneldotcomponentname_tx IN varchar2)
           Gets the list datasource of specified component.
 varchar2 getmaxfilesize(in_paneldotcomponentname_tx IN varchar2)
           Returns the upper limit of the file size specified for the file upload component.
 varchar2 getnumbermask(in_paneldotcomponentname_tx IN varchar2)
           Returns the number mask for the textField and textLabel components.
 varchar2 getprintcolor(in_paneldotcomponentname_tx IN varchar2)
           Returns the print color of the component
 number getrightclickedrowid(in_paneldotcomponentname_tx IN varchar2)
           Returns the ID of the row that is clicked with the right mouse button in the grid.
 varchar2 getrowheightpolicy(in_paneldotcomponentname_tx IN varchar2)
           Returns the row height policy of the grid component.
 number getselectedrowid(in_paneldotcomponentname_tx IN varchar2)
           Returns the row ID of the row selected by the user in the grid component.
 tt_selectedrows getselectedrowids(in_paneldotcomponentname_tx IN varchar2)
           Returns the list of row ID’s selected by the user in the grid component.
 tt_selectedvalues getselectedvalues(in_paneldotcomponentname_tx IN varchar2)
           Returns the selected values in a list.
 varchar2 getselectiontype(in_paneldotcomponentname_tx IN varchar2)
           Returns the selection type used for the grid component.
 varchar2 getstyleclass(in_paneldotcomponentname_tx IN varchar2)
           Gets the CSS class(es) added to the HTML object of the component.
 varchar2 gettextalignment(in_paneldotcomponentname_tx IN varchar2)
           Returns the text alignment value for textField, textlabel, dateField, formattedField, hyperLink, passwordField components.
 varchar2 getuploadedfilename(in_paneldotcomponentname_tx IN varchar2)
           Returns the name of the uploaded file.
 varchar2 getuploadedfilepath(in_paneldotcomponentname_tx IN varchar2)
           Returns the full path of the uploaded file.
 varchar2 geturl(in_paneldotcomponentname_tx IN varchar2)
           Returns the value of the URL attribute of the hyperlink component.
 blob getvaluebl(in_paneldotcomponentname_tx IN varchar2)
           Returns the value of the component as a BLOB.
 clob getvaluecl(in_paneldotcomponentname_tx IN varchar2)
           Returns the value of the component as a CLOB.
 date getvaluedt(in_paneldotcomponentname_tx IN varchar2)
           Returns the value of the component as Date.
 number getvaluenr(in_paneldotcomponentname_tx IN varchar2)
           Returns the value of the component as Number.
 varchar2 getvaluetx(in_paneldotcomponentname_tx IN varchar2)
           Returns the value of the component as Varchar2.
 varchar2 hasstyleclass(in_paneldotcomponentname_tx IN varchar2, in_styleclass_tx IN varchar2)
           Returns Y if the specified class is added to the component.
 varchar2 ischecked(in_paneldotcomponentname_tx IN varchar2)
           Returns whether the checkbox component is checked.
 varchar2 iseditable(in_paneldotcomponentname_tx IN varchar2)
           Returns the value of the editable attribute of the component.
 varchar2 isenabled(in_paneldotcomponentname_tx IN varchar2)
           Returns the value of the enabled attribute of the component.
 varchar2 isfocused(in_paneldotcomponentname_tx IN varchar2, in_innercomponent_yn IN varchar2 DEFAULT 'N')
           Returns whether the component has the focus.
 varchar2 isgridcolumneditable(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns whether the components in the grid column allow editing.
 varchar2 isgridcolumnvisible(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2)
           Returns whether the grid column is visible.
 varchar2 isgridheadervisible(in_paneldotcomponentname_tx IN varchar2)
           Returns whether the grid column header is visible.
 varchar2 ismousehover(in_paneldotcomponentname_tx IN varchar2)
           Returns the value of the mouseHover attribute of the grid component.
 varchar2 isprintable(in_paneldotcomponentname_tx IN varchar2)
           Returns whether the component is printable.
 varchar2 issortable(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2 DEFAULT null)
           Returns whether the grid or grid column is sortable.
 varchar2 istransferringfocus(in_paneldotcomponentname_tx IN varchar2)
           Deprecated. This value will be dismissed by Formspider. The value of attribute will be "Y" at run-time, even it is specified as "N".
 varchar2 isuploadsuccessful(in_paneldotcomponentname_tx IN varchar2)
           Returns the result of the latest file upload event.
 varchar2 isvisible(in_paneldotcomponentname_tx IN varchar2)
           Returns the display state of the component.
 varchar2 iswordwrap(in_paneldotcomponentname_tx IN varchar2)
           Returns the WordWrap state of the component.
  print(in_paneldotcomponentname_tx IN varchar2)
           Prints the contents of the textArea component.
  printtoexcel(in_paneldotcomponentname_tx IN varchar2, in_usepaging_yn IN varchar2 DEFAULT 'Y', in_filename_tx IN varchar2 DEFAULT null, in_fileformat_cd IN varchar2 DEFAULT file_format_xls)
           Generates an excel file using columns of a given grid component.
  removestyleclass(in_paneldotcomponentname_tx IN varchar2, in_styleclass_tx IN varchar2)
           Removes CSS class from the HTML object of the component.
  requestfocus(in_paneldotcomponentname_tx IN varchar2)
           Attempts to gain focus to the component.
  resetgridstate(in_paneldotcomponentname_tx IN varchar2, in_reloaddata_yn IN varchar2 DEFAULT 'Y')
           Resets the state of the Grid.
  savetofile(in_paneldotcomponentname_tx IN varchar2, in_filename_tx IN varchar2)
           Saves the content of the textArea component.
  setbackgroundcolor(in_paneldotcomponentname_tx IN varchar2, in_backgroundcolor_cd IN varchar2)
           Updates background color of the component.
  setbrowserwindowname(in_paneldotcomponentname_tx IN varchar2, in_browserwindowname_tx IN varchar2)
           Updates the browserWindowName attribute of the hyperLink component.
  seteditable(in_paneldotcomponentname_tx IN varchar2, in_editable_yn IN varchar2, in_primarykey_tx IN varchar2 DEFAULT null, in_row_id IN number DEFAULT null)
           Updates the editable attribute of the component.
  setenable(in_paneldotcomponentname_tx IN varchar2, in_enabled_yn IN varchar2, in_primarykey_tx IN varchar2 DEFAULT null, in_row_id IN number DEFAULT null)
           Updates the enable attribute of the component.
  setfont(in_paneldotcomponentname_tx IN varchar2, in_font_r IN t_font)
           Updates the font of the component.
  setfontcolor(in_paneldotcomponentname_tx IN varchar2, in_fontcolor_cd IN varchar2, in_primarykey_tx IN varchar2 DEFAULT null, in_row_id IN number DEFAULT null)
           Updates the font color of the component.
  setfontfamily(in_paneldotcomponentname_tx IN varchar2, in_fontfamily_tx IN varchar2)
           Updates the font family of the component.
  setfontsize(in_paneldotcomponentname_tx IN varchar2, in_fontsize_nr IN varchar2)
           Updates the font size of the component.
  setfontstyle(in_paneldotcomponentname_tx IN varchar2, in_fontstyle_tx IN varchar2)
           Updates the font style of the component.
  setgridcolumnlabel(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_label_tx IN varchar2)
           Deprecated. Use setGridHeaderLabel instead.
  setgridcolumnvisible(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_visible_yn IN varchar2)
           Updates the visible attribute of the grid column.
  setgridcolumnwidth(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_width_tx IN varchar2)
           Updates the width attribute of the grid column.
  setgridheaderbackgroundcolor(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_backgroundcolor_cd IN varchar2)
           Updates the background color of the grid column header.
  setgridheaderfontcolor(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_fontcolor_cd IN varchar2)
           Updates the font color of the grid column header.
  setgridheaderfontfamily(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_fontfamily_tx IN varchar2)
           Updates the font family of the grid column header.
  setgridheaderfontsize(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_fontsize_nr IN number)
           Updates the font size of the grid column header.
  setgridheaderfontstyle(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_fontstyle_tx IN varchar2)
           Updates the font style of the grid column header.
  setgridheaderlabel(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_label_tx IN varchar2)
           Sets the label of grid column header.
  setgridheadertextalignment(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_textalignment_cd IN varchar2)
           Updates the text alignment of the grid column header.
  setgridheadervisible(in_paneldotcomponentname_tx IN varchar2, in_visible_yn IN varchar2)
           Update the display state of the grid column header.
  setgridscrollbarpolicy(in_paneldotcomponentname_tx IN varchar2, in_policy_cd IN varchar2)
           Update when the grid scroll bar should be visible.
  setgridstate(in_paneldotcomponentname_tx IN varchar2, in_value_cl IN clob, in_reloaddata_yn IN varchar2 DEFAULT 'Y')
           Updates the state of the Grid.
  seticon(in_paneldotcomponentname_tx IN varchar2, in_icon_tx IN varchar2)
           Updates the icon of the component
  setlabel(in_paneldotcomponentname_tx IN varchar2, in_label_tx IN varchar2)
           Updates the label of the component
  setmaxfilesize(in_paneldotcomponentname_tx IN varchar2, in_maxfilesize_tx IN varchar2)
           Updates maximum file upload size for the fileUpload component.
  setmousehover(in_paneldotcomponentname_tx IN varchar2, in_mousehover_yn IN varchar2)
           Updates mouseHover behavior of the grid component.
  setnumbermask(in_paneldotcomponentname_tx IN varchar2, in_numbermask_tx IN varchar2)
           Updates the numbermask attribute for textField and textLabel components.
  setprintable(in_paneldotcomponentname_tx IN varchar2, in_printable_yn IN varchar2)
           Updates the behavior of text components when the screen is printed.
  setprintcolor(in_paneldotcomponentname_tx IN varchar2, in_printcolor_cd IN varchar2)
           Updates the color the component uses when it is printed.
  setrowheightpolicy(in_paneldotcomponentname_tx IN varchar2, in_rowheightpolicy_cd IN varchar2)
           Updates the row height policty of the grid component.
  setselectedrowid(in_paneldotcomponentname_tx IN varchar2, in_selectedrowid_nr IN number DEFAULT null)
           Selects a row in the grid component.
  setselectedrowids(in_paneldotcomponentname_tx IN varchar2, in_selectedrows_t IN tt_selectedrows)
           Selects multiple rows in the grid component.
  setselectedvalues(in_paneldotcomponentname_tx IN varchar2, in_selectedvalues_t IN tt_selectedvalues)
           Marks multiple values in the list component as selected.
  setselectiontype(in_paneldotcomponentname_tx IN varchar2, in_selectiontype_cd IN varchar2)
           Updates the selection type of the grid and list components.
  setsortable(in_paneldotcomponentname_tx IN varchar2, in_columnname_tx IN varchar2, in_sortable_yn IN varchar2)
           Sets whether clicking a grid column header orders the rows in the grid automatically by the column clicked.
  setsortable(in_paneldotcomponentname_tx IN varchar2, in_sortable_yn IN varchar2)
           Sets whether clicking a grid column header orders the rows in the grid automatically by the column clicked.
  setstyleclass(in_paneldotcomponentname_tx IN varchar2, in_styleclass_tx IN varchar2)
           Updates CSS classes of the component's HTML object.
  settextalignment(in_paneldotcomponentname_tx IN varchar2, in_textalignment_cd IN varchar2)
           Updates the text alignment of textField, textLabel, dateFeild,formattedField, hyperLink, passwordField components.
  settooltip(in_paneldotcomponentname_tx IN varchar2, in_tooltip_tx IN varchar2)
           Updates the tooltip message of the component.
  settransferfocus(in_paneldotcomponentname_tx IN varchar2, in_transferfocus_yn IN varchar2)
           Deprecated. This value will be dismissed by Formspider. The value of attribute will be "Y" at run-time, even it is specified as "N".
  seturl(in_paneldotcomponentname_tx IN varchar2, in_url_tx IN varchar2 DEFAULT null)
           Updates the URL property for the hyperLink, htmlRenderer and image components.
  setvalue(in_paneldotcomponentname_tx IN varchar2, in_value_dt IN date)
           Updates the value of the component with a date value.
  setvalue(in_paneldotcomponentname_tx IN varchar2, in_value_nr IN number)
           Updates the value of the component with a number value.
  setvalue(in_paneldotcomponentname_tx IN varchar2, in_value_tx IN varchar2)
           Updates the value of the component with a VARCHAR2 value
  setvalue(in_paneldotcomponentname_tx IN varchar2, in_value_cl IN clob)
           Updates value of the component with a CLOB value .
  setvalue(in_paneldotcomponentname_tx IN varchar2, in_value_bl IN blob)
           Updates value of the component with a BLOB value.
  setvisible(in_paneldotcomponentname_tx IN varchar2, in_visible_yn IN varchar2, in_primarykey_tx IN varchar2 DEFAULT null, in_row_id IN number DEFAULT null)
           Updates the display state of the component.
  setwordwrap(in_paneldotcomponentname_tx IN varchar2, in_wordwrap_yn IN varchar2)
           Updates the word wrap state for the text area component.

Field Detail

file_format_xls

        public varchar2(200) file_format_xls CONSTANT := bdf_constant.fileformatxls
Value: 'xls'

file_format_xlsx

        public varchar2(200) file_format_xlsx CONSTANT := bdf_constant.fileformatxlsx
Value: 'xlsx'

scrollbar_always

        public varchar2(200) scrollbar_always CONSTANT := bdf_constant.always
Value: 'Always'

scrollbar_never

        public varchar2(200) scrollbar_never CONSTANT := bdf_constant.never
Value: 'Never'

scrollbar_when_needed

        public varchar2(200) scrollbar_when_needed CONSTANT := bdf_constant.whenneeded
Value: 'WhenNeeded'

select_multiple

        public varchar2(200) select_multiple CONSTANT := bdf_constant.selectmultiple
Value: 'SelectMultiple'

select_one

        public varchar2(200) select_one CONSTANT := bdf_constant.selectone
Value: 'SelectOne'

Type Detail

t_font

public RECORD t_font(fontsize_nr number, 
fontcolor_cd varchar2(4000),
fontfamily_tx varchar2(255),
fontstyle_tx varchar2(255))
Record type for the Font object.
Parameters:
fontsize_nr - Font size
fontcolor_cd - Font color. Please see API_COLOR for the valid list of values for this parameter.
fontfamily_tx - Font family
fontstyle_tx - Font style


tt_selectedrows

public table OF number INDEX BY binary_integer tt_selectedrows()
Table type to hold the selected row OID’s in a grid component.


tt_selectedvalues

public table OF varchar2(4000) INDEX BY binary_integer tt_selectedvalues()
Table type to hold the selected values in a list component.


Method Detail

addstyleclass

public  addstyleclass(in_paneldotcomponentname_tx IN varchar2, 
in_styleclass_tx IN varchar2)
Adds CSS class to the HTML object of the component. CSS classes should be defined in the CSS file of the application. Application CSS file can be set at IDE application dialog.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
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_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.


clearfileuploaduifield

public  clearfileuploaduifield(in_paneldotcomponentname_tx IN varchar2)
Erases the value in the text field of the file upload component which points to the file to be uploaded.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


cleargridinteractions

public  cleargridinteractions(in_paneldotcomponentname_tx IN varchar2)
Clears sort, filters and functions of the grid component. Performs execute query after interactions are removed.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidcomponenttype - Raised when the component is not a grid.
e_notboundtodatasource - Raised when the grid component is not bound to a datasource
e_invalidfilterclause - Raised when the datasource filter specified by api_datasource.setFilter, api_datasource.setFilterWhereClause, api_datasource.setFilterOrderByClause APIs is not valid.


clearuploadedfile

public  clearuploadedfile(in_paneldotcomponentname_tx IN varchar2, 
in_clearfileuploaduifield_yn IN varchar2 DEFAULT 'Y')
Erases the uploaded file from the file upload component or the datasource the file upload component is bound to. Optionally, the API also provides a means to clear the text field of the upload component which points to the file.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_clearfileuploaduifield_yn - If set to Y, the API erases the value in the text field in the file upload component that shows the file path.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcurrentrow - Raised when the current row value set by api_datasource.setCurrentRow API does not actually exist in the datasource.
e_nocurrentrow - Raised when the datasource has no current row.


getbackgroundcolor

public varchar2 getbackgroundcolor(in_paneldotcomponentname_tx IN varchar2)
Returns the background color the the component
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getbrowserwindowname

public varchar2 getbrowserwindowname(in_paneldotcomponentname_tx IN varchar2)
Returns the browser window name of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getclickedgridcolumnname

public varchar2 getclickedgridcolumnname(in_paneldotcomponentname_tx IN varchar2)
Returns the name of the grid column clicked by the user.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getdatasource

public varchar2 getdatasource(in_paneldotcomponentname_tx IN varchar2)
Gets the datasource of specified component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Returns:
Name of datasource of given component.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getfont

public t_font getfont(in_paneldotcomponentname_tx IN varchar2)
Returns the Font object of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getfontcolor

public varchar2 getfontcolor(in_paneldotcomponentname_tx IN varchar2)
Returns the font color of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getfontfamily

public varchar2 getfontfamily(in_paneldotcomponentname_tx IN varchar2)
Returns the font family of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getfontsize

public number getfontsize(in_paneldotcomponentname_tx IN varchar2)
Returns the font size of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getfontstyle

public varchar2 getfontstyle(in_paneldotcomponentname_tx IN varchar2)
Returns the font style of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getgridcolumnlabel

public varchar2 getgridcolumnlabel(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns the label of the grid column.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.

Deprecated:
Use getGridHeaderLabel instead.


getgridcolumnwidth

public varchar2 getgridcolumnwidth(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns the width of the grid column.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


getgridheaderbackgroundcolor

public varchar2 getgridheaderbackgroundcolor(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns the background color of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


getgridheaderfontcolor

public varchar2 getgridheaderfontcolor(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns the font color of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


getgridheaderfontfamily

public varchar2 getgridheaderfontfamily(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns the font family of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


getgridheaderfontsize

public varchar2 getgridheaderfontsize(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns the font size of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


getgridheaderfontstyle

public varchar2 getgridheaderfontstyle(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns the font style of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


getgridheaderlabel

public varchar2 getgridheaderlabel(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns the label of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


getgridheadertextalignment

public varchar2 getgridheadertextalignment(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns the text alignment value of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


getgridscrollbarpolicy

public varchar2 getgridscrollbarpolicy(in_paneldotcomponentname_tx IN varchar2)
Returns the behavior model of the grid scroll bar. Values that may be returned from this API are specified as the following constants: api_component.SCROLLBAR_ALWAYS, api_component.SCROLLBAR_NEVER, api_component.SCROLLBAR_WHEN_NEEDED.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getgridstate

public clob getgridstate(in_paneldotcomponentname_tx IN varchar2)
Gets the state of the Grid. Functions, filters and applied sorts on Grid and order, width, lock, visible status on columns will be added to XML. Note: All column names must be specified to get/set Grid status properly. Un-named column would be ignored.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Returns:
Status of the Grid in XML notation.
Throws:
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


geticon

public varchar2 geticon(in_paneldotcomponentname_tx IN varchar2)
Returns the icon path of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getid

public number getid(in_paneldotcomponentname_tx IN varchar2)
Returns the run time ID of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getlabel

public varchar2 getlabel(in_paneldotcomponentname_tx IN varchar2)
Returns the label value of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getlistdatasource

public varchar2 getlistdatasource(in_paneldotcomponentname_tx IN varchar2)
Gets the list datasource of specified component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Returns:
Name of list datasource of given component.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the component type is not ComboBox or List.


getmaxfilesize

public varchar2 getmaxfilesize(in_paneldotcomponentname_tx IN varchar2)
Returns the upper limit of the file size specified for the file upload component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getnumbermask

public varchar2 getnumbermask(in_paneldotcomponentname_tx IN varchar2)
Returns the number mask for the textField and textLabel components. Please refer to "http://brimframework.wetpaint.com/page/Number+Mask" for more information
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getprintcolor

public varchar2 getprintcolor(in_paneldotcomponentname_tx IN varchar2)
Returns the print color of the component
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


getrightclickedrowid

public number getrightclickedrowid(in_paneldotcomponentname_tx IN varchar2)
Returns the ID of the row that is clicked with the right mouse button in the grid.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getrowheightpolicy

public varchar2 getrowheightpolicy(in_paneldotcomponentname_tx IN varchar2)
Returns the row height policy of the grid component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getselectedrowid

public number getselectedrowid(in_paneldotcomponentname_tx IN varchar2)
Returns the row ID of the row selected by the user in the grid component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getselectedrowids

public tt_selectedrows getselectedrowids(in_paneldotcomponentname_tx IN varchar2)
Returns the list of row ID’s selected by the user in the grid component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1 return A plsql table which holds a list of selectedRows.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getselectedvalues

public tt_selectedvalues getselectedvalues(in_paneldotcomponentname_tx IN varchar2)
Returns the selected values in a list.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1 return A plsql table which holds a list of selectedValues.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getselectiontype

public varchar2 getselectiontype(in_paneldotcomponentname_tx IN varchar2)
Returns the selection type used for the grid component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getstyleclass

public varchar2 getstyleclass(in_paneldotcomponentname_tx IN varchar2)
Gets the CSS class(es) added to the HTML object of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Returns:
Name of the class. If multiple classes are added, then a string with class names separated by space character returned. Ex: 'class1 class2 class3'
Throws:
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.


gettextalignment

public varchar2 gettextalignment(in_paneldotcomponentname_tx IN varchar2)
Returns the text alignment value for textField, textlabel, dateField, formattedField, hyperLink, passwordField components.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getuploadedfilename

public varchar2 getuploadedfilename(in_paneldotcomponentname_tx IN varchar2)
Returns the name of the uploaded file.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getuploadedfilepath

public varchar2 getuploadedfilepath(in_paneldotcomponentname_tx IN varchar2)
Returns the full path of the uploaded file. There is a special condition; because of security reason FireFox 3 does not show uploaded file path. So API will return just name of uploaded file.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


geturl

public varchar2 geturl(in_paneldotcomponentname_tx IN varchar2)
Returns the value of the URL attribute of the hyperlink component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


getvaluebl

public blob getvaluebl(in_paneldotcomponentname_tx IN varchar2)
Returns the value of the component as a BLOB.

Blob can be any type of document like pdf, word ,picture etc. This document type can be added to the component's blob column using file upload

Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invaliddatatype - Raised when the component’s data type cannot be casted as BLOB.


getvaluecl

public clob getvaluecl(in_paneldotcomponentname_tx IN varchar2)
Returns the value of the component as a CLOB.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invaliddatatype - Raised when the component’s data type cannot be casted as CLOB.


getvaluedt

public date getvaluedt(in_paneldotcomponentname_tx IN varchar2)
Returns the value of the component as Date.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invaliddatatype - Raised when the component’s data type cannot be casted as Date.


getvaluenr

public number getvaluenr(in_paneldotcomponentname_tx IN varchar2)
Returns the value of the component as Number.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invaliddatatype - Raised when the component’s data type cannot be casted as Number.


getvaluetx

public varchar2 getvaluetx(in_paneldotcomponentname_tx IN varchar2)
Returns the value of the component as Varchar2.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_notsupportedapi - Raised when component type is list and selection type is SelectMultiple.(For multiple selection getSelectedValues api might be used)
e_invaliddatatype - Raised when the component’s data type cannot be casted as Varchar2.


hasstyleclass

public varchar2 hasstyleclass(in_paneldotcomponentname_tx IN varchar2, 
in_styleclass_tx IN varchar2)
Returns Y if the specified class is added to the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
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_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.


ischecked

public varchar2 ischecked(in_paneldotcomponentname_tx IN varchar2)
Returns whether the checkbox component is checked.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.


iseditable

public varchar2 iseditable(in_paneldotcomponentname_tx IN varchar2)
Returns the value of the editable attribute of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


isenabled

public varchar2 isenabled(in_paneldotcomponentname_tx IN varchar2)
Returns the value of the enabled attribute of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


isfocused

public varchar2 isfocused(in_paneldotcomponentname_tx IN varchar2, 
in_innercomponent_yn IN varchar2 DEFAULT 'N')
Returns whether the component has the focus.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format.
in_innercomponent_yn - Use inner component name or parent of the component. For instance, if it is marked as N, it use name of the Grid component. Otherwise it use name of the component in Grid. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


isgridcolumneditable

public varchar2 isgridcolumneditable(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns whether the components in the grid column allow editing.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


isgridcolumnvisible

public varchar2 isgridcolumnvisible(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2)
Returns whether the grid column is visible.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


isgridheadervisible

public varchar2 isgridheadervisible(in_paneldotcomponentname_tx IN varchar2)
Returns whether the grid column header is visible.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


ismousehover

public varchar2 ismousehover(in_paneldotcomponentname_tx IN varchar2)
Returns the value of the mouseHover attribute of the grid component. If mouseHover is set to Y, then the row that the mouse cursor is over, is highlighted.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


isprintable

public varchar2 isprintable(in_paneldotcomponentname_tx IN varchar2)
Returns whether the component is printable.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


issortable

public varchar2 issortable(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2 DEFAULT null)
Returns whether the grid or grid column is sortable.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


istransferringfocus

public varchar2 istransferringfocus(in_paneldotcomponentname_tx IN varchar2)
Returns Y if the hyperlink component transfers the focus to a new browser window when it is clicked and N otherwise.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.

Deprecated:
This value will be dismissed by Formspider. The value of attribute will be "Y" at run-time, even it is specified as "N".


isuploadsuccessful

public varchar2 isuploadsuccessful(in_paneldotcomponentname_tx IN varchar2)
Returns the result of the latest file upload event.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


isvisible

public varchar2 isvisible(in_paneldotcomponentname_tx IN varchar2)
Returns the display state of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


iswordwrap

public varchar2 iswordwrap(in_paneldotcomponentname_tx IN varchar2)
Returns the WordWrap state of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


print

public  print(in_paneldotcomponentname_tx IN varchar2)
Prints the contents of the textArea component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


printtoexcel

public  printtoexcel(in_paneldotcomponentname_tx IN varchar2, 
in_usepaging_yn IN varchar2 DEFAULT 'Y',
in_filename_tx IN varchar2 DEFAULT null,
in_fileformat_cd IN varchar2 DEFAULT file_format_xls)
Generates an excel file using columns of a given grid component. In order to be printed the grid column should be visible, its width should be greater then 0 and the component inside of this column should be bound to a datasource column. Below is an example regarding the usage of this API for printing a grid bound to a datasource based on employees table of HR schema. Grid design XML; This usage will generate following excel output; FIRST NAME SALARY HIRE DATE Donald 2,600.00 21-06-1999 Douglas 2,600.00 13-01-2000 Jennifer 4,400.00 17-09-1987 Michael 13,000.00 17-02-1996 Pat 6,000.00 17-08-1997 Susan 6,500.00 07-06-1994 Hermann 10,000.00 07-06-1994 .....
Parameters:
in_paneldotcomponentname_tx - The name of datasource
in_usepaging_yn - Indicates whether current paging settings of the dataource should be used while printing excel file data. Default value is Y, if the value is N, all paging related settings will be ignored.
in_filename_tx - Name of the generated excel file. If not specified "file_YYYYMMDD_HHMI" default name will be used
in_fileformat_cd - Format of the generated excel file. Default value is FILE_FORMAT_XLS. Valid Constants for this input variable are: FILE_FORMAT_XLS, FILE_FORMAT_XLSX.
Throws:
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidcomponenttype - Raised when the component is not a grid.
e_notboundtodatasource - Raised when the grid component is not bound to a datasource
e_invalidinputparameter - Raised when in_fileFormat_cd value is invalid


removestyleclass

public  removestyleclass(in_paneldotcomponentname_tx IN varchar2, 
in_styleclass_tx IN varchar2)
Removes CSS class from the HTML object of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
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_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.


requestfocus

public  requestfocus(in_paneldotcomponentname_tx IN varchar2)
Attempts to gain focus to the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


resetgridstate

public  resetgridstate(in_paneldotcomponentname_tx IN varchar2, 
in_reloaddata_yn IN varchar2 DEFAULT 'Y')
Resets the state of the Grid. Note: All column names must be specified to get/set Grid state properly. Un-named column would be ignored.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_reloaddata_yn - Reloads the data if Grid has at least of the function, filter or orderBy attributes. If it is N, it does not run query again.
Throws:
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


savetofile

public  savetofile(in_paneldotcomponentname_tx IN varchar2, 
in_filename_tx IN varchar2)
Saves the content of the textArea component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_filename_tx - Default file name shown in the save dialog.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setbackgroundcolor

public  setbackgroundcolor(in_paneldotcomponentname_tx IN varchar2, 
in_backgroundcolor_cd IN varchar2)
Updates background color of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_backgroundcolor_cd - new value for the backgroundColor attribute. Please see API_COLOR for the valid list of values for this input parameter.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcolor - Raised when the background color is not a valid value.

See also:
api_color

setbrowserwindowname

public  setbrowserwindowname(in_paneldotcomponentname_tx IN varchar2, 
in_browserwindowname_tx IN varchar2)
Updates the browserWindowName attribute of the hyperLink component.

Browser window name can be selected any text but if name is selected as '_blank' and '_self' it provides new functionality.

Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_browserwindowname_tx - The new name of the browser window that the hyperLink component opens. The window name can be any text value. However there are two keyword that you can use for additional functionality. Setting _blank as the window name will cause Formspider open a new browser window every time the hyperLink is clicked. Setting the window name as _self will cause the Formspider open the URL the hyperLink is pointing to, in the current browser window.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


seteditable

public  seteditable(in_paneldotcomponentname_tx IN varchar2, 
in_editable_yn IN varchar2,
in_primarykey_tx IN varchar2 DEFAULT null,
in_row_id IN number DEFAULT null)
Updates the editable attribute of the component. If the component is used in a grid then you may use the in_primarykey_tx parameter to specify which instance of the component you should be effected by the API call.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_editable_yn - Editable state of the component
in_primarykey_tx - Primary Key value in the Datasource. This parameter is used to set the enable value of a cell in a grid component.
in_row_id - ID of the datasource row. This parameter is used to set the enable value of a cell in a grid component. The component instance that is showing a value from the datasource row specified with the primary key value or row id, will be effected from the API. If both of primary key and row id are specified, primary key will be used to find exact row in grid.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when the datasoruce of the grid is based on does not have a primary key.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_componentnotfoundongrid - Raised when the component does not exist in the grid.


setenable

public  setenable(in_paneldotcomponentname_tx IN varchar2, 
in_enabled_yn IN varchar2,
in_primarykey_tx IN varchar2 DEFAULT null,
in_row_id IN number DEFAULT null)
Updates the enable attribute of the component. If the component is used in a grid then you may use the in_primarykey_tx parameter to specify which instance of the component you should be effected by the API call.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_enabled_yn - New value for the enable attribute
in_primarykey_tx - Primary Key value in the Datasource. This parameter is used to set the enable value of a cell in a grid component.
in_row_id - ID of the datasource row. This parameter is used to set the enable value of a cell in a grid component. The component instance that is showing a value from the datasource row specified with the primary key value or row id, will be effected from the API. If both of primary key and row id are specified, primary key will be used to find exact row in grid.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when the datasoruce of the grid is based on does not have a primary key.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_componentnotfoundongrid - Raised when the component does not exist in the grid.


setfont

public  setfont(in_paneldotcomponentname_tx IN varchar2, 
in_font_r IN t_font)
Updates the font of the component.

If a font property is set to null then the framework will use the first not null value for the property in the container hierarchy of the component.

Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_font_r - The new font object. Please see API_COLOR for the valid list of values for in_font_r.fontcolor_cd parameter.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcolor - Raised when the background color is not a valid value.

See also:
api_color

setfontcolor

public  setfontcolor(in_paneldotcomponentname_tx IN varchar2, 
in_fontcolor_cd IN varchar2,
in_primarykey_tx IN varchar2 DEFAULT null,
in_row_id IN number DEFAULT null)
Updates the font color of the component.

If the component is used in a grid then you may use the in_primarykey_tx parameter to specify which instance of the component should be effected by the API call.

Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_fontcolor_cd - Font color of the component. Please see API_COLOR for the valid list of values for this input parameter.
in_primarykey_tx - Primary Key value in the Datasource. This parameter is used to set the enable value of a cell in a grid component.
in_row_id - ID of the datasource row. This parameter is used to set the enable value of a cell in a grid component. The component instance that is showing a value from the datasource row specified with the primary key value or row id, will be effected from the API. If both of primary key and row id are specified, primary key will be used to find exact row in grid.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when the datasoruce of the grid is based on does not have a primary key.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_componentnotfoundongrid - Raised when the component does not exist in the grid.
e_invalidcolor - Raised when the background color is not a valid value.

See also:
api_color

setfontfamily

public  setfontfamily(in_paneldotcomponentname_tx IN varchar2, 
in_fontfamily_tx IN varchar2)
Updates the font family of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_fontfamily_tx - Font family of the component
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


setfontsize

public  setfontsize(in_paneldotcomponentname_tx IN varchar2, 
in_fontsize_nr IN varchar2)
Updates the font size of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_fontsize_nr - Font size of the component
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


setfontstyle

public  setfontstyle(in_paneldotcomponentname_tx IN varchar2, 
in_fontstyle_tx IN varchar2)
Updates the font style of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_fontstyle_tx - Font style of the component
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


setgridcolumnlabel

public  setgridcolumnlabel(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_label_tx IN varchar2)
Sets the label of grid column.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_label_tx - New label value
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.

Deprecated:
Use setGridHeaderLabel instead.


setgridcolumnvisible

public  setgridcolumnvisible(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_visible_yn IN varchar2)
Updates the visible attribute of the grid column.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_visible_yn - New value for the visible attribute
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.
e_notboundtodatasource - Raised when the grid component is not bound to a datasource
e_invalidfilterclause - Raised when the datasource filter specified by api_datasource.setFilter, api_datasource.setFilterWhereClause, api_datasource.setFilterOrderByClause APIs is not valid.


setgridcolumnwidth

public  setgridcolumnwidth(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_width_tx IN varchar2)
Updates the width attribute of the grid column.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_width_tx - New value for the width attribute
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


setgridheaderbackgroundcolor

public  setgridheaderbackgroundcolor(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_backgroundcolor_cd IN varchar2)
Updates the background color of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_backgroundcolor_cd - The new value of the background color attribute. The valid list of values for this attribute are in the API_Color package.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.
e_invalidcolor - Raised when the background color is not a valid value.

See also:
api_color

setgridheaderfontcolor

public  setgridheaderfontcolor(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_fontcolor_cd IN varchar2)
Updates the font color of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_fontcolor_cd - New value for the font color attribute. Please see API_COLOR for the valid list of values for this input parameter.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.
e_invalidcolor - Raised when the background color is not a valid value.

See also:
api_color

setgridheaderfontfamily

public  setgridheaderfontfamily(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_fontfamily_tx IN varchar2)
Updates the font family of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_fontfamily_tx - New value for the font family attribute
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


setgridheaderfontsize

public  setgridheaderfontsize(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_fontsize_nr IN number)
Updates the font size of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_fontsize_nr - New value for the font size attribute
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


setgridheaderfontstyle

public  setgridheaderfontstyle(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_fontstyle_tx IN varchar2)
Updates the font style of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_fontstyle_tx - New value for the font style attribute
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


setgridheaderlabel

public  setgridheaderlabel(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_label_tx IN varchar2)
Sets the label of grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_label_tx - New label value
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.


setgridheadertextalignment

public  setgridheadertextalignment(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_textalignment_cd IN varchar2)
Updates the text alignment of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_textalignment_cd - The new text alignment value. Valid Constants for this input variable are: API_Layout.ALIGN_LEFT, API_Layout.ALIGN_CENTER, API_Layout.ALIGN_RIGHT.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.
e_invalidinputparameter - Raised when the in_textAlignment_cd value is invalid


setgridheadervisible

public  setgridheadervisible(in_paneldotcomponentname_tx IN varchar2, 
in_visible_yn IN varchar2)
Update the display state of the grid column header.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_visible_yn - new value for the visible attribute
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setgridscrollbarpolicy

public  setgridscrollbarpolicy(in_paneldotcomponentname_tx IN varchar2, 
in_policy_cd IN varchar2)
Update when the grid scroll bar should be visible.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_policy_cd - New scroll bar policy. Valid Constants for this input variable are: SCROLLBAR_WHEN_NEEDED, SCROLLBAR_ALWAYS, SCROLLBAR_NEVER
Throws:
e_invalidscrollbarpolicy - if in_policy_cd has inappropriate value.
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidinputparameter - Raised when the in_policy_cd value is invalid
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setgridstate

public  setgridstate(in_paneldotcomponentname_tx IN varchar2, 
in_value_cl IN clob,
in_reloaddata_yn IN varchar2 DEFAULT 'Y')
Updates the state of the Grid. Note: All column names must be specified to get/set Grid state properly. Un-named column would be ignored.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_value_cl - State XML of the Grid.
in_reloaddata_yn - Reloads the data if Grid has at least of the function, filter or orderBy attributes. If it is N, it does not run query again.
Throws:
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


seticon

public  seticon(in_paneldotcomponentname_tx IN varchar2, 
in_icon_tx IN varchar2)
Updates the icon of the component
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_icon_tx - Icon path of the component
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


setlabel

public  setlabel(in_paneldotcomponentname_tx IN varchar2, 
in_label_tx IN varchar2)
Updates the label of the component
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_label_tx - Label of the component
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


setmaxfilesize

public  setmaxfilesize(in_paneldotcomponentname_tx IN varchar2, 
in_maxfilesize_tx IN varchar2)
Updates maximum file upload size for the fileUpload component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_maxfilesize_tx - The new value for the maximum allowed file size for the file upload component. A valid value for this input parameter consist of a positive integer and its unit (case sensitive).

Ex: 5kb, 200mb, 2 gb . Valid units are b (for byte), kb (for kilobyte), mb(megabyte) and gb(gigabyte).

Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidinputparameter - Raised when the in_maxFileSize_tx value is invalid
e_invalidnumber - if number part of in_maxFileSize_tx parameter is invalid
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setmousehover

public  setmousehover(in_paneldotcomponentname_tx IN varchar2, 
in_mousehover_yn IN varchar2)
Updates mouseHover behavior of the grid component. If set to Y, the grid row that the mouse cursor is over is highlighted. Note that this action only available for grid component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_mousehover_yn - The new value of the mouse hover behavior of the grid component. Set to Y to enable highligting.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setnumbermask

public  setnumbermask(in_paneldotcomponentname_tx IN varchar2, 
in_numbermask_tx IN varchar2)
Updates the numbermask attribute for textField and textLabel components. Please refer to "http://brimframework.wetpaint.com/page/Number+Mask" for more information
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_numbermask_tx - New numbermask value
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setprintable

public  setprintable(in_paneldotcomponentname_tx IN varchar2, 
in_printable_yn IN varchar2)
Updates the behavior of text components when the screen is printed.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_printable_yn - The new value for the printable attribute.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


setprintcolor

public  setprintcolor(in_paneldotcomponentname_tx IN varchar2, 
in_printcolor_cd IN varchar2)
Updates the color the component uses when it is printed.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_printcolor_cd - The new color value. Please see API_COLOR for the valid list of values for this input parameter.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcolor - Raised when the background color is not a valid value.

See also:
api_color

setrowheightpolicy

public  setrowheightpolicy(in_paneldotcomponentname_tx IN varchar2, 
in_rowheightpolicy_cd IN varchar2)
Updates the row height policty of the grid component. If it is Dynamic then heigth of each grid row will be adjusted dynamically
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_rowheightpolicy_cd - New rowheight policy value. Valid Constants for this input variable are: API_Layout.POLICY_DYNAMIC, API_Layout.POLICY_STATIC.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidinputparameter - Raised when the in_rowHeightPolicy_cd value is invalid
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setselectedrowid

public  setselectedrowid(in_paneldotcomponentname_tx IN varchar2, 
in_selectedrowid_nr IN number DEFAULT null)
Selects a row in the grid component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_selectedrowid_nr - Datasource Row ID of the row to be selected.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setselectedrowids

public  setselectedrowids(in_paneldotcomponentname_tx IN varchar2, 
in_selectedrows_t IN tt_selectedrows)
Selects multiple rows in the grid component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_selectedrows_t - List of Datasource Row ID’s of the rows to be selected.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setselectedvalues

public  setselectedvalues(in_paneldotcomponentname_tx IN varchar2, 
in_selectedvalues_t IN tt_selectedvalues)
Marks multiple values in the list component as selected.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_selectedvalues_t - List of values to be set as selected in the list component.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_toomanyvalues - Raised when multiple values are being attempted to be marked as selected in a SelectOne list component.


setselectiontype

public  setselectiontype(in_paneldotcomponentname_tx IN varchar2, 
in_selectiontype_cd IN varchar2)
Updates the selection type of the grid and list components.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_selectiontype_cd - Selection type of the component. Valid Constants for this input variable are: SELECT_MULTIPLE, SELECT_ONE.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type. setSelectionType API is only defined for grids and lists.
e_invalidinputparameter - Raised when in_selectionType_cd value is invalid


setsortable

public  setsortable(in_paneldotcomponentname_tx IN varchar2, 
in_columnname_tx IN varchar2,
in_sortable_yn IN varchar2)
Sets whether clicking a grid column header orders the rows in the grid automatically by the column clicked.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_columnname_tx - The name of the grid column.
in_sortable_yn - New value for the sortable attribute
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidgridcolumnname - Raised when a grid column with the supplied name cannot be found.
e_invaliddatatype - Raised when the component’s data type which is in the specified column is CLOB.
e_notboundtodatasourcecolumn - Raised when the component which is in the specified column is not bound to a datasource column.


setsortable

public  setsortable(in_paneldotcomponentname_tx IN varchar2, 
in_sortable_yn IN varchar2)
Sets whether clicking a grid column header orders the rows in the grid automatically by the column clicked.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_sortable_yn - New value for the sortable attribute
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setstyleclass

public  setstyleclass(in_paneldotcomponentname_tx IN varchar2, 
in_styleclass_tx IN varchar2)
Updates CSS classes of the component's HTML object. Unlike the addStyleClass API, any existing style classes on the component 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_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
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_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponentname - Raised when the component does not exist in the application.


settextalignment

public  settextalignment(in_paneldotcomponentname_tx IN varchar2, 
in_textalignment_cd IN varchar2)
Updates the text alignment of textField, textLabel, dateFeild,formattedField, hyperLink, passwordField components.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_textalignment_cd - The new text alignment value. Valid Constants for this input variable are: API_Layout.ALIGN_LEFT, API_Layout.ALIGN_CENTER, API_Layout.ALIGN_RIGHT
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_invalidinputparameter - Raised when the in_textAlignment_cd value is invalid


settooltip

public  settooltip(in_paneldotcomponentname_tx IN varchar2, 
in_tooltip_tx IN varchar2)
Updates the tooltip message of the component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_tooltip_tx - The new tooltip message for the component.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.


settransferfocus

public  settransferfocus(in_paneldotcomponentname_tx IN varchar2, 
in_transferfocus_yn IN varchar2)
Updates the transfer focus attribute of the hyperLink component.

Please note that in Firefox, the first click on the hyperLink does not transfer the focus to the new browser window.

Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_transferfocus_yn - The new value for the transferFocus attribute.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.

Deprecated:
This value will be dismissed by Formspider. The value of attribute will be "Y" at run-time, even it is specified as "N".


seturl

public  seturl(in_paneldotcomponentname_tx IN varchar2, 
in_url_tx IN varchar2 DEFAULT null)
Updates the URL property for the hyperLink, htmlRenderer and image components.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_url_tx - The new value of the URL attribute (Default value: null)
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


setvalue

public  setvalue(in_paneldotcomponentname_tx IN varchar2, 
in_value_dt IN date)
Updates the value of the component with a date value.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_value_dt - New Date value for the component.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invalidcurrentrow - Raised when the current row value set by api_datasource.setCurrentRow API does not actually exist in the datasource.
e_nocurrentrow - Raised when the datasource has no current row.
e_invaliddatatype - Raised when the component’s data type cannot be casted as Date.
e_toomanyvalues - Raised when multiple values are being attempted to be marked as selected in a SelectOne list component.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setvalue

public  setvalue(in_paneldotcomponentname_tx IN varchar2, 
in_value_nr IN number)
Updates the value of the component with a number value.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_value_nr - New Number value for the component.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invalidcurrentrow - Raised when the current row value set by api_datasource.setCurrentRow API does not actually exist in the datasource.
e_nocurrentrow - Raised when the datasource has no current row.
e_invaliddatatype - Raised when the component’s data type cannot be casted as Number.
e_toomanyvalues - Raised when multiple values are being attempted to be marked as selected in a SelectOne list component.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setvalue

public  setvalue(in_paneldotcomponentname_tx IN varchar2, 
in_value_tx IN varchar2)
Updates the value of the component with a VARCHAR2 value
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_value_tx - New Varchar2 value for the component.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invalidcurrentrow - Raised when the current row value set by api_datasource.setCurrentRow API does not actually exist in the datasource.
e_nocurrentrow - Raised when the datasource has no current row.
e_notsupportedapi - Raised when component type is list and selection type is selectMultiple.(For multiple selection setSelectedValues api might be used)
e_invaliddatatype - Raised when the component’s data type cannot be casted as Varchar2.
e_toomanyvalues - Raised when multiple values are being attempted to be marked as selected in a SelectOne list component.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setvalue

public  setvalue(in_paneldotcomponentname_tx IN varchar2, 
in_value_cl IN clob)
Updates value of the component with a CLOB value .
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_value_cl - New CLOB value for the component.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invalidcurrentrow - Raised when the current row value set by api_datasource.setCurrentRow API does not actually exist in the datasource.
e_nocurrentrow - Raised when the datasource has no current row.
e_invaliddatatype - Raised when the component’s data type cannot be casted as CLOB.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setvalue

public  setvalue(in_paneldotcomponentname_tx IN varchar2, 
in_value_bl IN blob)
Updates value of the component with a BLOB value.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.
e_notboundtodatasourcecolumn - Raised when the component is not bound to a datasource column.
e_invalidcurrentrow - Raised when the current row value set by api_datasource.setCurrentRow API does not actually exist in the datasource.
e_nocurrentrow - Raised when the datasource has no current row.
e_invaliddatatype - Raised when the component’s data type cannot be casted as BLOB.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setvisible

public  setvisible(in_paneldotcomponentname_tx IN varchar2, 
in_visible_yn IN varchar2,
in_primarykey_tx IN varchar2 DEFAULT null,
in_row_id IN number DEFAULT null)
Updates the display state of the component. If the component is used in a grid then you may use the in_primarykey_tx parameter to specify which instance of the component should be effected by the API call.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_visible_yn - new value for the visible attribute
in_primarykey_tx - Primary Key value in the Datasource. This parameter is used to set the enable value of a cell in a grid component.
in_row_id - ID of the datasource row. This parameter is used to set the enable value of a cell in a grid component. The component instance that is showing a value from the datasource row specified with the primary key value or row id, will be effected from the API. If both of primary key and row id are specified, primary key will be used to find exact row in grid.
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when the datasoruce of the grid is based on does not have a primary key.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_componentnotfoundongrid - Raised when the component does not exist in the grid.


setwordwrap

public  setwordwrap(in_paneldotcomponentname_tx IN varchar2, 
in_wordwrap_yn IN varchar2)
Updates the word wrap state for the text area component.
Parameters:
in_paneldotcomponentname_tx - The fully qualified name of the component in the [panelName].[componentName] format. Ex: If component c1 is in panel p1 then the fully qualified component name is p1.c1
in_wordwrap_yn - The new word wrap state
Throws:
e_invalidcomponentname - Raised when the component does not exist in the application.
e_invalidinputformat - Raised when the value of the in_paneldotcomponentname_tx parameter is in incorrect format.
e_invalidcomponenttype - Raised when the API is not defined for the component type.


Formspider APIs