Package lumis.portal.theme

Interface ITheme

  • All Known Subinterfaces:
    IThemeSPI
    public interface ITheme
    A LumisXP theme.
    Since:
    7.0.0
    Version:
    $Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

    • Method Detail

      • getId

        java.lang.String getId()
        Returns the identifier of this theme.
        Returns:
        the identifier.
        Since:
        7.0.0

      • getName

        java.lang.String getName()
        Returns the name of this theme.
        Returns:
        the name, which may be a localizable string using this theme's string resource, or a simple non-localizable string.
        Since:
        7.0.0

      • getLocalizedName

        java.lang.String getLocalizedName()
        Returns the localized name (using the current user's session locale or the portal's default locale).
        Returns:
        the localized name (using the current user's session locale or the portal's default locale).
        Since:
        7.0.0

      • getDescription

        java.lang.String getDescription()
        Returns the description of this theme.
        Returns:
        the description, which may be a localizable string using this theme's string resource, or a simple non-localizable string, or null if this theme has no description set.
        Since:
        7.0.0

      • getLocalizedDescription

        java.lang.String getLocalizedDescription()
        Returns the localized description (using the current user's session locale or the portal's default locale).
        Returns:
        the localized description (using the current user's session locale or the portal's default locale).
        Since:
        7.0.0

      • getOpenRuntimeInterfaceWithoutActiveParentBehavior

        OpenRuntimeInterfaceBehavior getOpenRuntimeInterfaceWithoutActiveParentBehavior()
        Returns the default open runtime interface behavior set for this theme.
        Returns:
        the behavior selected for this theme, or null if no specific behavior was selected for this theme.
        Since:
        7.0.0

      • getOpenRuntimeInterfaceWithActiveParentBehavior

        OpenRuntimeInterfaceBehavior getOpenRuntimeInterfaceWithActiveParentBehavior()
        Returns the default open runtime interface behavior set for this theme when the runtime interface needs the parent interface to be kept active.
        Returns:
        the behavior selected for this theme, or null if no specific behavior was selected for this theme.
        Since:
        7.0.0

      • getPublicFilesChannelId

        java.lang.String getPublicFilesChannelId()
        Returns the channel identifier that will be used to identify what website to copy the theme static files to.
        Returns:
        the channel identifier that will be used to identify what website to copy the theme static files to.
        Since:
        17.0.0