|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.meshcms.webui.FormField
Encapsulates the functionalities of a form field.
Field Summary | |
static int |
EMAIL
Denotes a text field that is supposed to accept e-mail addresses. |
static int |
HIDDEN
Denotes a hidden field. |
static int |
NUMBER
Denotes a text field that is supposed to accept numbers. |
static int |
RESET
Denotes a reset button. |
static int |
SELECT_OPTION
Denotes a select field. |
static int |
SUBMIT
Denotes a submit button. |
static int |
TEXT
Denotes a text field. |
Constructor Summary | |
FormField()
|
Method Summary | |
boolean |
checkValue()
Tries to determine if the value of the field is acceptable. |
static java.lang.String |
createCode(java.lang.String s)
Returns a modified version of the passed string, such as it can be used as a field name. |
java.lang.String |
getCode()
Returns the element name of the field. |
java.lang.String |
getDescription()
Returns a descriptive name of the field. |
java.lang.String |
getName()
Returns the friendly name of the field. |
java.lang.String[] |
getOptions()
Returns the options of the field. |
int |
getRows()
Returns the number of rows for the editable field. |
int |
getType()
Returns the type of the field. |
java.lang.String |
getValue()
Returns the value of the field. |
boolean |
isMessageBody()
Returns the value of the message body flag. |
boolean |
isRecipient()
Returns the value of the recipient flag. |
boolean |
isRequired()
Returns the value of the required flag. |
boolean |
isSender()
Returns the value of the sender flag. |
boolean |
isSenderName()
Returns the value of the sender name flag. |
boolean |
isSubject()
Returns the value of the subject flag. |
void |
setCode(java.lang.String code)
Sets the element name of the field. |
void |
setMessageBody(boolean messageBody)
Sets the message body flag. |
void |
setName(java.lang.String name)
Sets the friendly name of the field. |
void |
setNameAndCode(java.lang.String name)
Sets both the friendly name and the element name of the field. |
void |
setOptions(java.lang.String[] options)
Sets the options of the field. To be used only for fields whose type is SELECT_OPTION . |
void |
setParameter(java.lang.String value)
Sets the value of a parameter. |
void |
setRecipient(boolean recipient)
Sets the recipient flag. |
void |
setRequired(boolean required)
Sets the required flag. |
void |
setRows(int rows)
Sets the number of rows for the editable field. |
void |
setSender(boolean sender)
Sets the sender flag. |
void |
setSenderName(boolean senderName)
Sets the sender name flag. |
void |
setSubject(boolean subject)
Sets the subject flag. |
void |
setType(int type)
Sets the type of the field. |
void |
setValue(java.lang.String value)
Sets the value of the field. |
java.lang.String |
toString()
Returns a description of the field. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int TEXT
public static final int EMAIL
public static final int SUBMIT
public static final int RESET
public static final int NUMBER
public static final int HIDDEN
public static final int SELECT_OPTION
Constructor Detail |
public FormField()
Method Detail |
public void setName(java.lang.String name)
public java.lang.String getName()
public void setCode(java.lang.String code)
public java.lang.String getCode()
public void setType(int type)
public int getType()
public void setValue(java.lang.String value)
public java.lang.String getValue()
public void setOptions(java.lang.String[] options)
SELECT_OPTION
.
public java.lang.String[] getOptions()
public void setNameAndCode(java.lang.String name)
createCode(java.lang.String)
.
public void setRequired(boolean required)
public boolean isRequired()
public void setSender(boolean sender)
public boolean isSender()
public void setRecipient(boolean recipient)
public boolean isRecipient()
public void setRows(int rows)
input
field is replaced with a textarea
when
this number is greater than 1.
public int getRows()
public void setParameter(java.lang.String value)
public boolean checkValue()
public static java.lang.String createCode(java.lang.String s)
public java.lang.String getDescription()
public java.lang.String toString()
public boolean isSenderName()
public void setSenderName(boolean senderName)
public boolean isSubject()
public void setSubject(boolean subject)
public boolean isMessageBody()
public void setMessageBody(boolean messageBody)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |