Package adalid.jee2

Class SpecialPage

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

  • Method Details

    • of

      public static SpecialPage of(String code)

    • of

      public static SpecialPage of(String code, String view)

    • view

      public static String view(String partialView)

    • getCode

      public String getCode()
      Returns:
      the page code

    • getView

      public String getView()
      Returns:
      the page view

    • isExternalView

      public boolean isExternalView()

    • isInternalView

      public boolean isInternalView()

    • isPublicView

      public boolean isPublicView()

    • setPublicView

      public void setPublicView(boolean b)
      El método setPublicView se utiliza para establecer si la página especial es, o no, pública; es decir, si la página puede, o no, ser utilizada por todos los usuarios del sistema, aun cuando no tengan autorización explícita para hacerlo. Su valor predeterminado es false.
      Parameters:
      b - true para que la página especial sea pública. Su valor predeterminado es false.

    • isStartOption

      public boolean isStartOption()

    • setStartOption

      public void setStartOption(boolean b)
      El método setStartOption se utiliza para establecer si la página especial puede, o no, ser utilizada por los usuarios como página de inicio.
      Parameters:
      b - true para permitir el uso de la página especial como página de inicio. Su valor predeterminado es true, si la página es interna (es decir, si view comienza con /faces/views/); y false, si es externa.

    • isMenuOption

      public boolean isMenuOption()

    • addToModuleMenu

      public void addToModuleMenu(Project... modules)
      El método addToModuleMenu se utiliza para agregar la página especial al menú de uno o mas módulos de la aplicación.
      Parameters:
      modules - uno o mas módulos de la aplicación.

    • getMenuModuleSet

      public Set<Project> getMenuModuleSet()

    • isInactiveOption

      public boolean isInactiveOption()

    • setInactiveOption

      public void setInactiveOption(boolean b)
      El método setInactiveOption se utiliza para establecer el estado inicial de la página especial como inactivo.
      Parameters:
      b - true para establecer el estado inicial de la página especial como inactivo. Su valor predeterminado es false.

    • getHelpDocument

      public String getHelpDocument()
      Returns:
      the help document

    • setHelpDocument

      public void setHelpDocument(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 String getHelpFileName()
      Returns:
      the page help file name

    • setHelpFileName

      public void setHelpFileName(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 String getHelpFileBookmark()
      Returns:
      the page help file bookmark

    • setHelpFileBookmark

      public void setHelpFileBookmark(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 String getIconClass()
      Returns:
      the page icon CSS class

    • setIconClass

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

    • getId

      public Long getId()
      Returns:
      the page ID

    • setId

      public void setId(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 String getNumericKeyCode()
      Returns:
      the page numeric key code

    • getDefaultLabel

      public String getDefaultLabel()
      Returns:
      the default label

    • setDefaultLabel

      public void setDefaultLabel(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 String getLocalizedLabel(Locale locale)
      Parameters:
      locale - the locale for the label
      Returns:
      the localized label

    • setLocalizedLabel

      public void setLocalizedLabel(Locale locale, 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 String getDefaultBreadcrumbLabel()
      Returns:
      the default breadcrumb label

    • setDefaultBreadcrumbLabel

      public void setDefaultBreadcrumbLabel(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 String getLocalizedBreadcrumbLabel(Locale locale)
      Parameters:
      locale - the locale for the breadcrumb label
      Returns:
      the localized breadcrumb label

    • setLocalizedBreadcrumbLabel

      public void setLocalizedBreadcrumbLabel(Locale locale, 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 String getDefaultDetailLabel()
      Returns:
      the default detail label

    • setDefaultDetailLabel

      public void setDefaultDetailLabel(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 String getLocalizedDetailLabel(Locale locale)
      Parameters:
      locale - the locale for the detail label
      Returns:
      the localized detail label

    • setLocalizedDetailLabel

      public void setLocalizedDetailLabel(Locale locale, 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 String getDefaultMasterLabel()
      Returns:
      the default master label

    • setDefaultMasterLabel

      public void setDefaultMasterLabel(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 String getLocalizedMasterLabel(Locale locale)
      Parameters:
      locale - the locale for the master label
      Returns:
      the localized master label

    • setLocalizedMasterLabel

      public void setLocalizedMasterLabel(Locale locale, 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 String getDefaultShortDescription()
      Returns:
      the default short description

    • setDefaultShortDescription

      public void setDefaultShortDescription(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 String getLocalizedShortDescription(Locale locale)
      Parameters:
      locale - the locale for the short description
      Returns:
      the localized short description

    • setLocalizedShortDescription

      public void setLocalizedShortDescription(Locale locale, 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