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

Class BaseWorkflowField

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.axemble.vdoc.sdk.document.fields.base.BaseWorkflowField

All Implemented Interfaces:

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

public abstract class BaseWorkflowField
extends BaseField

This base class provides direct access to the SDK API. It allows to create custom fields based on workflow information. The following methods are available: - getWorkflowModule() : the workflow system module (IWorkflowModule); - getWorkflowInstance() : the current workflow instance (IWorkflowInstance);

Version:

1.0, 15/04/2008

Author:

vlygeros

See Also:

IWorkflowModule, IWorkflowInstance, Serialized Form

Field Summary

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 and Description
BaseWorkflowField()

Method Summary

Modifier and Type	Method and Description
protected IDirectoryModule	getDirectoryModule()
protected IPortalModule	getPortalModule()
protected IProjectModule	getProjectModule()
protected IWorkflowInstance	getWorkflowInstance()
protected IWorkflowModule	getWorkflowModule()
void	init(Element element) Initializes the workflow members

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

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

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, isEmpty, 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

Constructor Detail

BaseWorkflowField

public BaseWorkflowField()

Method Detail

init

public void init(Element element)

Initializes the workflow members

Overrides:

init in class BaseField

Parameters:

element - The W3C Element object which defines the field

getWorkflowModule

protected IWorkflowModule getWorkflowModule()

Returns:

the workflowModule

getPortalModule

protected final IPortalModule getPortalModule()

Returns:

the portalModule

getDirectoryModule

protected final IDirectoryModule getDirectoryModule()

Returns:

the directoryModule

getProjectModule

protected final IProjectModule getProjectModule()

Returns:

the projectModule

getWorkflowInstance

protected IWorkflowInstance getWorkflowInstance()

Returns:

the workflowInstance