DateTimeFormatter  - AS3

El nombre del ID real de configuración regional utilizado por este objeto DateTimeFormatter.

Existen tres posibilidades para el valor del nombre, en función del sistema operativo y del valor del parámetro requestedLocaleIDName transferido al constructor Collator().

1. Si la configuración regional requerida no era LocaleID.DEFAULT y el sistema operativo admite la configuración regional requerida, el nombre devuelto es el mismo que la propiedad requestedLocaleIDName.
2. Si LocaleID.DEFAULT se ha utilizado como el valor del parámetro requestedLocaleIDName en el constructor, se utiliza el nombre de la configuración regional actual especificado por el sistema operativo del usuario. El valor de LocaleID.DEFAULT conserva la configuración personalizada del usuario en el sistema operativo. Transferir un valor explícito como el parámetro requestedLocaleIDName no necesariamente produce el mismo resultado que utilizar LocaleID.DEFAULT incluso si los dos ID de configuración regional son los mismos. El usuario podría haber personalizado los ajustes de la configuración regional de su equipo y, al solicitar un nombre ID de configuración regional explícito en lugar de utilizar LocaleID.DEFAULT, la aplicación no recuperaría dichos ajustes personalizados.
3. Si el sistema no admite el nombre de requestedLocaleIDName especificado en el constructor, se proporciona un nombre de ID de configuración regional de repuesto.

Elementos de API relacionados

El estado de operación anterior que este objeto DateTimeFormatter ha realizado. La propiedad lastOperationStatus se establece siempre que se llame al constructor o a un método de esta clase, o si se establece otra propiedad. Para conocer los valores posibles, consulte la descripción de cada método.

Elementos de API relacionados

El nombre del ID de configuración regional requerido que se transfirió al constructor de este objeto DateTimeFormatter.

Si se ha utilizado el valor LocaleID.DEFAULT, el nombre devuelto es "i-default". La configuración regional real que se utiliza puede ser diferente de la configuración regional requerida cuando cuando se aplica una configuración regional de repuesto. El nombre de la configuración regional real se puede recuperar usando la propiedad actualLocaleIDName.

Elementos de API relacionados

Construye un nuevo objeto DateTimeFormatter para dar formato a fechas y horas según las convenciones de la configuración regional especificada y de los estilos de formato de fecha y hora. Los estilos de fecha y hora se utilizan para convertir patrones de formato de fecha y hora en patrones predefinidos dependientes de la configuración regional del sistema operativo.

Este constructor determina si el sistema operativo actual admite el nombre del ID solicitado configuración regional. Si no se admite, se utilizará en su lugar una configuración regional repuesto. El nombre del ID de configuración regional de repuesto se puede determinar en la propiedad actualLocaleIDName.

Si se utiliza un repuesto para cualquiera de los parámetros requestedLocaleIDName, dateStyle o timeStyle, se establecerá la propiedad lastOperationStatus para indicar el tipo de repuesto.

Para dar formato a partir de las preferencias del sistema operativo actuales del usuario, transfiera el valor LocaleID.DEFAULT del parámetro requestedLocaleIDName al constructor.

Cuando se llama al constructor y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

Cuando nombre del ID de la configuración regional no está disponible, lastOperationStatus se establece en uno de los valores siguientes:

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Para obtener información detallada sobre las advertencias que aparecen en la lista anterior y sobre otros valores posibles de la propiedad lastOperationStatus, consulte las descripciones de la clase LastOperationStatus.

Elementos de API relacionados

Da formato a una cadena de visualización para un objeto Date que se interpreta como si estuviera en la hora local del usuario (se utilizan los componentes de hora local del objeto Date como date, day, fullYear, hours, minutes, month y seconds). El formato se realiza mediante las convenciones del ID de configuración regional y el estilo de fecha y hora (o mediante el patrón personalizado de fecha y hora) especificadas para la instancia de DateTimeFormatter.

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Parámetros

Elementos de API relacionados

Da formato a cadena de visualización para un objeto Date que se interpreta como si estuviera en hora UTC (con componentes UTC del objeto Date como dateUTC, dayUTC, fullYearUTC, hoursUTC, minutesUTC, monthUTC y secondsUTC), según el patrón dateStyle, timeStyle o dateTime. El formato se realiza mediante las convenciones del ID de configuración regional y el estilo de fecha y hora (o mediante el patrón personalizado de fecha y hora) especificadas para la instancia de DateTimeFormatter.

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Parámetros

Elementos de API relacionados

Muestra una lista de todos los nombres de ID de configuración regional admitidos por esta clase.

Si esta clase no se admite en el sistema operativo actual, este método devuelve un valor null.

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Elementos de API relacionados

Obtiene el estilo de fecha para esta instancia de DateTimeFormatter. El estilo de fecha se utiliza para recuperar un patrón de formato de fecha predefinido desde el sistema operativo. El valor del estilo de fecha puede establecerse con el constructor DateTimeFormatter(), el método setDateTimeStyles() o el método setDateTimePattern().

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Elementos de API relacionados

Devuelve la cadena de patrón utilizada por este objeto DateTimeFormatter para dar formato a fechas y horas.

Este patrón puede establecerse de tres formas distintas:

1. Mediante los parámetros dateStyle y timeStyle utilizados en el constructor
2. Mediante el método setDateTimeStyles()
3. Mediante el método setDateTimePattern().

Para ver una descripción de la sintaxis del patrón, consulte el método setDateTimePattern().

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Elementos de API relacionados

Devuelve un entero correspondiente al primer día de la semana para esta configuración regional y sistema de calendario. Un valor de 0 corresponde al domingo, 1 corresponde al lunes y así sucesivamente (el sábado, por ejemplo, se corresponde con el 6).

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Elementos de API relacionados

Recupera una lista de cadenas localizadas que contiene los nombres de los meses del sistema de calendario actual. El primer elemento de la lista es el nombre del primer mes del año.

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Parámetros

Elementos de API relacionados

Obtiene el estilo de hora para esta instancia de DateTimeFormatter. El estilo de hora se utiliza para recuperar un patrón de formato de hora predefinido desde el sistema operativo. El valor del estilo de hora puede establecerse con el constructor DateTimeFormatter(), el método setDateTimeStyles() o el método setDateTimePattern().

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Elementos de API relacionados

Recupera una lista de cadenas localizadas que contiene los nombres de los días de la semana del sistema de calendario actual. El primer elemento de la lista representa el nombre para el domingo.

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Parámetros

Elementos de API relacionados

Establece la cadena de patrón utilizada por este objeto DateTimeFormatter para dar formato a fechas y horas.

El patrón utilizado para dar formato a fechas se puede establecer de tres formas:

1. Mediante los parámetros dateStyle y timeStyle utilizados en el constructor
2. Mediante el método setDateTimeStyles()
3. Mediante este método setDateTimePattern().

Como efecto secundario, este método anula los estilos actuales de fecha y hora para el objeto DateTimeFormatter y los establece en el valor DateTimeStyle.CUSTOM.

Una cadena de patrón define cómo se aplica formato a la fechas y horas. El patrón contiene secuencias de letras que se sustituyen con valores de fecha y hora en la cadena con formato. Por ejemplo, en el patrón "yyyy/MM", los caracteres "yyyy" se reemplazan por un año de cuatro dígitos seguido de un carácter "/", y los caracteres "MM" se reemplazan por un mes de dos dígitos.

Muchas de las letras utilizadas en los patrones se pueden repetir más de una vez para crear distintos resultados, tal y como se describe en la siguiente tabla.

Si una secuencia supera el número máximo de letras admitidas por un patrón, se asigna de nuevo a la secuencia más larga que admita las letras de dicho patrón. Por ejemplo:

• MMMMMM se sustituye por MMMM
• dddd se sustituye por dd
• EEEEEEE se sustituye por EEEE
• aa se sustituye por a
• hhh se sustituye por hh
• mmmm se sustituye por mm

En teoría, un patrón puede contener hasta 255 caracteres, pero algunas plataformas tienen limitaciones más estrictas. Si el patrón supera el límite de caracteres de patrón, la propiedad lastOperationStatus se establece con el valor LastOperationStatus.PATTERN_SYNTAX_ERROR.

No todos los patrones posibles se admiten en cada sistema operativo. Si un patrón no se admite en la plataforma, se utiliza un patrón de repuesto y la propiedad lastOperationStatus se establece para indicar el uso de repuesto. Si no se pueden proporcionar ningún patrón de repuesto razonable, se utiliza una cadena vacía y se establece la propiedad lastOperationStatus para indicar que no se ha admitido el patrón.

En la tabla siguiente se describen las letras de patrones válidos y su significado.

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Parámetros

Elementos de API relacionados

Establece los estilos de fecha y hora para esta instancia del DateTimeFormatter. Los estilos de fecha y hora se utilizan para convertir patrones de formato de fecha y hora en patrones predefinidos dependientes de la configuración regional del sistema operativo. Este método sustituye a los estilos que se definieron mediante el constructor DateTimeFormatter() o utilizando el método setDateTimePattern(). El patrón de fecha y hora también se puede actualizar a partir de los estilos que están definidos.

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Parámetros

Elementos de API relacionados

Este ejemplo utiliza las siguientes configuraciones regionales: inglés (Estados Unidos), francés (Francia), español (España).

El ejemplo realiza las acciones siguientes para cada configuración regional de la lista:

1. Se crea un objeto DateTimeFormatter a partir del estilo predeterminado (estilo de fecha largo, estilo de hora largo)
2. Da formato a la fecha y hora actual utilizando el estilo predeterminado de fecha larga.
3. Cambia a estilo de fecha corta (sólo hora) con las constantes DateTimeStyle.NONE y DateTimeStyle.SHORT.
4. Da formato a la fecha y hora actual utilizando el estilo de fecha corta (sólo hora).

package {
    import flash.display.Sprite;
    import flash.globalization.DateTimeFormatter;
    import flash.globalization.DateTimeStyle;
    
    public class DateTimeFormatterExample extends Sprite
    {    
        private var localeList:Array = new Array("en-US", "fr-FR", "es-ES");
    
        public function DateTimeFormatterExample()
        {
            var date:Date = new Date();
            
            for each (var locale:String in localeList) {
                var dtf:DateTimeFormatter = new DateTimeFormatter(locale);
                trace('\n' + "LocaleID requested=" + dtf.requestedLocaleIDName 
                    + "; actual=" + dtf.actualLocaleIDName);
            
                var longDate:String = dtf.format(date);
                trace(longDate + " (" + dtf.getDateTimePattern() + ")");
            
                dtf.setDateTimeStyles(DateTimeStyle.NONE, DateTimeStyle.SHORT);
                var shortDate:String = dtf.format(date);
                trace(shortDate + " (" + dtf.getDateTimePattern() + ")");
            }        
        }
    }
}

El ejemplo realiza las acciones siguientes para cada configuración regional de la lista:

1. Crea tres campos de texto de entrada y de salida.
2. Crea un objeto DateTimeFormatter con la configuración regional de Inglés de Estados Unidos.
3. Llama a la función configureTextField(), que establece la posición y el tamaño de los campos de texto y añade un detector de eventos al objeto patternField.
4. Cuando el usuario introduce el patrón en el campo de texto patternField, la función textInputHandler da formato a la fecha y hora actual a partir del patrón y muestra el resultado y el valor de lastOperationStatus en los campos de texto de salida.

 
package {  
    import flash.display.Sprite;
    import flash.events.Event;
    import flash.globalization.DateTimeFormatter;
    import flash.text.*;
    
    public class DateTimePatternExample extends Sprite
    {    
        private var patternField:TextField = new TextField();
        private var resultField:TextField = new TextField();
        private var statusField:TextField = new TextField();
           private var date:Date = new Date();
         private var dtf:DateTimeFormatter = new DateTimeFormatter("en-US");           
         
        private function configureTextField():void
        {
            patternField.type = TextFieldType.INPUT;
            patternField.width = 300;
            patternField.height = 20;
            patternField.background = true;
            patternField.border = true;
            
            resultField.y = 40;
            resultField.width = 300;
            resultField.height = 20;
            
            statusField.y = 80;
            statusField.width = 300;
            statusField.height = 20;

            addChild(patternField);
            addChild(resultField);
            addChild(statusField);
            patternField.addEventListener(Event.CHANGE,textInputHandler);
        }

        private function textInputHandler(event:Event):void
        {                 
            dtf.setDateTimePattern(patternField.text);
            statusField.text = dtf.lastOperationStatus;
            resultField.text = dtf.format(date);
        }

        public function DateTimePatternExample()
        {
            configureTextField();    
        }
    }
}