Package com.vdoc.sdk.commons.ui.document.fields

Class BaseAdvancedField

java.lang.Object

com.axemble.vdp.ui.framework.foundation.Component

com.axemble.vdp.ui.framework.foundation.Widget

com.axemble.vdp.ui.framework.widgets.CtlInputWidget

com.axemble.vdoc.sdk.document.fields.base.BaseField

com.vdoc.sdk.commons.ui.document.fields.BaseAdvancedField

All Implemented Interfaces:

IWidget, IWritable, com.axemble.vdp.ui.core.document.fields.IFieldControl, com.axemble.vdp.utils.parameters.ParamsHandler, Serializable

public abstract class BaseAdvancedField
extends BaseField

Base advanced field

Author:

vmartinon

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BaseAdvancedField.Dependency	Dependency
class	BaseAdvancedField.JavascriptEvent	Javascript event

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Logger	LOG
protected String	widgetUniqueIdentifier

Fields inherited from class com.axemble.vdoc.sdk.document.fields.base.BaseField

aggregate

Fields inherited from class com.axemble.vdp.ui.framework.widgets.CtlInputWidget

accessKey, includeErrorInfo, mandatory, quickCreateLink, stringRecipient, tabIndex, throwDocumentChangedScript, throwEvents, throwEventsDefined, validationRules

Fields inherited from class com.axemble.vdp.ui.framework.foundation.Widget

actionListeners, isHidden, param, parentBlock, sysname, userId

Fields inherited from class com.axemble.vdp.ui.framework.foundation.Component

changeListeners, LOGGER

Fields inherited from interface com.axemble.vdp.utils.parameters.ParamsHandler

ERROR_EXCEED_ELEM_SIZE, ERROR_EXCEED_TOTAL_SIZE, ERROR_NOT_COMPLETED, ERROR_READ_FAILED, EXCEED_ELEM_NUMBER, NO_ERROR

Constructor Summary

Constructors

Constructor	Description
BaseAdvancedField()	Default constructor

Method Summary

Modifier and Type	Method	Description
protected void	autoRender(com.axemble.vdp.ui.framework.template.TemplateWriter templateWriter)	Auto render
protected void	cleanTemplateWriterCache()
protected BaseAdvancedField.Dependency	getDependency(String dependencyName)
protected final IDirectoryModule	getDirectoryModule()
protected int	getInitDelay()
protected BaseAdvancedField.JavascriptEvent	getJavascriptEvent(String eventName)
protected String	getLoadMethodContent()
protected final IPortalModule	getPortalModule()
protected final IProjectModule	getProjectModule()
protected Object	getRequestParameterValue(String inputName)
protected IResource	getResource()
Object	getStoredValue()
protected String	getWidgetUniqueIdentifier()
protected IWorkflowInstance	getWorkflowInstance()
protected IWorkflowModule	getWorkflowModule()
void	init(Element element)	This method is called once when the document is loaded
boolean	isEmpty()
protected void	putDependency(String dependencyName, BaseAdvancedField.Dependency dependency)
protected void	putJavascriptEvent(String eventName, BaseAdvancedField.JavascriptEvent javascriptEvent)
protected void	setInitDelay(int initDelay)
void	setStoredValue(Object storedValue)
void	updateControl()
void	updateValue()

Methods inherited from class com.axemble.vdoc.sdk.document.fields.base.BaseField

checkErrorMessage, getAbstractField, getField, getFieldChangeListener, getTemplateAsString, getTemplateWriter, getValue, init, init, renderErrorMessage, setValue

Methods inherited from class com.axemble.vdp.ui.framework.widgets.CtlInputWidget

addRefreshButton, addValidationRule, buildFieldElement, canThrowEventsInWebBrowser, clearValidationRules, findStringRecipient, focus, getAccessKey, getAssociatedLabel, getDescription, getDocumentChangedScript, getErrorInfo, getHelpMessageIcon, getParentId, getQuickCreateLink, getRefreshButton, getTabIndex, getValidationObject, getValidationRules, handleNoParams, handleParams, handleParams, hasValidationRules, inform, isDescription, isDocumentChangedScript, isEditable, isFocus, isForceParentId, isIncludeErrorInfo, isMandatory, isThrowDocumentChangedScript, isThrowEventsDefined, renderErrorInfo, renderInfoMessage, renderQuickCreate, setAccessKey, setAssociatedLabel, setDescription, setEditable, setErrorInfo, setIncludeErrorInfo, setMandatory, setQuickCreateContextParameter, setQuickCreateScreen, setTabIndex, setThrowDocumentChangedScript, setThrowEvents, setThrowEventsDefined, setValidationRules, validate

Methods inherited from class com.axemble.vdp.ui.framework.foundation.Widget

addActionListener, afterInit, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireOnClickMessage, buildFireOnClickMessage, buildFormName, findFileRecipient, findXmlRecipient, fireActionEvent, getCtrlTemplate, getCtrlTemplateWriter, getJavaScriptFocusScript, getJavascriptId, getParam, getParentBlock, getSysname, getUserDisplayName, getUserId, handleAction, hasActionListeners, isHidden, refresh, refreshWidgets, removeActionListener, removeActionListeners, render, renderMobile, setHidden, setParam, setParentBlock, setSysname, setUserId, write

Methods inherited from class com.axemble.vdp.ui.framework.foundation.Component

addChangeListener, createComponent, evaluateExpressions, fireChangeEvent, getDynamicDescription, getDynamicLabel, getLanguage, getNavigator, getRootNavigator, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, hasChangeListeners, removeChangeListener, removeChangeListeners, stateChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.axemble.vdp.ui.core.document.fields.IFieldControl

addValidationRule, clearValidationRules, getUserId, getValidationRules, hasValidationRules, inform, isEditable, isHidden, isMandatory, setEditable, setHidden, setMandatory, setUserId, validate

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.IWidget

addChangeListener, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, hasChangeListeners, removeChangeListener, removeChangeListeners

Field Details

LOG

protected static final Logger LOG

widgetUniqueIdentifier

protected String widgetUniqueIdentifier

Constructor Details

BaseAdvancedField

public BaseAdvancedField()

Default constructor

Method Details

init

public void init(Element element)

Description copied from class: BaseField

This method is called once when the document is loaded

Overrides:

init in class BaseField

Parameters:

element - The W3C Element object which defines the field

See Also:

• BaseField.init(org.w3c.dom.Element)

updateControl

public void updateControl()

Specified by:

updateControl in interface com.axemble.vdp.ui.core.document.fields.IFieldControl

Specified by:

updateControl in class BaseField

See Also:

• BaseField.updateControl()

updateValue

public void updateValue()

Specified by:

updateValue in interface com.axemble.vdp.ui.core.document.fields.IFieldControl

Specified by:

updateValue in class BaseField

See Also:

• BaseField.updateValue()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class com.axemble.vdp.ui.framework.widgets.CtlInputWidget

See Also:

• CtlInputWidget.isEmpty()

getStoredValue

public Object getStoredValue()

setStoredValue

public void setStoredValue(Object storedValue)

getJavascriptEvent

protected BaseAdvancedField.JavascriptEvent getJavascriptEvent(String eventName)

putJavascriptEvent

protected void putJavascriptEvent(String eventName,
 BaseAdvancedField.JavascriptEvent javascriptEvent)

getDependency

protected BaseAdvancedField.Dependency getDependency(String dependencyName)

putDependency

protected void putDependency(String dependencyName,
 BaseAdvancedField.Dependency dependency)

autoRender

protected void autoRender(com.axemble.vdp.ui.framework.template.TemplateWriter templateWriter)
                   throws RenderException

Auto render

Parameters:

templateWriter - the template writer

Throws:

RenderException

getLoadMethodContent

protected String getLoadMethodContent()

getWidgetUniqueIdentifier

protected String getWidgetUniqueIdentifier()

getInitDelay

protected int getInitDelay()

cleanTemplateWriterCache

protected void cleanTemplateWriterCache()

getRequestParameterValue

protected Object getRequestParameterValue(String inputName)

getWorkflowModule

protected IWorkflowModule getWorkflowModule()

getPortalModule

protected final IPortalModule getPortalModule()

getDirectoryModule

protected final IDirectoryModule getDirectoryModule()

getProjectModule

protected final IProjectModule getProjectModule()

getWorkflowInstance

protected IWorkflowInstance getWorkflowInstance()

getResource

protected IResource getResource()

setInitDelay

protected void setInitDelay(int initDelay)