Package com.axemble.vdoc.sdk.document.fields

Class SelectListCustomInputComponent

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.SelectListCustomInputComponent
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 SelectListCustomInputComponent extends com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseFieldComponent
Usage: (note: default values are in first position) invalid input: '<'field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_TEXT custom-widget-description = "?" - description for custom value textbox description = "?" - description of the control, ex: LG_DESCRIPTION ctrl = "com.axemble.vdoc.sdk.document.fields.SelectListCustomInputComponent" mode = "write" | "read" - set editable or not mandatory = "false" | "true" - set mandatory or not throw-events = "false" | "true" - throw events from the webbrowser when the control change

predictive = "false" | "true" - combobox or autoCompleteList emptyValue = "?" - empty value if component is not predictive allowreset = "false" | "never" | "always" custom-option-label = "?" - translation key for custom value custom-option-value = "?" - key for custom value size = "medium" | "veryshort" | "short" | "long" | "auto" - set the field size force-show-list = "false" | "true" - force to show list even if list is empty /> Field Type: java.lang.String

Author:
bchapoton
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected com.axemble.vdp.ui.framework.widgets.components.sys.forms.AutocompleteListInputComponent
    autoComplete
     
    protected com.axemble.vdp.ui.framework.widgets.components.sys.forms.ComboBoxInputComponent
    combobox
     
    protected String
    customOptionLabel
     
    protected String
    customOptionValue
     
    protected String
    emptyValue
     
    protected boolean
    forceShowList
     
    protected Map<String,String>
    list
     
    protected boolean
    predictive
     
    protected com.axemble.vdp.ui.framework.widgets.components.sys.forms.ResetTypeComponent
    resetType
     
    protected com.axemble.vdp.ui.framework.components.listeners.ChangeListener
    selectChangeListener
     
    protected String
    size
     
    protected com.axemble.vdp.ui.framework.widgets.components.sys.forms.TextInputComponent
    textbox
     
    protected com.axemble.vdp.ui.framework.components.listeners.EventListener
    updateFieldListListener
     
    protected String
    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
    Description
    SelectListCustomInputComponent()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCustomOptionLabel()
     
    String
    getCustomOptionValue()
     
    String
    getEmptyValue()
     
    String
    getJavascriptId()
     
    Map<String,String>
    getList()
     
    com.axemble.vdp.ui.framework.widgets.components.sys.forms.ResetTypeComponent
    getResetType()
     
    String
    getSize()
     
    Object
    getValidationObject()
     
    String
    getValue()
     
    void
    inform(String errorMessage)
    Add error message
    void
    init(com.axemble.vdp.ui.framework.document.fields.IAbstractField field, Element element)
     
    protected void
    initAdditionalParameters()
     
    boolean
    isEmpty()
     
    boolean
    isForceShowList()
     
    boolean
    isPredictive()
     
    IWritable
    render()
    Render the widget
    void
    setCustomOptionLabel(String customOptionLabel)
     
    void
    setCustomOptionValue(String customOptionValue)
     
    void
    setCustomWidgetDescription(String description)
     
    void
    setDescription(String description)
     
    void
    setEmptyValue(String emptyValue)
     
    void
    setForceShowList(boolean forceShowList)
     
    void
    setList(List<String> list)
     
    void
    setList(Map<String,String> list)
     
    void
    setListOption(List<com.axemble.vdp.ui.framework.widgets.list.Option> list)
     
    void
    setPredictive(boolean predictive)
     
    void
    setResetType(com.axemble.vdp.ui.framework.widgets.components.sys.forms.ResetTypeComponent resetType)
     
    void
    setSize(String size)
     
    void
    setValue(String value)
     
    void
    updateControl()
    Update widget
    void
    updateValue()
    Update field value
    boolean
    validate(boolean checkMandatory)
    Validate the field

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

    addCssDependency, addScriptDependency, getAbstractField, getField, getFieldChangeListener, getTemplateWriter, 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, getDescription, 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, isDescription, isDocumentChangedScript, isEditable, isFocus, isForceParentId, isIncludeErrorInfo, isMandatory, isThrowDocumentChangedScript, isThrowEvents, isThrowEventsDefined, registerWidget, renderErrorInfo, renderInfoMessage, renderQuickCreate, setAccesskey, setAssociatedLabel, setCondition, setEditable, setErrorInfo, setFormula, setFormulaCondition, setIncludeErrorInfo, setJavascriptId, setMandatory, setModeFormula, setProperty, setPropertytype, setQuickCreateContextParameter, setQuickCreateScreen, setRequiredFormula, setTabindex, setTemporarypropertyname, setThrowDocumentChangedScript, setThrowEvents, setThrowEventsDefined, setValidationRules

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

    addParameter, 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.form.classes.IBaseComponentSupport

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

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

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

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

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

    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

  • Field Details

    • predictive

      protected boolean predictive

    • list

      protected Map<String,String> list

    • customOptionValue

      protected String customOptionValue

    • customOptionLabel

      protected String customOptionLabel

    • value

      protected String value

    • size

      protected String size

    • resetType

      protected com.axemble.vdp.ui.framework.widgets.components.sys.forms.ResetTypeComponent resetType

    • emptyValue

      protected String emptyValue

    • combobox

      protected com.axemble.vdp.ui.framework.widgets.components.sys.forms.ComboBoxInputComponent combobox

    • autoComplete

      protected com.axemble.vdp.ui.framework.widgets.components.sys.forms.AutocompleteListInputComponent autoComplete

    • textbox

      protected com.axemble.vdp.ui.framework.widgets.components.sys.forms.TextInputComponent textbox

    • forceShowList

      protected boolean forceShowList

    • selectChangeListener

      protected com.axemble.vdp.ui.framework.components.listeners.ChangeListener selectChangeListener

    • updateFieldListListener

      protected com.axemble.vdp.ui.framework.components.listeners.EventListener updateFieldListListener

  • Constructor Details

    • SelectListCustomInputComponent

      public SelectListCustomInputComponent()

  • Method Details

    • init

      public void init(com.axemble.vdp.ui.framework.document.fields.IAbstractField field, Element element)
      Specified by:
      init in interface com.axemble.vdp.ui.core.document.fields.IFieldControl
      Overrides:
      init in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseFieldComponent

    • updateValue

      public void updateValue()
      Description copied from interface: IFieldComponent
      Update field value

    • updateControl

      public void updateControl()
      Description copied from interface: IFieldComponent
      Update widget

    • initAdditionalParameters

      protected void initAdditionalParameters()
      Specified by:
      initAdditionalParameters in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty 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

    • 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

    • getJavascriptId

      public String getJavascriptId()
      Overrides:
      getJavascriptId 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

    • setCustomWidgetDescription

      public void setCustomWidgetDescription(String description)

    • validate

      public boolean validate(boolean checkMandatory)
      Description copied from interface: IFieldComponent
      Validate the field
      Specified by:
      validate in interface IFieldComponent
      Specified by:
      validate in interface com.axemble.vdp.ui.core.document.fields.IFieldControl
      Overrides:
      validate in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent
      Parameters:
      checkMandatory -
      Returns:
      isValid

    • isPredictive

      public boolean isPredictive()

    • setPredictive

      public void setPredictive(boolean predictive)

    • getList

      public Map<String,String> getList()

    • setList

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

    • setList

      public void setList(List<String> list)

    • setListOption

      public void setListOption(List<com.axemble.vdp.ui.framework.widgets.list.Option> list)

    • getCustomOptionLabel

      public String getCustomOptionLabel()

    • setCustomOptionLabel

      public void setCustomOptionLabel(String customOptionLabel)

    • getValue

      public String getValue()

    • setValue

      public void setValue(String value)

    • getCustomOptionValue

      public String getCustomOptionValue()

    • setCustomOptionValue

      public void setCustomOptionValue(String customOptionValue)

    • getResetType

      public com.axemble.vdp.ui.framework.widgets.components.sys.forms.ResetTypeComponent getResetType()
      Returns:
      the resetType

    • setResetType

      public void setResetType(com.axemble.vdp.ui.framework.widgets.components.sys.forms.ResetTypeComponent resetType)
      Parameters:
      resetType - the resetType to set

    • inform

      public void inform(String errorMessage)
      Description copied from interface: IFieldComponent
      Add error message
      Specified by:
      inform in interface com.axemble.vdp.form.classes.IBaseComponentSupport
      Specified by:
      inform in interface IFieldComponent
      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
      Parameters:
      errorMessage -

    • getEmptyValue

      public String getEmptyValue()

    • setEmptyValue

      public void setEmptyValue(String emptyValue)

    • getSize

      public String getSize()

    • setSize

      public void setSize(String size)

    • isForceShowList

      public boolean isForceShowList()

    • setForceShowList

      public void setForceShowList(boolean forceShowList)