Package org.cxbox.core.service.rowmeta

Class FieldMetaBuilder<T extends org.cxbox.api.data.dto.DataResponseDTO>

java.lang.Object

org.cxbox.core.service.rowmeta.FieldMetaBuilder<T>

public abstract class FieldMetaBuilder<T extends org.cxbox.api.data.dto.DataResponseDTO>
extends Object

Constructor Summary

Constructors

Constructor	Description
FieldMetaBuilder()

Method Summary

Modifier and Type	Method	Description
void	buildExtremeRowDependentMeta(RowDependentFieldsMeta<T> fields, ExtremeBcDescription bcDescription, Long id, Long parentId)
void	buildIndependentMeta(FieldsMeta<T> fields, BusinessComponent bc)
abstract void	buildIndependentMeta(FieldsMeta<T> fields, InnerBcDescription bcDescription, Long parentId)
void	buildRowDependentMeta(RowDependentFieldsMeta<T> fields, BusinessComponent bc)
abstract void	buildRowDependentMeta(RowDependentFieldsMeta<T> fields, InnerBcDescription bcDescription, Long id, Long parentId)
CrudmaActionType	getActionType()
BusinessComponent	getBc()
<P extends org.cxbox.api.data.dto.DataResponseDTO, F> F	getParentField(DtoField<P,F> dtoField, BusinessComponent bc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FieldMetaBuilder

public FieldMetaBuilder()

Method Details

buildRowDependentMeta

public void buildRowDependentMeta(RowDependentFieldsMeta<T> fields,
 BusinessComponent bc)

This method configures form/list fields with UI changes, taking into account the information in the row:

Enabling field editing - the field becomes editable (editing is available in the form and in the list by double-clicking on the field) RowDependentFieldsCommonMeta.setEnabled(DtoField[]) #}

Requiring the field - the field becomes mandatory (if the form field is not filled in, an error message will appear) RowDependentFieldsCommonMeta.setRequired(DtoField[])

Adds a drop-down list to the Radio/Dictionary field of the form with values from the enum that are suitable only for enum fields RowDependentFieldsDictionaryMeta.setEnumValues(DtoField, Enum[])

Adds multiselect dropdown to the form field with custom values RowDependentFieldsDictionaryDeprecatedMeta.setDictionaryTypeWithCustomValues(DtoField, String...) )}

Setting up drilldown - adds link to the field RowDependentFieldsCommonMeta.setDrilldown(DtoField, DrillDownTypeSpecifier, String)

Setting hidden - makes fields hidden (the field on the form becomes hidden) RowDependentFieldsCommonMeta.setHidden(DtoField[])

e.t.c

You can specify field configuration conditions within the method:

Example:

 if (fields.get(ExampleDTO_.id).getCurrentValue() != null) {
     fields.setEnabled(ExampleDTO_.example);
 }
 

buildIndependentMeta

public void buildIndependentMeta(FieldsMeta<T> fields,
 BusinessComponent bc)

buildRowDependentMeta

public abstract void buildRowDependentMeta(RowDependentFieldsMeta<T> fields,
 InnerBcDescription bcDescription,
 Long id,
 Long parentId)

buildExtremeRowDependentMeta

public void buildExtremeRowDependentMeta(RowDependentFieldsMeta<T> fields,
 ExtremeBcDescription bcDescription,
 Long id,
 Long parentId)

getActionType

public CrudmaActionType getActionType()

getBc

public BusinessComponent getBc()

getParentField

public <P extends org.cxbox.api.data.dto.DataResponseDTO,
F>
F getParentField(DtoField<P,F> dtoField,
 BusinessComponent bc)

buildIndependentMeta

public abstract void buildIndependentMeta(FieldsMeta<T> fields,
 InnerBcDescription bcDescription,
 Long parentId)

The method configures list/form fields with UI changes:

Filterable - adding column sorting, available only for lists (icon appear) FieldsCommonMeta.enableFilter(DtoField[])

Sortable - adding column filtering, available only for lists (icon appear) FieldsCommonMeta.enableSort(DtoField[])

Filtering by enum values - adding filtering of columns with enum values(multiselect dropdown appear) FieldsDictionaryMeta.setEnumFilterValues(FieldsMeta, DtoField, Enum[])

Filtering by custom values - adding filtering of columns with custom values(multiselect dropdown appear) RowDependentFieldsDictionaryDeprecatedMeta.setDictionaryTypeWithCustomValues(DtoField, String...)

Specify acceptable formats when uploading files (when adding files, only files of the selected format will be available for addition) FieldsCommonMeta.setFileAccept(DtoField, List)

Filtering by values obtained from the field - adding filtering of columns with values obtained from the field(multiselect dropdown appear) FieldsCommonMeta.setConcreteFilterValues(DtoField, Collection)

e.t.c