Class StandardTheme

java.lang.Object
org.zkoss.web.theme.Theme
org.zkoss.web.theme.StandardTheme

public final class StandardTheme extends Theme
A standard implementation of Theme.
Since:
6.5.2
Author:
neillee
  • Field Details

    • DEFAULT_NAME

      public static final String DEFAULT_NAME
      Name used to identify the default theme
      See Also:
    • DEFAULT_DISPLAY

      public static final String DEFAULT_DISPLAY
      Name used to display the default theme
      See Also:
    • DEFAULT_PRIORITY

      public static final int DEFAULT_PRIORITY
      Priority of the default theme
      See Also:
    • DEFAULT_ORIGIN

      public static final StandardTheme.ThemeOrigin DEFAULT_ORIGIN
      Origin of the default theme. For default desktop theme, it is inside zul.jar/zkex.jar/zkmax.jar. For default tablet theme, it is inside zkmax.jar.
  • Constructor Details

    • StandardTheme

      public StandardTheme()
      Instantiate a default theme
    • StandardTheme

      public StandardTheme(String themeName)
      Instantiate a standard theme
      Parameters:
      themeName - name used to identify the theme
    • StandardTheme

      public StandardTheme(String themeName, StandardTheme.ThemeOrigin origin)
      Instantiate a standard theme
      Parameters:
      themeName - name used to identify the theme
      origin - where the theme resource is located, jar or folder
    • StandardTheme

      public StandardTheme(String themeName, String displayName, int priority)
      Instantiate a standard theme
      Parameters:
      themeName - name used to identify the theme
      displayName - name used to display the theme
      priority - used to choose which theme to use, if no theme is specified, and no preferred theme is set. Higher priority themes are chosen over the lower priority themes. Lower the priority value, higher the priority.
    • StandardTheme

      public StandardTheme(String themeName, String displayName, int priority, StandardTheme.ThemeOrigin origin)
      Instantiate a standard theme
      Parameters:
      themeName - name used to identify the theme
      displayName - name used to display the theme
      priority - used to choose which theme to use, if no theme is specified, and no preferred theme is set. Higher priority themes are chosen over the lower priority themes. Lower the priority value, higher the priority.
      origin - where the theme resources (i.e. CSS and images) are located
  • Method Details

    • getDisplayName

      public String getDisplayName()
      Returns:
      the name used to display the theme
    • setDisplayName

      public void setDisplayName(String displayName)
      Rename the display name
      Parameters:
      displayName - the new name used to display the theme
    • getPriority

      public int getPriority()
      Returns:
      the priority of the theme
    • setPriority

      public void setPriority(int priority)
      Adjust the priority of the theme
      Parameters:
      priority - the new priority of the theme
    • getOrigin

      public StandardTheme.ThemeOrigin getOrigin()
      Returns:
      the origin of the theme resource
    • getComparator

      public static Comparator<StandardTheme> getComparator()
      Defines the ordering of standard themes. Higher priority themes are ordered before the lower priority themes.
      Returns:
      the comparator based on theme's priority values