Package adalid.core.annotations
Annotation Interface EntityTableView
La anotación EntityTableView se utiliza para controlar la generación de las vistas (páginas) de consulta y/o registro tabular de la entidad,
conocidas como Tablas de Consulta y/o Tablas de Registro, respectivamente.
- Author:
- Jorge Campins
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptiondeletes indica si las vistas deben permitir, o no, eliminar instancias de la entidad, es decir, eliminar filas de la tabla de la base de datos correspondiente a la entidad.enabled indica si se debe, o no, generar las vistas.heading indica si las vistas Maestro/Detalle, donde la entidad es el detalle, muestran, o no, un encabezado con propiedades del maestro.helpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de consulta y/o registro tabular de la entidad.helpFile especifica la ruta y el nombre del archivo de ayuda de las vistas (páginas) de consulta y/o registro tabular de la entidad.inserts indica si las vistas deben permitir, o no, agregar nuevas instancias de la entidad, es decir, insertar nuevas filas a la tabla de la base de datos correspondiente a la entidad.menu especifica el tipo de vistas (páginas) generadas que deben ser accesibles desde el menú principal de la aplicación.quickFilter indica si las vistas generadas incluyen, o no, un snippet para suministrar criterios de búsqueda.readingViewAboveTableSnippet especifica la ruta y el nombre del snippet ubicado encima de la tabla en las vistas (páginas) de consulta tabular de la entidad.readingViewBelowTableSnippet especifica la ruta y el nombre del snippet ubicado debajo de la tabla en las vistas (páginas) de consulta tabular de la entidad.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 tabular de la entidad.readingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de consulta tabular de la entidad.readingViewRowActionSnippet especifica la ruta y el nombre del snippet de la columna de botones de acción de las filas de la tabla en las vistas (páginas) de consulta tabular de la entidad.readingViewRowNumberSnippet especifica la ruta y el nombre del snippet de la columna de números de secuencia de las filas de la tabla en las vistas (páginas) de consulta tabular de la entidad.readingViewRowStatusSnippet especifica la ruta y el nombre del snippet de la columna de iconos de estado de las filas de la tabla en las vistas (páginas) de consulta tabular de la entidad.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 tabular de la entidad.responsiveMode especifica el modo "responsive" de la tabla.introws específica el número inicial de filas por página que muestra la vista.introwsLimit específica el máximo número de filas por página que muestra la vista.stickyHeader indica si las tablas de las vistas generadas incluyen, o no, un encabezado fijo.updates indica si las vistas deben permitir, o no, modificar instancias de la entidad, es decir, actualizar filas de la tabla de la base de datos correspondiente a la entidad.writingViewAboveTableSnippet especifica la ruta y el nombre del snippet ubicado encima de la tabla en las vistas (páginas) de registro tabular de la entidad.writingViewBelowTableSnippet especifica la ruta y el nombre del snippet ubicado debajo de la tabla en las vistas (páginas) de registro tabular de la entidad.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 tabular de la entidad.writingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de registro tabular de la entidad.writingViewRowActionSnippet especifica la ruta y el nombre del snippet de la columna de botones de acción de las filas de la tabla en las vistas (páginas) de registro tabular de la entidad.writingViewRowNumberSnippet especifica la ruta y el nombre del snippet de la columna de números de secuencia de las filas de la tabla en las vistas (páginas) de registro tabular de la entidad.writingViewRowStatusSnippet especifica la ruta y el nombre del snippet de la columna de iconos de estado de las filas de la tabla en las vistas (páginas) de registro tabular de la entidad.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 tabular de la entidad.
-
Element Details
-
enabled
Kleenean enabledenabled 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
-
inserts
Kleenean insertsinserts indica si las vistas deben permitir, o no, agregar nuevas instancias de la entidad, es decir, insertar nuevas filas a la tabla de la base de datos correspondiente a la entidad. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para permitir agregar; 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:
- inserts
- Default:
UNSPECIFIED
-
updates
Kleenean updatesupdates indica si las vistas deben permitir, o no, modificar instancias de la entidad, es decir, actualizar filas de la tabla de la base de datos correspondiente a la entidad. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para permitir modificar; 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:
- updates
- Default:
UNSPECIFIED
-
deletes
Kleenean deletesdeletes indica si las vistas deben permitir, o no, eliminar instancias de la entidad, es decir, eliminar filas de la tabla de la base de datos correspondiente a la entidad. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para permitir eliminar; 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:
- deletes
- Default:
UNSPECIFIED
-
heading
Kleenean headingheading indica si las vistas Maestro/Detalle, donde la entidad es el detalle, muestran, o no, un encabezado con propiedades del maestro. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para mostrar el encabezado; 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:
- heading
- Default:
UNSPECIFIED
-
quickFilter
Kleenean quickFilterquickFilter indica si las vistas generadas incluyen, o no, un snippet para suministrar criterios de búsqueda. Este elemento es relevante solo si se especificó la ruta del snippet mediante el método setProjectFilterSnippetPath o si la entidad tiene una clave de negocio (vea la anotación BusinessKey) y/o una propiedad nombre (vea la anotación NameProperty), en cuyo caso se incluye el snippet predeterminado Constants.QUICK_FILTER_SNIPPET. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para incluir el snippet; 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:
- quickFilter
- Default:
UNSPECIFIED
-
stickyHeader
Kleenean stickyHeaderstickyHeader indica si las tablas de las vistas generadas incluyen, o no, un encabezado fijo. El encabezado fijo permanece visible durante el desplazamiento. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para incluir el encabezado fijo; en caso contrario, seleccione FALSE. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo se puede establecer utilizando el método setEntityTableViewWithStickyHeaderDefaultValue del proyecto maestro; si no se establece, es FALSE.- Returns:
- quickFilter
- Default:
UNSPECIFIED
-
rowsLimit
int rowsLimitrowsLimit específica el máximo número de filas por página 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:
- rowsLimit
- Default:
100
-
rows
int rowsrows específica el número inicial de filas por página 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 1 y el valor del elemento rowsLimit. El valor predeterminado es 10- Returns:
- rows
- Default:
10
-
responsiveMode
TableResponsiveMode responsiveModeresponsiveMode especifica el modo "responsive" de la tabla. Su valor es uno de los elementos de la enumeración TableResponsiveMode. Seleccione AUTO o PRIORITY para mostrar las columnas de la tabla dependiendo de su prioridad, según el tamaño de la pantalla; la diferencia entre estas opciones es que, especificando AUTO, la prioridad de las columnas se determina de manera automática. Seleccione REFLOW para mostrar todas las columnas, apiladas o no, según el tamaño de la pantalla. Seleccione NONE para que la tabla no sea "responsive". Omita el elemento o seleccione UNSPECIFIED para que se utilice el valor establecido mediante el método setDefaultEntityTableViewResponsiveMode del meta-proyecto, cuyo valor inicial es NONE.- Returns:
- responsiveMode
- Default:
UNSPECIFIED
-
helpDocument
String helpDocumenthelpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de consulta y/o registro tabular 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 helpFilehelpFile especifica la ruta y el nombre del archivo de ayuda de las vistas (páginas) de consulta y/o registro tabular 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 readingViewHeadSnippetreadingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de consulta tabular 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 readingViewEasternToolbarSnippetreadingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de consulta tabular 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 readingViewWesternToolbarSnippetreadingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de consulta tabular 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:
""
-
readingViewAboveTableSnippet
String readingViewAboveTableSnippetreadingViewAboveTableSnippet especifica la ruta y el nombre del snippet ubicado encima de la tabla en las vistas (páginas) de consulta tabular 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:
- readingViewAboveTableSnippet
- Default:
""
-
readingViewBelowTableSnippet
String readingViewBelowTableSnippetreadingViewBelowTableSnippet especifica la ruta y el nombre del snippet ubicado debajo de la tabla en las vistas (páginas) de consulta tabular 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:
- readingViewBelowTableSnippet
- Default:
""
-
readingViewRowActionSnippet
String readingViewRowActionSnippetreadingViewRowActionSnippet especifica la ruta y el nombre del snippet de la columna de botones de acción de las filas de la tabla en las vistas (páginas) de consulta tabular 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:
- readingViewRowActionSnippet
- Default:
""
-
readingViewRowStatusSnippet
String readingViewRowStatusSnippetreadingViewRowStatusSnippet especifica la ruta y el nombre del snippet de la columna de iconos de estado de las filas de la tabla en las vistas (páginas) de consulta tabular 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:
- readingViewRowStatusSnippet
- Default:
""
-
readingViewRowNumberSnippet
String readingViewRowNumberSnippetreadingViewRowNumberSnippet especifica la ruta y el nombre del snippet de la columna de números de secuencia de las filas de la tabla en las vistas (páginas) de consulta tabular 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:
- readingViewRowNumberSnippet
- Default:
""
-
writingViewHeadSnippet
String writingViewHeadSnippetwritingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de registro tabular 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 writingViewEasternToolbarSnippetwritingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de registro tabular 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 writingViewWesternToolbarSnippetwritingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de registro tabular 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:
""
-
writingViewAboveTableSnippet
String writingViewAboveTableSnippetwritingViewAboveTableSnippet especifica la ruta y el nombre del snippet ubicado encima de la tabla en las vistas (páginas) de registro tabular 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:
- writingViewAboveTableSnippet
- Default:
""
-
writingViewBelowTableSnippet
String writingViewBelowTableSnippetwritingViewBelowTableSnippet especifica la ruta y el nombre del snippet ubicado debajo de la tabla en las vistas (páginas) de registro tabular 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:
- writingViewBelowTableSnippet
- Default:
""
-
writingViewRowActionSnippet
String writingViewRowActionSnippetwritingViewRowActionSnippet especifica la ruta y el nombre del snippet de la columna de botones de acción de las filas de la tabla en las vistas (páginas) de registro tabular 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:
- writingViewRowActionSnippet
- Default:
""
-
writingViewRowStatusSnippet
String writingViewRowStatusSnippetwritingViewRowStatusSnippet especifica la ruta y el nombre del snippet de la columna de iconos de estado de las filas de la tabla en las vistas (páginas) de registro tabular 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:
- writingViewRowStatusSnippet
- Default:
""
-
writingViewRowNumberSnippet
String writingViewRowNumberSnippetwritingViewRowNumberSnippet especifica la ruta y el nombre del snippet de la columna de números de secuencia de las filas de la tabla en las vistas (páginas) de registro tabular 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:
- writingViewRowNumberSnippet
- Default:
""
-