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

Class AbstractBaseTaskFormPresenter.AbstractBaseFormEngine<D extends BaseFormData>

Object

AbstractBaseFormEngine<D>

All Implemented Interfaces:

BaseFormEngine<D>, Serializable

Direct Known Subclasses:

AbstractTaskFormPresenter.AbstractTaskFormPresenterFormEngine, DefaultSubFormPresenter.MasterDetailSubFormEngine

Enclosing class:

AbstractBaseTaskFormPresenter<F extends BaseForm,D extends BaseFormData,V extends BaseFormView<F>>

protected abstract static class AbstractBaseTaskFormPresenter.AbstractBaseFormEngine<D extends BaseFormData>
extends Object
implements BaseFormEngine<D>, Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Logger	_engineLogger
protected Set<AttachmentProvider>	attachmentProvieders
protected Map<String,Object>	contextVariables
protected AbstractBaseTaskFormPresenter<? extends BaseForm,? extends BaseFormData,? extends BaseFormView<? extends BaseForm>>	instance
protected boolean	strictMode

Constructor Summary

Constructors

Constructor	Description
AbstractBaseFormEngine(AbstractBaseTaskFormPresenter<? extends BaseForm,? extends BaseFormData,? extends BaseFormView<? extends BaseForm>> instance)

Method Summary

Modifier and Type	Method	Description
String	buildEngineContextInfo()	Constroi uma String informando detalhes sobre o contexto da engine
boolean	close()	Caso o presenter esteja disposto em uma janela, solicita o fechamento do mesmo
boolean	close(boolean forceClose)	Caso o presenter esteja disposto em uma janela, solicita o fechamento do mesmo
void	debug(Object object)
void	downloadUrl(String url)
void	executeClientSideJavaScript(String script)	Executa o comando javascript no browser host do vitruvio
void	executeUrl(String url)
String	formKey()	Acesso ao formKey
String	generateUUID()
Collection<AttachmentProvider>	getAttachmentProviders()
List<String>	getBulkTaskIds()	Retorna a lista imutavel de taskIds participantes do bulk.
Object	getContextData(String key)	Coleta os dados de contexto que podem ter qualquer formato ou nulo se nao existirem (ou forem realmente nulos)
String	getEngineUUID()
Field<?>	getField(String fieldId)	Acesso a um campo de dados, via ID
Collection<String>	getFieldIds()	Coleta os campos disponveis na engine
FormDebugFormat	getFormDebugFormat()
FormDebugMode	getFormDebugMode()	Handler de output info
FormDebugOutput	getFormDebugOutput()
String	getFormDescription()	Obtem a descricao parametrizada no formulario, ou NULL se nao for definida
String	getFormName()	Obtem o nome do form associado a engine
Object	getGlobalVariable(String key)	Acessa uma variavel global definida no escopo da engine do formulario
HistoricTaskInstance	getHistoricTask()	Acesso ao processo
Label	getLabel(String id)	Obtem uma referencia para o label informado
LayoutWrapper	getLayout(String layoutId)	Acesso ao Wrapper de Layout, via ID
Collection<String>	getLayoutIds()	Obtem uma colecao de paineis identificados
UsuarioDTO	getLoggedUser()	Acesso ao usuario logado
Collection<String>	getModifiedFields(String fieldId)	Obtem uma relacao de todos os fields modificados
String	getProcessDefinitionId()	ID da definicao do processo
String	getProcessInstanceId()	ID do Processo
Map<String,Object>	getProcessVariables()	Acesso as variaveis do processo
Task	getTask()	Acesso a tarefa vigente
String	getTaskId()	ID da tarefa
Validator	getValidator(String id)	Obtem um validador por ID
Collection<Validator>	getValidators()	Acesso a colecao de validadores
WidgetController	getWidgetController(String id)	Obtem o acesso ao controlador de widget, via ID
void	handleDebugInfo(String data)
boolean	hasContextData(String key)	Determina se existem informacoes de contexto identificadas pela KEY
boolean	isBulk()	Determina se a engine esta operando em modo bulk (finalizacao agrupada de tarefas).
boolean	isCancelEnabled()	Verifica se a engine permite neste momento o cancelamento do form
boolean	isFinishEnabled()
boolean	isForInitialized()
boolean	isFormModified()	Retorna a analise de estado se o formulario foi alterado deste o utlimo commit
boolean	isGlobalVariableSet(String key)	Determina se a variavel global existe
boolean	isMobile()
boolean	isSaveEnabled()
boolean	isStrictMode()	Determina o estado da engine
boolean	isTouchDevice()
boolean	isValid()	Determina se a engine de formularios considera os campos validos
boolean	isWeb()
void	makeResponsive(Layout l)
void	openUrl(String url)
void	openUrlCurrentWindow(String url)
void	registerAttachmentProvider(AttachmentProvider provider)
ClientSideTimerExtension	registerRepeatingTimer(int miliSeconds, Runnable runnable)	Registra um timer para execucao de comandos com repeticao.
protected ClientSideTimerExtension	registerTimer(int miliSeconds, ClientSideTimerRepeatMode mode, Runnable runnable)
ClientSideTimerExtension	registerTimerCommand(int miliSeconds, Runnable runnable)	Registra um timer para execucao de um comando, uma unica vez.
void	registerValidator(String id, Validator validator)	Registra dinamicamente um validador.
void	setCancelEnabled(boolean enabled)	Informa para a engine se e permitido cancelar o form atual
void	setContextData(String key, Object data)
void	setFinishEnabled(boolean enabled)
void	setGlobalVariable(String key, Object value)	Seta uma variavel com escopo na instancia do formulario vigente.
void	setResponsiveMobile()
void	setSaveEnabled(boolean enabled)
void	setStrictMode(boolean strict)	Configura a engine em modo estrito.
void	setZoom(double zoom)
void	unregisterAttachmentProvider(AttachmentProvider provider)
void	unsetGlobalVariable(String key)	Remove a variavel do escopo
void	updateUI(Runnable runnable)	Metodos que executam tarefas em background, podem necessitar atualizar a UI de referencia da Engine.

Methods inherited from class Object

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

Methods inherited from interface BaseFormEngine

commitAndGetFormData, getFormData, isFieldModified

Field Details

attachmentProvieders

protected Set<AttachmentProvider> attachmentProvieders

contextVariables

protected Map<String,Object> contextVariables

instance

protected AbstractBaseTaskFormPresenter<? extends BaseForm,? extends BaseFormData,? extends BaseFormView<? extends BaseForm>> instance

_engineLogger

protected static final Logger _engineLogger

strictMode

protected boolean strictMode

Constructor Details

AbstractBaseFormEngine

public AbstractBaseFormEngine(AbstractBaseTaskFormPresenter<? extends BaseForm,? extends BaseFormData,? extends BaseFormView<? extends BaseForm>> instance)

Method Details

getEngineUUID

public String getEngineUUID()

Specified by:

getEngineUUID in interface BaseFormEngine<D extends BaseFormData>

generateUUID

public String generateUUID()

Specified by:

generateUUID in interface BaseFormEngine<D extends BaseFormData>

isBulk

public boolean isBulk()

Description copied from interface: BaseFormEngine

Determina se a engine esta operando em modo bulk (finalizacao agrupada de tarefas).

Specified by:

isBulk in interface BaseFormEngine<D extends BaseFormData>

Returns:

true se o formulario foi aberto para finalizar multiplas tarefas simultaneamente

getBulkTaskIds

public List<String> getBulkTaskIds()

Description copied from interface: BaseFormEngine

Retorna a lista imutavel de taskIds participantes do bulk.

Specified by:

getBulkTaskIds in interface BaseFormEngine<D extends BaseFormData>

makeResponsive

public void makeResponsive(Layout l)

Specified by:

makeResponsive in interface BaseFormEngine<D extends BaseFormData>

setResponsiveMobile

public void setResponsiveMobile()

Specified by:

setResponsiveMobile in interface BaseFormEngine<D extends BaseFormData>

buildEngineContextInfo

public String buildEngineContextInfo()

Description copied from interface: BaseFormEngine

Constroi uma String informando detalhes sobre o contexto da engine

Specified by:

buildEngineContextInfo in interface BaseFormEngine<D extends BaseFormData>

Returns:

getTask

public Task getTask()

Description copied from interface: BaseFormEngine

Acesso a tarefa vigente

Specified by:

getTask in interface BaseFormEngine<D extends BaseFormData>

Returns:

getHistoricTask

public HistoricTaskInstance getHistoricTask()

Description copied from interface: BaseFormEngine

Acesso ao processo

Specified by:

getHistoricTask in interface BaseFormEngine<D extends BaseFormData>

Returns:

getTaskId

public String getTaskId()

Description copied from interface: BaseFormEngine

ID da tarefa

Specified by:

getTaskId in interface BaseFormEngine<D extends BaseFormData>

Returns:

isFormModified

public boolean isFormModified()

Description copied from interface: BaseFormEngine

Retorna a analise de estado se o formulario foi alterado deste o utlimo commit

Specified by:

isFormModified in interface BaseFormEngine<D extends BaseFormData>

Returns:

getModifiedFields

public Collection<String> getModifiedFields(String fieldId)

Description copied from interface: BaseFormEngine

Obtem uma relacao de todos os fields modificados

Specified by:

getModifiedFields in interface BaseFormEngine<D extends BaseFormData>

Parameters:

fieldId -

Returns:

getProcessInstanceId

public String getProcessInstanceId()

Description copied from interface: BaseFormEngine

ID do Processo

Specified by:

getProcessInstanceId in interface BaseFormEngine<D extends BaseFormData>

Returns:

getProcessDefinitionId

public String getProcessDefinitionId()

Description copied from interface: BaseFormEngine

ID da definicao do processo

Specified by:

getProcessDefinitionId in interface BaseFormEngine<D extends BaseFormData>

Returns:

getLabel

public Label getLabel(String id)

Description copied from interface: BaseFormEngine

Obtem uma referencia para o label informado

Specified by:

getLabel in interface BaseFormEngine<D extends BaseFormData>

Parameters:

id -

Returns:

getField

public Field<?> getField(String fieldId)

Description copied from interface: BaseFormEngine

Acesso a um campo de dados, via ID

Specified by:

getField in interface BaseFormEngine<D extends BaseFormData>

Parameters:

fieldId -

Returns:

getFieldIds

public Collection<String> getFieldIds()

Description copied from interface: BaseFormEngine

Coleta os campos disponveis na engine

Specified by:

getFieldIds in interface BaseFormEngine<D extends BaseFormData>

Returns:

getLayoutIds

public Collection<String> getLayoutIds()

Description copied from interface: BaseFormEngine

Obtem uma colecao de paineis identificados

Specified by:

getLayoutIds in interface BaseFormEngine<D extends BaseFormData>

Returns:

getLayout

public LayoutWrapper getLayout(String layoutId)

Description copied from interface: BaseFormEngine

Acesso ao Wrapper de Layout, via ID

Specified by:

getLayout in interface BaseFormEngine<D extends BaseFormData>

Parameters:

layoutId -

Returns:

getValidators

public Collection<Validator> getValidators()

Description copied from interface: BaseFormEngine

Acesso a colecao de validadores

Specified by:

getValidators in interface BaseFormEngine<D extends BaseFormData>

Returns:

getValidator

public Validator getValidator(String id)

Description copied from interface: BaseFormEngine

Obtem um validador por ID

Specified by:

getValidator in interface BaseFormEngine<D extends BaseFormData>

Parameters:

id -

Returns:

registerValidator

public void registerValidator(String id,
 Validator validator)

Description copied from interface: BaseFormEngine

Registra dinamicamente um validador. Caso o mesmo ID já exista um erro será lançado

Specified by:

registerValidator in interface BaseFormEngine<D extends BaseFormData>

formKey

public String formKey()

Description copied from interface: BaseFormEngine

Acesso ao formKey

Specified by:

formKey in interface BaseFormEngine<D extends BaseFormData>

Returns:

getFormName

public String getFormName()

Description copied from interface: BaseFormEngine

Obtem o nome do form associado a engine

Specified by:

getFormName in interface BaseFormEngine<D extends BaseFormData>

Returns:

getFormDescription

public String getFormDescription()

Description copied from interface: BaseFormEngine

Obtem a descricao parametrizada no formulario, ou NULL se nao for definida

Specified by:

getFormDescription in interface BaseFormEngine<D extends BaseFormData>

Returns:

setCancelEnabled

public void setCancelEnabled(boolean enabled)

Description copied from interface: BaseFormEngine

Informa para a engine se e permitido cancelar o form atual

Specified by:

setCancelEnabled in interface BaseFormEngine<D extends BaseFormData>

Parameters:

enabled -

isCancelEnabled

public boolean isCancelEnabled()

Description copied from interface: BaseFormEngine

Verifica se a engine permite neste momento o cancelamento do form

Specified by:

isCancelEnabled in interface BaseFormEngine<D extends BaseFormData>

Returns:

setSaveEnabled

public void setSaveEnabled(boolean enabled)

Specified by:

setSaveEnabled in interface BaseFormEngine<D extends BaseFormData>

isSaveEnabled

public boolean isSaveEnabled()

Specified by:

isSaveEnabled in interface BaseFormEngine<D extends BaseFormData>

setFinishEnabled

public void setFinishEnabled(boolean enabled)

Specified by:

setFinishEnabled in interface BaseFormEngine<D extends BaseFormData>

isFinishEnabled

public boolean isFinishEnabled()

Specified by:

isFinishEnabled in interface BaseFormEngine<D extends BaseFormData>

getLoggedUser

public UsuarioDTO getLoggedUser()

Description copied from interface: BaseFormEngine

Acesso ao usuario logado

Specified by:

getLoggedUser in interface BaseFormEngine<D extends BaseFormData>

Returns:

getProcessVariables

public Map<String,Object> getProcessVariables()

Description copied from interface: BaseFormEngine

Acesso as variaveis do processo

Specified by:

getProcessVariables in interface BaseFormEngine<D extends BaseFormData>

Returns:

getWidgetController

public WidgetController getWidgetController(String id)

Description copied from interface: BaseFormEngine

Obtem o acesso ao controlador de widget, via ID

Specified by:

getWidgetController in interface BaseFormEngine<D extends BaseFormData>

Parameters:

id -

Returns:

Controlador do Widget ou Nulo caso nao exista

setGlobalVariable

public void setGlobalVariable(String key,
 Object value)

Description copied from interface: BaseFormEngine

Seta uma variavel com escopo na instancia do formulario vigente. Essa variavel nao sera persistida

Specified by:

setGlobalVariable in interface BaseFormEngine<D extends BaseFormData>

Parameters:

key -

value -

unsetGlobalVariable

public void unsetGlobalVariable(String key)

Description copied from interface: BaseFormEngine

Remove a variavel do escopo

Specified by:

unsetGlobalVariable in interface BaseFormEngine<D extends BaseFormData>

Parameters:

key -

isGlobalVariableSet

public boolean isGlobalVariableSet(String key)

Description copied from interface: BaseFormEngine

Determina se a variavel global existe

Specified by:

isGlobalVariableSet in interface BaseFormEngine<D extends BaseFormData>

Parameters:

key -

Returns:

getGlobalVariable

public Object getGlobalVariable(String key)

Description copied from interface: BaseFormEngine

Acessa uma variavel global definida no escopo da engine do formulario

Specified by:

getGlobalVariable in interface BaseFormEngine<D extends BaseFormData>

Parameters:

key -

Returns:

hasContextData

public boolean hasContextData(String key)

Description copied from interface: BaseFormEngine

Determina se existem informacoes de contexto identificadas pela KEY

Specified by:

hasContextData in interface BaseFormEngine<D extends BaseFormData>

Parameters:

key -

Returns:

getContextData

public Object getContextData(String key)

Description copied from interface: BaseFormEngine

Coleta os dados de contexto que podem ter qualquer formato ou nulo se nao existirem (ou forem realmente nulos)

Specified by:

getContextData in interface BaseFormEngine<D extends BaseFormData>

Parameters:

key -

Returns:

setContextData

public void setContextData(String key,
 Object data)

debug

public void debug(Object object)

Specified by:

debug in interface BaseFormEngine<D extends BaseFormData>

isValid

public boolean isValid()

Description copied from interface: BaseFormEngine

Determina se a engine de formularios considera os campos validos

Specified by:

isValid in interface BaseFormEngine<D extends BaseFormData>

Returns:

registerRepeatingTimer

public ClientSideTimerExtension registerRepeatingTimer(int miliSeconds,
 Runnable runnable)

Description copied from interface: BaseFormEngine

Registra um timer para execucao de comandos com repeticao. E responsabilidade de quem invocar este metodo da engine controlar a parada do timer, exceto se a interface for desligada, quando a engine ira interromper automaticamente

Specified by:

registerRepeatingTimer in interface BaseFormEngine<D extends BaseFormData>

Parameters:

miliSeconds -

runnable -

Returns:

registerTimerCommand

public ClientSideTimerExtension registerTimerCommand(int miliSeconds,
 Runnable runnable)

Description copied from interface: BaseFormEngine

Registra um timer para execucao de um comando, uma unica vez. Este timer nao devera ser reusado pois ele sera destruido assim que o comando for executado

Specified by:

registerTimerCommand in interface BaseFormEngine<D extends BaseFormData>

Parameters:

miliSeconds -

runnable -

Returns:

registerTimer

protected ClientSideTimerExtension registerTimer(int miliSeconds,
 ClientSideTimerRepeatMode mode,
 Runnable runnable)

updateUI

public void updateUI(Runnable runnable)

Description copied from interface: BaseFormEngine

Metodos que executam tarefas em background, podem necessitar atualizar a UI de referencia da Engine. Neste caso, qualquer atualizacao deve ser realizada dentro de um bloco seguro que pode locar a interface para garantir o correto envio das alteracoes para o Browser

Specified by:

updateUI in interface BaseFormEngine<D extends BaseFormData>

Parameters:

runnable -

close

public boolean close()

Description copied from interface: BaseFormEngine

Caso o presenter esteja disposto em uma janela, solicita o fechamento do mesmo

Specified by:

close in interface BaseFormEngine<D extends BaseFormData>

Returns:

se a janela foi fechada

close

public boolean close(boolean forceClose)

Description copied from interface: BaseFormEngine

Caso o presenter esteja disposto em uma janela, solicita o fechamento do mesmo

Specified by:

close in interface BaseFormEngine<D extends BaseFormData>

Parameters:

forceClose - fecha o presenter ignorando qualquer confirmacao que possa ser necessaria

Returns:

se o presenter foi fechado

executeClientSideJavaScript

public void executeClientSideJavaScript(String script)

Description copied from interface: BaseFormEngine

Executa o comando javascript no browser host do vitruvio

Specified by:

executeClientSideJavaScript in interface BaseFormEngine<D extends BaseFormData>

Parameters:

script -

setStrictMode

public void setStrictMode(boolean strict)

Description copied from interface: BaseFormEngine

Configura a engine em modo estrito.

Specified by:

setStrictMode in interface BaseFormEngine<D extends BaseFormData>

Parameters:

strict - - Quando falso (padrao), a engine sera leniente com chamadas de metodo problematicas, como coletar fields que nao existem, etc

isStrictMode

public boolean isStrictMode()

Description copied from interface: BaseFormEngine

Determina o estado da engine

Specified by:

isStrictMode in interface BaseFormEngine<D extends BaseFormData>

Returns:

isMobile

public boolean isMobile()

Specified by:

isMobile in interface BaseFormEngine<D extends BaseFormData>

isTouchDevice

public boolean isTouchDevice()

Specified by:

isTouchDevice in interface BaseFormEngine<D extends BaseFormData>

isWeb

public boolean isWeb()

Specified by:

isWeb in interface BaseFormEngine<D extends BaseFormData>

setZoom

public void setZoom(double zoom)

Specified by:

setZoom in interface BaseFormEngine<D extends BaseFormData>

getFormDebugMode

public FormDebugMode getFormDebugMode()

Description copied from interface: BaseFormEngine

Handler de output info

Specified by:

getFormDebugMode in interface BaseFormEngine<D extends BaseFormData>

getFormDebugOutput

public FormDebugOutput getFormDebugOutput()

Specified by:

getFormDebugOutput in interface BaseFormEngine<D extends BaseFormData>

getFormDebugFormat

public FormDebugFormat getFormDebugFormat()

Specified by:

getFormDebugFormat in interface BaseFormEngine<D extends BaseFormData>

handleDebugInfo

public void handleDebugInfo(String data)

Specified by:

handleDebugInfo in interface BaseFormEngine<D extends BaseFormData>

isForInitialized

public boolean isForInitialized()

Specified by:

isForInitialized in interface BaseFormEngine<D extends BaseFormData>

openUrl

public void openUrl(String url)

Specified by:

openUrl in interface BaseFormEngine<D extends BaseFormData>

executeUrl

public void executeUrl(String url)

Specified by:

executeUrl in interface BaseFormEngine<D extends BaseFormData>

downloadUrl

public void downloadUrl(String url)

Specified by:

downloadUrl in interface BaseFormEngine<D extends BaseFormData>

openUrlCurrentWindow

public void openUrlCurrentWindow(String url)

Specified by:

openUrlCurrentWindow in interface BaseFormEngine<D extends BaseFormData>

registerAttachmentProvider

public void registerAttachmentProvider(AttachmentProvider provider)

Specified by:

registerAttachmentProvider in interface BaseFormEngine<D extends BaseFormData>

unregisterAttachmentProvider

public void unregisterAttachmentProvider(AttachmentProvider provider)

Specified by:

unregisterAttachmentProvider in interface BaseFormEngine<D extends BaseFormData>

getAttachmentProviders

public Collection<AttachmentProvider> getAttachmentProviders()

Specified by:

getAttachmentProviders in interface BaseFormEngine<D extends BaseFormData>