com.plumtree.remote.sci
Class SciSelectElement

java.lang.Object
  com.plumtree.remote.sci.SciSelectElement

All Implemented Interfaces:

ISciElement

public class SciSelectElement

extends java.lang.Object

implements ISciElement

Represents a select (drop-down) control.

Constructor Summary

SciSelectElement(java.lang.String fieldName, java.lang.String labelText)
Valued constructor

Method Summary

org.w3c.dom.Node	getRootNode() Gets the root Node to add to the page.
void	setLabelStyle(TypeStyle labelStyle) Sets the label style (important or normal).
void	setMandatoryValidation(java.lang.String message) Sets mandatory validation for the control.
void	setRegExpValidation(java.lang.String message, java.lang.String re, TypeMatch matchType) Sets regular expression validation for the control.
void	setSelectedValue(java.lang.String value) Sets the selected value.
void	setStorageType(TypeStorage storageType) Sets the storage type (integer or string).
void	setValue(NamedValue[] values) Sets the NamedValue list of values.
java.lang.String	toString() Writes the element to a string for debugging.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SciSelectElement

public SciSelectElement(java.lang.String fieldName,
                        java.lang.String labelText)

Valued constructor

Parameters:

fieldName - the name of the field; should be uppercase as the portal will uppercase all names in the NamedValue[] returned by IAdminEditor.finalize()

labelText - the text to display to the left of the control

Method Detail

setSelectedValue

public void setSelectedValue(java.lang.String value)

Sets the selected value.

Parameters:

value - the selected value

setValue

public void setValue(NamedValue[] values)

Sets the NamedValue list of values. (Similar to an OPTION array in HTML.)

Parameters:

values - a NamedValue of options

setStorageType

public void setStorageType(TypeStorage storageType)

Sets the storage type (integer or string).

Parameters:

storageType - the TypeStorage

setLabelStyle

public void setLabelStyle(TypeStyle labelStyle)

Sets the label style (important or normal).

Parameters:

labelStyle - the TypeStyle

setMandatoryValidation

public void setMandatoryValidation(java.lang.String message)

Sets mandatory validation for the control.

Parameters:

message - the message to display in the JavaScript alert if the field is empty

setRegExpValidation

public void setRegExpValidation(java.lang.String message,
                                java.lang.String re,
                                TypeMatch matchType)

Sets regular expression validation for the control.

Parameters:

message - the message to display in the JavaScript alert if validation fails

re - the regular expression to match

matchType - the TypeMatch (match or not-match)

getRootNode

public org.w3c.dom.Node getRootNode()

Gets the root Node to add to the page.

Specified by:

getRootNode in interface ISciElement

Returns:

the root Node

toString

public java.lang.String toString()

Writes the element to a string for debugging.

Returns:

the element as a string