Framework JavaScript ACube V2.10.0
 

Classe ComposantForm

Object
   |
   +--DefaultHtmlForm,DefaultElementForm
         |
         +--ComposantForm
Les Sous-Classes directes:
ComposantAssistant, ComposantRecherche, ComposantConnexion

class ComposantForm
extends DefaultHtmlForm,DefaultElementForm


La classe «ComposantForm» et le modèle de page Formulaire/Fiche :

> Le composant «composantForm» est associé au modèle de page Formulaire/Fiche. Ce composant représente un formulaire (balise HTML <form>). Il gère les propriétés du formulaire et il sert de conteneur pour tous les éléments deformulaires, rangés dans sa table «this.tabElement».
Il revient au développeur d'agencer le formulaire à sa guise (tableau, groupement, etc...) et de disposer les balises <div> ou <span> prêtes à accueillir les éléments de formulaires. Parallèlement, les éléments de formulaire que l'on souhaite utiliser, devront être instanciés et ajoutés au «ComposantForm».
> Le modèle de page «formulaire.html» est à utiliser pour afficher un formulaire ou une fiche. Il représente le cadre d'affichage des champs de formulaires. C'est aussi ce modèle de page qui met en oeuvre le regroupement d'informations dans une zone colorée (les groupes).

Cette classe reprend toutes les propriétés publiques et méthodes  publiques et privées héritées.
Ses propriétés publiques décrivent les attributs du composant et peuvent être manipulées ou interrogées en dehors de la bibliothèque du framework ergonomique. Ses propriétés privées sont utilisées au sein même du framework ergonomique.

«ComposantForm» hérite de «DefaultHtmlForm» et «DefaultElementForm». Il rassemble les différents éléments de type «DefaultElementForm» (champs, boutons ' ) ajoutés par le développeur.






Pas de paramétrage XML pour ce composant. Le paramétrage s'effectue au niveau inférieur puisque tous les éléments contenus par ce composant peuvent être liés à un flux XML.

RENDU IHM

exComposantForm

Fonctions globales utilisables : Lors de l'utilisation de la classe «ComposantForm», le développeur peut être amener à utiliser la fonction globale «enterEgalValider()» décrite dans la page Fonctions_Globales.enterEgalValider().

Date: 25/10/2005

Version: 1.1

Definie dans ergonomique/fw_formulaire_composant.js


Sommaire des Attributs
<private>  String argc
          L'élément «argc» dans la classe ComposantForm n'est pas une propriété, il permet de récupérer le nombre d'arguments passés en paramètres du constructeur de la classe (utile dans le cas des paramètres facultatifs, pour compter les paramètres soumis par le développeur).
<private>  String argv
          L'élément «argv» dans la classe ComposantForm n'est pas une propriété, il permet de récupérer dans un tableau les arguments passés en paramètres du constructeur de la classe (utile dans le cas des paramètres facultatifs, pour repérer les paramètres qui ont été soumis par le développeur).
<private>  boolean boolDisableAllAction
          La propriété privée «boolDisableAllAction» est le booléen qui indique la désactivation ou non des actions : boutons et liens.
<private>  String divHiddenBind
          La propriété privée «divHiddenBind» est l'id HTML du tag <div> susceptible d'accueillir des champs cachés générés par les éléments du formulaire.
 Array_String donneeElement
          La propriété privée «donneeElement» indique le nom XML associé à un enregistrement (tag extrait depuis le paramétrage XML, et décrit dans le contenu informatif).
<private>  string donneeListe
          La propriété privée «donneeListe» indique le nom XML associé à la liste des enregistrements (tag extrait depuis le paramétrage XML, et décrit dans le contenu informatif).
 Array_DefaultElementForm tabElement
          La propriété publique «tabElement» est un tableau d'éléments de type «DefaultElementForm» qui contient tous les éléments du formulaire ajoutés par le développeur.
 Array_ObjectOption tabOptionElement
          La propriété publique «tabOptionElement» est un tableau d'ObjectOption de type «ObjectOption» qui contient les options nécessaires à la création d'un nouvel élément de formulaire.
 boolean validationEnCours
          La propriété publique «validationEnCours» est un booléen qui indique si la validation du formulaire est en cours.
 XMLObject XMLData
          La propriété publique «XMLData» représente les données XML associées au composant Formulaire.
<private>  XMLObjectSauvegarde XMLExport
          La propriété privée «XMLExport» représente les données XML associées au composant Formulaire tel qu'affiché.
<private>  XMLObjectSauvegarde XMLObjectInfos
          La propriété privée «XMLObjectInfos» est un objet de type XMLObjectSauvegarde qui contient le flux XML des paramètres du formulaire.
   
Attributs hérités de la classeDefaultHtmlForm
action, enctype, method
   
Attributs hérités de la classeDefaultElementForm
readonly, disabled, id, value, statut, reference, onChange, check, onblur, formParent, ongletParent, zoneData, urlAide, altAide, lienAide, urlAssist, altAssist, bulleInfo, posBulleInfo, displayStyle, emptyDisplayStyle, onMouseOut, onMouseOver, onMouseMove, onMouseMoveBoutonAide, divBind, onfocus
   
Attributs hérités de la classeDefaultHtml
id, style, title, name, tabindex
 
Sommaire des Constructeurs
ComposantForm (<String_Obligatoire> id, <String_Facultatif> action, <String_Facultatif> method, <String_Facultatif> enctype)
            Crée une nouvelle instance du composant ComposantForm.
 
Sommaire des Méthodes
 void addElement(<String_Obligatoire> newElement)
           La méthode publique «addElement(newElement)» est utilisée à chaque fois que l'on souhaite ajouter un nouvel élément au formulaire.

Voir Exemple : Exemples d'appels aux méthodes publiques.
 void agir()
           La méthode publique «agir()» réalise l'action d'un ElementFormButtonLibre.
 void annuler()
           La méthode publique «annuler()» est la méthode d'annulation du formulaire, associée à l'élément «ElementFormButtonAnnuler».
 boolean controlerSurface()
           La méthode publique «controlerSurface()» est à implémenter par l'utilisateur du framework; renvoie «true» ou «false» suivant que le contrôle a réussi ou échoué.
 <private>  void creerComposantCalendrier(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerComposantCalendrier(XMLFormulaireElt)» est la méthode de création automatique d'un ComposantCalendrier dans un formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant au calendrier et crée le ComposantCalendrier à partir des données récupérées.
 <private>  void creerElementFormButtonAnnuler(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormButtonAnnuler(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormButtonAnnuler de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant au bouton d'annulation et crée l' ElementFormButtonAnnuler à partir des données récupérées.
 <private>  void creerElementFormButtonLibre(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormButtonLibre(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormButtonLibre de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant au bouton libre et crée l' ElementFormButtonLibre à partir des données récupérées.
 <private>  void creerElementFormButtonValider(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormButtonValider(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormButtonValider de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant au bouton de validation et crée l' ElementFormButtonValider à partir des données récupérées.
 <private>  void creerElementFormCheckbox(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormCheckbox(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormCheckbox de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant à la case à cocher et crée l' ElementFormCheckbox à partir des données récupérées.
 <private>  void creerElementFormFile(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormFile(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormFile de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant à la sélection de fichier et crée l' ElementFormFile à partir des données récupérées.
 <private>  void creerElementFormHidden(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormHidden(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormHidden de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant au champ caché et crée l' ElementFormHidden à partir des données récupérées.
 <private>  void creerElementFormPass(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormPass(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormPass de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant à la zone de saisie de mot de passe et crée l' ElementFormPass à partir des données récupérées.
 <private>  void creerElementFormRadio(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormRadio(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormRadio de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant aux boutons radio et crée l' ElementFormRadio à partir des données récupérées.
 <private>  void creerElementFormSelect(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormSelect(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormSelect de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant à la boite de selection et crée l' ElementFormSelect à partir des données récupérées.
 <private>  void creerElementFormSelectMaster(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormSelectMaster(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormSelectMaster de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant à la boite de selection et crée l' ElementFormSelectMaster à partir des données récupérées.
 <private>  void creerElementFormText(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormText(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormText de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant à la zone de texte et crée l' ElementFormText à partir des données récupérées.
 <private>  void creerElementFormTextarea(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerElementFormTextarea(XMLFormulaireElt)» est la méthode de création automatique d'un ElementFormTextarea de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant à la zone de texte et crée l' ElementFormTextarea à partir des données récupérées.
 <private>  void creerFilterComponent(<Element_Obligatoire> XMLFormulaireElt)
           La méthode privée «creerFilterComponent(XMLFormulaireElt)» est la méthode de création automatique d'un FilterComponent de formulaire.
Cette méthode parcourt la partie du fichier XML de formulaire correspondant au composant filtre et crée le FilterComponent à partir des données récupérées.
 <private>  Array creerOption(<Element_Obligatoire> XMLOptions)
           La méthode privée «creerOption(XMLOptions)» est la méthode de création automatique d'une ObjectOption pour un élément de formulaire complexe (selectbox ou radiobutton).
Elle crée les ObjectOption à partir des données récupérées, les ajoute dans la tableau tabOptionElement du formulaire.
 void disableAllAction()
           La méthode publique «disableAllAction()» permet de désactiver les boutons et les liens.
 void ecrireBind()
           La méthode publique «ecrireBind()» est la méthode globale de génération HTML du formulaire et de tous ses éléments.
 void ecrireHiddenBind()
           La méthode publique «ecrireHiddenBind()», ne fait que positionner les éventuels champs cachés générés dans un emplacement <div> prévu à cet effet, identifié par l'attribut laquo; divHiddenBind».
 string ecrireHiddenHtml()
           La méthode publique «ecrireHiddenHtml()», dans le cas d'un 'composantForm', est  la méthode qui se charge d'appeler 'ecrireHiddenHtml' pour chacun de ses éléments qui l'implémente (éléments tels le 'composantRattachement' susceptibles de générer des champs cachés dynamiquement en vue de la soumission du formulaire ),  puis de renvoyer le code HTML regroupant tous les champs cachés générés.
 string ecrireHtml()
           La méthode publique «ecrireHtml()» est la méthode globale de génération de code HTML pour le formulaire et tous ses éléments.
 void executerActionRedirection(<Obligatoire_String> url, <Facultatif_Array> parametres)
           Fonction permettant de lancer une action serveur en POST et de rediriger vers une page.
 void exportXML()
           La méthode publique «exportXML()» déclenche la génération du flux XML correspondant au contenu du formulaire tel que présenté, dans l'attribut XMLExport du composant.
 Object extend_DefaultElementForm(<String_Facultatif> id, <String_Facultative> value, <ObjectOption_Facultatif> tabOption, <int_Facultatif> statut)
           Crée une instance de la classe «DefaultElementForm».
 Object extend_DefaultHtmlForm(<String_Facultatif> id, <String_Facultatif> method, <String_Facultatif> action, <String_Facultatif> enctype)
           Crée une instance de la classe «DefaultHtmlForm».
 string getAction()
           La méthode publique «getAction()» retourne la propriété action (attribut html du tag <form> indiquant l'url de soumission du formulaire).
 DefaultElementForm getDefaultElementById(<String_Obligatoire> id)
           La méthode publique «getDefaultElementById(id)» cherche l'élément «id» dans la liste des éléments du formulaire et le renvoie.
 Object getTarget()
          
 XMLData getXMLData()
           La méthode publique «getXMLData()» retourne la propriété XMLData qui contient les données de formulaire.
 XMLObjectInfos getXMLObjectInfos()
           La méthode publique «getXMLObjectInfos()» retourne la propriété XMLObjectInfos qui contient les paramètres du formulaire.
 void importData()
           La méthode publique «importXML()» déclenche l'appel de demande de rapatriement du flux XML lié au contenu informatif du formulaire afin de l'afficher.
 void initXMLData(URLData, divAttente)
           La méthode publique «initXMLData()» initialise la propriété XMLData qui contient les données de formulaire.
 <private>  void instancierDataElt(<Element_Obligatoire> XMLFormulaireEltChild)
           La méthode privée «instancierDataElt(XMLFormulaireEltChild)» est la méthode de gestion du contenu de la balise DATA dans les formulaires de paramètres et de données lors de la génération automatique de formulaires.
Elle repère le noeud à gérer, et exécute les fonctions nécessaires selon son contenu :
- Si l'element contient des options, elle appelle directement la fonction creerOption qui met à jour l'attribut tabOptionElement de l'ElementForm.
 <private>  void instancierXmlData(<Element_Obligatoire> XMLFormulaireEltChild)
           La méthode privée «instancierXmlData(XMLFormulaireEltChild)» est la méthode de gestion du contenu de la balise DATA dans les formulaires de paramètres et de données lors de la génération automatique de formulaires.
 ComposantForm retourImportData()
           La méthode publique «retourImportData()» est la méthode de création des éléments du formulaire automatique, depuis un fichier XML répondant à la DTD DTD.formulaireDonnees.dtd.
Cette méthode parcourt les fichiers XML de paramètres et de données, repère les différents éléments renseignés et appelle les fonctions associées à chacun de ces éléments.
 void setAction(<String_Obligatoire> act)
           La méthode publique «setAction(act)» permet de valoriser la propriété action.
 void setDivHiddenBind(<String_Obligatoire> newDivHiddenBind)
           La méthode publique «setDivHiddenBind(newDivHiddenBind)» permet de valoriser la propriété divHiddenBind.
 void setMethod(<String_Obligatoire> newMethod)
           La méthode publique «setMethod(newMethod)» permet de valoriser la propriété method.
 void setTarget(target)
          
 void setXMLData(XMLData)
           La méthode publique «setXMLData()» modifie la propriété XMLData qui contient les données de formulaire.
 void setXMLObjectInfos(XMLObjectInfos)
           La méthode publique «setXMLObjectInfos()» modifie la propriété XMLObjectInfos qui contient les paramètres du formulaire.
 void soumettre()
           La méthode publique «soumettre()» réalise la soumission du formulaire.
 void valider()
           La méthode publique «valider()» est la méthode globale de validation du formulaire.
Elle se charge de lancer successivement :
·  controlerSurface()
·  disableAllAction()
·  soumettre()
C'est cette méthode qui est associée à l'élément «ElementFormButtonValider»
 
Méthodes héritées de la classe DefaultHtmlForm
extend_DefaultHtml
   
Méthodes héritées de la classe DefaultElementForm
newId, formatValue, setFormatValue, setAltAide, geturlAide, seturlAide, setAltAssist, geturlAssist, seturlAssist, getOngletParent, setOngletParent, getZoneData, setZoneData, getDomHtmlElement, getValue, setValue, getTabOption, setTabOption, setBulleInfo, setDisplayStyle, getDisplayStyle, setEmptyDisplayStyle, getEmptyDisplayStyle, getDivBind, setDivBind, ouvrirAide, ouvrirAssistant, ecrireAideHtml, setPositionBulleInfo, ecrireAssistHtml, ecrireBind, ecrireHtml, setStatut, setOnChange, setOnblur, setOnfocus, initReference, addOption, changeOption, removeOption, ecrireCellHtml
   
Méthodes héritées de la classe DefaultHtml
newId, setTitle, getTitle, getId, setStyle, getStyle
 

Détail des Attributs

argc

<private> String argc

argv

<private> String argv

boolDisableAllAction

<private> boolean boolDisableAllAction

divHiddenBind

<private> String divHiddenBind

donneeElement

Array_String donneeElement

donneeListe

<private> string donneeListe

tabElement

Array_DefaultElementForm tabElement

tabOptionElement

Array_ObjectOption tabOptionElement

validationEnCours

boolean validationEnCours

XMLData

XMLObject XMLData

XMLExport

<private> XMLObjectSauvegarde XMLExport

XMLObjectInfos

<private> XMLObjectSauvegarde XMLObjectInfos

Détail des Constructeurs

ComposantForm

ComposantForm(<String_Obligatoire> id, <String_Facultatif> action, <String_Facultatif> method, <String_Facultatif> enctype)

Détail des Méthodes

addElement

void addElement(<String_Obligatoire> newElement)

agir

void agir()

annuler

void annuler()

controlerSurface

boolean controlerSurface()

creerComposantCalendrier

 <private> void creerComposantCalendrier(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormButtonAnnuler

 <private> void creerElementFormButtonAnnuler(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormButtonLibre

 <private> void creerElementFormButtonLibre(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormButtonValider

 <private> void creerElementFormButtonValider(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormCheckbox

 <private> void creerElementFormCheckbox(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormFile

 <private> void creerElementFormFile(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormHidden

 <private> void creerElementFormHidden(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormPass

 <private> void creerElementFormPass(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormRadio

 <private> void creerElementFormRadio(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormSelect

 <private> void creerElementFormSelect(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormSelectMaster

 <private> void creerElementFormSelectMaster(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormText

 <private> void creerElementFormText(<Element_Obligatoire> XMLFormulaireElt)

creerElementFormTextarea

 <private> void creerElementFormTextarea(<Element_Obligatoire> XMLFormulaireElt)

creerFilterComponent

 <private> void creerFilterComponent(<Element_Obligatoire> XMLFormulaireElt)

creerOption

 <private> Array creerOption(<Element_Obligatoire> XMLOptions)

disableAllAction

void disableAllAction()

ecrireBind

void ecrireBind()

ecrireHiddenBind

void ecrireHiddenBind()

ecrireHiddenHtml

string ecrireHiddenHtml()

ecrireHtml

string ecrireHtml()

executerActionRedirection

void executerActionRedirection(<Obligatoire_String> url, <Facultatif_Array> parametres)

exportXML

void exportXML()

extend_DefaultElementForm

Object extend_DefaultElementForm(<String_Facultatif> id, <String_Facultative> value, <ObjectOption_Facultatif> tabOption, <int_Facultatif> statut)

extend_DefaultHtmlForm

Object extend_DefaultHtmlForm(<String_Facultatif> id, <String_Facultatif> method, <String_Facultatif> action, <String_Facultatif> enctype)

getAction

string getAction()

getDefaultElementById

DefaultElementForm getDefaultElementById(<String_Obligatoire> id)

getTarget

Object getTarget()

getXMLData

XMLData getXMLData()

getXMLObjectInfos

XMLObjectInfos getXMLObjectInfos()

importData

void importData()

initXMLData

void initXMLData(URLData, divAttente)

instancierDataElt

 <private> void instancierDataElt(<Element_Obligatoire> XMLFormulaireEltChild)

instancierXmlData

 <private> void instancierXmlData(<Element_Obligatoire> XMLFormulaireEltChild)

retourImportData

ComposantForm retourImportData()

setAction

void setAction(<String_Obligatoire> act)

setDivHiddenBind

void setDivHiddenBind(<String_Obligatoire> newDivHiddenBind)

setMethod

void setMethod(<String_Obligatoire> newMethod)

setTarget

void setTarget(target)

setXMLData

void setXMLData(XMLData)

setXMLObjectInfos

void setXMLObjectInfos(XMLObjectInfos)

soumettre

void soumettre()

valider

void valider()

Framework JavaScript ACube V2.10.0
 

Version 2.10.0, / Etat : Validé
Cette création est mise à disposition selon le Contrat Paternité - Pas d'Utilisation Commerciale - Partage des Conditions Initiales à l'Identique disponible en ligne http://creativecommons.org/licenses/by-nc-sa/2.0/fr/ ou par courrier postal à Creative Commons, 559 Nathan Abbott Way, Stanford,California 94305, USA.


Documentation generated by JSDoc on Wed Jan 6 17:05:02 2010