Saltar al contenido principal

MaskedDateField

Abrir en ChatGPT
Sombra dwc-datefield 24.10
Java API

El MaskedDateField es un campo de texto que permite a los usuarios ingresar fechas como números y formatea automáticamente la entrada basándose en una máscara definida cuando el campo pierde el foco. La máscara especifica el formato de fecha esperado, guiando tanto la entrada como la visualización. El componente admite un análisis flexible, validación, localización y restauración de valores para un manejo de fechas consistente y específico de la región.

¿Buscas entrada de tiempo?

El MaskedDateField se centra exclusivamente en los valores de fecha. Si necesitas un componente similar para ingresar y formatear hora, consulta el MaskedTimeField en su lugar.

El MaskedDateField puede instanciarse con o sin parámetros. Puedes definir un valor inicial, una etiqueta, un marcador de posición y un oyente de eventos para los cambios de valor.

Reglas de máscara​

El MaskedDateField admite múltiples formatos de fecha utilizados en todo el mundo, que varían según el orden de día, mes y año. Los patrones comunes incluyen:

  • Día/Mes/Año (utilizado en la mayor parte de Europa)
  • Mes/Día/Año (utilizado en los Estados Unidos)
  • Año/Mes/Día (utilizado en China, Japón y Corea; también el estándar ISO: YYYY-MM-DD)

Dentro de estos formatos, las variaciones locales incluyen la elección de separador (por ejemplo, -, / o .), si los años son de dos o cuatro dígitos, y si los meses o días de un solo dígito están rellenados con ceros a la izquierda.

Para manejar esta diversidad, el MaskedDateField utiliza indicadores de formato, cada uno comenzando con %, seguido de una letra que representa una parte específica de la fecha. Estos indicadores definen cómo se interpreta la entrada y cómo se muestra la fecha.

Aplicando máscaras programáticamente

Para formatear o analizar fechas con la misma sintaxis de máscara fuera de un campo, utiliza la clase de utilidad MaskDecorator.

Indicadores de formato de fecha​

FormatoDescripción
%YAño
%MMes
%DDía

Modificadores​

Los modificadores permiten un mayor control sobre cómo se formatean los componentes de la fecha:

ModificadorDescripción
zRellenar con ceros
sRepresentación de texto corto
lRepresentación de texto largo
pNúmero empaquetado
dDecimal (formato predeterminado)

Estos se pueden combinar para construir una amplia variedad de máscaras de fecha.

Localización del formato de fecha​

El MaskedDateField se adapta a los formatos de fecha regionales configurando la configuración regional apropiada. Esto asegura que las fechas se muestren y se analicen de una manera que coincida con las expectativas del usuario.

RegiónFormatoEjemplo
Estados UnidosMM/DD/YYYY07/04/2023
EuropaDD/MM/YYYY04/07/2023
Estándar ISOYYYY-MM-DD2023-07-04

Para aplicar la localización, utiliza el método setLocale(). Acepta un java.util.Locale y ajusta automáticamente tanto el formato como el análisis:

dateField.setLocale(Locale.FRANCE);

Lógica de análisis​

El MaskedDateField analiza la entrada del usuario según la máscara de fecha definida. Acepta entradas completas y abreviadas con o sin delimitadores, permitiendo una entrada flexible mientras asegura fechas válidas. El comportamiento de análisis depende del orden de formato definido por la máscara (por ejemplo, %Mz/%Dz/%Yz para mes/día/año). Este formato determina cómo se interpretan las secuencias numéricas.

Por ejemplo, asumiendo que hoy es 15 de septiembre de 2012, así es como se interpretarían varias entradas:

Ejemplos de escenarios de análisis​

EntradaYMD (ISO)MDY (EE.UU.)DMY (UE)
1
Un solo dígito siempre se interpreta como un número de día dentro del mes actual, por lo que esto sería el 1 de septiembre de 2012.Igual que YMDIgual que YMD
12
Dos dígitos siempre se interpretan como un número de día dentro del mes actual, por lo que esto sería el 12 de septiembre de 2012.Igual que YMDIgual que YMD
112
Tres dígitos se interpretan como un número de mes de 1 dígito seguido de un número de día de 2 dígitos, por lo que esto sería el 12 de enero de 2012.Igual que YMDTres dígitos se interpretan como un número de día de 1 dígito seguido de un número de mes de 2 dígitos, por lo que esto sería el 1 de diciembre de 2012.
1004
Cuatro dígitos se interpretan como MMDD, por lo que esto sería el 4 de octubre de 2012.Igual que YMDCuatro dígitos se interpretan como DDMM, por lo que esto sería el 10 de abril de 2012.
020304
Seis dígitos se interpretan como YYMMDD, por lo que esto sería el 4 de marzo de 2002.Seis dígitos se interpretan como MMDDYY, por lo que esto sería el 3 de febrero de 2004.Seis dígitos se interpretan como DDMMYY, por lo que esto sería el 2 de marzo de 2004.
8 digits
Ocho dígitos se interpretan como YYYYMMDD. Por ejemplo, 20040612 es el 12 de junio de 2004.Ocho dígitos se interpretan como MMDDYYYY. Por ejemplo, 06122004 es el 12 de junio de 2004.Ocho dígitos se interpretan como DDMMYYYY. Por ejemplo, 06122004 es el 6 de diciembre de 2004.
12/6
Dos números separados por cualquier delimitador válido se interpretan como MM/DD, por lo que esto sería el 6 de diciembre de 2012.
Nota: Todos los caracteres excepto letras y dígitos son considerados delimitadores válidos.
Igual que YMDDos números separados por cualquier delimitador se interpretan como DD/MM, por lo que esto sería el 12 de junio de 2012.
3/4/5
5 de abril de 20124 de marzo de 20053 de abril de 2005

Análisis de fecha textual 25.10​

Por defecto, el MaskedDateField solo acepta entradas numéricas para fechas. Sin embargo, puedes habilitar el análisis de fecha textual para permitir a los usuarios ingresar nombres de meses y días en su entrada. Esta función es particularmente útil para crear una entrada de fecha más natural.

Para habilitar el análisis textual, utiliza el método setTextualDateParsing():

dateField.setTextualDateParsing(true);

Sustitución del nombre del mes​

Cuando el análisis textual está habilitado, puedes utilizar modificadores especiales en tu máscara para aceptar nombres de meses en lugar de valores numéricos:

  • %Ms - Acepta nombres de meses cortos (Ene, Feb, Mar, etc.)
  • %Ml - Acepta nombres de meses largos (Enero, Febrero, Marzo, etc.)

Los nombres de los meses pueden aparecer en cualquier posición dentro de la máscara, y el campo aún aceptará la entrada numérica como alternativa.

Ejemplos​

MáscaraEntradaResultado
%Ms/%Dz/%YzSep/01/25Válido - Se analiza como 1 de septiembre de 2025
%Ml/%Dz/%YzSeptiembre/01/25Válido - Se analiza como 1 de septiembre de 2025
%Dz/%Ml/%Yz01/Septiembre/25Válido - Se analiza como 1 de septiembre de 2025
%Mz/%Dz/%Yz09/01/25Válido - La alternativa numérica sigue funcionando
info

Todos los 12 meses son compatibles tanto en forma corta (Ene, Feb, Mar, Abr, May, Jun, Jul, Ago, Sep, Oct, Nov, Dic) como en forma larga (Enero, Febrero, etc.).

Decoración del nombre del día​

Los nombres de los días de la semana pueden incluirse en la entrada para mejorar la legibilidad, pero son decorativos únicamente y se eliminan durante el análisis. No afectan el valor real de la fecha.

  • %Ds - Acepta nombres de días cortos (Lun, Mar, Mié, etc.)
  • %Dl - Acepta nombres de días largos (Lunes, Martes, Miércoles, etc.)
Los nombres de días requieren un día numérico

Al usar los nombres de días de la semana (%Ds o %Dl), tu máscara también debe incluir %Dz o %Dd para especificar el número de día real. Sin un componente de día numérico, la entrada será inválida.

Ejemplos​

MáscaraEntradaResultado
%Ds %Mz/%Dz/%YzLun 09/01/25Válido - El nombre del día es decorativo
%Dl %Mz/%Dz/%YzLunes 09/01/25Válido - El nombre del día es decorativo
%Mz/%Dz/%Yz %Ds09/01/25 MarVálido - Nombre del día al final
%Dl/%Mz/%YzLunes/09/25Inválido - Falta %Dz
%Mz/%Dl/%Yz09/Lunes/25Inválido - Falta %Dz

Todos los 7 días de la semana son compatibles tanto en forma corta (Lun, Mar, Mié, Jue, Vie, Sáb, Dom) como en forma larga (Lunes, Martes, etc.).

Reglas adicionales de análisis​

El análisis textual de fechas incluye varias características útiles:

  • Sin distinción de mayúsculas: Entradas como LUNES 09/01/25, lunes 09/01/25, o Lunes 09/01/25 funcionan de la misma manera.
  • Conocimiento del idioma local: Los nombres de meses y días deben coincidir con la configuración regional del campo. Por ejemplo, con un locale francés, usa septembre no September. Los nombres en inglés no serán reconocidos a menos que el locale esté configurado en inglés.
    • Locale francés: septiembre/01/25 es reconocido como septiembre
    • Locale alemán: Montag 09/01/25 es reconocido con lunes como el nombre del día

Estableciendo restricciones de min/max​

Puedes restringir el rango de fechas permitidas en un MaskedDateField utilizando los métodos setMin() y setMax():

dateField.setMin(LocalDate.of(2020, 1, 1));
dateField.setMax(LocalDate.of(2030, 12, 31));

Ambos métodos aceptan valores de tipo java.time.LocalDate. La entrada fuera del rango definido se considerará inválida.

Restaurando el valor​

El MaskedDateField incluye una función de restauración que restablece el valor del campo a un estado predefinido u original. Esto es útil para revertir la entrada del usuario o restablecer a una fecha predeterminada.

dateField.setRestoreValue(LocalDate.of(2025, 1, 1));
dateField.restoreValue();

Formas de restaurar el valor​

  • Programáticamente, llamando a restoreValue()
  • A través del teclado, presionando ESC (esta es la tecla de restauración predeterminada a menos que sea anulada por un oyente de eventos)

Puedes establecer el valor a restaurar con setRestoreValue(), pasando una instancia de LocalDate.

Patrones de validación​

Puedes aplicar reglas de validación del lado del cliente utilizando expresiones regulares con el método setPattern():

dateField.setPattern("^\\d{2}/\\d{2}/\\d{4}$");

Este patrón asegura que solo los valores que coinciden con el formato MM/DD/YYYY (dos dígitos, barra, dos dígitos, barra, cuatro dígitos) se consideren válidos.

Formato de expresión regular

El patrón debe seguir la sintaxis de RegExp de JavaScript como se documenta aquí.

Notas sobre el manejo de entrada

El campo intenta analizar y formatear las entradas de fecha numéricas según la máscara actual. Sin embargo, los usuarios aún pueden ingresar manualmente valores que no coinciden con el formato esperado. Si la entrada es sintácticamente válida pero semánticamente incorrecta o no se puede analizar (por ejemplo, 99/99/9999), puede pasar las verificaciones de patrones pero fallar en la validación lógica. Siempre debes validar el valor de entrada en tu lógica de aplicación, incluso si se establece un patrón de expresión regular, para asegurar que la fecha esté tanto correctamente formateada como tenga sentido.

Selector de fechas​

El MaskedDateField incluye un selector de calendario integrado que permite a los usuarios seleccionar una fecha visualmente, en lugar de escribirla. Esto mejora la usabilidad para los usuarios menos técnicos o cuando se requiere una entrada precisa.

Accediendo al selector​

Puedes acceder al selector de fecha utilizando getPicker():

DatePicker picker = dateField.getPicker();

Mostrar/ocultar el ícono del selector​

Utiliza setIconVisible() para mostrar u ocultar el ícono de calendario al lado del campo:

picker.setIconVisible(true); // muestra el ícono

Comportamiento de auto-apertura​

Puedes configurar el selector para que se abra automáticamente cuando el usuario interactúe con el campo (por ejemplo, haga clic, presione Intro o las teclas de flecha):

picker.setAutoOpen(true);
Forzar selección a través del selector

Para asegurar que los usuarios solo puedan seleccionar una fecha usando el selector de calendario (y no ingresar manualmente una), combina estas dos configuraciones:

dateField.getPicker().setAutoOpen(true); // Abre el selector al interactuar el usuario
dateField.setAllowCustomValue(false); // Desactiva la entrada de texto manual

Esta configuración garantiza que toda la entrada de fecha provenga a través de la interfaz del selector, lo cual es útil cuando deseas un control estricto sobre el formato y eliminar problemas de análisis de entradas escritas.

Abrir el calendario manualmente​

Para abrir el calendario programáticamente:

picker.open();

O utiliza el alias:

picker.show(); // igual que open()

Mostrar semanas en el calendario​

El selector puede mostrar opcionalmente números de semana en la vista del calendario:

picker.setShowWeeks(true);

MaskedDateFieldSpinner​

El MaskedDateFieldSpinner extiende el MaskedDateField al agregar controles de spinner que permiten a los usuarios incrementar o disminuir la fecha utilizando las teclas de flecha o botones de la interfaz. Proporciona un estilo de interacción más guiado, especialmente útil en aplicaciones de estilo de escritorio.

Características clave​

  • Cambio de fecha interactivo: Utiliza las teclas de flecha o botones de giro para incrementar o disminuir el valor de la fecha.

  • Unidad de paso personalizable: Elige qué parte de la fecha modificar utilizando setSpinField():

    spinner.setSpinField(MaskedDateFieldSpinner.SpinField.MONTH);

    Las opciones incluyen DAY, WEEK, MONTH y YEAR.

  • Límites de min/max: Hereda el soporte para fechas mínimas y máximas permitidas utilizando setMin() y setMax().

  • Salida formateada: Totalmente compatible con máscaras y configuraciones de localización del MaskedDateField.

Ejemplo: Configurar cambio semanal​

MaskedDateFieldSpinner spinner = new MaskedDateFieldSpinner();
spinner.setSpinField(MaskedDateFieldSpinner.SpinField.WEEK);

Esto hace que cada paso de giro avance o retroceda la fecha por una semana.

Estilo​

Loading...

Sigue aprendiendo