Referencia de ActionScript® 3.0 para la plataforma de Adobe® Flash®
Inicio  |  Ocultar lista de paquetes y clases |  Paquetes  |  Clases  |  Novedades  |  Índice  |  Apéndices  |  ¿Por qué hay texto en inglés?
Filtros: Recuperando datos del servidor...
Recuperando datos del servidor...
fl.events 

ScrollEvent  - AS3 Flash

Paquetefl.events
Clasepublic class ScrollEvent
HerenciaScrollEvent Inheritance Event Inheritance Object

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flash CS3
Versiones de motor de ejecución: Flash Player 9.0.28.0, AIR 1.0

La clase ScrollEvent define el evento de desplazamiento asociado al componente ScrollBar.

Elementos de API relacionados



Propiedades públicas
 PropiedadDefinido por
 Inheritedbubbles : Boolean
[solo lectura] Indica si un evento es un evento de propagación.
Event
 Inheritedcancelable : Boolean
[solo lectura] Indica si se puede evitar el comportamiento asociado al evento.
Event
 Inheritedconstructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.
Object
 InheritedcurrentTarget : Object
[solo lectura] Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
Event
  delta : Number
[solo lectura] Obtiene el tamaño del cambio en la posición de desplazamiento, expresado en píxeles.
ScrollEvent
  direction : String
[solo lectura] Obtiene un valor constante que indica la dirección del movimiento asociado al evento.
ScrollEvent
 InheritedeventPhase : uint
[solo lectura] La fase actual en el flujo del evento.
Event
  position : Number
[solo lectura] Obtiene la posición de desplazamiento actual, expresada en píxeles.
ScrollEvent
 Inheritedtarget : Object
[solo lectura] El destino del evento.
Event
 Inheritedtype : String
[solo lectura] El tipo de evento.
Event
Métodos públicos
 MétodoDefinido por
  
ScrollEvent(direction:String, delta:Number, position:Number)
Crea un nuevo objeto ScrollEvent con los parámetros especificados.
ScrollEvent
  
[override] Crea una copia del objeto ScrollEvent y define el valor de cada parámetro para que coincida con el original.
ScrollEvent
 Inherited
formatToString(className:String, ... arguments):String
Una función de utilidad para implementar el método toString() en las clases Event personalizadas de ActionScript 3.0.
Event
 Inherited
Indica si un objeto tiene definida una propiedad especificada.
Object
 Inherited
Comprueba si se ha llamado a preventDefault() en el evento.
Event
 Inherited
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.
Object
 Inherited
Cancela el comportamiento predeterminado de un evento si es posible cancelarlo.
Event
 Inherited
Indica si existe la propiedad especificada y si es enumerable.
Object
 Inherited
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.
Object
 Inherited
Impide el proceso de cualquier detector de eventos en el nodo actual y los nodos siguientes en el flujo del evento.
Event
 Inherited
Impide el proceso de cualquier detector de eventos en nodos siguientes al nodo actual.
Event
 Inherited
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.
Object
  
[override] Devuelve una cadena con todas las propiedades del objeto ScrollEvent.
ScrollEvent
 Inherited
Devuelve el valor simple del objeto especificado.
Object
Constantes públicas
 ConstanteDefinido por
  SCROLL : String = "scroll"
[estática] Define el valor de la propiedad type para un objeto de evento scroll.
ScrollEvent
Información sobre propiedades

delta

propiedad
delta:Number  [solo lectura]

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flash CS3
Versiones de motor de ejecución: Flash Player 9.0.28.0, AIR 1.0

Obtiene el tamaño del cambio en la posición de desplazamiento, expresado en píxeles. Valor positivo que indica que la dirección del desplazamiento ha sido hacia abajo o hacia la derecha. Valor negativo que indica que la dirección del desplazamiento ha sido hacia arriba o hacia la izquierda.



Implementación
    public function get delta():Number

direction

propiedad 
direction:String  [solo lectura]

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flash CS3
Versiones de motor de ejecución: Flash Player 9.0.28.0, AIR 1.0

Obtiene un valor constante que indica la dirección del movimiento asociado al evento. Un valor ScrollBarDirection.HORIZONTAL indica movimiento horizontal; un valor ScrollBarDirection.VERTICAL indica movimiento vertical.



Implementación
    public function get direction():String

Elementos de API relacionados

position

propiedad 
position:Number  [solo lectura]

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flash CS3
Versiones de motor de ejecución: Flash Player 9.0.28.0, AIR 1.0

Obtiene la posición de desplazamiento actual, expresada en píxeles.



Implementación
    public function get position():Number
Información sobre constructores

ScrollEvent

()Información sobre
public function ScrollEvent(direction:String, delta:Number, position:Number)

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flash CS3
Versiones de motor de ejecución: Flash Player 9.0.28.0, AIR 1.0

Crea un nuevo objeto ScrollEvent con los parámetros especificados.

Parámetros
direction:String — Dirección del movimiento asociado al evento. Un valor ScrollBarDirection.HORIZONTAL indica movimiento horizontal; un valor ScrollBarDirection.VERTICAL indica movimiento vertical.
 
delta:Number — Cambio en la posición de desplazamiento, expresado en píxeles. Valor positivo que indica que la dirección del desplazamiento ha sido hacia abajo o hacia la derecha. Valor negativo que indica que la dirección del desplazamiento ha sido hacia arriba o hacia la izquierda.
 
position:Number — Posición de desplazamiento actual.
Información sobre métodos

clone

()método
override public function clone():Event

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flash CS3
Versiones de motor de ejecución: Flash Player 9.0.28.0, AIR 1.0

Crea una copia del objeto ScrollEvent y define el valor de cada parámetro para que coincida con el original.

Valor devuelto
Event — Nuevo objeto ScrollEvent con valores de parámetros que coinciden con el original.

toString

()método 
override public function toString():String

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flash CS3
Versiones de motor de ejecución: Flash Player 9.0.28.0, AIR 1.0

Devuelve una cadena con todas las propiedades del objeto ScrollEvent. La cadena tiene el siguiente formato:

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

Valor devuelto
String — Representación de cadena del objeto ScrollEvent.
Información sobre constantes

SCROLL

Constante
public static const SCROLL:String = "scroll"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flash CS3
Versiones de motor de ejecución: Flash Player 9.0.28.0, AIR 1.0

Define el valor de la propiedad type de un objeto de evento scroll.

Este evento tiene las propiedades siguientes:

PropiedadValor
bubblesfalse
cancelablefalse; no hay ningún comportamiento predeterminado que cancelar.
currentTargetObjeto que procesa de forma activa el objeto de evento con un detector de eventos.
delta1; valor que indica la cantidad de desplazamiento que se ha realizado.
directionvertical; dirección de ScrollBar.
position0; posición del deslizador Scrollbar después de que se haya movido.
targetError que distribuyó el evento. El destino no es siempre el objeto que detecta el evento. Utilice la propiedad currentTarget para acceder al objeto que detecta el evento.


Ejemplo  ( Cómo utilizar este ejemplo )

El siguiente ejemplo detecta el evento scroll y utiliza la propiedad direction de la clase ScrollEvent para determinar si el contenido se desplazó horizontal o verticalmente:
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;
    }
}




[ X ]¿Por qué hay texto en inglés?
Cierto contenido de la Referencia de ActionScript 3.0 se muestra en inglés

No todo el contenido de la Referencia de ActionScript 3.0 se traduce a todos los idiomas. Si un elemento del lenguaje no se traduce, aparecerá en inglés. Por ejemplo, la clase ga.controls.HelpBox no está traducida en ningún idioma. Por lo tanto, en la versión en español de la referencia, la clase ga.controls.HelpBox aparecerá en inglés.