Package com.opencloud.rem.common.form
Class FormBuilder.FieldBuilder
- java.lang.Object
-
- com.opencloud.rem.common.form.FormBuilder.FieldBuilder
-
- Enclosing class:
- FormBuilder
public class FormBuilder.FieldBuilder extends Object
Used to build aField
for a particularFormBuilder
.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FormBuilder
add()
Builds a newField
using the values provided by thisFormBuilder.FieldBuilder
and adds it to the linkedFormBuilder
.FormBuilder.FieldBuilder
description(String description)
Sets this field's description.FormBuilder.FieldBuilder
displayName(String displayName)
Sets this field's display name.FormBuilder.FieldBuilder
id()
Marks this field as an ID field.FormBuilder.FieldBuilder
id(boolean id)
Sets this field's id flag.FormBuilder.FieldBuilder
readable(boolean readable)
Set's this field's readable flag.FormBuilder.FieldBuilder
required()
Marks this field as required.FormBuilder.FieldBuilder
required(boolean required)
Sets this field's required flag.FormBuilder.FieldBuilder
withAttribute(String name, String value)
Sets an arbitrary attribute on this field.FormBuilder.FieldBuilder
withFieldValueProvider(FieldValueProvider fieldValueProvider)
Sets a field value provider for this field.FormBuilder.FieldBuilder
writable(boolean writable)
Set's this field's writable flag.
-
-
-
Method Detail
-
required
public FormBuilder.FieldBuilder required()
Marks this field as required.- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
id
public FormBuilder.FieldBuilder id()
Marks this field as an ID field.- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
id
public FormBuilder.FieldBuilder id(boolean id)
Sets this field's id flag.- Parameters:
id
-true
to mark this field as an ID field (default isfalse
)- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
required
public FormBuilder.FieldBuilder required(boolean required)
Sets this field's required flag.- Parameters:
required
-true
to mark this field as required (default isfalse
)- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
description
public FormBuilder.FieldBuilder description(String description)
Sets this field's description.- Parameters:
description
- the field's description- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
displayName
public FormBuilder.FieldBuilder displayName(String displayName)
Sets this field's display name.- Parameters:
displayName
- the field's display name- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
readable
public FormBuilder.FieldBuilder readable(boolean readable)
Set's this field's readable flag.- Parameters:
readable
-false
to mark this field as unreadable (default istrue
)- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
writable
public FormBuilder.FieldBuilder writable(boolean writable)
Set's this field's writable flag.- Parameters:
writable
-false
to mark this field as unwritable (default istrue
)- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
withAttribute
public FormBuilder.FieldBuilder withAttribute(String name, String value)
Sets an arbitrary attribute on this field.- Parameters:
name
- the attribute's namevalue
- the attribute's value- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
withFieldValueProvider
public FormBuilder.FieldBuilder withFieldValueProvider(FieldValueProvider fieldValueProvider)
Sets a field value provider for this field.- Parameters:
fieldValueProvider
- theFieldValueProvider
for this field- Returns:
- the
FormBuilder.FieldBuilder
being used to construct thisField
-
add
public FormBuilder add()
Builds a newField
using the values provided by thisFormBuilder.FieldBuilder
and adds it to the linkedFormBuilder
.- Returns:
- the linked
FormBuilder
-
-