|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |
Object | +--ComposantCanalRSS
La classe «ComposantCanalRSS» est la classe permettant de gérer le composant CanalRSS.
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.
RENDU IHM
CanalRSS simple :
Voici, comme exemple, l'affichage d'un composant Canal RSS simple sans élément de pagination avec
le fichier xml des spécifications maquette.
Canal RSS avec pagination :
Voici l'affichage du même composant Canal RSS avec élément de pagination.
Date: 25/10/2005
Version: 1.1
Definie dans ergonomique/fw_canal_rss.js
Sommaire des Attributs | |
<private> Object |
argc
|
<private> Object |
argv
|
ComposantCanalRSS_Category |
category_tab
La propriété publique «category» est un tableau contenant des objets de type ComposantCanalRSS_Category. |
String |
cloud
La propriété publique «cloud» permet aux processus pour enregistrer en nuage d'être notifiés des mises à jour du canal, en implémentant un protocole de flux RSS publier-souscrire léger. |
String |
copyright
La propriété publique «copyright» reflète l'information du tag <copyright> du canal. |
<private> int |
currentPage
La propriété privée «currentPage» mémorise le numéro de la page courante - Valeur par défaut : Valeurs par défaut des Propriétés. |
String |
description
La propriété publique «description» reflète l'information du tag <description> du canal. |
<private> String |
divBind
Propriété privée «divBind» - Zone dynamique (objet DOM HTML) associée au composant. |
String |
docs
La propriété publique «docs» indique l' url pointant sur la documentation du format utilisé pour le fichier RSS. |
String |
generator
La propriété publique «generator» est une chaîne indiquant le programme utilisé pour générer le canal. |
<private> string |
id
Propriété privée «id» - ID du composant définit sous forme de chaîne de caractères. |
ComposantCanalRSS_Image |
image
La propriété publique «image» est de type ComposantCanalRSS_Image et contient les propriétes de l'image du canal RSS. |
String |
language
La propriété publique «langage» reflète l'information du tag <language> du canal. |
String |
lastBuildDate
La propriété publique «lastBuildDate» reflète l'information du tag <lastBuildDate> du canal. |
String |
link
La propriété publique «link» reflète l'information du tag <link> du canal. |
String |
managingEditor
La propriété publique «managingEditor» reflète l'information du tag <managingEditor> du canal. |
<private> int |
maxPage
Attribut html «maxPage» de ComposantCanalRSS, permettant de spécifier la nombre maximal de pages. |
<private> int |
navigation
Propriété privée «navigation» - Paramètre qui précise combien d'items par page seront présents pour l'élément de pagination. |
<private> int |
nombreCaracteres
Propriété privée «nombreCaracteres» - Paramètre qui précise sur combien de caractères sera visible le texte contenant la description d'un item. |
<private> int |
nombreItem
Propriété privée «nombreItem» - Paramètre qui précise le nombre d'item du flux RSS. |
String |
pubDate
La propriété publique «pubDate» reflète l'information du tag <pubDate> du canal. |
String |
skipDays_tab
La propriété publique «skipDays_tab» est un tableau contenant les jours lors des quels aucunes mises à jour automatiques ne sera effectuées. |
String |
skipHours_tab
La propriété publique «skipHours_tab» est un tableau contenant les heures aux quelles on ne rafraîchit automatiquement pas le canal. |
<private> Tableau d'ObjectItemCanal |
tabListe
La propriété privée «tabListe» est un tableau d'objets ObjectItemCanal reflétant l'ensemble des items du canal présents dans le composant CanalRSS. |
String |
textInput
La propriété private «textInput» donne la possibilité de paramétrer l'ajout d'un champ texte avec un bouton submit lié au canal. |
String |
title
La propriété publique «title» reflète l'information du tag <title> du canal. |
String |
ttl
La propriété publique «ttl» indique le temps de validité du canal. |
<private> String |
urlXMLCanalRSS
Propriété privée «urlXMLCanalRSS» - Paramètre qui précise l'URL du fichier XML correspondant au canal RSS. |
String |
webMaster
La propriété publique «webMaster» reflète l'information du tag <webMaster> du canal. |
<private> XMLObjectSauvegarde |
XMLObjectCanalRSS
Propriété privée «XMLObjectCanalRSS» - Objet de type XMLObjectSauvegarde référençant le flux XML intégrant le paramétrage du contenu informatif du composant. |
Sommaire des Constructeurs | |
ComposantCanalRSS
(<String_Obligatoire> id, <int_Facultatif> pagination, <int_Obligatoire> nombreCaracteres, <String_Obligatoire> urlXML)
Crée une instance de la classe CanalRSS. |
Sommaire des Méthodes | |
<private> void
|
addCategory(category_object)
La méthode publique «ComposantCanalRSS_addCategory()» permet d'ajouter un objet de type ComposantCanalRSS_Category dans la propriété category_tab du canal ou de l'item. |
<private> void
|
addSkipDay(skipDay)
La méthode publique «ComposantCanalRSS_addSkipDay()» permet d'ajouter la valeur d'un élément <skipDays> dans la propriété skipDays_tab |
<private> void
|
addSkipHour(skipHour)
La méthode publique «ComposantCanalRSS_addSkipHour()» permet d'ajouter la valeur d'un élément <skipHours> dans la propriété skipHours_tab |
<private> void
|
affiche_page(<int_Obligatoire> NumPage)
La méthode privée «affiche_page()» est appelée pour l'affichage de la (cas du canal RSS simple) ou des pages (cas de la pagination) du composant Canal RSS. |
<private> void
|
clean()
La méthode publique «ComposantCanalRSS_clean()» permet de nettoyer les propriétés du composant en vue de le mettre à jour. |
void
|
ecrireBind()
La méthode publique «ecrireBind()» déclenche la génération du code HTML de la zone dynamique associée au composant. |
<private> string
|
ecrireElementDomHTML()
La méthode privée «ecrireElementDOMHTML()» est la fonction interne renvoyant le code HTML associé au canal RSS. |
<private> void
|
iconeOut(<ObjectDOMHTML> widget)
La méthode privée «iconeOut(widget)» implémente le traitement à exécuter sur l'évènement "onMouseOut" du composant Canal RSS (désaffichage d'un Item). |
<private> void
|
iconeOver(<ObjectDOMHTML> widget)
La méthode privée «iconeOver(widget)» implémente le traitement à exécuter sur l'évènement "onMouseOver" du composant Canal RSS, gère l'affichage d'un Item. |
void
|
importCanalRSS()
La méthode publique «importCanalRSS()» permet de rappeler le flux XML du canal. |
<private> void
|
initDivBind()
La méthode privée «initDivBind()» permet de spécifier un pointeur vers le DOM HTML de la zone dynamique (DIV) gérant la présentation du composant canal RSS. |
<private> void
|
initTabByXML()
La méthode privée «initTabByXML()» permet de construire le tableau d'objets référençant l'ensemble des items du canal ainsi que les propriétés publiques du composant présentes dans le Canal RSS à partir d'un flux XML correspondant au paramètre urlXML. |
<private> string
|
itemOff(<String_Obligatoire> Item)
La méthode privée «itemOff(Item)» est appelée lors d'un clic sur un visuel d'un item de canal permettant de revenir à la visualisation de l'item sur un nombre de caractères égal à nombreCaracteres. |
<private> string
|
itemOn(<String_Obligatoire> Item)
La méthode privée «itemOn(Item)» est appelée lors d'un clic sur un visuel d'un item de canal permettant ainsi la visualisation complète hors de la limite nombreCaracteres de la description de l'item. |
<private> void
|
loaderTimer()
La méthode publique «ComposantCanalRSS_LoaderTimer()» permet au composant RSS de lancer son raffraîchissment Cette méthode est appelé uniquement si la propriété ttl est definie. |
<private> void
|
refresh()
La méthode privée «refresh()» est appelée lors d'un click sur le visuel «Actualiser» pour effectuer un nouvel appel du fichier XML du Canal RSS. |
<private> void
|
retourXML()
La méthode privée «retourXML()» est appelée après l'import d'un flux XML afin de procéder à l'affichage du canal. |
<private> void
|
skipUpdate()
La méthode publique «ComposantCanalRSS_skipUpdate()» est appelé lorque la propriété du canal ttl est definie. |
Détail des Attributs |
<private> Object argc
<private> Object argv
ComposantCanalRSS_Category category_tab
String cloud
String copyright
<private> int currentPage
String description
<private> String divBind
String docs
String generator
<private> string id
ComposantCanalRSS_Image image
String language
String lastBuildDate
String link
String managingEditor
<private> int maxPage
<private> int navigation
<private> int nombreCaracteres
<private> int nombreItem
String pubDate
String skipDays_tab
String skipHours_tab
<private> Tableau d'ObjectItemCanal tabListe
String textInput
String title
String ttl
<private> String urlXMLCanalRSS
String webMaster
<private> XMLObjectSauvegarde XMLObjectCanalRSS
Détail des Constructeurs |
ComposantCanalRSS(<String_Obligatoire> id, <int_Facultatif> pagination, <int_Obligatoire> nombreCaracteres, <String_Obligatoire> urlXML)
id - String_Obligatoire
String : indique l'id du composant à instancier. Sa valorisation doit correspondre au nom de la variable JavaScript du composant instancié.
pagination - int_Facultatif
Entier : indique le nombre d'items du canal par page. Laissé à «null» si pas de pagination.
nombreCaracteres - int_Obligatoire
Entier : indique le nombre de caractères maximum visible pour la chaîne de caractère de description de l'information de l'item.
urlXML - String_Obligatoire
String : indique l'url du fichier XML représentant le canal RSS.
divBind - String_Optionnel
String : indiquant la dynamique zone dynamique (objet DOM HTML) permettant de binder le code HTML du composant.
Détail des Méthodes |
<private> void addCategory(category_object)
category_object -
ComposantCanalRSS_Category}
<private> void addSkipDay(skipDay)
skipDay -
xmlElement}
<private> void addSkipHour(skipHour)
skipHour -
xmlElement}
<private> void affiche_page(<int_Obligatoire> NumPage)
NumPage - int_Obligatoire
: numéro de la page appelée du composant Canal RSS à afficher.
<private> void clean()
Aucun -
void ecrireBind()
Aucun -
<private> string ecrireElementDomHTML()
Aucun -
<private> void iconeOut(<ObjectDOMHTML> widget)
widget - ObjectDOMHTML
: Elément DOM HTML du composant CanalRSS.
<private> void iconeOver(<ObjectDOMHTML> widget)
widget - ObjectDOMHTML
Elément DOM HTML du composant Texte Long.
void importCanalRSS()
Aucun -
<private> void initDivBind()
Aucun -
<private> void initTabByXML()
Aucun -
<private> string itemOff(<String_Obligatoire> Item)
Item - String_Obligatoire
de canal sélectionné pour un retour é une visualisation sur un nombre de caractères égal à nombreCaracteres
<private> string itemOn(<String_Obligatoire> Item)
Item - String_Obligatoire
de canal sélectionné pour une visualisation complète.
<private> void loaderTimer()
Aucun -
<private> void refresh()
Aucun -
<private> void retourXML()
Aucun -
<private> void skipUpdate()
Aucun -
|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |