Framework JavaScript ACube V2.10.0
 

Classe ComposantCanalRSS

Object
   |
   +--ComposantCanalRSS

class 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.


model


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.

exComposantCanalRSSsimple

Canal RSS avec pagination :

Voici l'affichage du même composant Canal RSS avec élément de pagination.

exComposantCanalRSSavecPagination


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

argc

<private> Object argc

argv

<private> Object argv

category_tab

ComposantCanalRSS_Category category_tab

cloud

String cloud

copyright

String copyright

currentPage

<private> int currentPage

description

String description

divBind

<private> String divBind

docs

String docs

generator

String generator

id

<private> string id

image

ComposantCanalRSS_Image image

language

String language

lastBuildDate

String lastBuildDate

link

String link

managingEditor

String managingEditor

maxPage

<private> int maxPage

navigation

<private> int navigation

nombreCaracteres

<private> int nombreCaracteres

nombreItem

<private> int nombreItem

pubDate

String pubDate

skipDays_tab

String skipDays_tab

skipHours_tab

String skipHours_tab

tabListe

<private> Tableau d'ObjectItemCanal tabListe

textInput

String textInput

title

String title

ttl

String ttl

urlXMLCanalRSS

<private> String urlXMLCanalRSS

webMaster

String webMaster

XMLObjectCanalRSS

<private> XMLObjectSauvegarde XMLObjectCanalRSS

Détail des Constructeurs

ComposantCanalRSS

ComposantCanalRSS(<String_Obligatoire> id, <int_Facultatif> pagination, <int_Obligatoire> nombreCaracteres, <String_Obligatoire> urlXML)

Détail des Méthodes

addCategory

 <private> void addCategory(category_object)

addSkipDay

 <private> void addSkipDay(skipDay)

addSkipHour

 <private> void addSkipHour(skipHour)

affiche_page

 <private> void affiche_page(<int_Obligatoire> NumPage)

clean

 <private> void clean()

ecrireBind

void ecrireBind()

ecrireElementDomHTML

 <private> string ecrireElementDomHTML()

iconeOut

 <private> void iconeOut(<ObjectDOMHTML> widget)

iconeOver

 <private> void iconeOver(<ObjectDOMHTML> widget)

importCanalRSS

void importCanalRSS()

initDivBind

 <private> void initDivBind()

initTabByXML

 <private> void initTabByXML()

itemOff

 <private> string itemOff(<String_Obligatoire> Item)

itemOn

 <private> string itemOn(<String_Obligatoire> Item)

loaderTimer

 <private> void loaderTimer()

refresh

 <private> void refresh()

retourXML

 <private> void retourXML()

skipUpdate

 <private> void skipUpdate()

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