Framework JavaScript ACube V2.10.0
 

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.

Détail des Attributs

boolLoadingMessage

<private> boolean boolLoadingMessage

contentType

<private> String contentType

cookieDomainXML

<private> String cookieDomainXML

cookieMultiXML

<private> String cookieMultiXML

cookieNameXML

<private> String cookieNameXML

cookiePathXML

<private> String cookiePathXML

cookieSecureXML

<private> boolean cookieSecureXML

delaiUP

<private> boolean delaiUP

divBind

String divBind

divBindMessage

<private> String divBindMessage

divIdBind

<private> String divIdBind

ecrireXMLtoHTML

<private> String ecrireXMLtoHTML

frameIdBind

<private> String frameIdBind

loadingClasse

<private> String loadingClasse

loadingImage

<private> String loadingImage

loadingMessage

<private> String loadingMessage

reqDO

<private> boolean reqDO

requestBoolAsynchrone

<private> boolean requestBoolAsynchrone

requestData

<private> String requestData

requestMethode

<private> String requestMethode

status

<private> Integer status

statusText

<private> String statusText

urlXML

<private> String urlXML

xmlDoc

* XMLObject xmlDoc

xmlDocText

* String xmlDocText

xmlReq

* XMLHTTPRequest xmlReq

Détail des Constructeurs

XMLObject

XMLObject(<String_Facultatif> frameIdBind, <String_Obligatoire> divId, <String_Obligatoire> ecrireXMLtoHTML, <String_Obligatoire> urlXML, <boolean_Obligatoire> boolLoadingMessage)

Détail des Méthodes

debugXML

void debugXML()

deleteCookieXML

void deleteCookieXML()

endPrintLoadingMessage

 <private> void endPrintLoadingMessage()

importXML

void importXML()

initAsynchrone

void initAsynchrone(<boolean_Obligatoire> boolAsynchrone)

initCookieXML

void initCookieXML(<String_Obligatoire> cookieNameXML)

initDivBindXML

 <private> void initDivBindXML()

initLoadingMessage

number initLoadingMessage(<int_Obligatoire> colspan)

initRequestData

void initRequestData(<String_Obligatoire> methode,<String_Optionnel> data)

initRequestParams

void initRequestParams(<String_Obligatoire> methode,<Object_Facultatif> params)

initXML

void initXML()

parseErrorXML

number parseErrorXML(<String_Optionnel> type)

printLoadingMessage

 <private> void printLoadingMessage()

saveCookieXML

void saveCookieXML()

saveLocalXML

void saveLocalXML(<String_Obligatoire> path)

setDivBindMessage

void setDivBindMessage(<String_Obligatoire> divIdBindMessage)

setLoadingMessage

void setLoadingMessage(<String_Obligatoire> loadingMessage)

testStateChange

 <private> void testStateChange()

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