Visualisation d'une page Webjax
Control.Slider (class)
Si vous suivez l'ordre de présentation de la librairie Scriptaculous, vous avez pu prendre connaissance de la documentation sur Control.
Nous nous intéressons dans cette page à la définition de la seule classe présente pour le moment au sein de Control à savoir Control.Slider .
Le tableau ci après liste les méthodes présentes au sein de la classe Control.Slider :
Le tableau ci après liste les méthodes présentes au sein de la classe Control.Slider :
Méthode
Type
Arguments
Détails
initialize ( curseur , barre , options )
constructor
curseur : id DOM de l'élément servant de curseur (ndr :
un élément 'div', 'span' ou autre par exemple.
barre : id DOM de l'élément servant de curseur (ndr :
un élément 'div', 'span' ou autre par exemple.
options : objet d'options (ndr : voir page
Control.Slider.options pour plus de détails ).
Cet objet précise des paramètres pour la mise en place du slider.
Cette méthode est la méthode appelée lorsque le code trouve un
Control.Slider . Cette méthode contient tout le code et les appels de
fonctions nécessaires à la mise en place du slider.
dispose ()
private
aucun argument.
Méthode qui semble arrêter nombre de handlers/listeners d'événements.
setDisabled ()
private
aucun argument.
Méthode qui permet de valoriser l'attribut Control.Slider.disabled à 'true'.
setEnabled ()
private
aucun argument.
Contraire de la méthode setDisabled(), cette méthode permet de
valoriser la propriété Control.Slider.disabled à 'false'.
getNearestValues ( valeur )
private
valeur : valeur à tester et utiliser pour récupérer
les valeurs les plus proches.
La méthode permet de retourner une valeur en fonction d'une
valeur passée en argument.
La méthode se base sur un sous objet
Control.Slider.allowedValues pour effectuer les tests et déterminer
la valeur retournée qui peut être l'une des limites (ndr : en anglais
'range') de l'objet représentant les limites de valeurs fixes.
setValue ( valeurSlider , handleIdx )
private
valeurSlider : valeur en cours pour le curseur (ndr : nécessite confirmation)
handleIdx :
Méthode qui permet de changer la valeur dans un Control.Slider .
Cette méthode
est sans aucun doute appelée lorsque le curseur est déplacé ou qu'une fonction/méthode modifie la valeur du curseur.
setValueBy ( delta , handleIdx )
private
delta :
handleIdx :
Méthode qui permet d'utiliser setValue() en utilisant un paramètre 'delta'.
translateToPx ( valeur )
private
valeur : valeur à transformer en une valeur exprimée en pixels
Méthode qui permet de transformer une valeur passée en argument
en valeur exprimée en pixels.
05/01/07 :: précision à faire du type
de valeur tranmis à la méthode.
translateToValue ( valeurOffset )
private
valeurOffset :
Méthode qui permet de transformer une valeur de type 'offset' en
une valeur possiblement décimale.
getRange ( range )
private
range : valeur numérique transmise.
Est utilisée pour préciser un indice spécifiant les limites
de l'intervalle de valeurs renvoyé.
Méthode qui renvoit un objet via $R, objet contenant un intervalle
de valeurs dépendant de la valeur de 'range' et d'un tableau de valeurs trié
par la méthode Prototype.K qui rappellons le renvoit uniquement l'argument qu'on
lui a transmis.
minimumOffset ( )
private
aucun argument.
05/01/07 :: mise à jour à effectuer
maximumOffset ()
private
aucun argument
Méthode en relation avec la précédent qui permet surement de gérer
les limites graphiques du curseur en fonction de la page ou d'autres contraintes.
05/01/07 :: mise à jour à faire
isVertical ()
private
aucun argument.
Méthode qui répond à la question 'est on en présence d'un axe vertical ?'
La valeur retournée est booléenne selon que Control.Slider.axis égal 'vertical' ou non.
drawSpans ()
private
aucun argument.
05/01/07 :: mise à jour à faire
setSpan ( span , range )
private
span : objet correspond à un élément 'span' dont on modifie
les propriétés CSS
range : objet de type Range ou intervalle de valeurs
La méthode modifie les propriétés CSS de l'objet 'span' selon
la nature de l'axe (ndr : voir dans cette page isVertical() ).
updateStyles ()
private
aucun argument.
Méthode qui permet de mettre à jour les éléments avec le style 'selected'.
La méthode supprime et crée des associations avec 'selected'.
startDrag ( event )
private
event : objet Event
Méthode qui permet de lancer un déplacement en relation avec objet
Event transmis.
05/01/07 :: mise à jour à faire
update ( event )
private
event : objet Event
Méthode qui est appelée lorsque la souris bouge ;-)
Cette méthode semble corriger un défaut sous Apple.
05/01/07 : mise à jour à faire.
draw ( event )
private
event : objet Event
Méthode appellée depuis update().
Méthode qui travaille sur la
position du pointeur de la souris et sur les valeurs offSet.
05/01/07 : mise à jour à faire
endDrag ( event )
private
event : objet Event
Méthode appelée lorsque la souris est relâchée.
Cette méthode
appelle finishDrag() et arrête l'événement en cours.
05/01/07 : mise à jour à faire
finishDrag ( event , boolean )
private
event : objet Event
boolean : valeur 'true'
Méthode qui est appelée par endDrag() .
Cette méthode cloture
un événement notamment en valorisant Control.Slider.active à 'false' et 'Control.Slider.dragging' à 'false'.
Cette méthode se termine sur l'appel de
updateFinished() (ndr : voir ci après).
udpateFinished ( )
private
aucun argument.
Si tout est ok (ndr : test à décrire avec précision), on valorise
Control.Slider.event à 'null'.
Le tableau ci après présente les propriétés d'un Control.Slider :
Propriété
Type
Défaut
Description
track
id DOM (String) ou DOM Object
''
Element DOM qui correspond à la barre
de défilement du Control.Slider.
options
Object
{}
Objet d'options décrite dans la page Webjax
Control.Slider.options
axis
String
'horizontal'
Soit l'axe a été défini dans l'objet 'options'
passé en argument et la valeur correspond à celle transmise, soit la valeur par défaut est 'horizontal'
increment
Number
1
Cette valeur peut être définie dans Control.Slider.options.
Par défaut l'incrémentation de valeurs sur le slider est donc de 1 .
step
Number
1
Cette valeur peut avoir été défini dans l'objet d'options transmis.
range
Object Range
{0;1}
Objet dit 'intervalle de valeurs' qui peut avoir été défini dans l'appel Control.Slider().
Cet intervalle définit les limites en terme de valeurs du Control.Slider .
value
Number
0
compatibilité ascendante
values
Utilise Control.Slider.handles.map()
05/01/07 : mise à jour à faire.
spans
false
Des éléments DOM peuvent avoir été précisé dans les options lors de l'appel.
Cette propriété les représente s'ils existent effectivement.
restricted
Boolean
false
La valeur booléenne peut avoir été précisé lors de l'appel.
maximum
Number
1
Est valorisé soit par Control.Slider.options.maximum soit par la valeur 'end' de Control.Slider.range .
minimum
Number
0
Est valorisé par Control.Slider.options.minimum soit par la valeur 'start' de Control.Slider.range .
alignX
Number
0
Valeur qui permet d'aider à l'alignement du curseur sur la barre si nécessaire.
alignY
Number
0
Valeur qui permet d'aider à aligner le curseur sur la barre si nécessaire.
trackLength
Number
undefined
Résultat d'une soustraction entre Control.Slider.maximumOffset() et Control.Slider.minimumOffset()
handleLength
active
Boolean
false
Le Control.Slider est il actif ?
dragging
Boolean
false
Un déplacement est-il en cours au sein du Control.Slider ?
disabled
Boolean
false
Le Control.Slider est il actuellement désactivé
allowedValues
Tableau de valeurs autorisées (ndr, 05/01/07 : à décrire)
eventMouseDown
Permet de définir le listener de click souris non relaché.
eventMouseUp
Permet de définir le listener click de souris relaché.
eventMouseMove
Permet de définir le listerner de mouvement de souris
initialized
Boolean
true
Valorisée à 'true' à la fin de Control.Slider.initialize()
Nous nous intéressons dans cette page à la définition de la seule classe présente pour le moment au sein de Control à savoir Control.Slider .
Le tableau ci après liste les méthodes présentes au sein de la classe Control.Slider :
Le tableau ci après liste les méthodes présentes au sein de la classe Control.Slider :
| Méthode | Type | Arguments | Détails |
| initialize ( curseur , barre , options ) | constructor |
curseur : id DOM de l'élément servant de curseur (ndr :
un élément 'div', 'span' ou autre par exemple.
barre : id DOM de l'élément servant de curseur (ndr : un élément 'div', 'span' ou autre par exemple. options : objet d'options (ndr : voir page Control.Slider.options pour plus de détails ). Cet objet précise des paramètres pour la mise en place du slider. |
Cette méthode est la méthode appelée lorsque le code trouve un Control.Slider . Cette méthode contient tout le code et les appels de fonctions nécessaires à la mise en place du slider. |
| dispose () | private | aucun argument. | Méthode qui semble arrêter nombre de handlers/listeners d'événements. |
| setDisabled () | private | aucun argument. | Méthode qui permet de valoriser l'attribut Control.Slider.disabled à 'true'. |
| setEnabled () | private | aucun argument. | Contraire de la méthode setDisabled(), cette méthode permet de valoriser la propriété Control.Slider.disabled à 'false'. |
| getNearestValues ( valeur ) | private | valeur : valeur à tester et utiliser pour récupérer les valeurs les plus proches. |
La méthode permet de retourner une valeur en fonction d'une
valeur passée en argument. La méthode se base sur un sous objet Control.Slider.allowedValues pour effectuer les tests et déterminer la valeur retournée qui peut être l'une des limites (ndr : en anglais 'range') de l'objet représentant les limites de valeurs fixes. |
| setValue ( valeurSlider , handleIdx ) | private |
valeurSlider : valeur en cours pour le curseur (ndr : nécessite confirmation)
handleIdx : |
Méthode qui permet de changer la valeur dans un Control.Slider . Cette méthode est sans aucun doute appelée lorsque le curseur est déplacé ou qu'une fonction/méthode modifie la valeur du curseur. |
| setValueBy ( delta , handleIdx ) | private |
delta :
handleIdx : |
Méthode qui permet d'utiliser setValue() en utilisant un paramètre 'delta'. |
| translateToPx ( valeur ) | private | valeur : valeur à transformer en une valeur exprimée en pixels |
Méthode qui permet de transformer une valeur passée en argument
en valeur exprimée en pixels. 05/01/07 :: précision à faire du type de valeur tranmis à la méthode. |
| translateToValue ( valeurOffset ) | private | valeurOffset : | Méthode qui permet de transformer une valeur de type 'offset' en une valeur possiblement décimale. |
| getRange ( range ) | private |
range : valeur numérique transmise. Est utilisée pour préciser un indice spécifiant les limites de l'intervalle de valeurs renvoyé. |
Méthode qui renvoit un objet via $R, objet contenant un intervalle de valeurs dépendant de la valeur de 'range' et d'un tableau de valeurs trié par la méthode Prototype.K qui rappellons le renvoit uniquement l'argument qu'on lui a transmis. |
| minimumOffset ( ) | private | aucun argument. | 05/01/07 :: mise à jour à effectuer |
| maximumOffset () | private | aucun argument |
Méthode en relation avec la précédent qui permet surement de gérer
les limites graphiques du curseur en fonction de la page ou d'autres contraintes.
05/01/07 :: mise à jour à faire |
| isVertical () | private | aucun argument. |
Méthode qui répond à la question 'est on en présence d'un axe vertical ?'
La valeur retournée est booléenne selon que Control.Slider.axis égal 'vertical' ou non. |
| drawSpans () | private | aucun argument. | 05/01/07 :: mise à jour à faire |
| setSpan ( span , range ) | private |
span : objet correspond à un élément 'span' dont on modifie
les propriétés CSS
range : objet de type Range ou intervalle de valeurs |
La méthode modifie les propriétés CSS de l'objet 'span' selon la nature de l'axe (ndr : voir dans cette page isVertical() ). |
| updateStyles () | private | aucun argument. |
Méthode qui permet de mettre à jour les éléments avec le style 'selected'.
La méthode supprime et crée des associations avec 'selected'. |
| startDrag ( event ) | private | event : objet Event |
Méthode qui permet de lancer un déplacement en relation avec objet
Event transmis. 05/01/07 :: mise à jour à faire |
| update ( event ) | private | event : objet Event |
Méthode qui est appelée lorsque la souris bouge ;-) Cette méthode semble corriger un défaut sous Apple. 05/01/07 : mise à jour à faire. |
| draw ( event ) | private | event : objet Event |
Méthode appellée depuis update(). Méthode qui travaille sur la position du pointeur de la souris et sur les valeurs offSet. 05/01/07 : mise à jour à faire |
| endDrag ( event ) | private | event : objet Event |
Méthode appelée lorsque la souris est relâchée. Cette méthode appelle finishDrag() et arrête l'événement en cours. 05/01/07 : mise à jour à faire |
| finishDrag ( event , boolean ) | private |
event : objet Event
boolean : valeur 'true' |
Méthode qui est appelée par endDrag() . Cette méthode cloture un événement notamment en valorisant Control.Slider.active à 'false' et 'Control.Slider.dragging' à 'false'. Cette méthode se termine sur l'appel de updateFinished() (ndr : voir ci après). |
| udpateFinished ( ) | private | aucun argument. | Si tout est ok (ndr : test à décrire avec précision), on valorise Control.Slider.event à 'null'. |
Le tableau ci après présente les propriétés d'un Control.Slider :
| Propriété | Type | Défaut | Description |
| track | id DOM (String) ou DOM Object | '' | Element DOM qui correspond à la barre de défilement du Control.Slider. |
| options | Object | {} | Objet d'options décrite dans la page Webjax Control.Slider.options |
| axis | String | 'horizontal' | Soit l'axe a été défini dans l'objet 'options' passé en argument et la valeur correspond à celle transmise, soit la valeur par défaut est 'horizontal' |
| increment | Number | 1 | Cette valeur peut être définie dans Control.Slider.options. Par défaut l'incrémentation de valeurs sur le slider est donc de 1 . |
| step | Number | 1 | Cette valeur peut avoir été défini dans l'objet d'options transmis. |
| range | Object Range | {0;1} | Objet dit 'intervalle de valeurs' qui peut avoir été défini dans l'appel Control.Slider(). Cet intervalle définit les limites en terme de valeurs du Control.Slider . |
| value | Number | 0 | compatibilité ascendante |
| values | Utilise Control.Slider.handles.map() 05/01/07 : mise à jour à faire. |
||
| spans | false | Des éléments DOM peuvent avoir été précisé dans les options lors de l'appel. Cette propriété les représente s'ils existent effectivement. |
|
| restricted | Boolean | false | La valeur booléenne peut avoir été précisé lors de l'appel. |
| maximum | Number | 1 | Est valorisé soit par Control.Slider.options.maximum soit par la valeur 'end' de Control.Slider.range . |
| minimum | Number | 0 | Est valorisé par Control.Slider.options.minimum soit par la valeur 'start' de Control.Slider.range . |
| alignX | Number | 0 | Valeur qui permet d'aider à l'alignement du curseur sur la barre si nécessaire. |
| alignY | Number | 0 | Valeur qui permet d'aider à aligner le curseur sur la barre si nécessaire. |
| trackLength | Number | undefined | Résultat d'une soustraction entre Control.Slider.maximumOffset() et Control.Slider.minimumOffset() |
| handleLength | |||
| active | Boolean | false | Le Control.Slider est il actif ? |
| dragging | Boolean | false | Un déplacement est-il en cours au sein du Control.Slider ? |
| disabled | Boolean | false | Le Control.Slider est il actuellement désactivé |
| allowedValues | Tableau de valeurs autorisées (ndr, 05/01/07 : à décrire) | ||
| eventMouseDown | Permet de définir le listener de click souris non relaché. | ||
| eventMouseUp | Permet de définir le listener click de souris relaché. | ||
| eventMouseMove | Permet de définir le listerner de mouvement de souris | ||
| initialized | Boolean | true | Valorisée à 'true' à la fin de Control.Slider.initialize() |
: 05/01/2007 20:33:06 | 
: Scriptaculous.js, Scriptaculous, Control.Slider, Slider, rootClass, XHTML, XML, DOM, Slider, Graphique, 
