Package adalid.core.annotations

Annotation Type MasterProject

  • @Retention(RUNTIME)
@Target({TYPE,FIELD})
public @interface MasterProject
    La anotación MasterProject se utiliza para establecer atributos del proyecto maestro.
    Author:
    Jorge Campins

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String alias
      alias especifica el código alterno del proyecto.
      String helpDocument
      helpDocument especifica el documento incrustado de ayuda del proyecto.
      String helpFile
      helpFile especifica la ruta y el nombre del archivo de ayuda del proyecto.
      HelpFileAutoName helpFileAutoName
      helpFileAutoName especifica el método de generación automática del nombre del archivo de ayuda de las vistas (páginas) del proyecto.
      String helpFileAutoType
      helpFileAutoType especifica el tipo (la extensión sin el punto) de los nombres de archivo de ayuda generados automáticamente.

    • Element Detail

      • alias

        String alias
        alias especifica el código alterno del proyecto. El alias solo puede contener letras minúsculas y números, debe comenzar por una letra, y no puede ser jee2ap101, meta o workspace. Se recomienda utilizar un alias que tenga el nombre de su proyecto como prefijo.
        Returns:
        alias
        Default:
        ""

      • helpDocument

        String helpDocument
        helpDocument especifica el documento incrustado de ayuda del proyecto. Si utiliza la plataforma jee2, puede ser una URL o un iframe que incluya la URL del documento. Cada módulo y cada entidad del proyecto podrían tener su propio documento incrustado de ayuda, según lo establecido mediante los elementos de sus anotaciones ProjectModule y EntityClass. También se puede especificar un documento incrustado diferente para cada formato de vista de cada entidad, mediante las anotaciones EntityTableView, EntityDetailView, EntityTreeView y EntityConsoleView. 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 del proyecto. 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 módulo, cada entidad y cada vista (página) de cada entidad del proyecto podrían tener su propio archivo de ayuda, según lo establecido mediante los elementos de las anotaciones ProjectModule y EntityClass de cada módulo y cada entidad. También se puede especificar un archivo diferente para cada formato de vista de cada entidad, mediante las anotaciones EntityTableView, EntityDetailView, EntityTreeView y EntityConsoleView. 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:
        ""

      • helpFileAutoName

        HelpFileAutoName helpFileAutoName
        helpFileAutoName especifica el método de generación automática del nombre del archivo de ayuda de las vistas (páginas) del proyecto. Su valor es uno de los elementos de la enumeración HelpFileAutoName. Seleccione DISPLAY o ENTITY para que generar automáticamente el nombre del archivo de ayuda de las vistas con el nombre de la vista o con el de la entidad de la vista, respectivamente; alternativamente, omita el elemento o seleccione NONE para no generar nombres de archivos de ayuda de vistas automáticamente. Seleccione ENTITY para utilizar los archivos de ayuda generados por la clase utilitaria WebAppHelp. El valor predeterminado del atributo es NONE.
        Returns:
        helpFileAutoName
        Default:
        adalid.core.enums.HelpFileAutoName.UNSPECIFIED

      • helpFileAutoType

        String helpFileAutoType
        helpFileAutoType especifica el tipo (la extensión sin el punto) de los nombres de archivo de ayuda generados automáticamente. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento helpFileAutoName es DISPLAY o ENTITY. Su valor puede ser html, xhtml, pdf, gif, jpg, jpeg o png. Especifique xhtml para utilizar los archivos de ayuda generados por la clase utilitaria WebAppHelp. El valor predeterminado del atributo es html.
        Returns:
        helpFileAutoType
        Default:
        ""