Theme (Liferay 7.4.3.23-ga23 portal-kernel API)

All Superinterfaces:

Comparable<Theme>, Plugin, Serializable

All Known Subinterfaces:

StagedTheme
```
@ProviderType
public interface Theme
extends Comparable<Theme>, Plugin, Serializable
```
Author:

Brian Wing Shun Chan, Raymond Augé

Field Summary
- Fields inherited from interface com.liferay.portal.kernel.model.Plugin
  TYPE_HOOK, TYPE_LAYOUT_TEMPLATE, TYPE_PORTLET, TYPE_THEME, TYPE_WEB

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addSetting(String key, String value, boolean configurable, String type, String[] options, String script)`
`List<ColorScheme>`	`getColorSchemes()`
`Map<String,ColorScheme>`	`getColorSchemesMap()`
`Map<String,ThemeSetting>`	`getConfigurableSettings()`
`String`	`getContextPath()`
`String`	`getCssPath()`
`String`	`getDevice()`
`String`	`getFreeMarkerTemplateLoader()`
`String`	`getImagesPath()`
`String`	`getJavaScriptPath()`
`boolean`	`getLoadFromServletContext()`
`String`	`getName()`
`List<PortletDecorator>`	`getPortletDecorators()`
`Map<String,PortletDecorator>`	`getPortletDecoratorsMap()`
`String`	`getResourcePath(javax.servlet.ServletContext servletContext, String portletId, String path)`
`String`	`getRootPath()`
`String`	`getServletContextName()`
`String`	`getSetting(String key)`
`String[]`	`getSettingOptions(String key)`
`Map<String,ThemeSetting>`	`getSettings()`
`Properties`	`getSettingsProperties()`
`String`	`getStaticResourcePath()`
`String`	`getTemplateExtension()`
`String`	`getTemplatesPath()`
`ThemeCompanyLimit`	`getThemeCompanyLimit()`
`ThemeGroupLimit`	`getThemeGroupLimit()`
`String`	`getThemeId()`
`long`	`getTimestamp()`
`String`	`getVelocityResourceListener()`
`String`	`getVirtualPath()`
`boolean`	`getWARFile()`
`boolean`	`hasColorSchemes()`
`boolean`	`isCompanyAvailable(long companyId)`
`boolean`	`isControlPanelTheme()`
`boolean`	`isGroupAvailable(long groupId)`
`boolean`	`isLoadFromServletContext()`
`boolean`	`isPageTheme()`
`boolean`	`isWARFile()`
`boolean`	`resourceExists(javax.servlet.ServletContext servletContext, String portletId, String path)`
`void`	`setControlPanelTheme(boolean controlPanelTheme)`
`void`	`setCssPath(String cssPath)`
`void`	`setImagesPath(String imagesPath)`
`void`	`setJavaScriptPath(String javaScriptPath)`
`void`	`setLoadFromServletContext(boolean loadFromServletContext)`
`void`	`setName(String name)`
`void`	`setPageTheme(boolean pageTheme)`
`void`	`setRootPath(String rootPath)`
`void`	`setServletContextName(String servletContextName)`
`void`	`setSetting(String key, String value)`
`void`	`setTemplateExtension(String templateExtension)`
`void`	`setTemplatesPath(String templatesPath)`
`void`	`setThemeCompanyLimit(ThemeCompanyLimit themeCompanyLimit)`
`void`	`setThemeGroupLimit(ThemeGroupLimit themeGroupLimit)`
`void`	`setTimestamp(long timestamp)`
`void`	`setVirtualPath(String virtualPath)`

Methods inherited from interface Comparable
compareTo

Methods inherited from interface com.liferay.portal.kernel.model.Plugin
getDefaultPluginSetting, getDefaultPluginSetting, getPluginId, getPluginPackage, getPluginType, setDefaultPluginSetting, setPluginPackage

Method Detail

addSetting

void addSetting(String key,
                String value,
                boolean configurable,
                String type,
                String[] options,
                String script)

getColorSchemes
```
List<ColorScheme> getColorSchemes()
```

getColorSchemesMap

Map<String,ColorScheme> getColorSchemesMap()

getConfigurableSettings

Map<String,ThemeSetting> getConfigurableSettings()

getContextPath
```
String getContextPath()
```

getCssPath
```
String getCssPath()
```

getDevice
```
String getDevice()
```

getFreeMarkerTemplateLoader
```
String getFreeMarkerTemplateLoader()
```

getImagesPath
```
String getImagesPath()
```

getJavaScriptPath
```
String getJavaScriptPath()
```

getLoadFromServletContext
```
boolean getLoadFromServletContext()
```

getName
```
String getName()
```

getPortletDecorators

List<PortletDecorator> getPortletDecorators()

getPortletDecoratorsMap

Map<String,PortletDecorator> getPortletDecoratorsMap()

getResourcePath

String getResourcePath(javax.servlet.ServletContext servletContext,
                       String portletId,
                       String path)

getRootPath
```
String getRootPath()
```

getServletContextName
```
String getServletContextName()
```

getSetting
```
String getSetting(String key)
```

getSettingOptions

String[] getSettingOptions(String key)

getSettings
```
Map<String,ThemeSetting> getSettings()
```

getSettingsProperties
```
Properties getSettingsProperties()
```

getStaticResourcePath
```
String getStaticResourcePath()
```

getTemplateExtension
```
String getTemplateExtension()
```

getTemplatesPath
```
String getTemplatesPath()
```

getThemeCompanyLimit

ThemeCompanyLimit getThemeCompanyLimit()

getThemeGroupLimit
```
ThemeGroupLimit getThemeGroupLimit()
```

getThemeId
```
String getThemeId()
```

getTimestamp
```
long getTimestamp()
```

getVelocityResourceListener
```
String getVelocityResourceListener()
```

getVirtualPath
```
String getVirtualPath()
```

getWARFile
```
boolean getWARFile()
```

hasColorSchemes
```
boolean hasColorSchemes()
```

isCompanyAvailable

boolean isCompanyAvailable(long companyId)

isControlPanelTheme
```
boolean isControlPanelTheme()
```

isGroupAvailable

boolean isGroupAvailable(long groupId)

isLoadFromServletContext
```
boolean isLoadFromServletContext()
```

isPageTheme
```
boolean isPageTheme()
```

isWARFile
```
boolean isWARFile()
```

resourceExists

boolean resourceExists(javax.servlet.ServletContext servletContext,
                       String portletId,
                       String path)
                throws Exception

Throws:: Exception

setControlPanelTheme

void setControlPanelTheme(boolean controlPanelTheme)

setCssPath
```
void setCssPath(String cssPath)
```

setImagesPath
```
void setImagesPath(String imagesPath)
```

setJavaScriptPath

void setJavaScriptPath(String javaScriptPath)

setLoadFromServletContext

void setLoadFromServletContext(boolean loadFromServletContext)

setName
```
void setName(String name)
```

setPageTheme
```
void setPageTheme(boolean pageTheme)
```

setRootPath
```
void setRootPath(String rootPath)
```

setServletContextName

void setServletContextName(String servletContextName)

setSetting

void setSetting(String key,
                String value)

setTemplateExtension

void setTemplateExtension(String templateExtension)

setTemplatesPath

void setTemplatesPath(String templatesPath)

setThemeCompanyLimit

void setThemeCompanyLimit(ThemeCompanyLimit themeCompanyLimit)

setThemeGroupLimit

void setThemeGroupLimit(ThemeGroupLimit themeGroupLimit)

setTimestamp
```
void setTimestamp(long timestamp)
```

setVirtualPath

void setVirtualPath(String virtualPath)

Interface Theme

Field Summary

Fields inherited from interface com.liferay.portal.kernel.model.Plugin

Method Summary

Methods inherited from interface Comparable

Methods inherited from interface com.liferay.portal.kernel.model.Plugin

Method Detail

addSetting

getColorSchemes

getColorSchemesMap

getConfigurableSettings

getContextPath

getCssPath

getDevice

getFreeMarkerTemplateLoader

getImagesPath

getJavaScriptPath

getLoadFromServletContext

getName

getPortletDecorators

getPortletDecoratorsMap

getResourcePath

getRootPath

getServletContextName

getSetting

getSettingOptions

getSettings

getSettingsProperties

getStaticResourcePath

getTemplateExtension

getTemplatesPath

getThemeCompanyLimit

getThemeGroupLimit

getThemeId

getTimestamp

getVelocityResourceListener

getVirtualPath

getWARFile

hasColorSchemes

isCompanyAvailable

isControlPanelTheme

isGroupAvailable

isLoadFromServletContext

isPageTheme

isWARFile

resourceExists

setControlPanelTheme

setCssPath

setImagesPath

setJavaScriptPath

setLoadFromServletContext

setName

setPageTheme

setRootPath

setServletContextName

setSetting

setTemplateExtension

setTemplatesPath

setThemeCompanyLimit

setThemeGroupLimit

setTimestamp

setVirtualPath