Package 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:

  • Field Details Link icon

  • Constructor Details Link icon

    • CustomSelectionComponent Link icon

      public CustomSelectionComponent()

  • Method Details Link icon

    • addFieldTypeChangeListener Link icon

      public void addFieldTypeChangeListener(CustomSelectionComponent.FieldTypeChangeListener listener)
      Add a new listener
      Parameters:
      listener -

    • removeFieldTypeChangeListener Link icon

      public com.axemble.vdp.ui.framework.components.listeners.ChangeListener removeFieldTypeChangeListener(CustomSelectionComponent.FieldTypeChangeListener listener)
      Removes an ChangeListenerfrom the Widget.
      Parameters:
      listener - the ChangeListenerto remove.

    • removeFieldTypeChangeListeners Link icon

      public void removeFieldTypeChangeListeners()
      Removes all changeListeners from the Widget.

    • hasFieldTypeChangeListeners Link icon

      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 Link icon

      public String getKeyLabel(String key)

    • initAdditionalParameters Link icon

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

    • getFieldValue Link icon

      protected Object getFieldValue()

    • getFieldComponentClassName Link icon

      protected String getFieldComponentClassName(String type)

    • loadParameters Link icon

      protected void loadParameters(Element element)

    • updateControl Link icon

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

    • updateValue Link icon

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

    • isEmpty Link icon

      public boolean isEmpty()
      Specified by:
      isEmpty in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

    • render Link icon

      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 Link icon

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

    • setErrorInfo Link icon

      public void setErrorInfo(String errorMessage)
      Overrides:
      setErrorInfo in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

    • setDescription Link icon

      public void setDescription(String description)
      Overrides:
      setDescription in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

    • getDescription Link icon

      public String getDescription()
      Overrides:
      getDescription in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

    • isDescription Link icon

      public boolean isDescription()
      Overrides:
      isDescription in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

    • getJavascriptId Link icon

      public String getJavascriptId()
      Overrides:
      getJavascriptId in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

    • getValidationObject Link icon

      public Object getValidationObject()
      Specified by:
      getValidationObject in class com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent

    • inform Link icon

      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 -

    • createOptionList Link icon

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

    • addParameter Link icon

      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:

    • addParameter Link icon

      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:

    • getAvailableOptions Link icon

      public Collection<String> getAvailableOptions()
      Returns:
      la liste des champs définis.

    • getSelectedOption Link icon

      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 Link icon

      public String getSelectedOption()
      Returns:
      l'option sélectionnée.

    • setList Link icon

      public void setList(Map<Object,Object> list)
      Valorise la liste des options de la liste déroulante
      Parameters:
      list -

    • getCustomOptionValue Link icon

      public String getCustomOptionValue()