Framework JavaScript ACube V2.10.0
 

Framework JavaScript ACube V2.10.0

Ce document est l' API de Spécification du Framework JavaScript ACube V2.10.0.

Résumé

Résumé du projet

Ce logiciel est un programme informatique servant de framework JavaScript basé sur les normes W3C (XHTML/CSS/DOM/XML). Il offre la possibilité de mettre en œuvre facilement les principes ergonomiques et techniques propres à un client riche (cumul des avantages du client léger et du client lourd).
Le framework Javascript ACube est entièrement AJAX Compliant.

Ce logiciel est régi par la licence CeCILL soumise au droit français et respectant les principes de diffusion des logiciels libres. Vous pouvez utiliser, modifier et/ou redistribuer ce programme sous les conditions de la licence CeCILL V2 telle que diffusée par le CEA, le CNRS et l'INRIA sur le site "http://www.cecill.info".

1- Présentation des principes du Framework JavaScript ACUBE

2- Prérequis sur le JavaScript ACUBE et la JS Documentation
: Topo sur la modélisation Objet : niveaux de visibilité (privé, publique) ..., sur la  typologie des arguments (obligatoires, optionnels, facultatifs)..., sur la structure de la JSDoc


1- Présentation des principes du Framework JavaScript ACUBE

Frameworks client riche W3C

Découpage du framework ergonomique JavaScript client riche
Découpage du framework ergonomique JavaScript client riche

Cette figure présente une description structurelle du framework ergonomique à implémenter.

Ce découpage du framework ergonomique en plusieurs frameworks JavaScript a pour objectif de répondre à deux besoins de développement :

C’est dans cette optique que ce découpage suit le principe de « poupées russes » pour découpler et surcharger les frameworks répondant aux problématiques suivantes :

     L’implémentation du framework JavaScript ACUBE est conforme aux normes W3C et MAE de développement des client léger et client riche.


2- Prérequis sur le JavaScript ACUBE et la JS Documentation

La JS Documentation décrit l’ensemble de l’implémentation des différents frameworks en JavaScript, ergonomiques et techniques, mis à la disposition des développeurs.

MODELISATION

La modélisation des différents frameworks est basée sur une description sous forme de design patterns (patterns « architecturaux »). Ces patterns sont dédiés à la schématisation d’une architecture logicielle présentée sous forme d’objets de conception logiciels comme des classes et des relations.
Le fait que le langage Javascript ne soit pas un langage objet n’empêche pas de modéliser les frameworks sous forme de diagramme de classe proche de la modélisation « UML ». Il est ainsi possible d’implémenter ces objets en JavaScript en définissant des nouveaux types, de leur associer des constructeurs et de leur
attribuer des méthodes et des propriétés. Les concepts d’héritage, de polymorphisme, de classe abstraite, etc… propres au langage objet sont simulés par le biais d’un contournement de cette implémentation propre au langage JavaScript.

Pour ces raisons, nous utiliserons la modélisation d’une classe de la manière suivante :
Classe générique pour un Objet
Classe générique pour un Objet

Les caractères « privé » ou « publique » des méthodes et des propriétés des classes sont indiqués à titre indicatif dans leurs cas d’utilisations. Le contrôle de ces caractéristiques n’est pas véritablement implémentable en JavaScript.


N.B :
  Dans la JSDoc, les caractères privés sont indiqués avec la mention <private>. Les caractères publiques ne portent pas de mention.



De même, les relations entre ces classes sont flêchées et la cardinalité indique le mode d’instanciation de la classe de destination dans la classe source :

Relation entre deux classes
Relation un-aire entre deux classes

Cette relation indique qu’une instanciation de l’ObjetB est effectué dans l’objetA et qu’elle sera contenue dans la propriété: propriété de A.

Relation entre deux classes
Relation binaire entre deux classes

Cette relation indique qu’une instanciation de l’ObjetB2 peut être effectué dans l’objetA2 et qu’elle sera contenue dans la propriété: propriété de A.

Relation entre deux classes
Relation n-aire entre deux classes

Cette relation indique que plusieurs instanciations de l’ObjetB3 peuvent être effectué dans l’objetA3 et qu’elle sera contenue dans la propriété de type tableau: propriété de A.

On peut donc en conclure que la valorisation de la cardinalité fournit des informations intéressantes :

> 0..1 : Indique qu’une des propriétés de l’ObjectA est un ObjectB et qu’elle est optionnelle.
> 1..1 : Indique qu’une des propriétés de l’ObjectA est un ObjectB et qu’elle est obligatoirement renseignée.
> 1..N : Indique qu’une propriétés de l’ObjectA est un tableau d’ObjectB et qu’il y existe au moins une instance.
> 0..N : Indique qu’une propriétés de l’ObjectA est un tableau d’ObjectB et qu’il n'y existe pas forcément une instance.

La relation d’héritage apparaît aussi dans la modélisation en utilisant une flêche évidée.

Cette relation indique que toute instance de ObjectB hérite des propriétés et méthodes de ObjectA.

Cette relation indique que toute instance de ObjectB4 hérite des propriétés et méthodes de ObjectA4.

RENDU IHM

Un rendu d’affichage par le biais de copie d’écran pour chaque élément, composant ou modèle de page est proposé pour illustrer leurs différents cas d’utilisation. Ainsi, plusieurs rendus peuvent être présentés lors de la déclinaison d’un élément, composant ou modèle de page en fonction d’un type particulier ou d’un effet dynamique déclenché.

DESCRIPTION DES CLASSES PRESENTES

Ce document explicite les classes nécessaires à l’utilisation de chaque framework en décrivant leurs propriétés et les prototypes d’appel de leurs méthodes. Ces prototypes permettent de spécifier les arguments associés à ces méthodes.

La typologie de leurs arguments suit la règle suivante :
> Argument obligatoire souligne la nécessité de renseigner l’argument pour que l’appel de la fonction se déroule correctement.
> Argument optionnel permet une valorisation de l’argument à « null » ou à blanc « "" ».
> Argument facultatif permet une omission du passage de l’argument dans le prototype d’appel.
N.B : Si un des arguments facultatifs doit être renseigné alors l’ensemble des arguments facultatifs précédents celui-ci doivent alors être considérés comme des arguments optionnels.


N.B :  Dans la JSDoc, la typologie des arguments des constructeurs des classes (voir lien CONSTR en entête des pages de description des classes) se présente de la manière suivante : <type_typologie>. Exemple : ElementListe ( <String_Obligatoire> id, <boolean_Obligatoire> boolNum, <XMLObjectSauvegarde_Optionnel> XMLObject).


EXEMPLES

Une illustration par des exemples d’implémentation est proposée pour une meilleure compréhension générale : Voir page Exemples.



Sommaire des Fichiers
ergonomique/fw_agenda.js Framework Agenda management
ergonomique/fw_aide.js Ce fichier Javascript correspond au framework de gestion du composant modèle de page d'aide.
ergonomique/fw_apropos.js Ce fichier Javascript correspond au framework de gestion du composant modèle de page A Propos.
ergonomique/fw_arborescence.js Ce fichier Javascript correspond au framework de gestion du composant Arborescence.
ergonomique/fw_calendrier.js Ce fichier Javascript correspond au framework de gestion des calendriers.
ergonomique/fw_canal_rss.js Ce fichier Javascript correspond au framework de gestion d'un canal RSS.
ergonomique/fw_captcha.js Framework Captcha gesture file.
ergonomique/fw_clavierVirtuel.js Ce fichier Javascript correspond au framework de gestion du composant 'clavier virtuel'
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.
ergonomique/fw_contentEditor.js Ce fichier Javascript correspond au framework de gestion du composant 'ContentEditor' : éditeur de contenu WYSIWIG.
ergonomique/fw_contentViewer.js Ce fichier Javascript correspond au framework de gestion du composant 'ContentViewer'.
ergonomique/fw_crossTab.js Framework CrossTab management
ergonomique/fw_erreur.js Ce fichier Javascript correspond au framework de gestion du composant modèle de page d'Erreur.
ergonomique/fw_formulaire_composant.js Ce fichier Javascript correspond aux éléments de formulaires plus élaborés, appelés composant car généralement composés de plusieurs éléments de formulaires.
ergonomique/fw_formulaire_default.js Ce fichier Javascript correspond à la base du framework de gestion des formulaires.
ergonomique/fw_formulaire_element.js Ce fichier Javascript correspond aux différents éléments simples retenus pour composer un formulaire.
ergonomique/fw_gestioncolonne.js Ce fichier Javascript correspond au framework de gestion des calendriers.
ergonomique/fw_liste.js Ce fichier Javascript correspond au framework de gestion des listes.
ergonomique/fw_navig_onglets.js Ce fichier Javascript correspond au framework de gestion de la navigation par onglet.
ergonomique/fw_navigation.js Ce fichier Javascript correspond au framework de gestion du composant Frameset.
ergonomique/fw_process_follow_up.js Framework Process follow up file.
ergonomique/fw_svg_chart.js This JavaScript file is a part of Framework FRED ACUBE.
ergonomique/fw_tableau.js Ce fichier Javascript correspond au framework de gestion des tableaux.
ergonomique/fw_tableur.js Ce fichier Javascript correspond au framework de gestion des tableur.
ergonomique/fw_textelong.js Ce fichier Javascript correspond au framework de gestion du texte long.
technique/fw_bulle.js Ce fichier Javascript correspond au framework bulle offrant un ensemble de fonctionnalités techniques pour gérer l'affichage de bulle.
technique/fw_catalog.js Framework Acube Component Catalog gesture.
technique/fw_cookies.js Ce fichier Javascript correspond au framework de gestion des cookies.
technique/fw_cs.js Ce fichier Javascript correspond au framework de gestion des contrôles de surface.
technique/fw_eventManager.js Technic framework : EventManager and UUID4 generator
technique/fw_form.js Ce fichier Javascript correspond au framework de gestion des formulaires.
technique/fw_format.js Ce fichier Javascript correspond au framework de gestion des mises en forme de données.
technique/fw_outils.js Ce fichier Javascript correspond au framework commun offrant un ensemble de fonctionnalités techniques regroupées sous forme de boîte à outils.
technique/fw_popup.js Ce fichier Javascript correspond au framework de gestion des pop-up.
technique/fw_popupinline.js Framework PopUpinLine gesture file.
technique/fw_request.js Ce fichier Javascript correspond au framework de gestion des requetes HTTP.
technique/fw_svg.js This JavaScript file is a part of Framework FRED ACUBE.
In particular to manage the SVG Component ComposantSVG
«ComposantSVG»class permits to define a SVG Inline component except for Internet Explorer.
technique/fw_xml.js Ce fichier Javascript correspond au framework de gestion des flux XML.

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