CSFormItem
object.
get/set
methods within CSFormItem
provide access to this content data and so there
should not typically be any need to explicitly use the get/set
methods supplied here.
public class CSFormItemContent extends CSItemContent
CSFormItem
,
Serialized FormConstructor and Description |
---|
CSFormItemContent()
Deprecated.
Creates an empty
CSFormItemContent object. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Deprecated.
Creates a duplicate of this
CSFormItemContent object. |
CSItemContent |
createInstance()
Deprecated.
Creates a new
CSFormItemContent object and returns it as a CSItemContent , its superclass. |
boolean |
equals(java.lang.Object obj)
Deprecated.
Determines whether the data contained in this
CSFormItemContent object is the same as that
contained within the one supplied. |
java.lang.String |
getCapturedValue()
Deprecated.
Gets the value captured value of this form item.
|
java.lang.String |
getCFCheck()
Deprecated.
Gets the additional server-side validation to be performed on this form item (Cold Fusion only).
|
java.lang.String |
getDataType()
Deprecated.
Gets the type of data which this form item can hold.
|
java.lang.String |
getDDBContents()
Deprecated.
Gets the explicitly specified options to be used for an input control which is a drop-down list, a multiselect
box or a group of radio buttons.
|
java.lang.String |
getDefault()
Deprecated.
Gets the initial (default) value of the form item.
|
java.lang.String |
getDelimiter()
Deprecated.
Gets the HTML to be output between this form item and the next.
|
java.util.ArrayList |
getDisplayOptions()
Deprecated.
Gets the display values to be used for the options on a input control which is a drop-down list, a multiselect
box or a group of radio buttons.
|
java.lang.String |
getErrorMessage()
Deprecated.
Gets the error message to be shown to the user if invalid data or missing data is submitted for this form item.
|
java.lang.String |
getFieldSize()
Deprecated.
Gets the value to use for the SIZE attribute of this form item's input control in the HTML.
|
java.lang.String |
getFormat()
Deprecated.
|
java.lang.String |
getFormItemHTMLName()
Deprecated.
Gets the name of the form item as it appears in the HTML generated by the
buildHTML method. |
java.lang.String |
getFormItemName()
Deprecated.
Gets the name of the form item.
|
java.lang.String |
getFormLabel()
Deprecated.
Gets the text to be included in the HTML to identify this form item's input control on the form.
|
java.lang.String |
getInputClass()
Deprecated.
Gets the name of the class to be used by the
buildHTML method for
the HTML input control. |
java.lang.String |
getInputType()
Deprecated.
Gets the type of input control to use when displaying this form item (TEXTAREA, SELECT, MULTISELECT, RADIO,
CHECKBOX, HIDDEN).
|
java.lang.String |
getJSCheck()
Deprecated.
Gets the Javascript validation which should be performed against this form item.
|
java.lang.String |
getLabelClass()
Deprecated.
Gets the name of the class to be used by the
buildHTML method for
the label associated with the HTML input control. |
boolean |
getLabelOnLeft()
Deprecated.
Gets whether this item's label should be displayed on the left or not within the HTML generated by the
buildHTML method. |
java.lang.String |
getLabelPrefix()
Deprecated.
Gets the HTML to be used by the
buildHTML method before form label
text. |
java.lang.String |
getLabelSuffix()
Deprecated.
Gets the HTML to be used by the
buildHTML method after the form
label text. |
java.lang.String |
getMaxLength()
Deprecated.
Gets the value to use for the MAXLENGTH attribute of this form item's input control in the HTML.
|
java.lang.String |
getOptionsDatasource()
Deprecated.
Gets the name of the datasource to use for obtaining the values to display in input controls which offer the user
a selection of options.
|
java.lang.String |
getOptionsDelimiter()
Deprecated.
Gets the HTML to be used by the
buildHTML method between the options
if this item has a MULTICHECK or RADIO input type. |
java.lang.String |
getOptionsDisplayField()
Deprecated.
Gets the name of the database field to use for obtaining the values to display in input controls which offer the
user a selection of options.
|
java.lang.String |
getOptionsTable()
Deprecated.
Gets the name of the database table to use for obtaining the values to display in input controls which offer the
user a selection of options.
|
java.lang.String |
getOptionsValueField()
Deprecated.
Gets the name of the database field to use for obtaining the submittable values to associate with this form item
if it has an input control which offers the user a selection of options.
|
java.lang.String |
getOptionsWhereField()
Deprecated.
Gets the SQL to use for the WHERE clause when constructing a query to obtain values from a database, if the form
item has an input control which offers the user a selection of options, obtained from a database.
|
java.lang.String |
getPassThrough()
Deprecated.
Gets any pass through attributes that are to be included directly in the generated HTML for the form item.
|
java.lang.String |
getPrefix()
Deprecated.
Gets the HTML to be used by the
buildHTML method before this form
item's input control. |
java.lang.String |
getPrelim()
Deprecated.
Gets the HTML to be used by the
buildHTML method before the form
label prefix. |
boolean |
getRequired()
Deprecated.
Gets whether a captured value is required for this form item.
|
java.lang.String |
getSuffix()
Deprecated.
Gets the HTML to be used by the
buildHTML method after this form
item's control. |
java.util.ArrayList |
getValueOptions()
Deprecated.
Gets the submitted values to be used for the options on a input control which is a drop-down list, a multiselect
box or a group of radio buttons.
|
void |
setCapturedValue(java.lang.String strCapturedValue)
Deprecated.
Sets the value captured value of this form item.
|
void |
setCFCheck(java.lang.String strCFCheck)
Deprecated.
Specifies the additional validation server-side validation to be performed on this form item (ColdFusion only).
|
void |
setDataType(java.lang.String strDataType)
Deprecated.
Specifies the type of data which this form item can hold.
|
void |
setDDBContents(java.lang.String strDDBContents)
Deprecated.
Explicitly specifies the options to be used for an input control which is a drop-down list, a multiselect box or
a group of radio buttons.
|
void |
setDefault(java.lang.String strDefault)
Deprecated.
Sets the initial (default) value of the form item.
|
void |
setDelimiter(java.lang.String strDelimiter)
Deprecated.
Sets the HTML to be used by the
buildHTML method between this form
item and the next. |
void |
setDisplayOptions(java.util.ArrayList arrDisplayOptions)
Deprecated.
Sets the display values to be used for the options on a input control which is a drop-down list, a multiselect
box or a group of radio buttons.
|
void |
setErrorMessage(java.lang.String strErrorMessage)
Deprecated.
Specifies the error message to be shown to the user if invalid data or missing data is submitted for this form
item.
|
void |
setFieldSize(java.lang.String strFieldSize)
Deprecated.
Sets the value to use for the SIZE attribute of this form item's input control in the HTML.
|
void |
setFormat(java.lang.String strFormat)
Deprecated.
|
void |
setFormItemName(java.lang.String strFormItemName)
Deprecated.
Sets the name of the form item.
|
void |
setFormLabel(java.lang.String strFormLabel)
Deprecated.
Specifies the text to be included in the HTML to identify this form item's input control on the form.
|
void |
setInputClass(java.lang.String strInputClass)
Deprecated.
Sets the name of the class to be used by the
buildHTML method for
the HTML input control. |
void |
setInputType(java.lang.String strInputType)
Deprecated.
Specifies the type of input control to use when displaying this form item (TEXTAREA, SELECT, MULTISELECT, RADIO,
CHECKBOX, HIDDEN).
|
void |
setJSCheck(java.lang.String strJSCheck)
Deprecated.
Specifies the Javascript validation which should be performed against this form item.
|
void |
setLabelClass(java.lang.String strLabelClass)
Deprecated.
Sets the name of the class to be used by the
buildHTML method for
the label associated with the HTML input control. |
void |
setLabelOnLeft(boolean bLabelOnLeft)
Deprecated.
Sets whether this item's label should be displayed on the left or not within the HTML generated by the
buildHTML method. |
void |
setLabelPrefix(java.lang.String strLabelPrefix)
Deprecated.
Sets the HTML to be used by the
buildHTML method before form label
text. |
void |
setLabelSuffix(java.lang.String strLabelSuffix)
Deprecated.
Sets the HTML to be used by the
buildHTML method after the form
label text. |
void |
setMaxLength(java.lang.String strMaxLength)
Deprecated.
Sets the value to use for the MAXLENGTH attribute of this form item's input control in the HTML.
|
void |
setOptionsDatasource(java.lang.String strOptionsDatasource)
Deprecated.
Sets the name of the datasource to use for obtaining the values to display in input controls which offer the user
a selection of options.
|
void |
setOptionsDelimiter(java.lang.String strDelimiter)
Deprecated.
Sets the HTML to be used by the
buildHTML method between the options
if this item has a MULTICHECK or RADIO input type. |
void |
setOptionsDisplayField(java.lang.String strOptionsDisplayField)
Deprecated.
Sets the name of the database field to use for obtaining the values to display in input controls which offer the
user a selection of options.
|
void |
setOptionsTable(java.lang.String strOptionsTable)
Deprecated.
Sets the name of the database table to use for obtaining the values to display in input controls which offer the
user a selection of options.
|
void |
setOptionsValueField(java.lang.String strOptionsValueField)
Deprecated.
Sets the name of the database field to use for obtaining the submittable values to associate with this form item
if it has an input control which offers the user a selection of options.
|
void |
setOptionsWhereField(java.lang.String strOptionsWhereField)
Deprecated.
Sets the SQL to use for the WHERE clause when constructing a query to obtain values from a database if the form
item has an input control which offers the user a selection of options, obtained from a database.
|
void |
setPassThrough(java.lang.String strPassThrough)
Deprecated.
Specifies any pass through attributes that are to be included directly in the generated HTML for the form item.
|
void |
setPrefix(java.lang.String strPrefix)
Deprecated.
Sets the HTML to be used by the
buildHTML method before this form
item's input control. |
void |
setPrelim(java.lang.String strPrelim)
Deprecated.
Sets the HTML to be used by the
buildHTML method before the form
label prefix. |
void |
setRequired(boolean bRequired)
Deprecated.
Sets whether a captured value is required for this form item.
|
void |
setSuffix(java.lang.String strSuffix)
Deprecated.
Sets the HTML to be used by the
buildHTML method after this form
item's input control. |
void |
setValueOptions(java.util.ArrayList arrValueOptions)
Deprecated.
Sets the submitted values to be used for the options on a input control which is a drop-down list, a multiselect
box or a group of radio buttons.
|
java.lang.String |
toString()
Deprecated.
Outputs the contents of this
CSFormItemContent object to a String object in a
user-friendly format. |
getID, setID, unset
public CSFormItemContent()
CSFormItemContent
object.public void setFormItemName(java.lang.String strFormItemName)
strFormItemName
- The form item's name. For example, "UserProfile.HomeAddress.PostCode".public java.lang.String getFormItemName()
public java.lang.String getFormItemHTMLName()
buildHTML
method.
public void setCapturedValue(java.lang.String strCapturedValue)
strCapturedValue
- the value entered by the website user for the form item, after the HTML form has been displayed and
submitted.public java.lang.String getCapturedValue()
public void setDataType(java.lang.String strDataType)
strDataType
- the data type of the data which can be captured for this form item. Data type can be "char" for any
character data, "numeric", "integer" or "datetime".public void setFormat(java.lang.String strFormat)
public java.lang.String getDataType()
public java.lang.String getFormat()
public void setJSCheck(java.lang.String strJSCheck)
strJSCheck
- Javascript code for inclusion in the Javascript which is generated by the
buildHTML
method as part of the form HTML for this form
item.public java.lang.String getJSCheck()
buildHTML
method as part of the form HTML for this form
item.public void setCFCheck(java.lang.String strCFCheck)
At present only ColdFusion additional validation can only be specified in iCM. The code specified using this
method will be not used by the buildHTML
method. The onus is on the
caller to execute this code if running in a Cold Fusion environment.
strCFCheck
- ColdFusion code which performs custom validation of the captured value of this form item.public java.lang.String getCFCheck()
At present only Cold Fusion additional validation can only be specified in iCM. The code specified using this
method will be not used by the buildHTML
method. The onus is on the
caller to execute this code if running in a Cold Fusion environment.
public void setDDBContents(java.lang.String strDDBContents)
The submitted value of the input control will be the same as the displayed value. Note that these options will be
ignored by the buildHTML
and
getValueOptions
methods if a datasource is also specified for the form item, using the
setOptionsDatasource
method.
strDDBContents
- a comma-separated list of the values to use in building an input control with multiple options.public java.lang.String getDDBContents()
public void setValueOptions(java.util.ArrayList arrValueOptions)
Defaults to the values obtained from the datasource, if specified, using the
setOptionsDatasource
method, otherwise defaults to the values explicitly
specified using the setDDBContents
method.
arrValueOptions
- List of the submitted values to use in building an input control with multiple options.public java.util.ArrayList getValueOptions()
Defaults to the values obtained from the datasource, if specified using the
setOptionsDatasource
method, otherwise defaults to the values explicitly
specified using the setDDBContents
method.
public void setDisplayOptions(java.util.ArrayList arrDisplayOptions)
Defaults to the values obtained from the datasource, if specified using the
setOptionsDatasource
method, otherwise defaults to the values explicitly
specified using the setDDBContents
method.
arrDisplayOptions
- list of the submitted values to use in building an input control with multiple options.public java.util.ArrayList getDisplayOptions()
Defaults to the values obtained from the datasource, if specified using the
setOptionsDatasource
method, otherwise defaults to the values explicitly
specified using the setDDBContents
method.
public void setDefault(java.lang.String strDefault)
strDefault
- the value to be shown in the form item's input control when the form is displayed.public java.lang.String getDefault()
public void setFormLabel(java.lang.String strFormLabel)
strFormLabel
- the label to be used alongside the form item when the form is displayed.public java.lang.String getFormLabel()
public void setInputType(java.lang.String strInputType)
strInputType
- the input type to be used for this form item when the form is displayed.public java.lang.String getInputType()
public void setErrorMessage(java.lang.String strErrorMessage)
strErrorMessage
- the error message to be used in the event of a validation error.public java.lang.String getErrorMessage()
public void setPassThrough(java.lang.String strPassThrough)
onClick
attribute for a form item specify a Pass Through value of
onclick="onClickHandler();"
where onClickHandler
is the name of the javascript
method you wish to be invoked when the form item is clicked.
strPassThrough
- the pass through attributes.public java.lang.String getPassThrough()
public void setFieldSize(java.lang.String strFieldSize)
strFieldSize
- TEXTAREA input type types : x,y where x and y are the visible width and height; otherwise a numeric
integer.public java.lang.String getFieldSize()
public void setMaxLength(java.lang.String strMaxLength)
strMaxLength
- a numeric integer.public java.lang.String getMaxLength()
public void setRequired(boolean bRequired)
If set to true
, Javascript will automatically be generated by the
buildHTML
method to validate that a value has been entered for the
item.
bRequired
- returns true if it is compulsory for the user to enter a value for this form item, otherwise returns
false.public boolean getRequired()
If set to true
, Javascript will automatically be generated by the
buildHTML
method to validate that a value has been entered for the
item.
public void setLabelClass(java.lang.String strLabelClass)
buildHTML
method for
the label associated with the HTML input control.
strLabelClass
- The name of the class.public java.lang.String getLabelClass()
buildHTML
method for
the label associated with the HTML input control.
public void setInputClass(java.lang.String strInputClass)
buildHTML
method for
the HTML input control.
strInputClass
- The name of the class.public java.lang.String getInputClass()
buildHTML
method for
the HTML input control.
public void setLabelOnLeft(boolean bLabelOnLeft)
buildHTML
method.
bLabelOnLeft
- true
if it is compulsory for the user to enter a value for this form item, otherwise
returns false
.public boolean getLabelOnLeft()
buildHTML
method.
true
if the label should appear on the left; otherwise returns false
.public void setPrelim(java.lang.String strPrelim)
buildHTML
method before the form
label prefix.
strPrelim
- HTML to be output before the form label prefix.public java.lang.String getPrelim()
buildHTML
method before the form
label prefix.
public void setLabelSuffix(java.lang.String strLabelSuffix)
buildHTML
method after the form
label text.
strLabelSuffix
- The HTML to be output after the form label text.public java.lang.String getLabelSuffix()
buildHTML
method after the form
label text.
public void setLabelPrefix(java.lang.String strLabelPrefix)
buildHTML
method before form label
text.
strLabelPrefix
- HTML to be output before form label text.public java.lang.String getLabelPrefix()
buildHTML
method before form label
text.
public void setSuffix(java.lang.String strSuffix)
buildHTML
method after this form
item's input control.
strSuffix
- HTML to be output after the HTML for this form item's input control.public java.lang.String getSuffix()
buildHTML
method after this form
item's control.
public void setPrefix(java.lang.String strPrefix)
buildHTML
method before this form
item's input control.
strPrefix
- HTML to be output before the HTML for this form item's input control.public java.lang.String getPrefix()
buildHTML
method before this form
item's input control.
public void setOptionsDelimiter(java.lang.String strDelimiter)
buildHTML
method between the options
if this item has a MULTICHECK or RADIO input type.
strDelimiter
- HTML to be output in between the options.public java.lang.String getOptionsDelimiter()
buildHTML
method between the options
if this item has a MULTICHECK or RADIO input type.
public void setDelimiter(java.lang.String strDelimiter)
buildHTML
method between this form
item and the next.
strDelimiter
- HTML to be output after the getSuffix
HTML for this form item.public java.lang.String getDelimiter()
getSuffix
HTML for this form item.public void setOptionsDatasource(java.lang.String strOptionsDatasource)
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of countries where the names of the countries in the list are read from a database.
strOptionsDatasource
- the datasource from which to obtain option values for input controls such as multiselect boxes.public java.lang.String getOptionsDatasource()
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of countries where the names of the countries in the list are read from a database.
public void setOptionsTable(java.lang.String strOptionsTable)
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of Countries where the names of the countries in the list are read from a database.
strOptionsTable
- the database table from which to obtain option values for input controls such as multiselect boxes.public java.lang.String getOptionsTable()
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of countries where the names of the countries in the list are read from a database.
public void setOptionsDisplayField(java.lang.String strOptionsDisplayField)
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of Countries where the names of the countries in the list are read from a database.
strOptionsDisplayField
- the datasource from which to obtain option values for input controls such as multiselect boxes.public java.lang.String getOptionsDisplayField()
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of Countries where the names of the countries in the list are read from a database.
public void setOptionsValueField(java.lang.String strOptionsValueField)
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of Countries which displays country names but submits the country codes corresponding to the country names, where the names and codes of the countries are read from a database.
strOptionsValueField
- the datasource from which to obtain option values for input controls such as multiselect boxes.public java.lang.String getOptionsValueField()
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of countries which displays country names but submits the country codes corresponding to the country names, where the names and codes of the countries are read from a database.
public void setOptionsWhereField(java.lang.String strOptionsWhereField)
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of countries which displays a list of product names obtained from a database, but only where the product is of a certain type.
strOptionsWhereField
- the text to insert into the WHERE clause of a query to obtain option values from a database.public java.lang.String getOptionsWhereField()
Only relevant to form items which offer the user a selection of options to choose from, such as drop-down lists, radio buttons and multiselect boxes. For example, a drop-down list of countries which displays a list of product names obtained from a database, but only where the product is of a certain type.
public CSItemContent createInstance()
CSFormItemContent
object and returns it as a CSItemContent
, its superclass.
This is used by the clone
method in CSItemContent
.
CSFormItemContent
object.public java.lang.String toString()
CSFormItemContent
object to a String
object in a
user-friendly format.
toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSFormItemContent
object is the same as that
contained within the one supplied. Note that the key data used for searching is not tested for equality.
equals
in class CSItemContent
obj
- the CSFormItemContent
to be tested for equality.true
if the data matches, false
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException, java.lang.OutOfMemoryError
CSFormItemContent
object.
clone
in class CSItemContent
CSFormItemContent
object.java.lang.CloneNotSupportedException
- if cloning is not supported/allowed.java.lang.OutOfMemoryError
- if there are any problems allocating memory.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.