Package adalid.core.annotations

Annotation Type EntityDetailView

@Retention(RUNTIME)
@Target(TYPE)
public @interface EntityDetailView

La anotación EntityDetailView se utiliza para controlar la generación de las vistas (páginas) de consulta y/o registro detallado de la entidad, conocidas como Detalles de Consulta y/o Detalles de Registro, respectivamente.

Author:

Jorge Campins

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Kleenean	enabled	enabled indica si se debe, o no, generar las vistas.
Kleenean	heading	heading indica si las vistas Maestro/Detalle, donde la entidad es el detalle, muestran, o no, un encabezado con propiedades del maestro.
java.lang.String	helpDocument	helpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de consulta y/o registro detallado de la entidad.
java.lang.String	helpFile	helpFile especifica la ruta y el nombre del archivo de ayuda de las vistas (páginas) de consulta y/o registro detallado de la entidad.
Kleenean	inserting	inserting indica si la opción de menú generada para la vista de registro debe, o no, abrir la página en modo de inserción.
ViewMenuOption	menu	menu especifica el tipo de vistas (páginas) generadas que deben ser accesibles desde el menú principal de la aplicación.
java.lang.String	readingViewAboveDetailSnippet	readingViewAboveDetailSnippet especifica la ruta y el nombre del snippet ubicado encima del detalle en las vistas (páginas) de consulta detallada de la entidad.
java.lang.String	readingViewBelowDetailSnippet	readingViewBelowDetailSnippet especifica la ruta y el nombre del snippet ubicado debajo del detalle en las vistas (páginas) de consulta detallada de la entidad.
java.lang.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 detallada de la entidad.
java.lang.String	readingViewHeadSnippet	readingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de consulta detallada de la entidad.
java.lang.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 detallada de la entidad.
java.lang.String	writingViewAboveDetailSnippet	writingViewAboveDetailSnippet especifica la ruta y el nombre del snippet ubicado encima del detalle en las vistas (páginas) de registro detallado de la entidad.
java.lang.String	writingViewBelowDetailSnippet	writingViewBelowDetailSnippet especifica la ruta y el nombre del snippet ubicado debajo del detalle en las vistas (páginas) de registro detallado de la entidad.
java.lang.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 detallado de la entidad.
java.lang.String	writingViewHeadSnippet	writingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de registro detallado de la entidad.
java.lang.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 detallado de la entidad.

Element Detail

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:

adalid.core.enums.Kleenean.UNSPECIFIED

heading

Kleenean heading

heading 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:

adalid.core.enums.Kleenean.UNSPECIFIED

menu

ViewMenuOption menu

menu especifica el tipo de vistas (páginas) generadas que deben ser accesibles desde el menú principal de la aplicación. Su valor es uno de los elementos de la enumeración ViewMenuOption. Seleccione ALL para agregar una opción de menú para todas las vistas generadas, sin importar su tipo. Seleccione READING o WRITING para agregar una opción solo para las vistas de consulta o las de registro, respectivamente. Seleccione NONE para no agregar opciones de menú para las vistas generadas. El valor predeterminado del atributo es NONE. Este elemento no aplica a vistas Maestro/Detalle.

Returns:

menu

Default:

adalid.core.enums.ViewMenuOption.NONE

inserting

Kleenean inserting

inserting indica si la opción de menú generada para la vista de registro debe, o no, abrir la página en modo de inserción. Su valor es uno de los elementos de la enumeración Kleenean. este elemento solo es relevante si el valor del elemento menu es ALL o WRITING. Seleccione TRUE para abrir la página en modo de inserción; 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:

inserting

Default:

adalid.core.enums.Kleenean.UNSPECIFIED

helpDocument

java.lang.String helpDocument

helpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de consulta y/o registro detallado 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

java.lang.String helpFile

helpFile especifica la ruta y el nombre del archivo de ayuda de las vistas (páginas) de consulta y/o registro detallado 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

java.lang.String readingViewHeadSnippet

readingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de consulta detallada 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

java.lang.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 detallada 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

java.lang.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 detallada 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:

""

readingViewAboveDetailSnippet

java.lang.String readingViewAboveDetailSnippet

readingViewAboveDetailSnippet especifica la ruta y el nombre del snippet ubicado encima del detalle en las vistas (páginas) de consulta detallada 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:

readingViewAboveDetailSnippet

Default:

""

readingViewBelowDetailSnippet

java.lang.String readingViewBelowDetailSnippet

readingViewBelowDetailSnippet especifica la ruta y el nombre del snippet ubicado debajo del detalle en las vistas (páginas) de consulta detallada 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:

readingViewBelowDetailSnippet

Default:

""

writingViewHeadSnippet

java.lang.String writingViewHeadSnippet

writingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de registro detallado 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

java.lang.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 detallado 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

java.lang.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 detallado 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:

""

writingViewAboveDetailSnippet

java.lang.String writingViewAboveDetailSnippet

writingViewAboveDetailSnippet especifica la ruta y el nombre del snippet ubicado encima del detalle en las vistas (páginas) de registro detallado 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:

writingViewAboveDetailSnippet

Default:

""

writingViewBelowDetailSnippet

java.lang.String writingViewBelowDetailSnippet

writingViewBelowDetailSnippet especifica la ruta y el nombre del snippet ubicado debajo del detalle en las vistas (páginas) de registro detallado 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:

writingViewBelowDetailSnippet

Default:

""