Sybernet / Supplied Procedures Reference Release 3.00 Nov 25, 2006

HTTP.SP_HTML_INPUT

SP_HTML_INPUT creates an input field. All of the input fields that you are familar with may be created with this procedure. You can also create a TEXTAREA and SELECT list with this procedure.

It is not required that you use this procedure to create your form screens, but there are several reasons why you may want to. SP_HTML_INPUT supports pre-defined datatypes (such as int, smallint, and tinyint) which are validated on the client before these fields are submitted to your procedure. Input values are mapped so that they appear correctly on your screen. Have you ever wondered how to specify a value containing double quotes? SP_HTML_INPUT will do this for you automatically. The value passed to SELECT and TEXTAREA can be a select statement which is evaluated in real-time.

Perhaps the most compelling reason, however, is that SP_HTML_INPUT will make your input fields look and behave the same among NS4, NS7, and MSIE. NS4 correctly renders text fields with a monospace font-family. NS7 doesn't. NS7 does when when you create this field with SP_HTML_INPUT. MSIE buttons are absolutely pathetic, but look less so when created by SP_HTML_INPUT.

SP_HTML_INPUT will also raise an exception if you attempt to create an input field that it does not know about. HTML ignores invalid types and gives you a text field instead. If you misspell onFocus in an HTML form, HTML will ignore it. If you misspell onFocus when you call SP_HTML_INPUT, Oracle will complain.

All of the parameters are optional just like in regular HTML. All parameters are varchars unless otherwise indicated.

Syntax

Procedure SP_HTML_INPUT
(
    TYPE                IN  VARCHAR2	    := 'TEXT'       -- text|password|checkbox|radio|submit|reset|file|hidden|image|textarea|select
,   NAME                IN  VARCHAR2        := NULL         -- {CDATA}
,   VALUE               IN  VARCHAR2        := NULL         -- {CDATA}
,   ALERT               IN  VARCHAR2        := NULL         -- {CDATA}
,   CONFIRM             IN  VARCHAR2        := NULL         -- {CDATA}
,   ONBLUR              IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONCLICK             IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONCHANGE            IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONFOCUS             IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONSELECT            IN  VARCHAR2        := NULL         -- {SCRIPT}
,   TAGSIZE             IN  VARCHAR2        := NULL         -- {NUMBER}
,   MAXLENGTH           IN  VARCHAR2        := NULL         -- {NUMBER}
,   CHECKED             IN  VARCHAR2        := NULL         -- {CDATA}
,   MINVALUE            IN  VARCHAR2        := NULL         -- {NUMBER}
,   MAXVALUE            IN  VARCHAR2        := NULL         -- {NUMBER}
,   ROWS                IN  VARCHAR2        := NULL         -- {NUMBER}
,   COLS                IN  VARCHAR2        := NULL         -- {NUMBER}
,   WRAP                IN  VARCHAR2        := NULL         -- <deprecated>
,   DELIMETER           IN  VARCHAR2        := ','          -- {CHARACTER}
,   STYLE               IN  VARCHAR2        := '107'        -- {STYLESHEET}|{NUMBER}
,   ALIGN               IN  VARCHAR2        := NULL         -- TRUE|FALSE|LEFT|RIGHT
,   SCALE               IN  VARCHAR2        := NULL         -- {NUMBER}
,   COMMA               IN  VARCHAR2        := NULL         -- TRUE|FALSE
,   DEBUG               IN  BOOLEAN         := FALSE        -- TRUE|FALSE
,   PROCNAME            IN  VARCHAR2        := NULL         -- [OWNER.][OBJECT_NAME]
,   BUTTON              IN  VARCHAR2        := NULL         -- {CDATA}
,   DISABLED            IN  BOOLEAN         := NULL         -- TRUE|FALSE
,   READONLY            IN  BOOLEAN         := NULL         -- TRUE|FALSE
,   TABINDEX            IN  VARCHAR2        := NULL         -- {NUMBER}
,   NULLVALUE           IN  VARCHAR2        := NULL         -- <deprecated>
,   PROLOGUE            IN  VARCHAR2        := NULL         -- [{CDATA}=]{CDATA}
,   EPILOGUE            IN  VARCHAR2        := NULL         -- [{CDATA}=]{CDATA}
,   MULTIPLE            IN  BOOLEAN         := NULL         -- TRUE|FALSE
,   SORTED              IN  BOOLEAN         := TRUE         -- TRUE|FALSE
,   NLS_DATE_FORMAT     IN  VARCHAR2        := NULL         -- {CDATA}
,   EVALUATE            IN  BOOLEAN         := TRUE         -- TRUE|FALSE

,   ALT                 IN  VARCHAR2        := NULL         -- {CDATA}
,   ACCESSKEY           IN  VARCHAR2        := NULL         -- {CHARACTER}
,   ACCEPT              IN  VARCHAR2        := NULL         -- {CONTENTTYPES}
    --
    -- coreattrs
    --
,   ID                  IN  VARCHAR2        := NULL         -- {ID}
,   CLASS               IN  VARCHAR2        := NULL         -- {CDATA}
,   DECORATION          IN  VARCHAR2        := NULL         -- {STYLESHEET}
,   TITLE               IN  VARCHAR2        := NULL         -- {TEXT}
    --
    -- il8n
    --
,   LANG                IN  VARCHAR2        := NULL         -- {LANGUAGECODE}
,   DIR                 IN  VARCHAR2        := NULL         -- (ltr|rtl)
    --
    -- events
    --
,   ONDBLCLICK          IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONMOUSEDOWN         IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONMOUSEUP           IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONMOUSEOVER         IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONMOUSEMOVE         IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONMOUSEOUT          IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONKEYPRESS          IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONKEYDOWN           IN  VARCHAR2        := NULL         -- {SCRIPT}
,   ONKEYUP             IN  VARCHAR2        := NULL         -- {SCRIPT}
)   ;

Parameters

type

name

value

alert

confirm

onblur

onclick

onchange

onfocus

onselect

tagsize

maxlength

checked

minvalue

maxvalue

rows

cols

wrap

delimeter

style

align

scale

comma

debug

procname

button

disabled

readonly

tabindex

prologue

epilogue

multiple

sorted

nls_date_format

evaluate

decoration

Types

The following types are recognized by SP_HTML_INPUT. These types include the standard HTML input types as well as predefined types that correspond to similarly named datatypes in Sybase and Oracle.

The predefined types can include a default tag size, maxlength, value, minValue, maxValue, and scaling. You have the ability to override any or all of these defaults. A BIT type, for example, may be specified with a maxValue of 3.

text

button

checkbox

radio

reset

submit

password

file

hidden

select

    VALUE => 'Red,Green,Blue'

    VALUE => '1=Red,2=Green,3=Blue'

    VALUE => ',Red,Green,Blue'

    VALUE => 'SELECT NAME FROM HTTP.HTTP_COLORS'

    VALUE => 'SELECT VALUE, NAME FROM HTTP.HTTP_COLORS'

    VALUE => 'SELECT VALUE, NAME FROM HTTP.COLORS ORDER BY VALUE'

textarea

    http.sp_html_input
    (
        TYPE      => 'TEXTAREA'
    ,   VALUE     => 'Please fill this in'
    ,   ROWS      => '20'
    ,   COLS      => '60'
    )   ;

    http.sp_html_input
    (
        TYPE      => 'TEXTAREA'
    ,   VALUE     => 'SELECT DESCRIPTION FROM HTTP.HTTP_HELPTEXT WHERE ROW_ID = ''Welcome'''
    ,   ROWS      => '20'
    ,   COLS      => '60'
    ,   MAXLENGTH => '32767'
    )   ;

alpha

bit

char

date

datetime

decimal

int

money

number

numeric

phone

smalldatetime

smallint

smallmoney

ssn

telephone

time

tinyint

varvhar

varchar2

Defaults

The following table summarizes the default tag sizes and the min and max values. When calling SP_HTML_INPUT, you have the ability to override any of these values.

Styles

DATE, DATETIME, and SMALLDATETIME are essentially the same data type. The table above illustrates each for style 107. The remaining styles are defined here.

Example

The first example is a simple input field. There are two things to note about this example: the procedure will automtically quote the ADDRESS value for you, and this value will not be concatenated to any other string because that might result in truncation.

 
   http.sp_html_input
   (
       TYPE     => 'text'
   ,   NAME     => 'address'
   ,   VALUE    => ADDRESS
   ,   SIZE     => '30'
   )   ;

Example

Here are two radio buttons. sp_html_input will automatically determine if the button is checked based on the parameter name (PIZZA). This is actually very convenient because to do this yourself you would have to test whether or not PIZZA was equal to each button value.

 
    http.sp_html_input
    (
        TYPE      => 'radio'
    ,   NAME      => 'PIZZA'
    ,   VALUE     => 'Cheese'
    ,   CHECKED   => PIZZA
    )   ;

    http.sp_html_input
    (
        TYPE      => 'radio'
    ,   NAME      => 'PIZZA'
    ,   VALUE     => 'Pepperoni'
    ,   CHECKED   => PIZZA
    )   ;

Example

The next example illustrates how you can use Sybase datatypes when calling sp_html_input.

 
    http.sp_html_input
    (
        TYPE      => 'SMALLINT'
    ,   NAME      => 'Balance'
    )   ;

Example

Because they were not specified, the Sybernet SDK will automatically set both SIZE and MAXLENGTH to 6. It will also validate that the value in this field is a whole number between -32,768 and 32,767. Here's another example that overrides these defaults:

 
    http.sp_html_input
    (
        TYPE      => 'INT'
    ,   NAME      => 'Account'
    ,   SIZE      => '30'
    ,   MAXLENGTH => '30'
    ,   minValue  => '200000'
    ,   maxValue  => '299999'
    )   ;

Example

The next example specifies the Sybase datetype DATETIME and validates that the date entered is at least November 25, 1996.

 
    http.sp_html_input
    (
        TYPE      => 'DATETIME'
    ,   NAME      => 'Birthday'
    ,   minValue  => 'Nov 25, 1996'
    )   ;

Example

A standard submit button which displays a confirmation before submitting the form. The button is named because the procedure that receives this form wants to know which button the user clicked.

 
    http.sp_html_input
    (
        TYPE       => 'submit'
    ,   NAME       => 'button'
    ,   VALUE      => 'Save'
    ,   CONFIRM    => 'Are you sure you want to save this form?'
    )   ;

Example

Similar to the example above except an alert is displayed and the form is not submitted. Normally, this would be preceded by some condition that tests whether or not the user is allowed to click this button.

 
    http.sp_html_input
    (
        TYPE       => 'submit'
    ,   NAME       => 'button'
    ,   VALUE      => 'Drop'
    ,   ALERT      => 'You are not permitted to drop this form!'
    )   ;

Example

This is just a simple button that behaves exactly like the BACK button on your browser's tool bar. Notice that it uses the onClick event handler and supplies the entire JavaScript code in the onClick parameter.

 
    http.sp_html_input
    (
        TYPE        => 'button'
    ,   VALUE       => 'Back'
    ,   onClick     => 'window.history.back()'
    )   ;

Example

Version 2.22 of the Sybernet SDK introduced 3 new parameters that allow you to control how numeric data is displayed and edited by the user. They are ALIGN, SCALE and COMMA.

ALIGN may be either TRUE, FALSE or NULL. When TRUE, numeric data is right-aligned.

SCALE is a positive integer that determines the number of decimal digits that are displayed and edited. If zero, no decimal digits are displayed.

COMMAS may be either TRUE, FALSE or NULL. When TRUE, commas are inserted at the expected location.

 
    http.sp_html_input
    (
        TYPE       => 'NUMERIC'
    ,   VALUE      => '1,234.5678'
    ,   ALIGN      => 'TRUE'
    ,   SCALE      => '2'
    ,   COMMAS     => 'TRUE'
    )   ;

Example

The following example illutrates how to create a drop-down list. The value part is simply a list of names separated by commas. The list is sorted automatically:

    http.sp_html_input
    (
        TYPE          => 'SELECT'
    ,   NAME          => 'FOOD'
    ,   VALUE         => 'Apples,Oranges,Pears,Turnips,Grapefruit,Watermelon,Pizza,Chicken'
    )   ;

Example

The same example except that I want to specify both the value and text values. To do this I simply pass these as pairs separated by an equal sign. The list is sorted by the text value in this case:

    http.sp_html_input
    (
        TYPE          => 'SELECT'
    ,   NAME          => 'FOOD'
    ,   VALUE         => '1=Apples,2=Oranges,3=Pears,4=Turnips,5=Grapefruit,6=Watermelon,7=Pizza,8=Chicken'
    )   ;

Example

The following example illustrates how to create a list dynamically using a table:

    http.sp_html_input
    (
        TYPE          => 'SELECT'
    ,   NAME          => 'PLATFORM'
    ,   VALUE         => 'SELECT PLATFORM FROM CRON_PLATFORMS'
    )   ;

Example

The following example illustrates how to select both value and text from a table. Because an order by clause was specified, the list is not sorted:

    http.sp_html_input
    (
        type          => 'SELECT'
    ,   name          => 'DATENAMES'
    ,   value         => 'select selectedIndex, datename from cron_datenames order by selectedIndex'
    )   ;

See Also