Class PathFormatHelper


  • public final class PathFormatHelper
    extends Object
    Helper for formatting the Alias, and Theme and Widgetset names.
    Since:
    8.1
    Author:
    Vaadin Ltd.
    • Method Detail

      • getThemeAlias

        public static String getThemeAlias​(String themeName,
                                           String pathPrefix)
        Returns the alias for the theme given a the theme name and a path prefix.
        Parameters:
        themeName - the theme name
        pathPrefix - the prefix for the /VAADIN/ folder
        Returns:
        the alias
      • getThemePath

        public static String getThemePath​(String themeName)
        Returns the expected/default path of the theme folder in the source bundle.
        Parameters:
        themeName - the name of the theme
        Returns:
        the path of the theme folder in the source bundle
      • getWidgetsetAlias

        public static String getWidgetsetAlias​(String widgetsetName,
                                               String pathPrefix)
        Returns the alias for a widgetset given a the widgetset name and a path prefix.
        Parameters:
        widgetsetName - the name of the widgetset
        pathPrefix - the prefix for the /VAADIN/ folder
        Returns:
        the alias
      • getWidgetsetPath

        public static String getWidgetsetPath​(String widgetsetName)
        Returns the expected/default path of the widgetset folder in the source bundle.
        Parameters:
        widgetsetName - the name of the widgetset
        Returns:
        the path of the widgetset folder in the source bundle
      • getRootResourceAlias

        public static String getRootResourceAlias​(String resourceName,
                                                  String pathPrefix)
        Returns the alias for a resource that will placed under the /VAADIN/ folder.
        Parameters:
        resourceName - the name of the resource
        pathPrefix - the prefix for the /VAADIN/ folder
        Returns:
        the alias
      • getRootResourcePath

        public static String getRootResourcePath​(String resourceName)
        Returns the expected/default path of the resource in the source bundle.
        Parameters:
        resourceName - the name of the resource
        Returns:
        the path of the resource in the source bundle