Package adalid.core.annotations

Annotation Interface EntityTreeView

@Retention(RUNTIME) @Target(TYPE) public @interface EntityTreeView
La anotación EntityTreeView se utiliza para controlar la generación de las vistas (páginas) de consulta y/o registro jerárquico de la entidad, conocidas como Árboles de Consulta y/o Árboles de Registro, respectivamente. Solo aplica si la entidad es jerárquica, es decir, tiene una relación de varios-a-uno con ella misma y la propiedad que establece tal relación ha sido designada como propiedad padre (vea Anotación ParentProperty).
Author:
Jorge Campins

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    branchLimit
    branchLimit específica el máximo número de nodos por rama que muestra la vista.
    Kleenean
    enabled
    enabled indica si se debe, o no, generar las vistas.
    String
    helpDocument
    helpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de consulta y/o registro jerárquico de la entidad.
    String
    helpFile
    helpFile especifica la ruta y el nombre del archivo de ayuda de las vistas (páginas) de consulta y/o registro jerárquico de la entidad.
    ViewMenuOption
    menu
    menu especifica el tipo de vistas (páginas) generadas que deben ser accesibles desde el menú principal de la aplicación.
    String
    readingViewAboveTreeSnippet
    readingViewAboveTreeSnippet especifica la ruta y el nombre del snippet ubicado encima del árbol en las vistas (páginas) de consulta jerárquica de la entidad.
    String
    readingViewBelowTreeSnippet
    readingViewBelowTreeSnippet especifica la ruta y el nombre del snippet ubicado debajo del árbol en las vistas (páginas) de consulta jerárquica de la entidad.
    String
    readingViewEasternToolbarSnippet
    readingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de consulta jerárquica de la entidad.
    String
    readingViewHeadSnippet
    readingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de consulta jerárquica de la entidad.
    String
    readingViewWesternToolbarSnippet
    readingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de consulta jerárquica de la entidad.
    int
    rootLimit
    rootLimit específica el máximo número de nodos raíz (sin nodo superior) que muestra la vista.
    String
    writingViewAboveTreeSnippet
    writingViewAboveTreeSnippet especifica la ruta y el nombre del snippet ubicado encima del árbol en las vistas (páginas) de registro jerárquico de la entidad.
    String
    writingViewBelowTreeSnippet
    writingViewBelowTreeSnippet especifica la ruta y el nombre del snippet ubicado debajo del árbol en las vistas (páginas) de registro jerárquico de la entidad.
    String
    writingViewEasternToolbarSnippet
    writingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de registro jerárquico de la entidad.
    String
    writingViewHeadSnippet
    writingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de registro jerárquico de la entidad.
    String
    writingViewWesternToolbarSnippet
    writingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de registro jerárquico de la entidad.

  • Element Details

    • enabled

      Kleenean enabled
      enabled indica si se debe, o no, generar las vistas. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para generar las vistas; 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:
      enabled
      Default:
      UNSPECIFIED

    • rootLimit

      int rootLimit
      rootLimit específica el máximo número de nodos raíz (sin nodo superior) que muestra la vista. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor debe ser un número entero entre 5 y 1000. El valor predeterminado es 100.
      Returns:
      rootLimit
      Default:
      100

    • branchLimit

      int branchLimit
      branchLimit específica el máximo número de nodos por rama que muestra la vista. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor debe ser un número entero entre 5 y 1000. El valor predeterminado es 100.
      Returns:
      branchLimit
      Default:
      100

    • helpDocument

      String helpDocument
      helpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de consulta y/o registro jerárquico de la entidad. Si utiliza la plataforma jee2, puede ser una URL o un iframe que incluya la URL del documento. Las vistas utilizarán el documento incrustado definido para el correspondiente formato de vista de la entidad, la entidad de la vista, el módulo al que pertenece la entidad de la vista o el proyecto maestro, buscando en ese orden; si ninguno de ellos está definido, no habrá un documento incrustado disponible para la vista.
      Returns:
      helpDocument
      Default:
      ""

    • helpFile

      String helpFile
      helpFile especifica la ruta y el nombre del archivo de ayuda de las vistas (páginas) de consulta y/o registro jerárquico de la entidad. Si utiliza la plataforma jee2, la ruta del archivo debe ser relativa al subdirectorio especificado mediante el atributo extraordinario HELP_RESOURCES_FOLDER del proyecto maestro, y cuyo valor por omisión es el subdirectorio resources/help/custom-made del directorio src/main/webapp del módulo Web de la aplicación. Cada vista de la entidad podría tener su propio archivo de ayuda, según lo establecido mediante el elemento helpFileAutoName de la anotación EntityClass. La vista que no tenga su propio archivo de ayuda utilizará el definido para el correspondiente formato de vista de la entidad, la entidad de la vista, el módulo al que pertenece la entidad de la vista o el proyecto maestro, buscando en ese orden; si ninguno de ellos está definido, la página de ayuda no estará disponible para la vista.
      Returns:
      helpFile
      Default:
      ""

    • readingViewHeadSnippet

      String readingViewHeadSnippet
      readingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de consulta jerárquica de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      readingViewHeadSnippet
      Default:
      ""

    • readingViewEasternToolbarSnippet

      String readingViewEasternToolbarSnippet
      readingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de consulta jerárquica de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      readingViewEasternToolbarSnippet
      Default:
      ""

    • readingViewWesternToolbarSnippet

      String readingViewWesternToolbarSnippet
      readingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de consulta jerárquica de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      readingViewWesternToolbarSnippet
      Default:
      ""

    • readingViewAboveTreeSnippet

      String readingViewAboveTreeSnippet
      readingViewAboveTreeSnippet especifica la ruta y el nombre del snippet ubicado encima del árbol en las vistas (páginas) de consulta jerárquica de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      readingViewAboveTreeSnippet
      Default:
      ""

    • readingViewBelowTreeSnippet

      String readingViewBelowTreeSnippet
      readingViewBelowTreeSnippet especifica la ruta y el nombre del snippet ubicado debajo del árbol en las vistas (páginas) de consulta jerárquica de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      readingViewBelowTreeSnippet
      Default:
      ""

    • writingViewHeadSnippet

      String writingViewHeadSnippet
      writingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de registro jerárquico de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      writingViewHeadSnippet
      Default:
      ""

    • writingViewEasternToolbarSnippet

      String writingViewEasternToolbarSnippet
      writingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de registro jerárquico de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      writingViewEasternToolbarSnippet
      Default:
      ""

    • writingViewWesternToolbarSnippet

      String writingViewWesternToolbarSnippet
      writingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de registro jerárquico de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      writingViewWesternToolbarSnippet
      Default:
      ""

    • writingViewAboveTreeSnippet

      String writingViewAboveTreeSnippet
      writingViewAboveTreeSnippet especifica la ruta y el nombre del snippet ubicado encima del árbol en las vistas (páginas) de registro jerárquico de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      writingViewAboveTreeSnippet
      Default:
      ""

    • writingViewBelowTreeSnippet

      String writingViewBelowTreeSnippet
      writingViewBelowTreeSnippet especifica la ruta y el nombre del snippet ubicado debajo del árbol en las vistas (páginas) de registro jerárquico de la entidad. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      writingViewBelowTreeSnippet
      Default:
      ""