|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |
Object | +--ComposantTexteLong
La classe «ComposantTexteLong» est la classe permettant de décrire l'objet associé à un Texte Long.
Sa propriété publique décrit l' attribut du composant et peut être manipulé eou interrogée 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
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
Definie dans ergonomique/fw_textelong.js
Sommaire des Attributs | |
<private> String |
argc
L'élément «argc» dans la classe ComposantTexteLong 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 facultatifs, pour compter les paramètres soumis par le développeur). |
<private> String |
argv
L'élément «argv» dans la classe ComposantTexteLong 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 facultatifs, pour repérer les paramètres qui ont été soumis par le développeur). |
<private> String |
divBind
Propriété privée «divBind» - Zone dynamique (objet DOM HTML) associée au composant. |
<private> String |
id
Propriété privée «id» - ID du composant définit sous forme de chaîne de caractères. |
<private> String |
PdfUrl
Propriété privée «PdfUrl» - Chaîne de caractère précisant l'URL du fichier de rendu PDF pour le texte long. |
<private> boolean |
popup
Propriété privée «popup» - booléen permettant de proposer le visuel PDF à l'utilisateur dans une fenêtre. |
Array_ObjectTexteLong |
tabTitres
La propriété publique «tabTitres» est un tableau d'objets ObjectTexteLong reflétant l'ensemble des titres et/ou sous-titres présents dans le composant du texte long. |
Array_ObjectTexteLong |
tabTitreSuperieur
La propriété publique «tabTitresSuperieur» est un tableau d'objets ObjectTexteLong reflétant les titres supérieurs présents dans le composant du texte long - Valeur par défaut : Valeurs par défaut des Propriétés. |
<private> String |
type
Propriété privée «type» - Chaîne de caractères précisant le type de texte long désiré. |
<private> String |
VersionImprimable
Propriété privée «VersionImprimable» - Chaîne de caractère précisant l'URL de la page HTML pour le rendu imprimable et pour le texte long. |
<private> XMLObjectSauvegarde |
XMLObjectTexteLong
Propriété privée «XMLObjectTexteLong» - Objet de type XMLObjectSauvegarde référençant le flux XML intégrant le paramétrage du contenu informatif du composant. |
Sommaire des Constructeurs | |
ComposantTexteLong
(<String_Obligatoire> id, <String_Obligatoire> type, <String_Facultatif> PdfUrl, <String_Obligatoire> VersionImprimable, <boolean_Optionnel> popup, <XMLObjectSauvegarde_Optionnel> XMLObjectCont)
Crée une nouvelle instance de la classe ComposantTexteLong |
Sommaire des Méthodes | |
string
|
ecrireArboRecursif(TabSousTitresArbo, <int_Optionnel> IdNiveau)
La méthode publique «ecrireArboRecursif(TabSousTitresArbo, IdNiveau)» déclenche la génération de la partie récursive du code HTML associé au composant Texte Long Arborescent. |
void
|
ecrireBind()
La méthode publique «ecrireBind()» déclenche la génération du code HTML de la zone dynamique associée au composant. |
void
|
ecrireBindSousTitre(tableau)
La méthode publique «ecrireBindSousTitre()» déclenche la génération du code HTML des zoneq dynamique associée aux sous-titre du composant texte long. |
<private> string
|
ecrireComposantDomHTML()
Méthode privée «ecrireComposantDomHTML()» - Fonction interne renvoyant le code HTML associé au texte long avec navigation par ancre. |
<private> string
|
ecrireComposantDomHTML_Arbo()
Méthode privée «ecrireComposantDomHTML_Arbo()» - Fonction interne renvoyant le code HTML associé au texte long avec navigation par arborescence. |
<private> string
|
ecrireComposantDomHTML_Titre()
Méthode privée «ecrireComposantDOMHTML_Titre()» - Fonction interne renvoyant le code HTML associé au texte long avec navigation par titre. |
<private> string
|
ecrireSommaireAncreRecursif(<Array_ObjectTexteLong_Obligatoire> Tableau, <int_Obligatoire> IdNiveau)
Méthode privée «ecrireSommaireAncreRecursif()» - Cette fonction va générer récursivement le code HTML du sommaire contenant les liens vers les ancres dans la page. |
string
|
ecrireSousTitre(<Array_ObjectTexteLong> tabEcrireEval)
La méthode publique «ecrireTitre(tabEcrireEval)» déclenche la génération du code HTML associé au composantTexte Long par Titre. |
<private> string
|
ecrireTexteAncreRecursif(<Array_ObjectTexteLong_Obligatoire> Tableau, <int_Obligatoire> IdNiveau)
Méthode privée «ecrireTexteAncreRecursif()» - Cette fonction va générer récursivement le code HTML du corps de la page avec les liens de retour par icônes. |
string
|
ecrireTitre(<Array_ObjectTexteLong> tabEcrireEval)
La méthode publique «ecrireTitre(tabEcrireEval)» déclenche la génération du code HTML associé au composantTexte Long par Titre. |
<private> string
|
ecrireTitreCorpsSousTitreRecursif(<t_ObjectTexteLong_Obligatoire> tabEcrireEval, <int_Obligatoire> IdNiveau)
Méthode privée «ecrireCorpsSousTitreRecursif(tabEcrireEval, IdNiveau)» - Cette fonction génère la partie corps de page et est appelée juste après la fonction ecrireTitreSousTitreRecursif. |
<private> string
|
ecrireTitreDernierSousTitre(<Array_ObjectTexteLong_Obligatoire> tabEcrireEval, <ComposantTexteLong_Obligatoire> Appel)
Méthode privée «ecrireTitreDernierSousTitreRecursif(tabEcrireEval, Appel)» - Cette fonction génère le dernier type de page dans la navigation par titre du texte long. |
<private> string
|
ecrireTitreRecursif(<Array_ObjectTexteLong_Obligatoire> Tableau, <int_Obligatoire> IdNiveau, <int_Obligatoire> IdFonction)
Méthode privée «ecrireTitreRecursif(Tableau, IdNiveau, IdFonction)» - Cette fonction génère la première page de sommaire pour le texte long à navigation par titre et ce de manière récursive toujours. |
<private> string
|
ecrireTitreSousTitreRecursif(<Array_ObjectTexteLong_Obligatoire> tabEcrireEval, <int_Obligatoire> IdNiveau)
Méthode privée «ecrireSousTitreRecursif(tabEcrireEval, IdNiveau)» - Cette fonction s'occupe de la génération de l'en-tête (ou sommaire) des pages qui ont une page parente (titre ou sous-titre) et également des pages filles (détail des sous-titres). |
<private> void
|
iconeOut(<ObjectDOMHTML_Obligatoire> widget, <ObjectDOMHTML_Facultatif> Id)
La méthode privée «iconeOut(widget, Id)» implémente le traitement à exécuter sur l'évènement "onMouseOut" du composant Texte Long. |
<private> void
|
iconeOver(<ObjectDOMHTML_Obligatoire> widget, <ObjectDOMHTML_Facultatif> Id)
La méthode privée «iconeOver(widget, Id)» implémente le traitement à exécuter sur l'évènement "onMouseOver" du composant Texte Long. |
<private> void
|
initDivBind()
La méthode privée «initDivBind()» permet de spécifier un pointeur vers le DOM HTML de la zone dynamique gérant la présentation du contenu dynamique correspondant au texte long. |
<private> void
|
initTabByXML()
La méthode privée «initTabByXML()» permet de construire le tableau d'objets référençant l'ensemble des titres et sous-titres présents dans le texte long à partir d'un paramétrage effectué par un flux XML. |
void
|
setDivBind(<objetDOMHtml_Obligatoire> divBind)
La méthode publique «setDivBind(divBind)» permet d'associer une zone dynamique présente dans la page au composant. |
Détail des Attributs |
<private> String argc
<private> String argv
<private> String divBind
<private> String id
<private> String PdfUrl
<private> boolean popup
Array_ObjectTexteLong tabTitres
Array_ObjectTexteLong tabTitreSuperieur
<private> String type
<private> String VersionImprimable
<private> XMLObjectSauvegarde XMLObjectTexteLong
Détail des Constructeurs |
ComposantTexteLong(<String_Obligatoire> id, <String_Obligatoire> type, <String_Facultatif> PdfUrl, <String_Obligatoire> VersionImprimable, <boolean_Optionnel> popup, <XMLObjectSauvegarde_Optionnel> XMLObjectCont)
id - String_Obligatoire
: String indiquant l'id du composant à instancier. Sa valorisation doit correspondre au nom de la variable JavaScript du composant instancié.
type - String_Obligatoire
: String indiquant les types de Texte Long souhaités. Valeurs possibles : "titre", "arbo", "autre chaîne de caractère" (type ancre).
PdfUrl - String_Facultatif
: String indiquant l' URL du fichier PDF. Dans le cas d'une chaîne vide, le visuel Version Imprimable n'apparaît pas à l'utilisateur.
VersionImprimable - String_Obligatoire
: String indiquant l'URL du fichier HTML. Dans le cas d'une chaîne vide, le visuel Version Imprimable n'apparaît pas à l'utilisateur.
popup - boolean_Optionnel
: booléen permettant de proposer le visuel PDF à l'utilisateur dans une fenêtre.
XMLObjectCont - XMLObjectSauvegarde_Optionnel
XMLObject de type XMLObjectSauvegarde : pour paramétrer le contenu informatif.
tabTitres - t_ObjectTexteLong_Facultatif
tabTitresTableau d'objets ObjectTexteLong : pour paramétrer le contenu informatif en JavaScript si pas de flux XML pour effectuer ce paramétrage.
Détail des Méthodes |
string ecrireArboRecursif(TabSousTitresArbo, <int_Optionnel> IdNiveau)
IdNiveau - int_Optionnel
: Id de l'élément DOM HTML à afficher dans un niveau du composant Texte Long Arborescent.
Tableau - Array_ObjectDOMHTML_Obligatoire
des sous-titres du composant Texte Long à afficher en niveau.
void ecrireBind()
Aucun -
void ecrireBindSousTitre(tableau)
Aucun -
<private> string ecrireComposantDomHTML()
Aucun -
<private> string ecrireComposantDomHTML_Arbo()
Aucun -
<private> string ecrireComposantDomHTML_Titre()
Aucun -
<private> string ecrireSommaireAncreRecursif(<Array_ObjectTexteLong_Obligatoire> Tableau, <int_Obligatoire> IdNiveau)
Tableau - Array_ObjectTexteLong_Obligatoire
: Tableau d'objets référençant l'ensemble des titres et sous-titres présents dans le texte long.
IdNiveau - int_Obligatoire
: N° représentant le niveau du titre dans le texte long.
string ecrireSousTitre(<Array_ObjectTexteLong> tabEcrireEval)
tabEcrireEval - Array_ObjectTexteLong
: tableau d'objets ObjectTexteLong reflétant l'ensemble des titres présents dans le composant du texte long.
<private> string ecrireTexteAncreRecursif(<Array_ObjectTexteLong_Obligatoire> Tableau, <int_Obligatoire> IdNiveau)
Tableau - Array_ObjectTexteLong_Obligatoire
: Tableau d'objets référençant l'ensemble des titres et sous-titres présents dans le texte long.
IdNiveau - int_Obligatoire
: N° représentant le niveau du titre dans le corps de la page.
string ecrireTitre(<Array_ObjectTexteLong> tabEcrireEval)
tabEcrireEval - Array_ObjectTexteLong
: tableau d'objets ObjectTexteLong reflétant l'ensemble des titres présents dans le composant du texte long.
<private> string ecrireTitreCorpsSousTitreRecursif(<t_ObjectTexteLong_Obligatoire> tabEcrireEval, <int_Obligatoire> IdNiveau)
tabEcrireEval - t_ObjectTexteLong_Obligatoire
: Tableau d'objets référençant l'ensemble des titres et sous-titres présents dans le texte long.
IdNiveau - int_Obligatoire
: N° représentant le niveau du titre dans le corps de page.
<private> string ecrireTitreDernierSousTitre(<Array_ObjectTexteLong_Obligatoire> tabEcrireEval, <ComposantTexteLong_Obligatoire> Appel)
tabEcrireEval - Array_ObjectTexteLong_Obligatoire
: Tableau d'objets référençant l'ensemble des titres et sous-titres présents dans le texte long.
Appel - ComposantTexteLong_Obligatoire
: Objet ComposantTexteLong
<private> string ecrireTitreRecursif(<Array_ObjectTexteLong_Obligatoire> Tableau, <int_Obligatoire> IdNiveau, <int_Obligatoire> IdFonction)
Tableau - Array_ObjectTexteLong_Obligatoire
: Tableau d'objets référençant l'ensemble des titres et sous-titres présents dans le texte long.
IdNiveau - int_Obligatoire
: N° représentant le niveau du titre dans le sommaire.
IdFonction - int_Obligatoire
: N° représentant le niveau du sous-titre dans le sommaire.
<private> string ecrireTitreSousTitreRecursif(<Array_ObjectTexteLong_Obligatoire> tabEcrireEval, <int_Obligatoire> IdNiveau)
tabEcrireEval - Array_ObjectTexteLong_Obligatoire
: le Tableau d'objets référençant l'ensemble des titres et sous-titres présents dans le texte long.
IdNiveau - int_Obligatoire
: N° représentant le niveau du titre dans le sommaire.
<private> void iconeOut(<ObjectDOMHTML_Obligatoire> widget, <ObjectDOMHTML_Facultatif> Id)
widget - ObjectDOMHTML_Obligatoire
: Elément DOM HTML du composant Texte Long.
Id - ObjectDOMHTML_Facultatif
: Référence de l'élément icône à positionner.
<private> void iconeOver(<ObjectDOMHTML_Obligatoire> widget, <ObjectDOMHTML_Facultatif> Id)
widget - ObjectDOMHTML_Obligatoire
: Elément DOM HTML du composant Texte Long.
Id - ObjectDOMHTML_Facultatif
: Référence de l'élément icône à positionner.
<private> void initDivBind()
Aucun -
<private> void initTabByXML()
Aucun -
void setDivBind(<objetDOMHtml_Obligatoire> divBind)
divBind - objetDOMHtml_Obligatoire
Objet DOM HTML référençant la zone dynamique associée au composant.
|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |