Package adalid.jee2

Class SpecialPage

  • public class SpecialPage
extends java.lang.Object
    Author:
    Jorge Campins

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCode()  
      java.lang.String getDefaultBreadcrumbLabel()  
      java.lang.String getDefaultDetailLabel()  
      java.lang.String getDefaultLabel()  
      java.lang.String getDefaultMasterLabel()  
      java.lang.String getDefaultShortDescription()  
      java.lang.String getHelpDocument()  
      java.lang.String getHelpFileBookmark()  
      java.lang.String getHelpFileName()  
      java.lang.String getIconClass()  
      java.lang.Long getId()  
      java.lang.String getLocalizedBreadcrumbLabel​(java.util.Locale locale)  
      java.lang.String getLocalizedDetailLabel​(java.util.Locale locale)  
      java.lang.String getLocalizedLabel​(java.util.Locale locale)  
      java.lang.String getLocalizedMasterLabel​(java.util.Locale locale)  
      java.lang.String getLocalizedShortDescription​(java.util.Locale locale)  
      java.lang.String getNumericKeyCode()  
      java.lang.String getView()  
      boolean isExternalView()  
      boolean isInternalView()  
      static SpecialPage of​(java.lang.String code)  
      static SpecialPage of​(java.lang.String code, java.lang.String view)  
      void setDefaultBreadcrumbLabel​(java.lang.String defaultBreadcrumbLabel)
      El método setDefaultBreadcrumbLabel se utiliza para establecer la etiqueta de la miga de pan de la página que se almacena en el archivo de recursos por defecto.
      void setDefaultDetailLabel​(java.lang.String defaultDetailLabel)
      El método setDefaultDetailLabel se utiliza para establecer la etiqueta del detalle de la página que se almacena en el archivo de recursos por defecto.
      void setDefaultLabel​(java.lang.String defaultLabel)
      El método setDefaultLabel se utiliza para establecer la etiqueta de la página que se almacena en el archivo de recursos por defecto.
      void setDefaultMasterLabel​(java.lang.String defaultMasterLabel)
      El método setDefaultMasterLabel se utiliza para establecer la etiqueta del maestro de la página que se almacena en el archivo de recursos por defecto.
      void setDefaultShortDescription​(java.lang.String defaultShortDescription)
      El método setDefaultShortDescription se utiliza para establecer la descripción corta de la página que se almacena en el archivo de recursos por defecto.
      void setHelpDocument​(java.lang.String document)
      El método setHelpDocument se utiliza para establecer el documento incrustado de ayuda de la página.
      void setHelpFileBookmark​(java.lang.String bookmark)
      El método setHelpFileBookmark se utiliza para establecer el marcador en el archivo de ayuda de la página.
      void setHelpFileName​(java.lang.String fileName)
      El método setHelpFileName se utiliza para establecer la ruta y el nombre del archivo de ayuda de la página.
      void setIconClass​(java.lang.String iconClass)
      El método setIconClass se utiliza para establecer la clase CSS de la página.
      void setId​(java.lang.Long id)
      El método setId se utiliza para establecer el ID de la página.
      void setLocalizedBreadcrumbLabel​(java.util.Locale locale, java.lang.String localizedBreadcrumbLabel)
      El método setLocalizedBreadcrumbLabel se utiliza para establecer la etiqueta de la miga de pan de la página que se almacena en el archivo de recursos de configuración regional.
      void setLocalizedDetailLabel​(java.util.Locale locale, java.lang.String localizedDetailLabel)
      El método setLocalizedDetailLabel se utiliza para establecer la etiqueta del detalle de la página que se almacena en el archivo de recursos de configuración regional.
      void setLocalizedLabel​(java.util.Locale locale, java.lang.String localizedLabel)
      El método setLocalizedLabel se utiliza para establecer la etiqueta de la página que se almacena en el archivo de recursos de configuración regional.
      void setLocalizedMasterLabel​(java.util.Locale locale, java.lang.String localizedMasterLabel)
      El método setLocalizedMasterLabel se utiliza para establecer la etiqueta del maestro de la página que se almacena en el archivo de recursos de configuración regional.
      void setLocalizedShortDescription​(java.util.Locale locale, java.lang.String localizedShortDescription)
      El método setLocalizedShortDescription se utiliza para establecer la descripción corta de la página que se almacena en el archivo de recursos de configuración regional.
      static java.lang.String view​(java.lang.String partialView)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • of

        public static SpecialPage of​(java.lang.String code)

      • of

        public static SpecialPage of​(java.lang.String code,
                             java.lang.String view)

      • view

        public static java.lang.String view​(java.lang.String partialView)

      • getCode

        public java.lang.String getCode()
        Returns:
        the page code

      • getView

        public java.lang.String getView()
        Returns:
        the page view

      • isExternalView

        public boolean isExternalView()

      • isInternalView

        public boolean isInternalView()

      • getHelpDocument

        public java.lang.String getHelpDocument()
        Returns:
        the help document

      • setHelpDocument

        public void setHelpDocument​(java.lang.String document)
        El método setHelpDocument se utiliza para establecer el documento incrustado de ayuda de la página.
        Parameters:
        document - definición del documento incrustado de ayuda de la página; si utiliza la plataforma jee2, puede ser una URL o un iframe que incluya la URL del documento.

      • getHelpFileName

        public java.lang.String getHelpFileName()
        Returns:
        the page help file name

      • setHelpFileName

        public void setHelpFileName​(java.lang.String fileName)
        El método setHelpFileName se utiliza para establecer la ruta y el nombre del archivo de ayuda de la página.
        Parameters:
        fileName - ruta y nombre del archivo de ayuda de la página; 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.

      • getHelpFileBookmark

        public java.lang.String getHelpFileBookmark()
        Returns:
        the page help file bookmark

      • setHelpFileBookmark

        public void setHelpFileBookmark​(java.lang.String bookmark)
        El método setHelpFileBookmark se utiliza para establecer el marcador en el archivo de ayuda de la página.
        Parameters:
        bookmark - marcador en el archivo de ayuda de la página.

      • getIconClass

        public java.lang.String getIconClass()
        Returns:
        the page icon CSS class

      • setIconClass

        public void setIconClass​(java.lang.String iconClass)
        El método setIconClass se utiliza para establecer la clase CSS de la página.
        Parameters:
        iconClass - clase CSS de la página.

      • getId

        public java.lang.Long getId()
        Returns:
        the page ID

      • setId

        public void setId​(java.lang.Long id)
        El método setId se utiliza para establecer el ID de la página.
        Parameters:
        id - ID de la página.

      • getNumericKeyCode

        public java.lang.String getNumericKeyCode()
        Returns:
        the page numeric key code

      • getDefaultLabel

        public java.lang.String getDefaultLabel()
        Returns:
        the default label

      • setDefaultLabel

        public void setDefaultLabel​(java.lang.String defaultLabel)
        El método setDefaultLabel se utiliza para establecer la etiqueta de la página que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la descripción.
        Parameters:
        defaultLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta de la página

      • getLocalizedLabel

        public java.lang.String getLocalizedLabel​(java.util.Locale locale)
        Parameters:
        locale - the locale for the label
        Returns:
        the localized label

      • setLocalizedLabel

        public void setLocalizedLabel​(java.util.Locale locale,
                              java.lang.String localizedLabel)
        El método setLocalizedLabel se utiliza para establecer la etiqueta de la página que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la descripción.
        Parameters:
        locale - configuración regional
        localizedLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta de la página

      • getDefaultBreadcrumbLabel

        public java.lang.String getDefaultBreadcrumbLabel()
        Returns:
        the default breadcrumb label

      • setDefaultBreadcrumbLabel

        public void setDefaultBreadcrumbLabel​(java.lang.String defaultBreadcrumbLabel)
        El método setDefaultBreadcrumbLabel se utiliza para establecer la etiqueta de la miga de pan de la página que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        defaultBreadcrumbLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta de la miga de pan de la página

      • getLocalizedBreadcrumbLabel

        public java.lang.String getLocalizedBreadcrumbLabel​(java.util.Locale locale)
        Parameters:
        locale - the locale for the breadcrumb label
        Returns:
        the localized breadcrumb label

      • setLocalizedBreadcrumbLabel

        public void setLocalizedBreadcrumbLabel​(java.util.Locale locale,
                                        java.lang.String localizedBreadcrumbLabel)
        El método setLocalizedBreadcrumbLabel se utiliza para establecer la etiqueta de la miga de pan de la página que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        locale - configuración regional
        localizedBreadcrumbLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta de la miga de pan de la página

      • getDefaultDetailLabel

        public java.lang.String getDefaultDetailLabel()
        Returns:
        the default detail label

      • setDefaultDetailLabel

        public void setDefaultDetailLabel​(java.lang.String defaultDetailLabel)
        El método setDefaultDetailLabel se utiliza para establecer la etiqueta del detalle de la página que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        defaultDetailLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta del detalle de la página

      • getLocalizedDetailLabel

        public java.lang.String getLocalizedDetailLabel​(java.util.Locale locale)
        Parameters:
        locale - the locale for the detail label
        Returns:
        the localized detail label

      • setLocalizedDetailLabel

        public void setLocalizedDetailLabel​(java.util.Locale locale,
                                    java.lang.String localizedDetailLabel)
        El método setLocalizedDetailLabel se utiliza para establecer la etiqueta del detalle de la página que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        locale - configuración regional
        localizedDetailLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta del detalle de la página

      • getDefaultMasterLabel

        public java.lang.String getDefaultMasterLabel()
        Returns:
        the default master label

      • setDefaultMasterLabel

        public void setDefaultMasterLabel​(java.lang.String defaultMasterLabel)
        El método setDefaultMasterLabel se utiliza para establecer la etiqueta del maestro de la página que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        defaultMasterLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta del maestro de la página

      • getLocalizedMasterLabel

        public java.lang.String getLocalizedMasterLabel​(java.util.Locale locale)
        Parameters:
        locale - the locale for the master label
        Returns:
        the localized master label

      • setLocalizedMasterLabel

        public void setLocalizedMasterLabel​(java.util.Locale locale,
                                    java.lang.String localizedMasterLabel)
        El método setLocalizedMasterLabel se utiliza para establecer la etiqueta del maestro de la página que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        locale - configuración regional
        localizedMasterLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta del maestro de la página

      • getDefaultShortDescription

        public java.lang.String getDefaultShortDescription()
        Returns:
        the default short description

      • setDefaultShortDescription

        public void setDefaultShortDescription​(java.lang.String defaultShortDescription)
        El método setDefaultShortDescription se utiliza para establecer la descripción corta de la página que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la descripción.
        Parameters:
        defaultShortDescription - una o más oraciones que describen brevemente la página

      • getLocalizedShortDescription

        public java.lang.String getLocalizedShortDescription​(java.util.Locale locale)
        Parameters:
        locale - the locale for the short description
        Returns:
        the localized short description

      • setLocalizedShortDescription

        public void setLocalizedShortDescription​(java.util.Locale locale,
                                         java.lang.String localizedShortDescription)
        El método setLocalizedShortDescription se utiliza para establecer la descripción corta de la página que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la descripción.
        Parameters:
        locale - configuración regional
        localizedShortDescription - una o más oraciones que describen brevemente la página