Packagefl.events
Classepublic class ScrollEvent
HéritageScrollEvent Inheritance Event Inheritance Object

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9.0.28.0

La classe ScrollEvent définit l'événement de défilement qui est associé au composant ScrollBar.

Voir aussi

ScrollBar
ScrollBarDirection
UIComponent


Propriétés publiques
 PropriétéDéfini par
 Inheritedbubbles : Boolean
[lecture seule] Indique si un événement peut se propager vers le haut (bubbling).
Event
 Inheritedcancelable : Boolean
[lecture seule] Indique si le comportement associé à l'événement peut être annulé.
Event
 Inheritedconstructor : Object
Référence à l'objet de classe ou à la fonction constructeur d'une occurrence donnée d'un objet.
Object
 InheritedcurrentTarget : Object
[lecture seule] L'objet qui traite activement l'objet Event avec un écouteur d'événements.
Event
  delta : Number
[lecture seule] Récupère la taille du changement de la position du défilement, en pixels.
ScrollEvent
  direction : String
[lecture seule] Récupère une valeur constante qui indique la direction du mouvement associé à l'événement.
ScrollEvent
 InheritedeventPhase : uint
[lecture seule] Phase actuelle du flux d'événements.
Event
  position : Number
[lecture seule] Récupère la position actuelle du défilement, en pixels.
ScrollEvent
 Inheritedprototype : Object
[statique] Référence à l'objet prototype d'un objet de classe ou fonction.
Object
 Inheritedtarget : Object
[lecture seule] Cible de l'événement.
Event
 Inheritedtype : String
[lecture seule] Type d'événement.
Event
Méthodes publiques
 MéthodeDéfini par
  
ScrollEvent(direction:String, delta:Number, position:Number)
Crée un nouvel objet ScrollEvent avec les paramètres spécifiés.
ScrollEvent
  
Crée une copie de l'objet ScrollEvent et définit la valeur de chaque paramètre pour correspondre à l'original.
ScrollEvent
 Inherited
formatToString(className:String, ... arguments):String
Fonction d'un utilitaire permettant d'implémenter la méthode toString() dans des classes Event ActionScript 3.0 personnalisées.
Event
 Inherited
Indique si la propriété spécifiée d'un objet est définie.
Object
 Inherited
Vérifie si la méthode preventDefault() a été appelée pour l'événement.
Event
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l'objet spécifié en tant que paramètre.
Object
 Inherited
Annule le comportement par défaut d'un événement si cette opération est possible.
Event
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d'une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Bloque le traitement des écouteurs d'événement dans le nœud actuel et les suivants dans le flux d'événements.
Event
 Inherited
Bloque le traitement des écouteurs d'événement dans les nœuds qui suivent le nœud actuel dans le flux d'événements.
Event
  
Renvoie une chaîne contenant toutes les propriétés de l'objet ScrollEvent.
ScrollEvent
 Inherited
Renvoie la valeur primitive de l'objet spécifié.
Object
Constantes publiques
 ConstanteDéfini par
 InheritedACTIVATE : String = "activate"
[statique] La constante ACTIVATE définit la valeur de la propriété type d'un objet événement activate.
Event
 InheritedADDED : String = "added"
[statique] La constante Event.ADDED définit la valeur de la propriété type d'un objet événement added.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[statique] La constante Event.ADDED_TO_STAGE définit la valeur de la propriété type d'un objet d'événement addedToStage.
Event
 InheritedCANCEL : String = "cancel"
[statique] La constante Event.CANCEL définit la valeur de la propriété type d'un objet événement cancel.
Event
 InheritedCHANGE : String = "change"
[statique] La constante Event.CHANGE définit la valeur de la propriété type de l'objet d'événement change.
Event
 InheritedCLEAR : String = "clear"
[statique] La constante Event.CLEAR définit la valeur de la propriété type d'un objet événement clear.
Event
 InheritedCLOSE : String = "close"
[statique] La constante Event.CLOSE définit la valeur de la propriété type d'un objet événement close.
Event
 InheritedAIR-only CLOSING : String = "closing"
[statique] La constante Event.CLOSING définit la valeur de la propriété type d'un objet événement closing.
Event
 InheritedCOMPLETE : String = "complete"
[statique] La constante Event.COMPLETE définit la valeur de la propriété type d'un objet événement complete.
Event
 InheritedCONNECT : String = "connect"
[statique] La constante Event.CONNECT définit la valeur de la propriété type d'un objet événement connect.
Event
 InheritedCOPY : String = "copy"
[statique] Définit la valeur de la propriété type d'un objet d'événement copy.
Event
 InheritedCUT : String = "cut"
[statique] Définit la valeur de la propriété type d'un objet d'événement cut.
Event
 InheritedDEACTIVATE : String = "deactivate"
[statique] La constante Event.DEACTIVATE définit la valeur de la propriété type d'un objet événement deactivate.
Event
 InheritedDISPLAYING : String = "displaying"
[statique] La constante Event.DISPLAYING définit la valeur de la propriété type d'un objet événement displaying.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[statique] La constante Event.ENTER_FRAME définit la valeur de la propriété type d'un objet événement enterFrame.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[statique] La constante Event.EXIT_FRAME définit la valeur de la propriété type d'un objet événement exitFrame.
Event
 InheritedAIR-only EXITING : String = "exiting"
[statique] La constante Event.EXITING définit la valeur de la propriété type de l'objet d'événement exiting.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[statique] La constante Event.FRAME_CONSTRUCTED définit la valeur de la propriété type d'un objet événement frameConstructed.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[statique] La constante Event.FULL_SCREEN définit la valeur de la propriété type d'un objet événement fullScreen.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[statique] La constante Event.HTML_BOUNDS_CHANGE définit la valeur de la propriété type d'un objet événement htmlBoundsChange.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[statique] La constante Event.HTML_DOM_INITIALIZE définit la valeur de la propriété type d'un objet événement htmlDOMInitialize.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[statique] La constante Event.HTML_RENDER définit la valeur de la propriété type d'un objet événement htmlRender.
Event
 InheritedID3 : String = "id3"
[statique] La constante Event.ID3 définit la valeur de la propriété type d'un objet événement id3.
Event
 InheritedINIT : String = "init"
[statique] La constante Event.INIT définit la valeur de la propriété type d'un objet événement init.
Event
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[statique] La constante Event.LOCATION_CHANGE définit la valeur de la propriété type d'un objet événement locationChange.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[statique] La constante Event.MOUSE_LEAVE définit la valeur de la propriété type d'un objet événement mouseLeave.
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[statique] La constante Event.NETWORK_CHANGE définit la valeur de la propriété type d'un objet événement networkChange.
Event
 InheritedOPEN : String = "open"
[statique] La constante Event.OPEN définit la valeur de la propriété type d'un objet événement open.
Event
 InheritedPASTE : String = "paste"
[statique] La constante Event.PASTE définit la valeur de la propriété type d'un objet événement paste.
Event
 InheritedREMOVED : String = "removed"
[statique] La constante Event.REMOVED définit la valeur de la propriété type d'un objet événement removed.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[statique] La constante Event.REMOVED_FROM_STAGE définit la valeur de la propriété type d'un objet événement removedFromStage.
Event
 InheritedRENDER : String = "render"
[statique] La constante Event.RENDER définit la valeur de la propriété type d'un objet événement render.
Event
 InheritedRESIZE : String = "resize"
[statique] La constante Event.RESIZE définit la valeur de la propriété type d'un objet événement resize.
Event
  SCROLL : String = "scroll"
[statique] Définit la valeur de la propriété type d'un objet événement scroll.
ScrollEvent
 InheritedSELECT : String = "select"
[statique] La constante Event.SELECT définit la valeur de la propriété type d'un objet événement select.
Event
 InheritedSELECT_ALL : String = "selectAll"
[statique] La constante Event.SELECT_ALL définit la valeur de la propriété type d'un objet événement selectAll.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[statique] La constante Event.SOUND_COMPLETE définit la valeur de la propriété type d'un objet événement soundComplete.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[statique] La constante Event.TAB_CHILDREN_CHANGE définit la valeur de la propriété type d'un objet événement tabChildrenChange.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[statique] La constante Event.TAB_ENABLED_CHANGE définit la valeur de la propriété type d'un objet événement tabEnabledChange.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[statique] La constante Event.TAB_INDEX_CHANGE définit la valeur de la propriété type d'un objet événement tabIndexChange.
Event
 InheritedUNLOAD : String = "unload"
[statique] La constante Event.UNLOAD définit la valeur de la propriété type d'un objet événement unload.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[statique] La constante Event.USER_IDLE définit la valeur de la propriété type d'un objet événement userIdle.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[statique] La constante Event.USER_PRESENT définit la valeur de la propriété type d'un objet événement userPresent.
Event
Détails de la propriété
deltapropriété
delta:Number  [lecture seule]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9.0.28.0

Récupère la taille du changement de la position du défilement, en pixels. Une valeur positive indique que le défilement était orienté vers le bas ou la droite. Une valeur négative indique que le défilement était orienté vers le haut ou la gauche.



Implémentation
    public function get delta():Number
directionpropriété 
direction:String  [lecture seule]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9.0.28.0

Récupère une valeur constante qui indique la direction du mouvement associé à l'événement. Une valeur de ScrollBarDirection.HORIZONTAL indique un mouvement horizontal ; une valeur de ScrollBarDirection.VERTICAL indique un mouvement vertical.



Implémentation
    public function get direction():String

Voir aussi

positionpropriété 
position:Number  [lecture seule]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9.0.28.0

Récupère la position actuelle du défilement, en pixels.



Implémentation
    public function get position():Number
Détails du constructeur
ScrollEvent()Constructeur
public function ScrollEvent(direction:String, delta:Number, position:Number)

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9.0.28.0

Crée un nouvel objet ScrollEvent avec les paramètres spécifiés.

Paramètres
direction:String — Direction du mouvement associé à l'événement. Une valeur de ScrollBarDirection.HORIZONTAL indique un mouvement horizontal ; une valeur de ScrollBarDirection.VERTICAL indique un mouvement vertical.
 
delta:Number — Changement de la position du défilement, en pixels. Une valeur positive indique que le défilement était orienté vers le bas ou la droite. Une valeur négative indique que le défilement était orienté vers le haut ou la gauche.
 
position:Number — Position actuelle du défilement.
Détails de la méthode
clone()méthode
override public function clone():Event

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9.0.28.0

Crée une copie de l'objet ScrollEvent et définit la valeur de chaque paramètre pour correspondre à l'original.

Valeur renvoyée
Event — Nouvel objet ScrollEvent avec les mêmes valeurs de paramètres que l'original.
toString()méthode 
override public function toString():String

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9.0.28.0

Renvoie une chaîne contenant toutes les propriétés de l'objet ScrollEvent. La chaîne présente le format suivant :

[ScrollEvent type= valeur bubbles= valeur cancelable= valeur direction= valeur delta= valeur position= valeur]

Valeur renvoyée
String — Représentation sous forme de chaîne de l'objet ScrollEvent.
Détails de la constante
SCROLLConstante
public static const SCROLL:String = "scroll"

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9.0.28.0

Définit la valeur de la propriété type d'un objet événement scroll.

Les propriétés de cet événement sont les suivantes :

PropriétéValeur
bubbles false
cancelable false ; il n'existe aucun comportement par défaut à annuler.
currentTarget Objet qui traite activement l'objet de l'événement avec un écouteur d'événement.
delta 1 ; valeur indiquant la longueur du défilement effectué.
direction vertical ; direction de l'objet ScrollBar.
position 0 ; position du curseur de Scrollbar après son déplacement.
target Objet qui a distribué l'événement. La cible n'est pas toujours l'objet écoutant l'événement. Pour accéder à l'objet qui écoute l'événement, utilisez la propriété currentTarget.


Exemple

L'exemple suivant écoute l'événement scroll et fait appel à la propriété direction de la classe ScrollEvent pour déterminer si le contenu a fait l'objet d'un défilement horizontal ou vertical :
import fl.containers.ScrollPane;
import fl.events.ScrollEvent;
import fl.controls.ScrollBarDirection;

var myScrollPane:ScrollPane = new ScrollPane();
myScrollPane.scrollDrag = true;
myScrollPane.source = "http://www.helpexamples.com/flash/images/image1.jpg";
myScrollPane.addEventListener(ScrollEvent.SCROLL, scrollHandler);
addChild(myScrollPane);

function scrollHandler(event:ScrollEvent):void {
    switch (event.direction) {
        case ScrollBarDirection.HORIZONTAL:
            trace("horizontal scroll", event.position, "of", event.currentTarget.maxHorizontalScrollPosition);
            break;
        case ScrollBarDirection.VERTICAL:
            trace("vertical scroll", event.position, "of", event.currentTarget.maxVerticalScrollPosition);
            break;
    }
}