ergonomique/fw_textelong.js
Résumé
Ce fichier Javascript correspond au framework de gestion du texte long. Cette description consiste à présenter les prototypes des fonctions, des
exemples d'appel et les précisions techniques nécessaires à la mise en oeuvre de ce framework.
Le framework Texte long utilise les classes utilitaires suivantes :
> ComposantTexteLong pour gérer le composant Texte long.
> ObjectTexteLong
pour décrire l'objet associé à un item du texte long (titre ou sous titre).

Ainsi, conformément aux principes du framework ergonomique, l'ensemble du contenu informatif peut être paramétré sous forme de flux XML ou par
l'intermédiaire d'un tableau JavaScript.
Le paramétrage du contenu informatif consiste à indiquer pour chaque titre (ou sous-titre) son libellé,
c'est-à-dire son contenu textuel ainsi que le titre lui-même à afficher puis une liste de sous-titres. La liste de sous-titres contient les mêmes
informations que le titre parent à savoir, libellé, titre et liste des sous titres.
L'arborescence XML associé à ce paramétrage doit
avoir la forme suivante :
<COMPOSANT>
<PARTIE>
<TITRE></TITRE>
<LIBELLE></LIBELLE>
<LISTE_PARTIE></LISTE_PARTIE>
</PARTIE>
</COMPOSANT>
L'élément racine de nom «COMPOSANT» ici peut prendre n'importe quel nom. Ce nom d'élément est utile que lors de la construction
de la page pour passer le bon paramétrage lors de la construction du composant.
La détermination de ce nom est déterminé soit par un
modèle de page ou par le développeur de la page. Il faut bien remarquer la structure récursive du format XML pour le texte long. La balise
<LISTE_PARTIE> peut contenir à nouveau la même information que la balise <PARTIE> en une ou plusieurs instances.
Voir Exemple de structure XML du contenu informatif de ce composant pour l'exemple de texte long fourni dans les spécifiactions de maquettage :
Exemples de structure XML.
RENDU IHM
Composant Texte Long Arborescent :
Voici l'affichage d?un composant de texte long
arborescent. La sélection d'un titre ou sous-titre entraîne l'affichage sous le titre lui-même de son contenu ainsi que l'arborescence de ses sous-titres.
Lorsqu'un titre ou sous-titre est sélectionné tous les autres titres et sous-titres sont désaffichés. Par ailleurs, l'arborescence qui mène au
sous-titre consulté apparaît en gras. Cette sélection en gras subit le même comportement que l'affichage ou désaffichage du texte lors de la
sélection.
Composant Texte long Par Ancre :
Voici l'affichage du composant Texte Long à navigation par ancres. Cette
représentation affiche le texte dans son intégralité ainsi qu'un sommaire en en-tête qui permet par simple clic de se rendre sur la partie
concernée. Au niveau de chaque titre ou sous-titre il y a une icône de retour au sommaire.
Composant Texte Long Titre :
Voici l'affichage du texte long avec une navigation par titre. L'en-tête est
toujours le sommaire arborescent avec visibilité sur toutes les parties et sous-parties du texte long. Ensuite, la navigation s'effectue par page lors du clic sur une partie,
cette page incluant une navigation de type ancrage. Chaque page contient donc
une navigation par ancre ainsi qu'une icône en haut à gauche permettant le
retour à la partie directement parente.
Nous allons détaillés maintenant la navigation de la partie I de la maquette.
Ci-dessous, nous avons
donc comme point d'entrée le sommaire général du texte long à navigation par titre :
Le clic sur la première partie génère l'affichage ci-dessous avec un sommaire à navigation par ancre puis un retour à ce sommaire par
icône de retour. L'icône présente en haut à droite permet le retour au sommaire général.
Ensuite, le clic sur la première sous partie génère l'affichage ci-dessous. Il n'y a plus de sommaire car il n'y a plus de sous partie. L'icône en
haut à droite permet toujours le retour à la partie parente du texte long.
Date: 25/10/2005
Version: 1.1
Auteur: Ministère des Affaires Etrangères, Aubay SA, Steve Péguet
Sommaire des Classes
|
ObjectTexteLong |
La classe «ObjectTexteLong» est la classe permettant de gérer le composant Texte Long. |
ComposantTexteLong |
La classe «ComposantTexteLong» est la classe permettant de décrire l'objet associé à un Texte Long. |
Sommaire des Fonctions Globales
|
static void
|
affiche(<String_Obligatoire> block)
|
static void
|
ComposantTexteLong_constructor()
La fonction «ComposantTexteLong_constructor()»; permet la configuration des éléments de l'objet de gestion
d'un DOM ComposantTexteLong lors de son instanciation.
|
static Array_ObjectTexteLong
|
CreerSousTitre(<XMLObjectSauvegarde_Obligatoire> XMLDoc)
La fonction globale «CreerSousTitre(XMLDoc)» permet de créer le tableau javascript qui représente le composant
Texte Long.
|
static void
|
gestion_block_recursif(<Array_ObjectTexteLong_Obligatoire> Tableau, <String_Obligatoire> block, <int_Obligatoire> IdNiveau, <int_Obligatoire> Appel)
La fonction globale «gestion_block_recursif(Tableau, block, IdNiveau, Appel)» permet de gérer l'affichage
du texte du titre cliqué : passage de police gras à normal et affichage/désaffichage du bloc
de texte correspondant.
|
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