Clipboard  - AS3

Conjunto de cadenas con los nombres de los formatos de datos disponibles en este objeto Clipboard.

Las constantes de cadena de los nombres de formatos estándar se definen en la clase ClipboardFormats. También se pueden utilizar otras cadenas (definidas por la aplicación) como nombres de formatos para transferir datos como un objeto.

Elementos de API relacionados

 var availableFormats:Array = Clipboard.generalClipboard.formats;

Portapapeles del sistema operativo.

Cualquier dato pegado en el portapapeles del sistema está disponible en otras aplicaciones. Esto puede incluir código remoto no seguro ejecutándose en un navegador web.

Nota: en aplicaciones de Flash Player 10, la acción de pegar desde el portapapeles requiere un evento de usuario (un método abreviado de teclado para el comando Pegar o un clic del ratón en la opción Pegar del menú contextual). Clipboard.getData() devuelve el contenido del portapapeles sólo si se ha recibido el objeto InteractiveObject y actúa como un evento paste. En cualquier otro caso, la llamada a Clipboard.getData() no se producirá correctamente. La misma restricción se aplica a AIR en cuanto al contenido que no se encuentra dentro del entorno limitado de seguridad de la aplicación.

El objeto generalClipboard se crea automáticamente. No es posible asignar otra intancia de Clipboard a esta propiedad. Utilice los métodos getData() y setData() para leer y escribir datos en el objeto existente.

Siempre debe borrar el portapapeles antes de escribir datos nuevos para garantizar que se borran todos los datos en otros formatos.

El objeto generalClipboard no se puede transferir al método NativeDragManager de AIR. Cree un nuevo objeto Clipboard para operaciones nativas de arrastrar y colocar en una aplicación de AIR.

 import flash.desktop.ClipboardFormats;
 
 var copy:String = "A string to copy to the system clipboard.";
 Clipboard.generalClipboard.clear();
 Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, copy);

 import flash.desktop.ClipboardFormats;
 
 var pasteData:String  = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT) as String;

Indica si el formato del portapapeles de promesas de archivo se admite en el sistema del cliente.

Crea un objeto Clipboard vacío.

Cree objetos Clipboard para alojar los datos de un gesto nativo de arrastrar y colocar en Adobe AIR. Los objetos Clipboard se pueden utilizar para un solo gesto de arrastrar y colocar, lo que significa que no es posible reutilizarlos.

No cree un objeto Clipboard para operaciones de copiar y pegar. Utilice el objeto Clipboard.generalClipboard sencillo en su lugar.

Elementos de API relacionados

 import flash.desktop.Clipboard;
 
 var clipboard:Clipboard = new Clipboard();

Elimina todas las representaciones de datos de este objeto Clipboard.

 Clipboard.generalClipboard.clear();

Elimina la representación de datos del formato especificado.

Parámetros

 import flash.desktop.ClipboardFormats;
 
 Clipboard.generalClipboard.clearData(ClipboardFormats.TEXT_FORMAT);

Obtiene los datos del portapapeles si existen datos en el formato especificado.

Flash Player requiere llamar al método getData() en un controlador de eventos paste. En AIR, esta restricción sólo se aplica al contenido situado fuera del entorno limitado de seguridad de la aplicación.

Cuando se accede a un formato de datos estándar, los datos se devuelve como un nuevo objeto del tipo de datos de Flash correspondiente.

Cuando se accede a un formato definido por la aplicación, el valor del parámetro transferMode determina si se devuelve una referencia al objeto original o un objeto anónimo con una copia serializada del objeto original. Cuando se especifica un modo originalPreferred o clonePreferred, AIR o Flash Player devuelve una versión alternativa si la versión preferida no está disponible. Cuando se especifica un modo originalOnly o cloneOnly, AIR o Flash Player devuelve null si la versión solicitada no está disponible.

Parámetros

Elementos de API relacionados

 import flash.desktop.ClipboardFormats;

 var pasteData:String = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT) as String;

Comprueba si existen datos del formato especificado en este objeto Clipboard.

Utilice las constantes de la clase ClipboardFormats para hacer referencia a los nombres de formatos estándar.

Parámetros

Elementos de API relacionados

if(Clipboard.generalClipboard.hasFormat(ClipboardFormats.TEXT_FORMAT)){
    //do something 
}

Añade una representación de la información que se va a transferir en el formato de datos especificado.

En el entorno limitado de seguridad de Adobe AIR, se puede llamar a setData() en cualquier momento. En otros contextos, sólo se puede llamar a setData() como respuesta a un evento generado por el usuario, por ejemplo, una pulsación de tecla o un clic de ratón.

Se pueden añadir representaciones diferentes de la misma información al portapapeles en varios formatos. Esto aumenta la capacidad de otros componentes o aplicaciones para utilizar los datos disponibles. Por ejemplo, se puede añadir una imagen como datos de mapa de bits para que la puedan utilizar las aplicaciones de edición de imágenes, para que se pueda usar como URL o como archivo PNG codificado para el sistema de archivos nativo.

El parámetro de datos debe ser del tipo de datos del formato especificado:

Los nombres de formato personalizados no pueden comenzar por "air:" ni por "flash:". Para evitar conflictos de nombres al utilizar formatos personalizados, utilice el ID de aplicación o el nombre del paquete como prefijo del formato, por ejemplo, "com.example.nombreAplicación.paqueteDatos".

Al transferir dentro de o entre aplicaciones de AIR, el parámetro serializable determina si hay una referencia y una copia, o si sólo se dispone de una referencia al objeto. Establezca serializable como true para disponer de una referencia y una copia del objeto de datos disponible. Establezca serializable como false para hacer que una sola referencia al objeto esté disponible. Las referencias al objeto sólo son válidas en la aplicación activa, por lo que establecer serializable como false también implica que los datos de dicho formato no estén disponibles en otras aplicaciones de AIR o Flash Player. Un componente puede elegir obtener la referencia o la copia del objeto estableciendo el modo de transferencia de portapapeles adecuado al acceder a los datos en dicho formato.

Nota: los formatos estándar siempre se convierten en formatos nativos cuando los datos se pegan o se arrastran fuera de una aplicación admitida, por lo que el valor del parámetro serializable no afecta a la disponibilidad de los datos en los formatos no estándar de aplicaciones que no sean de AIR.

Para retrasar la representación de los datos de un formato, utilice el método setDataHandler(). Si se utilizan los métodos setData() y setDataHandler() para añadir una representación de datos con el mismo nombre de formato, nunca se llama a la función del controlador.

Nota: en Mac OS, al establecer el parámetro format como ClipboardFormats.URL_FORMAT, la URL se transfiere sólo si es una URL válida. En caso contrario, el objeto Clipboard se vacía (y llamar a getData() devuelve null).

Parámetros

Elementos de API relacionados

 import flash.desktop.ClipboardFormats;
 
 var htmlString:String = "<html><body>Body content</body></html>";
 Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, urlString);
 Clipboard.generalClipboard.setData(ClipboardFormats.HTML_FORMAT, urlString);

Añade una referencia a una función de controlador que genera los datos que se van a transferir.

Utilice esta función de controlador para retrasar la creación o la representación de los datos has que se acceda a ellos.

La función del controlador debe devolver el tipo de datos del formato especificado:

Se llama a la función del controlador únicamente cuando se leen datos del formato especificado. Tenga en cuenta que en algunos casos el sistema operativo llama a la función antes de que se produzca una acción de colocar. Por ejemplo, cuando se utiliza una función de controlador para proporcionar los datos de un archivo arrastrado desde una aplicación de AIR al el sistema de archivos, el sistema operativo llama a la función de controlador de datos en cuanto el gesto de arrastrar abandona la aplicación de AIR (por lo general, produce una pausa no deseada cuando el archivo datos se descarga o se crea). Puede utilizar un URLFilePromise para este fin en su lugar.

Tenga en cuenta que los datos subyacentes pueden cambiar entre el momento en que se añade el controlador y el momento en que se leen, a no ser que la aplicación realice las acciones necesarias para proteger los datos. El comportamiento se produce cuando no se garantiza que los datos del portapapeles representados por una función más de una vez. El portapapeles puede devolver los datos producidos por la primera llamada a la función o volver a llamarla. No se base en ninguno de los comportamientos.

En el entorno limitado de seguridad de Adobe AIR, se puede llamar a setDataHandler() en cualquier momento. En otros contextos, sólo se puede llamar a setDataHandler() como respuesta a un evento generado por el usuario, por ejemplo, una pulsación de tecla o un clic de ratón.

Para añadir datos directamente a este objeto Clipboard, utilice el método setData(). Si se llama a métodos setData() y setDataHandler() con el mismo nombre de formato, nunca se llama a la función del controlador.

Nota: en Mac OS, al establecer el parámetro format como ClipboardFormats.URL_FORMAT, la URL se transfiere sólo si la función de controlador devuelve una URL válida. En caso contrario, el objeto Clipboard se vacía (y llamar a getData() devuelve null).

Parámetros

Elementos de API relacionados

 import flash.desktop.ClipboardFormats;
 
 Clipboard.generalClipboard.setDataHandler(ClipboardFormats.TEXT_FORMAT, randomNumberGenerator);

 public function randomNumberGenerator():String{
     return Math.random().toString();
 }

1. Escriba los datos, en este caso una cadena, en Clipboard.generalClipboard.
2. Lea el contenido del portapapeles desde Clipboard.generalClipboard.

Nota: debido a restricciones de seguridad en el acceso a datos de portapapeles, este ejemplo no funciona en Flash Player. En Flash Player, sólo se puede llamar al método getData() del objeto Clipboard en un controlador de eventos paste.

package
{
    import flash.display.Sprite;
    import flash.desktop.Clipboard;
    import flash.desktop.ClipboardFormats;
    import flash.desktop.ClipboardTransferMode;

    public class ClipboardExample extends Sprite
    {
        public function ClipboardExample()
        {
            var sally:String = "Sally";
            var person:String;
            
            copy(sally);
            person = paste();
            trace(person); //traces: "Sally"
        }

        private function copy(text:String):void 
        {
            Clipboard.generalClipboard.clear();
            Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, text);
        }
        
        private function paste():String
        {
            if(Clipboard.generalClipboard.hasFormat(ClipboardFormats.TEXT_FORMAT))
            {
                return String(Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT));
            } 
            else 
            {
                return null;
            }
        }
        
    }
}