Annotation Interface StringField


@Retention(RUNTIME) @Target(FIELD) public @interface StringField
La anotación StringField se utiliza para establecer atributos de propiedades y parámetros String.
Author:
Jorge Campins
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    allowDiacritics indica si se permiten, o no, signos diacríticos al almacenar valores de la propiedad o parámetro en la base de datos.
    autoComplete especifica si los campos de entrada de la propiedad o parámetro deben tener habilitado, o no, el autocompletado.
    converter específica el nombre de un componente personalizado que permite convertir el valor de la propiedad o parámetro.
    int
    displayLength específica la cantidad de caracteres que se utiliza para calcular el tamaño del componente correspondiente a la propiedad o parámetro en las vistas (páginas) de la aplicación.
    fetch especifica si la operación de consulta obtiene el valor de la propiedad simultáneamente con el resto de las propiedades de la entidad o posteriormente, por demanda.
    letterCase especifica la conversión que se debe realizar al almacenar valores de la propiedad o parámetro en la base de datos.
    mask especifica la plantilla de la máscara para capturar los valores de la propiedad o parámetro.
    int
    maxLength específica la cantidad máxima de caracteres que deben tener los valores de la propiedad o parámetro.
    int
    minLength específica la cantidad mínima de caracteres que pueden tener los valores de la propiedad o parámetro.
    regex especifica la expresión regular que deben satisfacer los valores de la propiedad o parámetro.
    richTextFormat indica si la propiedad permite, o no, el uso del formato de texto enriquecido (RTF).
    char
    slotChar especifica el caracter que se muestra al capturar los valores de la propiedad o parámetro con una máscara, para resaltar donde el usuario debe escribir una letra o número.
    translatable indica si el valor de la propiedad puede, o no, ser traducido a otros idiomas.
    validator específica el nombre de un componente personalizado que permite validar el valor de la propiedad o parámetro.
  • Element Details

    • displayLength

      int displayLength
      displayLength específica la cantidad de caracteres que se utiliza para calcular el tamaño del componente correspondiente a la propiedad o parámetro en las vistas (páginas) de la aplicación. Su valor debe ser un número entero entre 0 y 32.767. El valor predeterminado es el valor, especificado o determinado, del elemento maxLength. Especifique 0 para utilizar el máximo permitido por la plataforma.
      Returns:
      displayLength
      Default:
      -1
    • maxLength

      int maxLength
      maxLength específica la cantidad máxima de caracteres que deben tener los valores de la propiedad o parámetro. Su valor debe ser un número entero entre 0 y 32.767. El valor predeterminado es 2.000. Especifique 0 para utilizar el máximo permitido por la plataforma.
      Returns:
      maxLength
      Default:
      -1
    • minLength

      int minLength
      minLength específica la cantidad mínima de caracteres que pueden tener los valores de la propiedad o parámetro. Su valor debe ser un número entero entre 0 y 32.000. El valor predeterminado es 0.
      Returns:
      minLength
      Default:
      -1
    • mask

      String mask
      mask especifica la plantilla de la máscara para capturar los valores de la propiedad o parámetro. La plantilla puede tener los siguientes caracteres, que tienen un significado especial:
      • 9: Representa un solo dígito, de 0 a 9.
      • a: Representa un solo carácter alfabético, de A a Z o de a a z.
      • *: Representa un solo carácter alfanumérico, de 0 a 9, de A a Z o de a a z.
      La plantilla puede tener una parte opcional; esa parte se debe colocar entre corchetes. Por ejemplo, la plantilla "(999) 999-9999[ x9999]" serviría para capturar números telefónicos, con un número opcional de extensión.
      Returns:
      mask
      Default:
      ""
    • slotChar

      char slotChar
      slotChar especifica el caracter que se muestra al capturar los valores de la propiedad o parámetro con una máscara, para resaltar donde el usuario debe escribir una letra o número. Este elemento solo es relevante si se especifica un valor para el elemento mask. No puede ser un caracter de control. Su valor predeterminado es el guion bajo (underscore).
      Returns:
      slotChar
      Default:
      '_'
    • regex

      String regex
      regex especifica la expresión regular que deben satisfacer los valores de la propiedad o parámetro. Para más información sobre expresiones regulares consulte la documentación de Java (la página Regular Expressions es un buen punto de partida).
      Returns:
      regex
      Default:
      ""
    • fetch

      FetchType fetch
      fetch especifica si la operación de consulta obtiene el valor de la propiedad simultáneamente con el resto de las propiedades de la entidad o posteriormente, por demanda. Este elemento solo es relevante si el valor del elemento maxLength es 0. Su valor es uno de los elementos de la enumeración FetchType. Seleccione EAGER para obtener el valor de la propiedad simultáneamente con el resto de las propiedades de la entidad; seleccione LAZY para obtenerlo posteriormente, por demanda; alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es EAGER.
      Returns:
      fetch
      Default:
      UNSPECIFIED
    • autoComplete

      AutoComplete autoComplete
      autoComplete especifica si los campos de entrada de la propiedad o parámetro deben tener habilitado, o no, el autocompletado. Cuando el usuario comienza a escribir en un campo que tiene habilitado el autocompletado, el navegador debe mostrar y permitir seleccionar alguno de los valores escritos anteriormente. El valor de autoComplete es uno de los elementos de la enumeración AutoComplete. Seleccione ON u OFF para habilitar o inhabilitar el autocompletado, respectivamente. Si la propiedad o parámetro es un password, puede utilizar NEW_PASSWORD en lugar de ON para que, además de valores escritos anteriormente, el navegador ofrezca a los usuarios contraseñas generadas automáticamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del navegador.
      Returns:
      autoComplete
      Default:
      UNSPECIFIED
    • letterCase

      LetterCase letterCase
      letterCase especifica la conversión que se debe realizar al almacenar valores de la propiedad o parámetro en la base de datos. Su valor es uno de los elementos de la enumeración LetterCase. Seleccione LOWER, UPPER o CAPITALIZED para convertir todos los caracteres a minúsculas, todos a mayúsculas, o para capitalizar (convertir el primer carácter de cada palabra a mayúscula y el resto a minúsculas), respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para no ejecutar conversión alguna.
      Returns:
      letterCase
      Default:
      UNSPECIFIED
    • allowDiacritics

      Kleenean allowDiacritics
      allowDiacritics indica si se permiten, o no, signos diacríticos al almacenar valores de la propiedad o parámetro en la base de datos. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para permitir signos diacríticos; en caso contrario, seleccione FALSE. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es TRUE.
      Returns:
      allowDiacritics
      Default:
      UNSPECIFIED
    • richTextFormat

      Kleenean richTextFormat
      richTextFormat indica si la propiedad permite, o no, el uso del formato de texto enriquecido (RTF). Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para permitir el uso de RTF; en caso contrario, seleccione FALSE. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es FALSE.
      Returns:
      richTextFormat
      Default:
      UNSPECIFIED
    • translatable

      Kleenean translatable
      translatable indica si el valor de la propiedad puede, o no, ser traducido a otros idiomas. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si el valor se puede traducir; en caso contrario, seleccione FALSE. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es TRUE. Si el valor de la propiedad es una contraseña, un texto grande (maxLength = 0), un texto variante (@VariantString), un documento incrustado (@EmbeddedDocument), una referencia a un archivo cargado (@FileReference), o una URL (@UniformResourceLocator o @UrlProperty) este elemento no es relevante ya que tales valores no deben ser traducidos.
      Returns:
      translatable
      Default:
      UNSPECIFIED
    • converter

      String converter
      converter específica el nombre de un componente personalizado que permite convertir el valor de la propiedad o parámetro.
      Returns:
      converter
      Default:
      ""
    • validator

      String validator
      validator específica el nombre de un componente personalizado que permite validar el valor de la propiedad o parámetro.
      Returns:
      validator
      Default:
      ""