Package br.com.davinti.vitruvio.activiti.component.form.impl.descriptors

Class AbstractBaseForm

Object

AbstractBaseForm

All Implemented Interfaces:

BaseForm, MutableBaseForm, Serializable

Direct Known Subclasses:

AbstractFormCommomBase, PanelFormImpl, SubFormImpl

public abstract class AbstractBaseForm
extends Object
implements MutableBaseForm

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Script	afterFormRenderScript
protected Collection<FieldDescriptor>	allFields
protected boolean	allowsBulkFinish
protected String	backgroundColor
protected BulkAction	bulkAction
protected ComponentFactory	componentFactory
protected String	composer
protected List<FormComponentContainer>	containers
protected String	customCss
protected FormDebugFormat	debugFormat
protected FormDebugMode	debugMode
protected FormDebugOutput	debugOutput
protected String	description
protected Map<String,FieldDescriptor>	fields
protected String	formKey
protected String	height
protected Script	initScript
protected Map<String,FieldDescriptor>	labels
protected Map<String,FieldDescriptor>	modelMemberfields
protected String	name
protected Script	persistScript
protected Script	preInitScript
protected MutableValidationRules	validationRules
protected Map<String,FormElementDescriptor>	widgets
protected String	width
protected String	windowHeight
protected String	windowWidth

Constructor Summary

Constructors

Constructor	Description
AbstractBaseForm()
AbstractBaseForm(String formKey, String name, String description)

Method Summary

Modifier and Type	Method	Description
void	addFormComponentContainer(FormComponentContainer container)
void	addFormComponentContainers(Collection<FormComponentContainer> containers)
void	addValidator(ValidatorDescriptor descriptor)
boolean	allowsBulkFinish()	Determina se este formulario permite conclusao em grupo de tarefas
String	backgroundColor()	Cor de fundo personalizada do container componente
MutableBaseForm	clone()
String	composer()
String	customCss()	Estilo css personalizado, para o container do componente
FormDebugFormat	debugFormat()	Formato de representacao dos dados de debug
FormDebugMode	debugMode()	Coleta o modo de debug configurado para este formulario
FormDebugOutput	debugOutput()	Caso o modo de debug esteja ativo, especifica qual a saida das informacoes coletadas
String	formKey()	Form key
Script	getAfterFormRenderScript()	Script que podera ser invocado logo apos a renderizacao do form e criacao da UI.
Collection<FieldDescriptor>	getAllFields()
BulkAction	getBulkAction()	Obtem a definicao da acao de conclusao em grupo, caso exista
String	getDescription()	Descricao do formulario
FieldDescriptor	getFieldDescriptorById(String id)	Localiza na estrutura de descricao do formulario, a definicao de um deterinado field por ID
Set<String>	getFieldIds()	Obtem a relacao de todos os IDs de campos disponiveis no formulario
String	getHeight()	Tamanho em altura do formulario
Script	getInitScript()	Hook script que caso presente, sera invocado assim que o formulario estiver renderizado
FieldDescriptor	getLabelDescriptorById(String id)	Localiza na estrutura de descricao do formulario, a definicao de um deterinado label por ID
Set<String>	getLabelIds()	Obtem a relacao de todos os IDs de labels disponiveis no formulario
Set<String>	getModelMemberFieldIds()	Obtem a relacao de todos os IDs de campos que facam parte do modelo de dados do formulario
String	getName()	Nome do formulario
Script	getPersistScript()	Hook script, invocado ao persistir os dados do formulario
Script	getPreInitScript()	Hook de pre init, e invocado logo apos a configuracao dos dados do formulario, porem antes da inicializacao dos widgets
List<FormComponentContainer>	getRootContainers()	Todo formulario comeca com containers de componentes.
MutableValidationRules	getValidationRules()	Obtem o conjunto de regras gerais
List<ValidatorDescriptor>	getValidators()	Relacao de validadores customizados do formulario
Set<String>	getWidgetIds()	Obtem a relacao de todos os IDs de widgets disponiveis no formulario
String	getWidth()	Tamanho em largura do container do formulario
String	getWindowHeight()	Quando o sistema julgar que este formulario deve ser exibido em uma janela, este metodo pode retornar uma dica do tamanho ideal de exibicao
String	getWindowWidth()	Quando o sistema julgar que este formulario deve ser exibido em uma janela, este metodo pode retornar uma dica do tamanho ideal de exibicao
boolean	isModelMember(String fieldId)	Determina se determinado campo faz parte do modelo de dados do formulario, ou seja: Se os dados deste campo devem ser persistidos/carregados
void	mapDescriptors()
void	mapDescriptors(FormComponentContainer container)	Mapeia recursivamente os campos deste container
void	mapFields(FieldDescriptor descriptor)
void	mapWidgets(FormElementDescriptor descriptor)
void	setAfterFormRenderScript(Script script)
void	setAllowsBulkFinish(boolean allows)
void	setBackgroundColor(String color)
void	setBulkAction(BulkAction bulkAction)
void	setComposer(String composer)
void	setCustomCss(String css)
void	setDebugFormat(FormDebugFormat format)
void	setDebugMode(FormDebugMode debugMode)
void	setDebugOutput(FormDebugOutput output)
void	setDescription(String description)
void	setFormKey(String formKey)
void	setHeight(String height)
void	setInitScript(Script script)
void	setName(String name)
void	setPersistScript(Script persistScript)
void	setPreInitScript(Script preInitScript)
void	setWidth(String width)
void	setWindowHeight(String h)
void	setWindowWidth(String w)
String	toString()

Methods inherited from class Object

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

Field Details

formKey

protected String formKey

composer

protected String composer

name

protected String name

description

protected String description

width

protected String width

height

protected String height

windowWidth

protected String windowWidth

windowHeight

protected String windowHeight

backgroundColor

protected String backgroundColor

customCss

protected String customCss

preInitScript

protected Script preInitScript

afterFormRenderScript

protected Script afterFormRenderScript

initScript

protected Script initScript

persistScript

protected Script persistScript

containers

protected List<FormComponentContainer> containers

validationRules

protected MutableValidationRules validationRules

fields

protected Map<String,FieldDescriptor> fields

allFields

protected Collection<FieldDescriptor> allFields

modelMemberfields

protected Map<String,FieldDescriptor> modelMemberfields

widgets

protected Map<String,FormElementDescriptor> widgets

labels

protected Map<String,FieldDescriptor> labels

componentFactory

protected transient ComponentFactory componentFactory

debugMode

protected FormDebugMode debugMode

debugOutput

protected FormDebugOutput debugOutput

debugFormat

protected FormDebugFormat debugFormat

allowsBulkFinish

protected boolean allowsBulkFinish

bulkAction

protected BulkAction bulkAction

Constructor Details

AbstractBaseForm

public AbstractBaseForm()

AbstractBaseForm

public AbstractBaseForm(String formKey,
 String name,
 String description)

Method Details

getAllFields

public Collection<FieldDescriptor> getAllFields()

formKey

public String formKey()

Description copied from interface: BaseForm

Form key

Specified by:

formKey in interface BaseForm

Returns:

setFormKey

public void setFormKey(String formKey)

getName

public String getName()

Description copied from interface: BaseForm

Nome do formulario

Specified by:

getName in interface BaseForm

Returns:

setName

public void setName(String name)

getDescription

public String getDescription()

Description copied from interface: BaseForm

Descricao do formulario

Specified by:

getDescription in interface BaseForm

Returns:

setDescription

public void setDescription(String description)

getRootContainers

public List<FormComponentContainer> getRootContainers()

Description copied from interface: BaseForm

Todo formulario comeca com containers de componentes. Dentro dos containers, podem haver outros containers e outros elementos

Specified by:

getRootContainers in interface BaseForm

Returns:

getValidationRules

public MutableValidationRules getValidationRules()

Description copied from interface: BaseForm

Obtem o conjunto de regras gerais

Specified by:

getValidationRules in interface BaseForm

Returns:

getValidators

public List<ValidatorDescriptor> getValidators()

Description copied from interface: BaseForm

Relacao de validadores customizados do formulario

Specified by:

getValidators in interface BaseForm

Returns:

addValidator

public void addValidator(ValidatorDescriptor descriptor)

Specified by:

addValidator in interface MutableBaseForm

addFormComponentContainers

public void addFormComponentContainers(Collection<FormComponentContainer> containers)

Specified by:

addFormComponentContainers in interface MutableBaseForm

addFormComponentContainer

public void addFormComponentContainer(FormComponentContainer container)

Specified by:

addFormComponentContainer in interface MutableBaseForm

setInitScript

public void setInitScript(Script script)

Specified by:

setInitScript in interface MutableBaseForm

getInitScript

public Script getInitScript()

Description copied from interface: BaseForm

Hook script que caso presente, sera invocado assim que o formulario estiver renderizado

Specified by:

getInitScript in interface BaseForm

Returns:

getPreInitScript

public Script getPreInitScript()

Description copied from interface: BaseForm

Hook de pre init, e invocado logo apos a configuracao dos dados do formulario, porem antes da inicializacao dos widgets

Specified by:

getPreInitScript in interface BaseForm

Returns:

setPreInitScript

public void setPreInitScript(Script preInitScript)

Specified by:

setPreInitScript in interface MutableBaseForm

getAfterFormRenderScript

public Script getAfterFormRenderScript()

Description copied from interface: BaseForm

Script que podera ser invocado logo apos a renderizacao do form e criacao da UI. Nesta etapa, os dados ainda nao foram carregados e nenhum evento da UI foi processado. Pode ser util para declarar funcoes globais por exemplo

Specified by:

getAfterFormRenderScript in interface BaseForm

Returns:

setAfterFormRenderScript

public void setAfterFormRenderScript(Script script)

Specified by:

setAfterFormRenderScript in interface MutableBaseForm

getPersistScript

public Script getPersistScript()

Description copied from interface: BaseForm

Hook script, invocado ao persistir os dados do formulario

Specified by:

getPersistScript in interface BaseForm

Returns:

setPersistScript

public void setPersistScript(Script persistScript)

Specified by:

setPersistScript in interface MutableBaseForm

mapDescriptors

public void mapDescriptors(FormComponentContainer container)

Mapeia recursivamente os campos deste container

Specified by:

mapDescriptors in interface MutableBaseForm

Parameters:

container -

mapDescriptors

public void mapDescriptors()

Specified by:

mapDescriptors in interface MutableBaseForm

mapFields

public void mapFields(FieldDescriptor descriptor)

Specified by:

mapFields in interface MutableBaseForm

mapWidgets

public void mapWidgets(FormElementDescriptor descriptor)

toString

public String toString()

Overrides:

toString in class Object

getFieldIds

public Set<String> getFieldIds()

Description copied from interface: BaseForm

Obtem a relacao de todos os IDs de campos disponiveis no formulario

Specified by:

getFieldIds in interface BaseForm

Returns:

getModelMemberFieldIds

public Set<String> getModelMemberFieldIds()

Description copied from interface: BaseForm

Obtem a relacao de todos os IDs de campos que facam parte do modelo de dados do formulario

Specified by:

getModelMemberFieldIds in interface BaseForm

Returns:

getWidgetIds

public Set<String> getWidgetIds()

Description copied from interface: BaseForm

Obtem a relacao de todos os IDs de widgets disponiveis no formulario

Specified by:

getWidgetIds in interface BaseForm

Returns:

isModelMember

public boolean isModelMember(String fieldId)

Description copied from interface: BaseForm

Determina se determinado campo faz parte do modelo de dados do formulario, ou seja: Se os dados deste campo devem ser persistidos/carregados

Specified by:

isModelMember in interface BaseForm

Parameters:

fieldId -

Returns:

getFieldDescriptorById

public FieldDescriptor getFieldDescriptorById(String id)

Description copied from interface: BaseForm

Localiza na estrutura de descricao do formulario, a definicao de um deterinado field por ID

Specified by:

getFieldDescriptorById in interface BaseForm

Parameters:

id -

Returns:

getLabelIds

public Set<String> getLabelIds()

Description copied from interface: BaseForm

Obtem a relacao de todos os IDs de labels disponiveis no formulario

Specified by:

getLabelIds in interface BaseForm

Returns:

getLabelDescriptorById

public FieldDescriptor getLabelDescriptorById(String id)

Description copied from interface: BaseForm

Localiza na estrutura de descricao do formulario, a definicao de um deterinado label por ID

Specified by:

getLabelDescriptorById in interface BaseForm

Parameters:

id -

Returns:

setWidth

public void setWidth(String width)

Specified by:

setWidth in interface MutableBaseForm

setHeight

public void setHeight(String height)

Specified by:

setHeight in interface MutableBaseForm

getWidth

public String getWidth()

Description copied from interface: BaseForm

Tamanho em largura do container do formulario

Specified by:

getWidth in interface BaseForm

Returns:

getHeight

public String getHeight()

Description copied from interface: BaseForm

Tamanho em altura do formulario

Specified by:

getHeight in interface BaseForm

Returns:

setWindowWidth

public void setWindowWidth(String w)

Specified by:

setWindowWidth in interface MutableBaseForm

getWindowWidth

public String getWindowWidth()

Description copied from interface: BaseForm

Quando o sistema julgar que este formulario deve ser exibido em uma janela, este metodo pode retornar uma dica do tamanho ideal de exibicao

Specified by:

getWindowWidth in interface BaseForm

Returns:

setWindowHeight

public void setWindowHeight(String h)

Specified by:

setWindowHeight in interface MutableBaseForm

getWindowHeight

public String getWindowHeight()

Description copied from interface: BaseForm

Quando o sistema julgar que este formulario deve ser exibido em uma janela, este metodo pode retornar uma dica do tamanho ideal de exibicao

Specified by:

getWindowHeight in interface BaseForm

Returns:

backgroundColor

public String backgroundColor()

Description copied from interface: BaseForm

Cor de fundo personalizada do container componente

Specified by:

backgroundColor in interface BaseForm

Returns:

setBackgroundColor

public void setBackgroundColor(String color)

Specified by:

setBackgroundColor in interface MutableBaseForm

customCss

public String customCss()

Description copied from interface: BaseForm

Estilo css personalizado, para o container do componente

Specified by:

customCss in interface BaseForm

Returns:

setCustomCss

public void setCustomCss(String css)

Specified by:

setCustomCss in interface MutableBaseForm

composer

public String composer()

Specified by:

composer in interface BaseForm

Returns:

setComposer

public void setComposer(String composer)

Specified by:

setComposer in interface MutableBaseForm

debugMode

public FormDebugMode debugMode()

Description copied from interface: BaseForm

Coleta o modo de debug configurado para este formulario

Specified by:

debugMode in interface BaseForm

Returns:

setDebugMode

public void setDebugMode(FormDebugMode debugMode)

Specified by:

setDebugMode in interface MutableBaseForm

debugOutput

public FormDebugOutput debugOutput()

Description copied from interface: BaseForm

Caso o modo de debug esteja ativo, especifica qual a saida das informacoes coletadas

Specified by:

debugOutput in interface BaseForm

Returns:

setDebugOutput

public void setDebugOutput(FormDebugOutput output)

Specified by:

setDebugOutput in interface MutableBaseForm

setDebugFormat

public void setDebugFormat(FormDebugFormat format)

Specified by:

setDebugFormat in interface MutableBaseForm

debugFormat

public FormDebugFormat debugFormat()

Description copied from interface: BaseForm

Formato de representacao dos dados de debug

Specified by:

debugFormat in interface BaseForm

Returns:

allowsBulkFinish

public boolean allowsBulkFinish()

Description copied from interface: BaseForm

Determina se este formulario permite conclusao em grupo de tarefas

Specified by:

allowsBulkFinish in interface BaseForm

Returns:

setAllowsBulkFinish

public void setAllowsBulkFinish(boolean allows)

Specified by:

setAllowsBulkFinish in interface MutableBaseForm

getBulkAction

public BulkAction getBulkAction()

Description copied from interface: BaseForm

Obtem a definicao da acao de conclusao em grupo, caso exista

Specified by:

getBulkAction in interface BaseForm

Returns:

setBulkAction

public void setBulkAction(BulkAction bulkAction)

Specified by:

setBulkAction in interface MutableBaseForm

clone

public MutableBaseForm clone()

Specified by:

clone in interface MutableBaseForm

Overrides:

clone in class Object