|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |
Object | +--XMLObjectCookie
La classe «XMLObjectCookie» est la classe permettant de gérer un flux XML dans un DOM à partir d'un cookie sur disque.
L'ensemble des propriétés de la classe XMLObjectCookie est une restriction de l'ensemble des propriétés de la classe
XMLObject. L'usage de l'une ou de l'autre dépend du cas d'utilisation métier.
Ainsi, la classe XMLObjectCookie a pour but de désérialiser dans un DOM XML une chaîne de caractères présente dans un cookie client
disque reflétant un flux XML alors que le recours à la classe XMLObject consiste à rapatrier un flux XML distant pour le monter en mémoire dans
un DOM XML. Il est donc inutile que la classe XMLObjectCookie possède les propriétés «urlXML» et
«ecrireXMLtoHTML». L'url est utile pour le rapatriement d'un flux XML distant.
Le nom de la fonction de
génération HTML, associée au DOM XML présent dans l'objet, est nécessaire pour gérer l'événement de fin de
chargement du flux XML. Lors de l'utilisation d'une classe XMLObjectCookie, l'appel de la fonction de génération HTML peut s'effectuer juste après la
désérialisation sans gestion d'événement ou de synchronisme.
De même que pour les propriétés, une restriction sur les méthodes présentes dans la classe XMLObject est
effectuée pour la classe XMLObjectCookie : disparition des méthodes «testStateChange» propre à la
gestion d'événement du chargement de flux XML distant pour MSIE, «importXML» propre à la demande de
rapatriement d'un flux XML distant et «initCookieXML» dont le périmètre fonctionnel est reporté dans le
constructeur de la classe XMLObjectCookie.
Bien sûr, le constructeur de XMLObjectCookie est adapté à la
spécificité de cette classe et la méthode «parseErrorXML» propre à la classe XMLObject
est transformée en une méthode spécifique «parseErrorCookieXML» propre à la classe
XMLObjectCookie pour une gestion d'erreur distincte.
Par contre, une nouvelle méthode fait son apparition pour pouvoir effectuer la désérialisation
dans un DOM XML d'une chaîne de caractères reflétant un flux XML présente dans un cookie client disque : «importCookieXML».
Date: 04/09/2007
Version: 2.6
Definie dans technique/fw_xml.js
Sommaire des Attributs | |
<private> String |
argc
L'élément «argc» dans la classe XMLObjectCookie 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 optionnels, pour compter les paramètres soumis par le développeur). |
<private> String |
argv
L'élément «argv» dans la classe XMLObjectCookie 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 optionnels, pour repérer les paramètres qui ont été soumis par le développeur). |
<private> String |
boolLoadingMessage
Propriété privée «boolLoadingMessage» : voir XMLObject.boolLoadingMessage. |
<private> String |
cookieDomainXML
Propriété privée «cookieDomainXML» : voir XMLObject.cookieDomainXML. |
<private> String |
cookieMultiXML
Propriété privée «cookieMultiXML» : voir XMLObject.cookieMultiXML. |
<private> String |
cookieNameXML
Propriété privée «cookieNameXML» : voir XMLObject.cookieNameXML. |
<private> String |
cookiePathXML
Propriété privée «cookiePathXML» : voir XMLObject.cookiePathXML. |
<private> String |
cookieSecureXML
Propriété privée «cookieSecureXML» : voir XMLObject.cookieSecureXML. |
String |
divBind
Propriété publique «divBind» : voir XMLObject.divBind. |
<private> String |
divBindMessage
Propriété privée «divBindMessage» : voir XMLObject.divBindMessage. |
<private> String |
divIdBind
Propriété privée «divIdBind» : voir XMLObject.divIdBind. |
<private> String |
frameIdBind
Propriété privée «frameIdBind» : voir XMLObject.frameIdBind. |
<private> String |
loadingClasse
Propriété privée «loadingClasse» : voir XMLObject.loadingClasse. |
<private> String |
loadingImage
Propriété privée «loadingImage» : voir XMLObject.loadingImage. |
<private> String |
loadingMessage
Propriété privée «loadingMessage» : voir XMLObject.loadingMessage. |
* XMLObject |
xmlDoc
Propriété publique «xmlDoc» : voir XMLObject.xmlDoc. |
Sommaire des Constructeurs | |
XMLObjectCookie
(<String_Facultatif> frameIdBind, <String_Facultatif> divId, <String_Obligatoire> cookieNameXML, <Boolean_Obligatoire> boolLoadingMessage)
Le constructeur retourne une instance de la classe «XMLObjectCookie». |
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
|
importCookieXML()
Propre à la classe XMLObjectCookie - La méthode publique «importCookieXML()» permet de désérialiser, dans le DOM XML de la classe XMLObjectCookie, une chaîne de caractères présente dans le cookie client disque. |
<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. |
number
|
parseErrorCookieXML(<String_Facultatif> type)
Propre à la classe XMLObjectCookie - La méthode publique «parseErrorCookieXML(type)» permet de détecter si le cookie client est présent ou non. |
<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
|
saveCookieSessionXML()
Propre à la classe XMLObjectCookie - La méthode publique «saveCookieSessionXML()» permet de mettre à jour le cookie de session. Elle procède en récupérant des informations de l'ancien cookie avant de le supprimer et de le recréer. |
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. |
Détail des Attributs |
<private> String argc
<private> String argv
<private> String boolLoadingMessage
<private> String cookieDomainXML
<private> String cookieMultiXML
<private> String cookieNameXML
<private> String cookiePathXML
<private> String cookieSecureXML
String divBind
<private> String divBindMessage
<private> String divIdBind
<private> String frameIdBind
<private> String loadingClasse
<private> String loadingImage
<private> String loadingMessage
* XMLObject xmlDoc
Détail des Constructeurs |
XMLObjectCookie(<String_Facultatif> frameIdBind, <String_Facultatif> divId, <String_Obligatoire> cookieNameXML, <Boolean_Obligatoire> boolLoadingMessage)
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_Facultatif
«divId» : String indiquant l'ID du DIV support de la zone dynamique où la génération HTML du flux XML est effectuée.
cookieNameXML - String_Obligatoire
«cookieNameXML» : String indiquant le nom du cookie client sur disque sauvegardant le flux XML.
boolLoadingMessage - Boolean_Obligatoire
«boolLoadingMessage» : Booléen indiquant l'affichage d'un message d'attente lors de la réception du flux XML.
cookiePathXML - String_Facultatif
«cookiePathXML» : String indiquant le path du cookie.
cookieDomainXML - String_Facultatif
«cookieDomainXML» : String indiquant le domaine du cookie.
cookieSecureXML - String_Facultatif
«cookieSecureXML» : String indiquant si le cookie et sécurisé.
cookieMultiXML - Boolean_Facultatif
«cookieMultiXML» : String indiquant si le cookie peut être mutlitple.
Détail des Méthodes |
void debugXML()
Aucun -
void deleteCookieXML()
Aucun -
<private> void endPrintLoadingMessage()
Aucun -
void importCookieXML()
Aucun -
<private> void initDivBindXML()
Aucun -
number initLoadingMessage(<int_Obligatoire> colspan)
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.
number parseErrorCookieXML(<String_Facultatif> type)
type - String_Facultatif
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
<private> void printLoadingMessage()
Aucun -
void saveCookieSessionXML()
Aucun -
void saveCookieXML()
Aucun -
void saveLocalXML(<String_Obligatoire> path)
user_pref("signed.applets.codebase_principal_support", true);
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 :void setDivBindMessage(<String_Obligatoire> divIdBindMessage)
divIdBindMessage - String_Obligatoire
identifant de la zone dynamique.
void setLoadingMessage(<String_Obligatoire> loadingMessage)
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»).
|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |