Classe XMLObject
Object
|
+--XMLObject
- class
XMLObject
La classe «XMLObject» est la classe permettant de gérer un flux XML dans un DOM à partir d'une URL ou d'un emplacement sur disque.
Les deux propriétés publiques divBind et xmlDoc peuvent être utilisées par le développeur métier utilisant ce framework technique.
Les propriétés privées frameIdBind, divIdbind, cookieNameXML, cookiePathXML,
cookieDomainXML, cookieSecureXML, urlXML, divBindMessage, loadingMessage,
boolLoadingMessage, ecrireXMLtoHTML sont utilisées au sein même du framework XML.

Explications sur le mécanisme de communication mis en oeuvre via l'objet XMLObject.
Date: 04/09/2007
Version: 2.6
Definie dans technique/fw_xml.js
Sommaire des Attributs |
<private> boolean |
boolLoadingMessage
Propriété privée «boolLoadingMessage» : Booléen indiquant l'affichage d'un message d'attente lors du rapatriement du flux XML. |
<private> String |
contentType
Propriété privée «contentType» : content-type de la réponse du flux rapatrié. |
<private> String |
cookieDomainXML
Propriété privée «cookieDomainXML» : Attribut domain du cookie client sur disque utile pour sauvegarder le flux XML dans un cookie. |
<private> String |
cookieMultiXML
Propriété privée «cookieMultiXML» : booléen indiquant si le cookie peut être multiple. |
<private> String |
cookieNameXML
Propriété privée «cookieNameXML» : Attribut nom du cookie client sur disque utile pour sauvegarder le flux XML dans un cookie. |
<private> String |
cookiePathXML
Propriété privée «cookiePathXML» : Attribut path du cookie client sur disque utile pour sauvegarder le flux XML dans un cookie. |
<private> boolean |
cookieSecureXML
Propriété privée «cookieSecureXML» : Attribut secure du cookie client sur disque utile pour sauvegarder le flux XML dans un cookie. |
<private> boolean |
delaiUP
Propriété privée «delaiUP» : Booléen indiquant su le délai d'attente de la réponse duserveur est atteint. |
String |
divBind
La propriété publique «divBind» reflète la zone dynamique associée au flux XML utile pour générer un contenu HTML représentatif au cas d'utilisation métier. |
<private> String |
divBindMessage
La propriété privée «divBindMessage» : Zone dynamique associée à l'affichage du message d'attente lors du rapatriement du flux XML. |
<private> String |
divIdBind
La propriété privée «divIdIdBind» est l'ID (sous forme de chaîne de caractères) de la zone dynamique associée au flux XML. |
<private> String |
ecrireXMLtoHTML
Propriété privée «ecrireXMLtoHTML» : contient le nom de la fonction appelée lorsque le rapatriement du flux XML est terminé. |
<private> String |
frameIdBind
La propriété privée «frameIdBind» est l'ID (sous forme de chaîne de caractères) de la frame d'emplacement de la zone dynamique associée au flux XML. |
<private> String |
loadingClasse
Propriété privée «loadingClasse» : Propriété spécifiant la classe pour la mise en forme du texte du message d'attente affiché lors du rapatriement du flux XML. |
<private> String |
loadingImage
Propriété privée «loadingImage» : Propriété spécifiant l'image d'attente affichée lors du rapatriement du flux XML. |
<private> String |
loadingMessage
Propriété privée «loadingMessage» : Propriété spécifiant le texte du message d'attente affiché lors du rapatriement du flux XML. |
<private> boolean |
reqDO
Propriété privée «reqDO» : Booléen indiquant si le flux a été recu est l'action déclenchée. |
<private> boolean |
requestBoolAsynchrone
Propriété privée «requestBoolAsynchrone» : Synchronisme de la requête de rapatriement de flux XML. |
<private> String |
requestData
Propriété privée «requestData» : Données envoyées lors de la requête de rapatriement de flux XML. |
<private> String |
requestMethode
Propriété privée «requestMethode» : Méthode de la requête de rapatriement de flux XML. |
<private> Integer |
status
Propriété privée «status» : status de la réponse du flux XML (égal à 200 quand pas de problème). |
<private> String |
statusText
Propriété privée «statusText» : texte du status explicitant une erreur survenant lors du rapatriement du flux XML (status différent de 200). |
<private> String |
urlXML
Propriété privée «urlXML» : URL d'appel du flux XML. |
* XMLObject |
xmlDoc
La propriété publique «xmlDoc» est un pointeur sur l'objet DOM en mémoire associé au flux XML. |
* String |
xmlDocText
La propriété publique «xmlDocText» est chaîne de caractères contenant l'ensemble des informations contenues dans l'objet DOM. |
* XMLHTTPRequest |
xmlReq
La propriété publique «xmlReq» est un pointeur sur l'objet Request permettant de rapatrier le flux XML. |
Sommaire des Constructeurs |
XMLObject
(<String_Facultatif> frameIdBind, <String_Obligatoire> divId, <String_Obligatoire> ecrireXMLtoHTML, <String_Obligatoire> urlXML, <boolean_Obligatoire> boolLoadingMessage)
Le constructeur retourne une instance de la classe «XMLObject» utile pour appeler soit les méthodes publiques associées à cette dernière soit pour interroger ses propriétés
publiques.
|
Sommaire des Méthodes |
void
|
debugXML()
La méthode publique «debugXML()» est destinée aux développeurs pour afficher dans une boîte d'alerte le contenu du flux XML associé à un objet XMLObject dans un but de debogage.
|
void
|
deleteCookieXML()
La méthode publique «deleteCookieXML()» permet de détruire le cookie de sauvegarde du DOM XML présent dans l'objet XMLObject.
|
<private> void
|
endPrintLoadingMessage()
La méthode privée «printLoadingMessage()» est la méthode interne utilisée pour effacer le message défilant d'attente du rapatriement du
flux XML.
|
void
|
importXML()
La méthode publique «importXML()» déclenche le rapatriement d'un flux XML (à partir d'une URL) et appelle la méthode «ecrireXMLtoHTML»
configurée par le constructeur de l'objet lors de son initialisation.
|
void
|
initAsynchrone(<boolean_Obligatoire> boolAsynchrone)
La méthode publique «initAsynchrone()» permet d'initialiser le synchronisme de la requête de rappatriement de flux XML
effectuée par la méthode «importXML» en renseignant l'attribut requestBoolAsynchrone.
|
void
|
initCookieXML(<String_Obligatoire> cookieNameXML)
La méthode publique «initCookieXML(cookieNameXML)» permet d'initialiser les attributs du futur cookie de sauvegarde du flux XML en précisant son nom et les
autres attributs optionnels losque l'on souhaite s'affranchir des attributs par défaut listés dans le tableau du résumé de
fw_cookies.js.
|
<private> void
|
initDivBindXML()
La méthode privée «initDivBindXML()» permet de spécifier avec les éléments fournis dans le
constructeur («frameIdBind» et «divId») un pointeur vers le DOM HTML de la zone dynamique gérant la
présentation du contenu dynamique correspondant au flux XML.
|
number
|
initLoadingMessage(<int_Obligatoire> colspan)
La méthode publique «initLoadingMessage(colspan)» a pour but d'initialiser le message d'attente à afficher dans la zone dynamique propre à la
génération HTML reflétant le contenu du flux XML.
|
void
|
initRequestData(<String_Obligatoire> methode,<String_Optionnel> data)
La méthode publique «initRequestData()» permet d'initialiser la requête de rapatriement de flux XML
effectuée par la méthode «importXML» en renseignant les attributs requestMethode et requestData.
|
void
|
initRequestParams(<String_Obligatoire> methode,<Object_Facultatif> params)
La méthode publique «initRequestParams()» permet d'initialiser la requête de rapatriement de flux XML
effectuée par la méthode «importXML» en renseignant les attributs requestMethode et requestData.
|
void
|
initXML()
Le framework technique fw_xml.js propose la fonction
«XMLObjectCookie_initXML()»; Elle permet d'initialiser le document XML contenu dans l'attribut xmlDoc à vide.
|
number
|
parseErrorXML(<String_Optionnel> type)
La méthode publique «parseErrorXML(type)» permet d'analyser le flux XML renvoyé pour vérifier la présence ou non d'une erreur :
la détection de la présence d'une erreur s'effectue de la manière suivante.
|
<private> void
|
printLoadingMessage()
La méthode privée «printLoadingMessage()» est la méthode interne utilisée pour afficher le message défilant d'attente du rapatriement du
flux XML.
|
void
|
saveCookieXML()
La méthode publique «saveCookieXML()» permet de sérialiser le DOM XML présent dans l'objet XMLObject en chaîne de caractères et de
sauvegarder cette sérialisation dans un cookie client sur disque et cela pour une durée d'expiration de 10 ans.
|
void
|
saveLocalXML(<String_Obligatoire> path)
La méthode publique «saveLocalXML(path)» offre la possibilité de sauvegarder le flux XML présent dans le DOM de l'objet XMLObject dans un fichier
placé sur disque.
|
void
|
setDivBindMessage(<String_Obligatoire> divIdBindMessage)
La méthode publique «setDivBindMessage(divIdBindMessage)» a pour but d'initialiser la zone dynamique ou sera généré le code
HTML du message d'attente.
|
void
|
setLoadingMessage(<String_Obligatoire> loadingMessage)
La méthode publique «XMLObject_setLoadingMessage(libelleLoadingMessage)» a pour but d'initialiser les informations sur le contenu du message d'attente.
|
<private> void
|
testStateChange()
La méthode privée «testStateChange()» est à usage interne du framework.
|
boolLoadingMessage
<private> boolean boolLoadingMessage
Propriété privée «boolLoadingMessage» : Booléen indiquant l'affichage d'un message d'attente lors du rapatriement du flux XML. Cette propriété est initialisée
lors de la construction de l'objet.
contentType
<private> String contentType
Propriété privée «contentType» : content-type de la réponse du flux rapatrié. Cette propriété est initialisée lors du chargement du flux XML par la méthode send pour être utilisée lors du traitement des erreurs sur une session non valide.
cookieDomainXML
<private> String cookieDomainXML
Propriété privée «cookieDomainXML» : Attribut domain du cookie client sur disque utile pour sauvegarder le flux XML dans un cookie. Cette propriété peut être
initialisée par le biais de la méthode publique «initCookieXML».
cookieMultiXML
<private> String cookieMultiXML
Propriété privée «cookieMultiXML» : booléen indiquant si le cookie peut être multiple. Cette propriété permet de suvegarder
des flux xml de gros volumes en créant physiquement plusieurs cookues, elle n'est active que pour la classe XMLObjectCookie
cookieNameXML
<private> String cookieNameXML
Propriété privée «cookieNameXML» : Attribut nom du cookie client sur disque utile pour sauvegarder le flux XML dans un cookie. Cette propriété peut être
initialisée par le biais de la méthode publique «initCookieXML».
cookiePathXML
<private> String cookiePathXML
Propriété privée «cookiePathXML» : Attribut path du cookie client sur disque utile pour sauvegarder le flux XML dans un cookie. Cette propriété peut être
initialisée par le biais de la méthode publique «initCookieXML».
cookieSecureXML
<private> boolean cookieSecureXML
Propriété privée «cookieSecureXML» : Attribut secure du cookie client sur disque utile pour sauvegarder le flux XML dans un cookie. Cette propriété peut être
initialisée par le biais de la méthode publique «initCookieXML».
- Valeur par défaut : Valeurs par défaut des Propriétés
delaiUP
<private> boolean delaiUP
Propriété privée «delaiUP» : Booléen indiquant su le délai d'attente de la réponse duserveur est atteint.
divBind
String divBind
La propriété publique «divBind» reflète la zone dynamique associée au flux XML utile pour générer un contenu HTML représentatif au cas d'utilisation métier. Cette
propriété est initialisée lors de la construction de l'objet par la méthode «initDivBindXML».
divBindMessage
<private> String divBindMessage
La propriété privée «divBindMessage» : Zone dynamique associée à l'affichage du message d'attente lors du rapatriement du flux XML. Cette propriété est
initialisée lors de la construction de l'objet. Elle peut être confondue avec celle liée à la zone dynamique associée à la génération HTML du flux XML
(«divBind»). Cette propriété peut être initialisée à une autre valeur (lors de la présence d'un tableau) par le biais de la méthode publique
«initLoadingMessage».
divIdBind
<private> String divIdBind
La propriété privée «divIdIdBind» est l'ID (sous forme de chaîne de caractères) de la zone dynamique associée au flux XML. Cette propriété est
initialisée par le biais du constructeur de l'objet.
ecrireXMLtoHTML
<private> String ecrireXMLtoHTML
Propriété privée «ecrireXMLtoHTML» : contient le nom de la fonction appelée lorsque le rapatriement du flux XML est terminé.
Le traitement de cette fonction est propre au cas d'utilisation métier implémenté et peut se décliner par exemple de la manière suivante :
· Confirmation de la réalisation d'un traitement serveur.
· Affichage d'un rendu HTML associé à un flux XML donné (Ex : liste déroulante contenant des
choix
reflétant le flux XML, tableau de données dynamiques, libellé dynamique ...).
· Modification d'un flux XML suite au bon déroulement d'une action (ajout, suppression,
modification)
et réaffichage de son rendu HTML.
· ...
Cette propriété est initialisée lors de la
construction de l'objet.
frameIdBind
<private> String frameIdBind
La propriété privée «frameIdBind» est l'ID (sous forme de chaîne de caractères) de la frame d'emplacement de la zone dynamique associée au flux XML. Cette
propriété est initialisée par le biais du constructeur de l'objet.
loadingClasse
<private> String loadingClasse
Propriété privée «loadingClasse» : Propriété spécifiant la classe pour la mise en forme du texte du message d'attente affiché lors du rapatriement du flux XML. La valeur par
défaut est une classe standard. Cette propriété est initialisée lors de la construction de l'objet.
- Valeur par défaut : Valeurs par défaut des Propriétés
loadingImage
<private> String loadingImage
loadingMessage
<private> String loadingMessage
reqDO
<private> boolean reqDO
Propriété privée «reqDO» : Booléen indiquant si le flux a été recu est l'action déclenchée.
requestBoolAsynchrone
<private> boolean requestBoolAsynchrone
Propriété privée «requestBoolAsynchrone» : Synchronisme de la requête de rapatriement de flux XML. Cette propriété est initialisée par le biais de initAsynchrone de l'objet.
Renseigné à true pour une requête asynchrone à false pour une requête synchrone.
- Valeur par défaut : Valeurs par défaut des Propriétés
requestData
<private> String requestData
Propriété privée «requestData» : Données envoyées lors de la requête de rapatriement de flux XML. Cette propriété est initialisée par le biais de initRequest de l'objet.
requestMethode
<private> String requestMethode
status
<private> Integer status
Propriété privée «status» : status de la réponse du flux XML (égal à 200 quand pas de problème). Cette propriété est initialisée lors du chargement du flux XML par la méthode send pour être contrôlée lors du traitement des erreurs.
statusText
<private> String statusText
Propriété privée «statusText» : texte du status explicitant une erreur survenant lors du rapatriement du flux XML (status différent de 200). Cette propriété est initialisée lors du chargement du flux XML par la méthode send pour être affichée lors du traitement des erreurs.
urlXML
<private> String urlXML
Propriété privée «urlXML» : URL d'appel du flux XML. Cette propriété est initialisée par le biais du constructeur de l'objet.
xmlDoc
* XMLObject xmlDoc
La propriété publique «xmlDoc» est un pointeur sur l'objet DOM en mémoire associé au flux XML. Par son intermédiaire, le développeur peut interroger, manipuler et enregistrer le flux XML rapatrié.
xmlDocText
* String xmlDocText
La propriété publique «xmlDocText» est chaîne de caractères contenant l'ensemble des informations contenues dans l'objet DOM. Par son intermédiaire, le développeur peut effectuer une alert dessus pour l'afficher dans une boîte modale.
xmlReq
* XMLHTTPRequest xmlReq
La propriété publique «xmlReq» est un pointeur sur l'objet Request permettant de rapatrier le flux XML.
XMLObject
XMLObject(<String_Facultatif> frameIdBind, <String_Obligatoire> divId, <String_Obligatoire> ecrireXMLtoHTML, <String_Obligatoire> urlXML, <boolean_Obligatoire> boolLoadingMessage)
Le constructeur retourne une instance de la classe «XMLObject» utile pour appeler soit les méthodes publiques associées à cette dernière soit pour interroger ses propriétés
publiques.
Remarques: Le code du constructeur prépare les appels futurs aux méthodes de l'objet. L'utilisation de ce constructeur est requise pour un fonctionnement correct des méthodes
décrites dans la suite de ce document.
La fonction désignée par «ecrireXMLtoHTML» doit fonctionner sans argument. Elle doit implémenter le traitement à réaliser sur le client
suite à une opération de rapatriement d'un flux XML.
Dans le cas où «urlXML» représente une URL absolue (http://site.domaine.topdomaine), il est alors préconisé de
spécifier une URL dont les noms de serveur et de domaine sont identiques aux noms de l'URL de la page HTML utilisant ce framework.
Ex : si http://serveur.domaine.topdomaine/demo.htm utilise fw_xml.js alors
urlXML doit débuter par http://serveur.domaine.topdomaine.
Si toutefois les noms de serveur et de domaine d'«urlXML» ne correspondent pas aux noms de serveur et de domaine de la page HTML
incluant ce framework, alors l'ensemble des appels à la méthode «importXML» peut être soumis à une demande de confirmation utilisateur via une
fenêtre navigateur. Ce fonctionnement dépend des paramètres de sécurité du navigateur. Il est activé sur tous les navigateurs paramétrés avec un security manager
actif. (Niveau de sécurité supérieur à faible pour IE).

Exemple de boîte de confirmation.
Si les noms de serveurs et de domaine correspondent aux noms de serveur et de domaine de la page HTML incluant ce framework alors cette contrainte est levée. Pour s'affranchir de ces contraintes, il est donc
conseillé d'utiliser des adresses relatives.
Voir Exemple d'instanciation de la classe XMLObject pour une liste : Exemples d'appels aux constructeurs.
Parameters:
frameIdBind - String_Facultatif
«frameIdBind» : String indiquant l'ID de la Frame où se situe la fonction de génération HTML du flux XML.
divId - String_Obligatoire
«divId» : String indiquant l'ID de la DIV support de la zone dynamique où la génération HTML du flux XML sera effectuéee.
ecrireXMLtoHTML - String_Obligatoire
«ecrireXMLtoHTML» : String indiquant le nom de la fonction appelée après réception du flux XML. Cette fonction effectue le traitement de génération HTML du flux XML.
urlXML - String_Obligatoire
«urlXML» : String indiquant l'URL d'appel du flux XML.
boolLoadingMessage - boolean_Obligatoire
«boolLoadingMessage» : Booléen indiquant l'affichage d'un message d'attente lors de la réception du flux XML.
Date: 04/09/2007
Version: 2.6
debugXML
void debugXML()
La méthode publique «debugXML()» est destinée aux développeurs pour afficher dans une boîte d'alerte le contenu du flux XML associé à un objet XMLObject dans un but de debogage.
Voir Exemple d'appel pour afficher le contenu XML de la liste : Exemples d'appels aux méthodes publiques.
Date: 25/10/2005
Version: 1.1
deleteCookieXML
void deleteCookieXML()
La méthode publique «deleteCookieXML()» permet de détruire le cookie de sauvegarde du DOM XML présent dans l'objet XMLObject.
Voir Exemple de suppression du cookie de sauvegarde du flux XML : : Exemples d'appels aux méthodes publiques.
Date: 25/10/2005
Version: 1.1
endPrintLoadingMessage
<private> void endPrintLoadingMessage()
La méthode privée «printLoadingMessage()» est la méthode interne utilisée pour effacer le message défilant d'attente du rapatriement du
flux XML.
Date: 25/10/2005
Version: 1.1
importXML
void importXML()
La méthode publique «importXML()» déclenche le rapatriement d'un flux XML (à partir d'une URL) et appelle la méthode «ecrireXMLtoHTML»
configurée par le constructeur de l'objet lors de son initialisation.
Fonctionnement :
1. Effectue une requête de rapatriement de flux XML sur l'URL définie au moment de l'instanciation
(voir constructeur) et après initialisation de la méthode, des données passées à la requête et du synchronisme
(voir «initRequestParams», «initRequestData» et «initAsynchrone»).
2. Un objet DOM est construit à partir de la ressource obtenue. Cet objet DOM est ensuite accessible via la propriété «xmlDoc»
(voir propriété). Chaque appel à cette méthode provoque la destruction de tout objet DOM précédemment crée sur le même objet XMLObject.
3. La méthode «ecrireXMLtoHTML» spécifiée lors de l'instanciation est exécutée une fois le flux rapatrié.
4. La méthode «importXML» prend fin au retour de l'appel à la méthode «ecrireXMLtoHTML».
En cas d'échec de la
requête (échec du rapatriement du flux, erreur fonctionnelle ...), l'objet DOM construit correspond à un arbre XML décrivant l'erreur survenue. Pour une erreur technique, ce format est
spécifique au navigateur utilisé. Pour une erreur fonctionnelle, le format est spécifique au cas d'utilisation métier implémenté. Afin de déterminer le résultat d'une
invocation de la méthode, la méthode «parseErrorXML» doit être employée.
La méthode «importXML»
peut échouer pour les raisons critiques suivantes :
> L'URL spécifiée ne correspond pas à une ressource XML ou n'existe pas, l'objet DOM ne peut être construit.
> Le service de
flux est interrompu au cours du transfert XML (exception, interruption de service), l'objet DOM ne peut pas être construit.
Voir Exemple d'import XML lors d'une instanciation de l'objet XMLObject déjà effectuée : Exemples d'appels aux méthodes publiques.
Date: 04/09/2007
Version: 2.6
Voir:
initAsynchrone
void initAsynchrone(<boolean_Obligatoire> boolAsynchrone)
Parameters:
boolAsynchrone - boolean_Obligatoire
Renseigné à true pour une requête asynchrone à false pour une requête synchrone.
Date: 06/06/2006
Version: 2.0
initCookieXML
void initCookieXML(<String_Obligatoire> cookieNameXML)
La méthode publique «initCookieXML(cookieNameXML)» permet d'initialiser les attributs du futur cookie de sauvegarde du flux XML en précisant son nom et les
autres attributs optionnels losque l'on souhaite s'affranchir des attributs par défaut listés dans le tableau du résumé de
fw_cookies.js.
Voir Exemple d'initialisation des futurs attributs d'un cookie de sauvegarde d'un flux XML : Exemples d'appels
aux méthodes publiques.
Parameters:
cookieNameXML - String_Obligatoire
String contenant le nom du cookie de sauvegarde du flux XML.
Date: 25/10/2005
Version: 1.1
initDivBindXML
<private> void initDivBindXML()
La méthode privée «initDivBindXML()» permet de spécifier avec les éléments fournis dans le
constructeur («frameIdBind» et «divId») un pointeur vers le DOM HTML de la zone dynamique gérant la
présentation du contenu dynamique correspondant au flux XML.
Ce pointeur vers le DOM HTML est stocké dans la propriété «divBind»
de l'instance de la classe XMLObject.
Date: 25/10/2005
Version: 1.1
initLoadingMessage
number initLoadingMessage(<int_Obligatoire> colspan)
La méthode publique «initLoadingMessage(colspan)» a pour but d'initialiser le message d'attente à afficher dans la zone dynamique propre à la
génération HTML reflétant le contenu du flux XML. Par défaut, ce message se caractérise par l'affichage d'une image défilante dont
l'emplacement est spécifié en paramètre dans la variable JavaScript présente dans le framework sous le nom ««importXML()» pour initialiser le message d'attente en lui spécifiant le nombre de colonnes présentes dans le tableau.
Voir Exemple d''import XML nécessitant une initialisation du message d'attente au péalable : Exemples d'appels aux méthodes publiques.
Parameters:
colspan - int_Obligatoire
Entier indiquant le nombre de colonnes présentes dans le corps du tableau associé à la zone dynamique propre à la génération HTML reflétant le contenu du flux XML.
Date: 25/10/2005
Version: 1.1
initRequestData
void initRequestData(<String_Obligatoire> methode,<String_Optionnel> data)
La méthode publique «initRequestData()» permet d'initialiser la requête de rapatriement de flux XML
effectuée par la méthode «importXML» en renseignant les attributs requestMethode et requestData.
Voir Exemple d'initialisation de requête XML lors d'une instanciation de l'objet XMLObject déjà effectuée pour la validation d'un formulaire : Exemples d'appels aux méthodes publiques.
Parameters:
methode - String_Obligatoire
Méthode de la requête pouvant prendre les valeurs "HEAD", "GET" ou "POST".
data - String_Optionnel
Paramètres de la requête pour envoyer des données sous la forme "VAR1=valeur1&VAR2=valeur2". Attention de ne pas oublier d'encoder les valeurs pour prendre en compte les caractères sépciaux (accents, '&', '?'...).
Date: 06/06/2006
Version: 2.0
initRequestParams
void initRequestParams(<String_Obligatoire> methode,<Object_Facultatif> params)
La méthode publique «initRequestParams()» permet d'initialiser la requête de rapatriement de flux XML
effectuée par la méthode «importXML» en renseignant les attributs requestMethode et requestData.
Voir Exemple d'initialisation de requête XML lors d'une instanciation de l'objet XMLObject déjà effectuée pour la validation d'un formulaire : Exemples d'appels aux méthodes publiques.
Parameters:
methode - String_Obligatoire
Méthode de la requête pouvant prendre les valeurs "HEAD", "GET" ou "POST".
params - Object_Facultatif
Paramètres de la requête pour envoyer des données sous la forme "VAR1=valeur1&VAR2=valeur2". Cet objet params peut être construit de la manière suivante avant de le passer en argument de la fonction : var params = { VAR1=var1.getValue(), VAR2=var2.getValue() };
Date: 06/06/2006
Version: 2.0
initXML
void initXML()
Le framework technique fw_xml.js propose la fonction
«XMLObjectCookie_initXML()»; Elle permet d'initialiser le document XML contenu dans l'attribut xmlDoc à vide.
Date: 14/11/2006
Version: 2.4
parseErrorXML
number parseErrorXML(<String_Optionnel> type)
La méthode publique «parseErrorXML(type)» permet d'analyser le flux XML renvoyé pour vérifier la présence ou non d'une erreur :
la détection de la présence d'une erreur s'effectue de la manière suivante.
> Erreur serveur empêchant le renvoi du flux :
· Rapport d'erreur renvoyé par Tomcat;
· Erreur de status renvoyée par le serveur Web (Ex: 404, 500...);
· Erreur de session invalide renvoyée par une redemande d'authentification;
> Erreur de parsing XML par le parser du navigateur.
> Erreur fonctionnelle ou technique applicative :
· Détection du nom du premier élément XML à «ERREUR» et
récupération du libellé du message d'erreur dans le contenu informatif du flux XML.
Si une erreur est détectée, l'affichage de la page d'erreur est réalisé soit
directement dans la page d'appel du flux XML (par défaut), soit dans une fenêtre fille si "popup" est passé en argument de la fonction.
L'URL de la page d'erreur est spécifiée en
paramètre dans la variable générique présente dans le framework sous le nom «page_erreur_url».
Remarque :
Cette fonction est généralement appelée
dans la méthode «ecrireXMLtoHTML» pour vérifier la présence du
flux attendu avant tout traitement de lecture de ce flux par cettedernière.
- Voir Valeurs des Constantes - Globales : «page_erreur_url», ...
Voir Exemple de détection d'erreur dans notre cas d'utilisation avec génération de la liste : Exemples d'appels aux méthodes publiques.
Parameters:
type - String_Optionnel
String indiquant le type d'affichage de l'erreur si l'erreur ne s'affiche pas dans la page : "popup" affichage dans une fenêtre
Date: 06/06/2006
Version: 2.0
printLoadingMessage
<private> void printLoadingMessage()
La méthode privée «printLoadingMessage()» est la méthode interne utilisée pour afficher le message défilant d'attente du rapatriement du
flux XML.
Version: 2.1 Date : 13/07/2006
saveCookieXML
void saveCookieXML()
La méthode publique «saveCookieXML()» permet de sérialiser le DOM XML présent dans l'objet XMLObject en chaîne de caractères et de
sauvegarder cette sérialisation dans un cookie client sur disque et cela pour une durée d'expiration de 10 ans. Avant d'appeler pour la première
utilisation de cette méthode, il est nécessaire d'initialiser le cookie via la méthode
«initCookieXML(cookieNameXML)». Il est ensuite possible de sauvegarder au gré des manipulations du DOM XML, ses différents
états dans le même cookie client. Il faut tout de même garder en mémoire la limitation des 4000 caractères maximum par cookie disque.
Voir Exemple de sauvegarde de flux XML sur cookie : : Exemples d'appels aux méthodes publiques.
Date: 04/09/2007
Version: 2.6
saveLocalXML
void saveLocalXML(<String_Obligatoire> path)
La méthode publique «saveLocalXML(path)» offre la possibilité de sauvegarder le flux XML présent dans le DOM de l'objet XMLObject dans un fichier
placé sur disque.
Pour pouvoir effectuer cet enregistrement sur disque à partir d'un navigateur, il est nécessaire de modifier les paramètres
de sécurité du navigateur en élargissant la confiance de celui-ci vis-à-vis des scripts lancés par les sites en intranet/extranet.
Ce
paramétrage est propre au type de navigateur utilisé :
> pour MSIE, il consiste à modifier la politique de sécurité du
navigateur à partir du menu Outils Options Internet Sécurité.

Il est ainsi possible de
personnaliser le niveau de sécurité soit pour l'ensemble de l'intranet local soit en listant les sites de confiance en activant les contrôles d'initialisation et de
script ActiveX non marqués comme sécurisés de la manière suivante :

> pour les navigateurs de
type Gecko, elle consiste à modifier le fichier de paramétrage propre aux préférences de l'utilisateur : prefs.js présent dans le profile de
l'utilisateur propre au navigateur (Exemple d'emplacement pour Mozilla : C:\Documents and Settings\Administrateur\Application\Data\Mozilla\Profiles\).
L'élargissement de la politique de sécurité s'effectue en ajoutant en fin de fichier la ligne de commande suivante :
user_pref("signed.applets.codebase_principal_support", true);
Remarque :
Cette méthode ne se charge pas de la vérification de la
validité de l'emplacement. Il est donc nécessaire de garantir avant son appel, d'une part, la présence du disque et du ou des répertoires et, d'autre
part, des droits d'écriture de l'utilisateur sur cet emplacement (la manipulation des disques : fichier, arborescence, présence ou non via javascript ne fait pas
partie de ce framework). De plus, si un fichier de même nom est déjà présent, l'appel à cette méthode remplace ce dernier par la
sauvegarde du flux XML.
Voir Exemple de sauvegarde d'un flux XML présent dans l'objet XMLObject : : Exemples d'appels aux méthodes
publiques.
Parameters:
path - String_Obligatoire
Emplacement indiquant le chemin et le nom du fichier de sauvegarde placé sur un disque. Pour être pris en compte sur l'ensemble des navigateurs, l'emplacement doit être spécifié de la manière suivante :
{Disque}:\{Répertoire}\{Nom du fichier}.xml.
Date: 25/10/2005
Version: 1.1
setDivBindMessage
void setDivBindMessage(<String_Obligatoire> divIdBindMessage)
La méthode publique «setDivBindMessage(divIdBindMessage)» a pour but d'initialiser la zone dynamique ou sera généré le code
HTML du message d'attente. Le message placé dans cette zone dynamique a pour vocation d'être ensuite fermé
Cette méthode doit être appelée avant la demande de rapatriement du flux XML via l'appel à
«importXML()» pour initialiser la zone dynamique qui sinon est valorisée par défaut à la zone dynamique qui contiendra (en HTML) les données issues du flux XML.
Voir Exemple d'import XML nécessitant une initialisation du message d'attente au péalable : Exemples d'appels aux méthodes publiques.
Parameters:
divIdBindMessage - String_Obligatoire
identifant de la zone dynamique.
Version: 2.1 Date : 13/07/2006
setLoadingMessage
void setLoadingMessage(<String_Obligatoire> loadingMessage)
La méthode publique «XMLObject_setLoadingMessage(libelleLoadingMessage)» a pour but d'initialiser les informations sur le contenu du message d'attente.
Elle doit être appelée avant la demande de rapatriement du flux XML via l'appel à la méthode
«importXML()» pour initialiser les informations qui sinon sont valorisées avec leur valeur par défaut.
Voir Exemple d'import XML nécessitant une initialisation du message d'attente au péalable : Exemples d'appels aux méthodes publiques.
Parameters:
loadingMessage - String_Obligatoire
«loadingMessage» : String indiquant le texte du message d'attente.
loadingClasse - String_Optionnel
«loadingClasse» : String indiquant la classe appliquée sur le texte du message d'attente.
blLoadingImage - boolean_Optionnel
: Booléen indiquant si on insère l'image dans le message d'attente (cf. «loadingImage»).
Version: 2.1 Date : 13/07/2006
testStateChange
<private> void testStateChange()
La méthode privée «testStateChange()» est à usage interne du framework.
Elle invoque la méthode «ecrireXMLtoHTML» lorsque le rapatriement du flux est achevé en synchrone.
Date: 04/09/2007
Version: 2.6
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