Fields (Broadleaf Metadata Common 1.6.0-GA API)

java.lang.Object
- com.broadleafcommerce.metadata.dsl.core.utils.Fields

public final class Fields
extends Object

Author:: Nick Crum (ncrum)

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static DefaultField`	`bool()`
`static DefaultField`	`colorPicker()`
`static DefaultCustomAttributesGridField`	`customAttributesGrid()`
`static DefaultDateField`	`date()`
`static DefaultField`	`decimal()`
`static DefaultDerivedSelectField`	`derivedSelect()`
`static DefaultDerivedUrlField`	`derivedUrl()`
`static DefaultDynamicField`	`dynamic()` Creates a new `DefaultDynamicField`.
`static DefaultField`	`field()`
`static DefaultField`	`field(String type)`
`static DefaultFieldArrayBlockField`	`fieldArrayBlock()`
`static DefaultFieldArrayGridField`	`fieldArrayGrid()`
`static DefaultFileInputField`	`fileInput()`
`static DefaultField`	`html()`
`static DefaultField`	`integer()`
`static DefaultField`	`longInteger()`
`static DefaultLookupField`	`lookup()` Creates a new `LookupField`.
`static DefaultLookupField`	`lookupOption()` Creates a new `LookupField` with `LookupField.optionSelection()` configured.
`static DefaultLookupField`	`lookupValue()` Creates a new `LookupField` with `LookupField.valueSelection()` configured.
`static DefaultMoneyField`	`money()`
`static DefaultPhoneField`	`phone()` Creates a new `DefaultPhoneField`.
`static DefaultQueryBuilderField`	`queryBuilder()`
`static DefaultResidentGridField`	`residentGrid()`
`static DefaultResidentMapField`	`residentMap()` Creates a new `ResidentMapField`.
`static DefaultRuleBuilderField`	`ruleBuilder()`
`static DefaultSelectField`	`select()`
`static DefaultField`	`string()`
`static DefaultField`	`stringArray()`
`static DefaultField`	`text()` Alias for `string()`.
`static DefaultField`	`textArea()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

field
```
public static DefaultField field()
```

field

public static DefaultField field(String type)

string
```
public static DefaultField string()
```
Returns:

a field that renders a text input

text
```
public static DefaultField text()
```
Alias for string().

Returns:

a field that renders a text input

textArea
```
public static DefaultField textArea()
```
Returns:

a field that renders a textarea input

integer
```
public static DefaultField integer()
```

longInteger

public static DefaultField longInteger()

decimal
```
public static DefaultField decimal()
```

html
```
public static DefaultField html()
```

bool
```
public static DefaultField bool()
```

date
```
public static DefaultDateField date()
```

colorPicker

public static DefaultField colorPicker()

stringArray

public static DefaultField stringArray()

derivedSelect

public static DefaultDerivedSelectField derivedSelect()

derivedUrl

public static DefaultDerivedUrlField derivedUrl()

dynamic
```
public static DefaultDynamicField dynamic()
```
Creates a new DefaultDynamicField.

Returns:

a DefaultDynamicField

phone
```
public static DefaultPhoneField phone()
```
Creates a new DefaultPhoneField.

Returns:

a DefaultDynamicField

select

public static DefaultSelectField select()

fileInput

public static DefaultFileInputField fileInput()

money

public static DefaultMoneyField money()

lookup
```
public static DefaultLookupField lookup()
```
Creates a new LookupField.

Returns:

a LookupField

See Also:

for lookups that persist the entire selected option, for lookups that persist only the selected options value (e.g. it's ID)

lookupOption
```
public static DefaultLookupField lookupOption()
```
Creates a new LookupField with LookupField.optionSelection() configured. This is useful in situations where the selection of an option should result in the option being stored as the field's value.

Returns:

a LookupField

lookupValue
```
public static DefaultLookupField lookupValue()
```
Creates a new LookupField with LookupField.valueSelection() configured. This is useful in situations where the selection of an option should result in only the option's value, or ID, being stored as the field's value.

Returns:

a LookupField

residentGrid

public static DefaultResidentGridField residentGrid()

residentMap
```
public static DefaultResidentMapField residentMap()
```
Creates a new ResidentMapField. This field is useful for managing a key-value map that is resident on the entity being managed.

Returns:

a ResidentMapField

customAttributesGrid

public static DefaultCustomAttributesGridField customAttributesGrid()

ruleBuilder

public static DefaultRuleBuilderField ruleBuilder()

queryBuilder

public static DefaultQueryBuilderField queryBuilder()

fieldArrayGrid

public static DefaultFieldArrayGridField fieldArrayGrid()

fieldArrayBlock

public static DefaultFieldArrayBlockField fieldArrayBlock()

Class Fields

Method Summary

Methods inherited from class java.lang.Object

Method Detail

field

field

string

text

textArea

integer

longInteger

decimal

html

bool

date

colorPicker

stringArray

derivedSelect

derivedUrl

dynamic

phone

select

fileInput

money

lookup

lookupOption

lookupValue

residentGrid

residentMap

customAttributesGrid

ruleBuilder

queryBuilder

fieldArrayGrid

fieldArrayBlock