Flash CS4 Professional ActionScript 2.0

Classe ScrollPane

Héritage MovieClip > Classe UIObject > Classe UIComponent > View > ScrollView > ScrollPane

Nom de classe ActionScript mx.containers.ScrollPane

Les propriétés de la classe ScrollPane permettent d'effectuer les opérations suivantes au moment de l'exécution : définir le contenu, contrôler la progression du chargement et régler la quantité d'informations à faire défiler.

La définition d'une propriété de la classe ScrollPane avec ActionScript annule le paramètre du même nom défini dans l'inspecteur des propriétés ou des composants.

Vous pouvez configurer un panneau défilant de façon à ce que les utilisateurs puissent y faire défiler le contenu. Pour ce faire, définissez la propriété scrollDrag sur true ; un curseur en forme de main apparaît sur le contenu. Contrairement à la plupart des autres composants, les événements sont diffusés lorsque le bouton de la souris est enfoncé et continuent à diffuser jusqu'à ce que l'utilisateur relâche le bouton de la souris. Si le contenu d'un panneau défilant comporte des arrêts de tabulation valides, vous devez définir scrollDrag sur false sinon chaque interaction de la souris avec les contenus invoquera le déplacement par défilement.

Toutes les classes de composants ont une propriété version qui correspond à une propriété de classe. Les propriétés de classe ne sont disponibles que pour la classe elle-même. La propriété version renvoie une chaîne qui indique la version du composant. Pour accéder à cette propriété, utilisez le code suivant :

trace(mx.containers.ScrollPane.version);

REMARQUE

 

Le code trace(myScrollPaneInstance.version); renvoie undefined.

Méthodes de la classe ScrollPane

Le tableau suivant répertorie les méthodes de la classe ScrollPane.

Méthode

Description

ScrollPane.getBytesLoaded()

Renvoie le nombre d'octets du contenu chargé.

ScrollPane.getBytesTotal()

Renvoie le nombre total d'octets du contenu à charger.

ScrollPane.refreshPane()

Recharge le contenu du panneau défilant (mais ne redessine pas la barre de défilement).

Méthodes héritées de la classe UIObject

Le tableau suivant répertorie les méthodes de la classe ScrollPane héritées de la classe UIObject. Lors de l'appel à ces méthodes depuis l'objet ScrollPane, utilisez le formulaire ScrollPaneInstance.methodName.

Méthode

Description

UIObject.createClassObject()

Crée un objet dans la classe spécifiée.

UIObject.createObject()

Crée un sous-objet dans un objet.

UIObject.destroyObject()

Détruit une occurrence de composant.

UIObject.doLater()

Appelle une fonction lorsque les paramètres ont été définis dans les inspecteurs des propriétés et des composants.

UIObject.getStyle()

Obtient la propriété de style de l'objet ou de la déclaration
de style.

UIObject.invalidate()

Marque l'objet de sorte qu'il soit redessiné dans le prochain intervalle d'image.

UIObject.move()

Déplace l'objet à l'emplacement demandé.

UIObject.redraw()

Force la validation de l'objet pour qu'il soit dessiné dans l'image active.

UIObject.setSize()

Redimensionne l'objet à la taille demandée.

UIObject.setSkin()

Définit une enveloppe dans l'objet.

UIObject.setStyle()

Définit la propriété de style sur l'objet ou la déclaration
de style.

Méthodes héritées de la classe UIComponent

Le tableau suivant répertorie les méthodes de la classe ScrollPane héritées de la classe UIComponent. Lors de l'appel à ces méthodes depuis l'objet ScrollPane, utilisez le formulaire ScrollPaneInstance.methodName.

Méthode

Description

UIComponent.getFocus()

Renvoie une référence à l'objet ayant le focus.

UIComponent.setFocus()

Attribue le focus à l'occurrence de composant.

Propriétés de la classe ScrollPane

Le tableau suivant répertorie les propriétés de la classe ScrollPane.

Méthode

Description

ScrollPane.content

Référence au contenu chargé dans le panneau défilant (lecture seule).

ScrollPane.contentPath

Chaîne indiquant une URL absolue ou relative du fichier SWF ou JPEG à charger dans le panneau défilant, ou qui correspond à l'identifiant de liaison d'un clip dans la bibliothèque du document en cours.

ScrollPane.hLineScrollSize

Quantité de contenu à faire défiler horizontalement lorsque vous cliquez sur un bouton fléché.

ScrollPane.hPageScrollSize

Quantité de contenu à faire défiler horizontalement lorsque vous cliquez sur le rail de défilement.

ScrollPane.hPosition

Position horizontale (en pixels) de la barre de défilement horizontale du panneau défilant.

ScrollPane.hScrollPolicy

Etat de la barre de défilement horizontale. Elle peut être toujours activée ("on"), toujours désactivée ("off") ou disponible en fonction des besoins ("auto"). La valeur par défaut est "auto".

ScrollPane.scrollDrag

Indique si le défilement a lieu (true) ou non (false) lorsqu'un utilisateur fait glisser du contenu dans le panneau défilant.
La valeur par défaut est  false.

ScrollPane.vLineScrollSize

Quantité de contenu à faire défiler verticalement lorsque vous cliquez sur un bouton fléché.

ScrollPane.vPageScrollSize

Quantité de contenu à faire défiler verticalement lorsque vous cliquez sur le rail de défilement.

ScrollPane.vPosition

Position horizontale (en pixels) de la barre de défilement verticale du panneau défilant.

ScrollPane.vScrollPolicy

Etat de la barre de défilement verticale. Elle peut être toujours activée ("on"), toujours désactivée ("off") ou disponible en fonction des besoins ("auto"). La valeur par défaut est "auto".

Propriétés héritées de la classe UIObject

Le tableau suivant répertorie les propriétés de la classe ScrollPane héritées de la classe UIObject. Lors de l'appel à ces propriétés depuis l'objet ScrollPane, utilisez le formulaire ScrollPaneInstance.propertyName.

Propriété

Description

UIObject.bottom

Lecture seule ; position du bord inférieur de l'objet par rapport au bord inférieur de son parent.

UIObject.height

Lecture seule ; hauteur de l'objet, en pixels.

UIObject.left

Lecture seule ; bord gauche de l'objet, en pixels.

UIObject.right

Lecture seule ; position du bord droit de l'objet par rapport au bord droit de son parent.

UIObject.scaleX

Nombre indiquant le facteur de redimensionnement dans la direction x de l'objet par rapport à son parent.

UIObject.scaleY

Nombre indiquant le facteur de redimensionnement dans la direction y de l'objet par rapport à son parent.

UIObject.top

Lecture seule ; renvoie la position du bord supérieur de l'objet par rapport à son parent.

UIObject.visible

Valeur booléenne indiquant si l'objet est visible (true) ou non (false).

UIObject.width

Lecture seule ; largeur de l'objet, en pixels.

UIObject.x

Lecture seule ; bord gauche de l'objet, en pixels.

UIObject.y

Lecture seule ; bord supérieur de l'objet, en pixels.

Propriétés héritées de la classe UIComponent

Le tableau suivant répertorie les propriétés de la classe ScrollPane héritées de la classe UIComponent. Lors de l'appel à ces propriétés depuis l'objet ScrollPane, utilisez le formulaire ScrollPaneInstance.propertyName.

Propriété

Description

UIComponent.enabled

Indique si le composant peut recevoir le focus et la saisie.

UIComponent.tabIndex

Nombre indiquant l'ordre de tabulation pour un composant dans un document.

Evénements de la classe ScrollPane

Le tableau suivant répertorie les événements de la classe ScrollPane.

Evénement

Description

ScrollPane.complete

Diffusé lorsque le contenu du panneau défilant est chargé.

ScrollPane.progress

Diffusé lorsque le contenu du panneau défilant est en cours de chargement.

ScrollPane.scroll

Diffusé lorsque vous cliquez sur la barre de défilement.

Evénements hérités de la classe UIObject

Le tableau suivant répertorie les événements de la classe ScrollPane hérités de la classe UIObject.

Evénement

Description

UIObject.draw

Diffusé lorsqu'un objet est sur le point de dessiner ses graphiques.

UIObject.hide

Diffusé lorsqu'un objet passe de l'état visible à l'état invisible.

UIObject.load

Diffusé lorsque des sous-objets sont créés.

UIObject.move

Diffusé lorsque l'objet a été déplacé.

UIObject.resize

Diffusé lorsqu'un objet a été redimensionné.

UIObject.reveal

Diffusé lorsqu'un objet passe de l'état invisible à l'état visible.

UIObject.unload

Diffusé lorsque les sous-objets sont purgés.

Evénements hérités de la classe UIComponent

Le tableau suivant répertorie les événements de la classe ScrollPane hérités de la classe UIComponent.

Evénement

Description

UIComponent.focusIn

Diffusé lorsqu'un objet reçoit le focus.

UIComponent.focusOut

Diffusé lorsqu'un objet perd le focus.

UIComponent.keyDown

Diffusé lorsqu'une touche est enfoncée.

UIComponent.keyUp

Diffusé lorsqu'une touche est relâchée.