com.axemble.vdoc.sdk.document.fields

Class CustomSelectionComponent

java.lang.Object

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

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

com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseComponent

com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseFieldComponent

com.axemble.vdoc.sdk.document.fields.CustomSelectionComponent

All Implemented Interfaces:

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

public class CustomSelectionComponent
extends com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseFieldComponent

Composant de paramétrage dynamique

Propose 5 types de champs (voir CustomSelectionComponent.FieldTypeKeys), à définir dans l'attribut "options" (séparés par ";") :

• customOption : une valeur prédéfinie
• selector : un champ sélecteur
• field : un champ sélecteur de champ
• customValue : un champ texte
• cutomList : un champ liste déroulante

Les paramètres des différents champs sont à indiquer sous la forme TypedeChamp-NomParamètre (Ex : field-label="LG_FROM_FIELD"). Quelques paramètres ont une valeur par défaut : field-screen="Property", field-method="select", field-ctrl="selector", selector-screen="filecenterNode", selector-method="select", selector-selectable="Folder".

Utiliser addParameter( String key, Object value ) ou addParameter( String type, String key, Object value ) pour valoriser les attributs des différents champs. Utiliser setList(Map list ) pour valoriser la liste des options de la combo box.

Author:

Vincent

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CustomSelectionComponent.FieldTypeChangeListener Classe pour gérer les évènements de la combo
static interface	CustomSelectionComponent.FieldTypeKeys All available field keys customOption : CustomSelectionComponent.FieldTypeKeys.CUSTOM_OPTION_KEY selector : CustomSelectionComponent.FieldTypeKeys.SELECTOR_KEY field : CustomSelectionComponent.FieldTypeKeys.FIELD_KEY customValue : CustomSelectionComponent.FieldTypeKeys.CUSTOM_VALUE_KEY customList : CustomSelectionComponent.FieldTypeKeys.CUSTOM_LIST_KEY

Field Summary

Fields

Modifier and Type	Field and Description
protected com.axemble.vdp.ui.framework.widgets.CtlComboBox	comboBox
protected Map<Object,Object>	customListOptions
protected String	customOptionLabel
protected String	customOptionValue
static String	FIELD_METHOD_DEFAULT_VALUE
static String	FIELD_SCREEN_DEFAULT_VALUE
protected IFieldComponent	fieldComponent
protected HashMap<String,String>	knownKeys
static String	SELECTOR_METHOD_DEFAULT_VALUE
static String	SELECTOR_SCREEN_DEFAULT_VALUE
static String	SELECTOR_SELECTABLE_DEFAULT_VALUE
protected static String	SEPARATOR
protected Object	value

Fields inherited from class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseFieldComponent

aggregate, hasService

Fields inherited from class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

accesskey, associatedLabel, condition, description, editable, errorInfo, formula, formulaCondition, includeErrorInfo, javascriptId, mandatory, modeFormula, property, propertytype, quickCreateLink, requiredFormula, rules, stringRecipient, tabindex, temporarypropertyname, throwDocumentChangedScript, throwEvents, throwEventsDefined, validationRules

Fields inherited from class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseComponent

additionalParameters, additionalParametersNodes, id, parameters

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
CustomSelectionComponent()

Method Summary

Modifier and Type	Method and Description
void	addFieldTypeChangeListener(CustomSelectionComponent.FieldTypeChangeListener listener) Add a new listener
void	addParameter(String key, Object value) Valorise les paramètres des champs
void	addParameter(String type, String key, Object value) Valorise les paramètres des champs
protected Collection<com.axemble.vdp.ui.framework.widgets.list.Option>	createOptionList(Map<Object,Object> list)
Collection<String>	getAvailableOptions()
String	getCustomOptionValue()
String	getDescription()
protected String	getFieldComponentClassName(String type)
protected Object	getFieldValue()
String	getJavascriptId()
String	getKeyLabel(String key)
String	getSelectedOption()
String	getSelectedOption(Object value) Retourne l'option de la combo sélectionnée en fonction de la valeur du composant
Object	getValidationObject()
boolean	hasFieldTypeChangeListeners() Returns true if the list has a change listener, false otherwise.
void	inform(String errorMessage) Add error message
protected void	initAdditionalParameters()
boolean	isDescription()
boolean	isEmpty()
protected void	loadParameters(Element element)
com.axemble.vdp.ui.framework.components.listeners.ChangeListener	removeFieldTypeChangeListener(CustomSelectionComponent.FieldTypeChangeListener listener) Removes an ChangeListenerfrom the Widget.
void	removeFieldTypeChangeListeners() Removes all changeListeners from the Widget.
IWritable	render() Render the widget
void	setDescription(String description)
void	setErrorInfo(String errorMessage)
protected void	setFieldComponentParameter(String key, Object value, String selectedType)
void	setList(Map<Object,Object> list) Valorise la liste des options de la liste déroulante
void	updateControl() Update widget
void	updateValue() la valeur sauvegardé peut être : - custom => String - property => IProperty - selector => Objet du sélecteur

Methods inherited from class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseFieldComponent

addCssDependency, addScriptDependency, getAbstractField, getField, getFieldChangeListener, getTemplateWriter, init, init, isHasService, setHasService, stateChanged

Methods inherited from class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

addRefreshButton, addValidationRule, afterInit, canThrowEventsInWebBrowser, clearValidationRules, findStringRecipient, focus, getAccesskey, getAssociatedLabel, getDocumentChangedScript, getErrorInfo, getFormula, getFormulaCondition, getHelpMessageIcon, getJavaScriptFocusScript, getModeFormula, getParentId, getProperty, getPropertyName, getPropertytype, getQuickCreateLink, getRefreshButton, getRequiredFormula, getTabindex, getTemporarypropertyname, getValidationRules, handleNoParams, handleParams, handleParams, hasValidationRules, init, initParameters, initParameters, isCondition, isDocumentChangedScript, isEditable, isFocus, isForceParentId, isIncludeErrorInfo, isMandatory, isThrowDocumentChangedScript, isThrowEvents, isThrowEventsDefined, registerWidget, renderErrorInfo, renderInfoMessage, renderQuickCreate, setAccesskey, setAssociatedLabel, setCondition, setEditable, setFormula, setFormulaCondition, setIncludeErrorInfo, setJavascriptId, setMandatory, setModeFormula, setProperty, setPropertytype, setQuickCreateContextParameter, setQuickCreateScreen, setRequiredFormula, setTabindex, setTemporarypropertyname, setThrowDocumentChangedScript, setThrowEvents, setThrowEventsDefined, setValidationRules, validate

Methods inherited from class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseComponent

getAdditionalParameters, getAdditionalParametersNodes, getAdditionalParametersNodesElement, getId, getParameter, getParameter, getParameterBoolean, getParameterBoolean, getParameterDate, getParameterDate, getParameterInt, getParameterInteger, getParameterList, getParameterLong, getParameterNumber, getParameters, getParameterString, getParameterString, hasParameter, removeParameter, setAdditionalParameters, setAdditionalParametersNodes, setId, setParameters

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

addActionListener, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireOnClickMessage, buildFireOnClickMessage, buildFormName, findFileRecipient, findXmlRecipient, fireActionEvent, getCtrlTemplate, getCtrlTemplateWriter, getParam, getParentBlock, getSysname, getUserDisplayName, getUserId, handleAction, hasActionListeners, isHidden, refresh, refreshWidgets, removeActionListener, removeActionListeners, 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

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, isEditable, isHidden, isMandatory, setEditable, setHidden, setMandatory, setUserId, validate

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

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

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

afterInit, getParentBlock, getSysname, refresh, setParentBlock, setSysname

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

write

Methods inherited from interface com.axemble.vdp.form.classes.IBaseComponentSupport

getLanguage, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, isHidden, setHidden

Field Detail

SEPARATOR

protected static final String SEPARATOR

See Also:

Constant Field Values

customOptionLabel

protected String customOptionLabel

customOptionValue

protected String customOptionValue

customListOptions

protected Map<Object,Object> customListOptions

SELECTOR_SCREEN_DEFAULT_VALUE

public static final String SELECTOR_SCREEN_DEFAULT_VALUE

See Also:

Constant Field Values

SELECTOR_METHOD_DEFAULT_VALUE

public static final String SELECTOR_METHOD_DEFAULT_VALUE

See Also:

Constant Field Values

SELECTOR_SELECTABLE_DEFAULT_VALUE

public static final String SELECTOR_SELECTABLE_DEFAULT_VALUE

See Also:

Constant Field Values

FIELD_SCREEN_DEFAULT_VALUE

public static final String FIELD_SCREEN_DEFAULT_VALUE

See Also:

Constant Field Values

FIELD_METHOD_DEFAULT_VALUE

public static final String FIELD_METHOD_DEFAULT_VALUE

See Also:

Constant Field Values

knownKeys

protected HashMap<String,String> knownKeys

comboBox

protected com.axemble.vdp.ui.framework.widgets.CtlComboBox comboBox

fieldComponent

protected IFieldComponent fieldComponent

value

protected Object value

Constructor Detail

CustomSelectionComponent

public CustomSelectionComponent()

Method Detail

addFieldTypeChangeListener

public void addFieldTypeChangeListener(CustomSelectionComponent.FieldTypeChangeListener listener)

Add a new listener

Parameters:

listener -

removeFieldTypeChangeListener

public com.axemble.vdp.ui.framework.components.listeners.ChangeListener removeFieldTypeChangeListener(CustomSelectionComponent.FieldTypeChangeListener listener)

Removes an ChangeListenerfrom the Widget.

Parameters:

listener - the ChangeListenerto remove.

removeFieldTypeChangeListeners

public void removeFieldTypeChangeListeners()

Removes all changeListeners from the Widget.

hasFieldTypeChangeListeners

public boolean hasFieldTypeChangeListeners()

Returns true if the list has a change listener, false otherwise.

Returns:

true if the list has a change listener, false otherwise.

getKeyLabel

public String getKeyLabel(String key)

initAdditionalParameters

protected void initAdditionalParameters()

Specified by:

initAdditionalParameters in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

getFieldValue

protected Object getFieldValue()

getFieldComponentClassName

protected String getFieldComponentClassName(String type)

loadParameters

protected void loadParameters(Element element)

updateControl

public void updateControl()

Description copied from interface: IFieldComponent

Update widget

updateValue

public void updateValue()

la valeur sauvegardé peut être : - custom => String - property => IProperty - selector => Objet du sélecteur

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

render

public IWritable render()
                 throws RenderException

Description copied from interface: IWidget

Render the widget

Specified by:

render in interface IWidget

Specified by:

render in class com.axemble.vdp.ui.framework.foundation.Widget

Returns:

writableWidget

Throws:

RenderException

setFieldComponentParameter

protected void setFieldComponentParameter(String key,
                                          Object value,
                                          String selectedType)

setErrorInfo

public void setErrorInfo(String errorMessage)

Overrides:

setErrorInfo in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

setDescription

public void setDescription(String description)

Overrides:

setDescription in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

getDescription

public String getDescription()

Overrides:

getDescription in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

isDescription

public boolean isDescription()

Overrides:

isDescription in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

getJavascriptId

public String getJavascriptId()

Overrides:

getJavascriptId in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

getValidationObject

public Object getValidationObject()

Specified by:

getValidationObject in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

inform

public void inform(String errorMessage)

Description copied from interface: IFieldComponent

Add error message

Specified by:

inform in interface IFieldComponent

Specified by:

inform in interface com.axemble.vdp.form.classes.IBaseComponentSupport

Specified by:

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

Overrides:

inform in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

createOptionList

protected Collection<com.axemble.vdp.ui.framework.widgets.list.Option> createOptionList(Map<Object,Object> list)

addParameter

public void addParameter(String key,
                         Object value)

Valorise les paramètres des champs

Overrides:

addParameter in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseComponent

Parameters:

key - nom du paramètre du type TypedeChamp-NomParamètre (voir CustomSelectionComponent.FieldTypeKeys)

value - valeur du paramètre

See Also:

CustomSelectionComponent.FieldTypeKeys

addParameter

public void addParameter(String type,
                         String key,
                         Object value)

Valorise les paramètres des champs

Parameters:

type - type du champ à valoriser (voir CustomSelectionComponent.FieldTypeKeys)

key - nom du paramètre

value - valeur du paramètre

See Also:

CustomSelectionComponent.FieldTypeKeys

getAvailableOptions

public Collection<String> getAvailableOptions()

Returns:

la liste des champs définis.

getSelectedOption

public String getSelectedOption(Object value)

Retourne l'option de la combo sélectionnée en fonction de la valeur du composant

Parameters:

value -

Returns:

getSelectedOption

public String getSelectedOption()

Returns:

l'option sélectionnée.

setList

public void setList(Map<Object,Object> list)

Valorise la liste des options de la liste déroulante

Parameters:

list -

getCustomOptionValue

public String getCustomOptionValue()