ThemeDisplay

java.lang.Object
- com.liferay.portal.kernel.theme.ThemeDisplay

All Implemented Interfaces:

Mergeable<ThemeDisplay>, java.io.Serializable, java.lang.Cloneable
```
@JSON
 @ProviderType
public class ThemeDisplay
extends java.lang.Object
implements java.lang.Cloneable, Mergeable<ThemeDisplay>, java.io.Serializable
```
Provides general configuration methods for the portal, providing access to the portal's pages, sites, themes, locales, URLs, and more. This class is an information context object that holds data commonly referred to for various kinds of front-end information.
Liferay makes the ThemeDisplay available as a request attribute and in various scripting and templating scopes. A typical way to obtain ThemeDisplay is from a request:
```
 
 themeDisplay = (ThemeDisplay) request.getAttribute(WebKeys.THEME_DISPLAY);
 
 
```
Author:

Brian Wing Shun Chan

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ThemeDisplay()

Constructors
Constructor and Description
`ThemeDisplay()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clearLayoutFriendlyURL(Layout layout)`
`java.lang.Object`	`clone()`
`Account`	`getAccount()`
`java.lang.String`	`getCDNBaseURL()` Returns the content delivery network (CDN) base URL, or the current portal URL if the CDN base URL is `null`.
`java.lang.String`	`getCDNDynamicResourcesHost()` Returns the content delivery network (CDN) dynamic resources host, or the current portal URL if the CDN dynamic resources host is `null`.
`java.lang.String`	`getCDNHost()`
`ColorScheme`	`getColorScheme()`
`java.lang.String`	`getColorSchemeId()` Returns the color scheme ID as defined in the theme's `liferay-look-and-feel.xml`.
`Company`	`getCompany()` Returns the portal instance bean.
`long`	`getCompanyGroupId()`
`long`	`getCompanyId()` Returns the portal instance ID.
`java.lang.String`	`getCompanyLogo()` Returns the server's relative path to the portal instance's logo.
`int`	`getCompanyLogoHeight()` Returns the height of the portal instance's logo in pixels.
`int`	`getCompanyLogoWidth()` Returns the width of the portal instance's logo in pixels.
`Contact`	`getContact()`
`Group`	`getControlPanelGroup()`
`Layout`	`getControlPanelLayout()`
`User`	`getDefaultUser()` Returns the portal instance's default user.
`long`	`getDefaultUserId()` Returns the ID of the portal instance's default user.
`Device`	`getDevice()` Returns the information about the detected device, such as the device's brand, browser, operating system, screen resolution, etc.
`long`	`getDoAsGroupId()`
`java.lang.String`	`getDoAsUserId()` Returns the encrypted ID of the "do as" user, which can be used by an administrative user to impersonate another user, on that user's behalf.
`java.lang.String`	`getDoAsUserLanguageId()`
`java.lang.String`	`getI18nLanguageId()` Returns the current internationalization language's code.
`java.lang.String`	`getI18nPath()` Returns the path element for the current internationalization language.
`java.lang.String`	`getLanguageId()` Returns the current language's code.
`Layout`	`getLayout()` Returns the site's page.
`java.lang.String`	`getLayoutFriendlyURL(Layout layout)`
`java.util.List<Layout>`	`getLayouts()` Returns the site's top-level pages.
`LayoutSet`	`getLayoutSet()` Returns the current layout set, being either a public layout set or a private layout set.
`java.lang.String`	`getLayoutSetLogo()` Returns the path to the site's configured logo, or `null` if there is no configured logo.
`LayoutTypePortlet`	`getLayoutTypePortlet()`
`java.lang.String`	`getLifecycle()` Returns the numeric portlet lifecycle indicator.
`java.util.Locale`	`getLocale()` Returns the locale used for displaying content.
`MDRRuleGroupInstance`	`getMDRRuleGroupInstance()`
`java.lang.String`	`getPathApplet()`
`java.lang.String`	`getPathCms()`
`java.lang.String`	`getPathColorSchemeImages()` Returns the base URL for the color scheme's images, which can be configured in the theme's `liferay-look-and-feel.xml`.
`java.lang.String`	`getPathContext()`
`java.lang.String`	`getPathFlash()`
`java.lang.String`	`getPathFriendlyURLPrivateGroup()` Returns the URL for the site's private layout set.
`java.lang.String`	`getPathFriendlyURLPrivateUser()` Returns the URL for the user's private page set.
`java.lang.String`	`getPathFriendlyURLPublic()` Returns the URL for the site's public page set.
`java.lang.String`	`getPathImage()` Returns the URL for the portal instance's images.
`java.lang.String`	`getPathJavaScript()` Returns the URL for the portal instance's JavaScript resources.
`java.lang.String`	`getPathMain()` Returns the URL for the portal instance's main servlet.
`java.lang.String`	`getPathSound()`
`java.lang.String`	`getPathThemeCss()` Returns the URL for the theme's CSS directory.
`java.lang.String`	`getPathThemeImages()` Returns the URL for the theme's images.
`java.lang.String`	`getPathThemeJavaScript()` Returns the URL for the theme's JavaScript directory.
`java.lang.String`	`getPathThemeRoot()` Returns the base URL for the theme.
`java.lang.String`	`getPathThemeTemplates()` Returns the URL for the theme's templates.
`PermissionChecker`	`getPermissionChecker()` Returns the permission checker, which is used to ensure users making resource requests have the necessary access permissions.
`long`	`getPlid()` Returns the primary key of the page.
`java.lang.String`	`getPortalDomain()`
`java.lang.String`	`getPortalURL()` Returns the portal instance's base URL, which can be configured by setting the `web.server.host` property in a `portal-ext.properties` file.
`PortletDisplay`	`getPortletDisplay()`
`java.lang.String`	`getPpid()`
`java.lang.String`	`getProtocol()`
`java.lang.String`	`getRealCompanyLogo()`
`int`	`getRealCompanyLogoHeight()`
`int`	`getRealCompanyLogoWidth()`
`User`	`getRealUser()` Returns the logged in user.
`long`	`getRealUserId()` Returns the ID of the logged in user.
`Group`	`getRefererGroup()`
`long`	`getRefererGroupId()`
`long`	`getRefererPlid()`
`javax.servlet.http.HttpServletRequest`	`getRequest()` Returns the currently served HTTP servlet request.
`javax.servlet.http.HttpServletResponse`	`getResponse()` Returns the currently served HTTP servlet response.
`Group`	`getScopeGroup()` Returns the scoped or sub-scoped active group (e.g. site).
`long`	`getScopeGroupId()` Returns the ID of the scoped or sub-scoped active group (e.g. site).
`java.lang.String`	`getScopeGroupName()` Returns the name of the scoped or sub-scoped active group (e.g. site).
`Layout`	`getScopeLayout()`
`java.lang.String`	`getServerName()` Returns the portal instance's server name, which can be configured by setting the `web.server.host` property in a `portal-ext.properties` file.
`int`	`getServerPort()` Returns the server port, which can be configured by setting the `web.server.http.port` or `web.server.https.port` property in a `portal-ext.properties` file.
`java.lang.String`	`getSessionId()` Returns the session ID, or a blank string if the session ID is not available to the application.
`java.util.Locale`	`getSiteDefaultLocale()`
`Group`	`getSiteGroup()`
`long`	`getSiteGroupId()`
`long`	`getSiteGroupIdOrLiveGroupId()`
`java.lang.String`	`getSiteGroupName()`
`javax.portlet.PortletPreferences`	`getStrictLayoutPortletSetup(Layout layout, java.lang.String portletId)`
`Theme`	`getTheme()`
`java.lang.String`	`getThemeId()`
`java.lang.String`	`getThemeSetting(java.lang.String key)` Returns the theme's configurable settings, which are declared in `liferay-look-and-feel.xml` and are configurable in the user interface.
`java.util.Properties`	`getThemeSettings()` Returns the theme's configurable settings, which are declared in `liferay-look-and-feel.xml` and are configurable in the user interface.
`java.lang.String`	`getTilesContent()`
`java.lang.String`	`getTilesTitle()`
`java.util.TimeZone`	`getTimeZone()`
`java.util.List<Layout>`	`getUnfilteredLayouts()`
`java.lang.String`	`getURLControlPanel()`
`java.lang.String`	`getURLCurrent()`
`java.lang.String`	`getURLHome()`
`javax.portlet.PortletURL`	`getURLMyAccount()`
`java.lang.String`	`getURLPortal()`
`javax.portlet.PortletURL`	`getURLPublishToLive()`
`java.lang.String`	`getURLSignIn()`
`java.lang.String`	`getURLSignOut()`
`javax.portlet.PortletURL`	`getURLUpdateManager()`
`User`	`getUser()` The user for which the current request is being handled.
`long`	`getUserId()` Returns the ID of the user for which the current request is being handled.
`boolean`	`isAddSessionIdToURL()`
`boolean`	`isAjax()`
`boolean`	`isAsync()`
`boolean`	`isFreeformLayout()` Deprecated. As of Judson (7.1.x), as of 7.1.x, with no direct replacement
`boolean`	`isHubAction()`
`boolean`	`isHubPartialAction()`
`boolean`	`isHubResource()`
`boolean`	`isI18n()`
`boolean`	`isImpersonated()` Returns `true` if the user is being impersonated by an administrative user.
`boolean`	`isIncludedJs(java.lang.String js)`
`boolean`	`isIncludePortletCssJs()`
`boolean`	`isIsolated()`
`boolean`	`isLifecycleAction()`
`boolean`	`isLifecycleEvent()`
`boolean`	`isLifecycleRender()`
`boolean`	`isLifecycleResource()`
`boolean`	`isPortletEmbedded(long groupId, Layout layout, java.lang.String portletId)`
`boolean`	`isPortletEmbedded(java.lang.String portletId)`
`boolean`	`isSecure()`
`boolean`	`isShowControlPanelIcon()`
`boolean`	`isShowHomeIcon()`
`boolean`	`isShowLayoutTemplatesIcon()`
`boolean`	`isShowMyAccountIcon()`
`boolean`	`isShowPageCustomizationIcon()`
`boolean`	`isShowPageSettingsIcon()`
`boolean`	`isShowPortalIcon()`
`boolean`	`isShowSignInIcon()`
`boolean`	`isShowSignOutIcon()`
`boolean`	`isShowSiteAdministrationIcon()`
`boolean`	`isShowStagingIcon()`
`boolean`	`isSignedIn()`
`boolean`	`isStateExclusive()`
`boolean`	`isStateMaximized()`
`boolean`	`isStatePopUp()`
`boolean`	`isThemeCssFastLoad()`
`boolean`	`isThemeImagesFastLoad()`
`boolean`	`isThemeJsBarebone()`
`boolean`	`isThemeJsFastLoad()`
`boolean`	`isTilesSelectable()`
`boolean`	`isWidget()`
`ThemeDisplay`	`merge(ThemeDisplay themeDisplay)`
`void`	`setAccount(Account account)`
`void`	`setAddSessionIdToURL(boolean addSessionIdToURL)`
`void`	`setAjax(boolean ajax)`
`void`	`setAsync(boolean async)`
`void`	`setCDNBaseURL(java.lang.String cdnBase)`
`void`	`setCDNDynamicResourcesHost(java.lang.String cdnDynamicResourcesHost)`
`void`	`setCDNHost(java.lang.String cdnHost)`
`void`	`setCompany(Company company)`
`void`	`setCompanyLogo(java.lang.String companyLogo)`
`void`	`setCompanyLogoHeight(int companyLogoHeight)`
`void`	`setCompanyLogoWidth(int companyLogoWidth)`
`void`	`setContact(Contact contact)`
`void`	`setDevice(Device device)`
`void`	`setDoAsGroupId(long doAsGroupId)`
`void`	`setDoAsUserId(java.lang.String doAsUserId)`
`void`	`setDoAsUserLanguageId(java.lang.String doAsUserLanguageId)`
`void`	`setFreeformLayout(boolean freeformLayout)` Deprecated. As of Judson (7.1.x), as of 7.1.x, with no direct replacement
`void`	`setHubAction(boolean hubAction)`
`void`	`setHubPartialAction(boolean hubPartialAction)`
`void`	`setHubResource(boolean resource)`
`void`	`setI18nLanguageId(java.lang.String i18nLanguageId)`
`void`	`setI18nPath(java.lang.String i18nPath)`
`void`	`setIncludePortletCssJs(boolean includePortletCssJs)`
`void`	`setIsolated(boolean isolated)`
`void`	`setLanguageId(java.lang.String languageId)`
`void`	`setLayout(Layout layout)`
`void`	`setLayouts(java.util.List<Layout> layouts)`
`void`	`setLayoutSet(LayoutSet layoutSet)`
`void`	`setLayoutSetLogo(java.lang.String layoutSetLogo)`
`void`	`setLayoutTypePortlet(LayoutTypePortlet layoutTypePortlet)`
`void`	`setLifecycle(java.lang.String lifecycle)`
`void`	`setLifecycleAction(boolean lifecycleAction)`
`void`	`setLifecycleEvent(boolean lifecycleEvent)`
`void`	`setLifecycleRender(boolean lifecycleRender)`
`void`	`setLifecycleResource(boolean lifecycleResource)`
`void`	`setLocale(java.util.Locale locale)`
`void`	`setLookAndFeel(Theme theme, ColorScheme colorScheme)`
`void`	`setMDRRuleGroupInstance(MDRRuleGroupInstance mdrRuleGroupInstance)`
`void`	`setPathApplet(java.lang.String pathApplet)`
`void`	`setPathCms(java.lang.String pathCms)`
`void`	`setPathColorSchemeImages(java.lang.String pathColorSchemeImages)`
`void`	`setPathContext(java.lang.String pathContext)`
`void`	`setPathFlash(java.lang.String pathFlash)`
`void`	`setPathFriendlyURLPrivateGroup(java.lang.String pathFriendlyURLPrivateGroup)`
`void`	`setPathFriendlyURLPrivateUser(java.lang.String pathFriendlyURLPrivateUser)`
`void`	`setPathFriendlyURLPublic(java.lang.String pathFriendlyURLPublic)`
`void`	`setPathImage(java.lang.String pathImage)`
`void`	`setPathJavaScript(java.lang.String pathJavaScript)`
`void`	`setPathMain(java.lang.String pathMain)`
`void`	`setPathSound(java.lang.String pathSound)`
`void`	`setPathThemeCss(java.lang.String pathThemeCss)`
`void`	`setPathThemeImages(java.lang.String pathThemeImages)`
`void`	`setPathThemeJavaScript(java.lang.String pathThemeJavaScript)`
`void`	`setPathThemeRoot(java.lang.String pathThemeRoot)`
`void`	`setPathThemeTemplates(java.lang.String pathThemeTemplates)`
`void`	`setPermissionChecker(PermissionChecker permissionChecker)`
`void`	`setPlid(long plid)`
`void`	`setPortalDomain(java.lang.String portalDomain)`
`void`	`setPortalURL(java.lang.String portalURL)`
`void`	`setPpid(java.lang.String ppid)`
`void`	`setRealCompanyLogo(java.lang.String realCompanyLogo)`
`void`	`setRealCompanyLogoHeight(int realCompanyLogoHeight)`
`void`	`setRealCompanyLogoWidth(int realCompanyLogoWidth)`
`void`	`setRealUser(User realUser)`
`void`	`setRefererGroupId(long refererGroupId)`
`void`	`setRefererPlid(long refererPlid)`
`void`	`setRequest(javax.servlet.http.HttpServletRequest httpServletRequest)`
`void`	`setResponse(javax.servlet.http.HttpServletResponse httpServletResponse)`
`void`	`setScopeGroupId(long scopeGroupId)`
`void`	`setSecure(boolean secure)`
`void`	`setServerName(java.lang.String serverName)`
`void`	`setServerPort(int serverPort)`
`void`	`setSessionId(java.lang.String sessionId)`
`void`	`setShowControlPanelIcon(boolean showControlPanelIcon)`
`void`	`setShowHomeIcon(boolean showHomeIcon)`
`void`	`setShowLayoutTemplatesIcon(boolean showLayoutTemplatesIcon)`
`void`	`setShowMyAccountIcon(boolean showMyAccountIcon)`
`void`	`setShowPageCustomizationIcon(boolean showPageCustomizationIcon)`
`void`	`setShowPageSettingsIcon(boolean showPageSettingsIcon)`
`void`	`setShowPortalIcon(boolean showPortalIcon)`
`void`	`setShowSignInIcon(boolean showSignInIcon)`
`void`	`setShowSignOutIcon(boolean showSignOutIcon)`
`void`	`setShowSiteAdministrationIcon(boolean showSiteAdministrationIcon)`
`void`	`setShowStagingIcon(boolean showStagingIcon)`
`void`	`setSignedIn(boolean signedIn)`
`void`	`setSiteDefaultLocale(java.util.Locale siteDefaultLocale)`
`void`	`setSiteGroupId(long siteGroupId)`
`void`	`setStateExclusive(boolean stateExclusive)`
`void`	`setStateMaximized(boolean stateMaximized)`
`void`	`setStatePopUp(boolean statePopUp)`
`void`	`setThemeCssFastLoad(boolean themeCssFastLoad)`
`void`	`setThemeImagesFastLoad(boolean themeImagesFastLoad)`
`void`	`setThemeJsBarebone(boolean themeJsBarebone)`
`void`	`setThemeJsFastLoad(boolean themeJsFastLoad)`
`void`	`setTilesContent(java.lang.String tilesContent)`
`void`	`setTilesSelectable(boolean tilesSelectable)`
`void`	`setTilesTitle(java.lang.String tilesTitle)`
`void`	`setTimeZone(java.util.TimeZone timeZone)`
`void`	`setUnfilteredLayouts(java.util.List<Layout> unfilteredLayouts)`
`void`	`setURLControlPanel(java.lang.String urlControlPanel)`
`void`	`setURLCurrent(java.lang.String urlCurrent)`
`void`	`setURLHome(java.lang.String urlHome)`
`void`	`setURLLayoutTemplates(java.lang.String urlLayoutTemplates)`
`void`	`setURLPortal(java.lang.String urlPortal)`
`void`	`setURLPublishToLive(javax.portlet.PortletURL urlPublishToLive)`
`void`	`setURLSignIn(java.lang.String urlSignIn)`
`void`	`setURLSignOut(java.lang.String urlSignOut)`
`void`	`setUser(User user)`
`void`	`setWidget(boolean widget)`
`ThemeDisplay`	`split()`
`java.lang.String`	`translate(java.lang.String key)`
`java.lang.String`	`translate(java.lang.String pattern, java.lang.Object... arguments)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ThemeDisplay
```
public ThemeDisplay()
```

Method Detail

clearLayoutFriendlyURL

public void clearLayoutFriendlyURL(Layout layout)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:: clone in class java.lang.Object
Throws:: java.lang.CloneNotSupportedException

getAccount
```
public Account getAccount()
```

getCDNBaseURL
```
public java.lang.String getCDNBaseURL()
```
Returns the content delivery network (CDN) base URL, or the current portal URL if the CDN base URL is null. The CDN base URL can be configured by setting the cdn.host.http or cdn.host.https property in a portal-ext.properties file.

Returns:

the CDN base URL, or the current portal URL if the CDN base URL is null

getCDNDynamicResourcesHost
```
public java.lang.String getCDNDynamicResourcesHost()
```
Returns the content delivery network (CDN) dynamic resources host, or the current portal URL if the CDN dynamic resources host is null. By setting the cdn.dynamic.resources.enabled property to true in a portal-ext.properties file, the CDN can be used for dynamic resources, like minified CSS and JS files.

Returns:

the CDN dynamic resources host, or the current portal URL if the CDN dynamic resources host is null

getCDNHost
```
public java.lang.String getCDNHost()
```

getColorScheme
```
public ColorScheme getColorScheme()
```

getColorSchemeId
```
public java.lang.String getColorSchemeId()
```
Returns the color scheme ID as defined in the theme's liferay-look-and-feel.xml.

Returns:

the color scheme ID as defined in the theme's liferay-look-and-feel.xml

getCompany
```
public Company getCompany()
```
Returns the portal instance bean.
Company is Liferay's technical name for a portal instance.

Returns:

the portal instance bean

getCompanyGroupId
```
public long getCompanyGroupId()
```

getCompanyId
```
public long getCompanyId()
```
Returns the portal instance ID.
Company is Liferay's technical name for a portal instance.

Returns:

the portal instance ID

getCompanyLogo
```
public java.lang.String getCompanyLogo()
```
Returns the server's relative path to the portal instance's logo.
Company is Liferay's technical name for a portal instance.

Returns:

the server's relative path to the portal instance's logo

getCompanyLogoHeight
```
public int getCompanyLogoHeight()
```
Returns the height of the portal instance's logo in pixels.
Company is Liferay's technical name for a portal instance.

Returns:

the height of the portal instance's logo in pixels

getCompanyLogoWidth
```
public int getCompanyLogoWidth()
```
Returns the width of the portal instance's logo in pixels.
Company is Liferay's technical name for a portal instance.

Returns:

the width of the portal instance's logo in pixels

getContact
```
public Contact getContact()
```

getControlPanelGroup
```
public Group getControlPanelGroup()
```

getControlPanelLayout
```
public Layout getControlPanelLayout()
```

getDefaultUser
```
public User getDefaultUser()
                    throws PortalException
```
Returns the portal instance's default user.

Returns:

the portal instance's default user

Throws:

PortalException

getDefaultUserId
```
public long getDefaultUserId()
                      throws PortalException
```
Returns the ID of the portal instance's default user.

Returns:

the ID of the portal instance's default user

Throws:

PortalException

getDevice
```
public Device getDevice()
```
Returns the information about the detected device, such as the device's brand, browser, operating system, screen resolution, etc.

Returns:

the information about the detected device

getDoAsGroupId
```
public long getDoAsGroupId()
```

getDoAsUserId
```
public java.lang.String getDoAsUserId()
```
Returns the encrypted ID of the "do as" user, which can be used by an administrative user to impersonate another user, on that user's behalf.

Returns:

the encrypted ID of the "do as" user, which can be used by an administrative user to impersonate another user, on that user's behalf

getDoAsUserLanguageId

public java.lang.String getDoAsUserLanguageId()

getI18nLanguageId
```
public java.lang.String getI18nLanguageId()
```
Returns the current internationalization language's code.
For example:

English (U.K.) returns en_GB

Returns:

the current internationalization language's code

getI18nPath
```
public java.lang.String getI18nPath()
```
Returns the path element for the current internationalization language.
For example, the German localization returns /de. Liferay's UI language can be changed by adding the language code into the URL path. The following URL uses the German localization: http://localhost:8080/de/web/guest/home.

Returns:

the path element for the current internationalization language

getLanguageId
```
public java.lang.String getLanguageId()
```
Returns the current language's code.
For example:

English (U.K.) returns en_GB

Returns:

the current language's code

getLayout
```
public Layout getLayout()
```
Returns the site's page.
Layout is Liferay's technical name for a page.

Returns:

the site's page

getLayoutFriendlyURL

public java.lang.String getLayoutFriendlyURL(Layout layout)

getLayouts
```
public java.util.List<Layout> getLayouts()
```
Returns the site's top-level pages.
Layout is Liferay's technical name for a page.

Returns:

the site's top-level pages

getLayoutSet
```
public LayoutSet getLayoutSet()
```
Returns the current layout set, being either a public layout set or a private layout set.
A site can have public and private pages (layouts), which are contained in a public layout set and a private page set, respectively.

Returns:

the current layout set, being either a public layout set or a private layout set

getLayoutSetLogo
```
public java.lang.String getLayoutSetLogo()
```
Returns the path to the site's configured logo, or null if there is no configured logo.

Returns:

the path to the site's configured logo, or null if there is no configured logo

getLayoutTypePortlet

public LayoutTypePortlet getLayoutTypePortlet()

getLifecycle

public java.lang.String getLifecycle()

Returns the numeric portlet lifecycle indicator.

For example:

 
 returns "0" for RENDER phase
 returns "1" for ACTION phase
 returns "2" for RESOURCE phase
 returns "3" for EVENT phase

Returns:: the numeric portlet lifecycle indicator

getLocale
```
public java.util.Locale getLocale()
```
Returns the locale used for displaying content.

Returns:

the locale used for displaying content

getMDRRuleGroupInstance

public MDRRuleGroupInstance getMDRRuleGroupInstance()

getPathApplet

public java.lang.String getPathApplet()

getPathCms
```
public java.lang.String getPathCms()
```

getPathColorSchemeImages
```
public java.lang.String getPathColorSchemeImages()
```
Returns the base URL for the color scheme's images, which can be configured in the theme's liferay-look-and-feel.xml.

Returns:

the base URL for the color scheme's images

getPathContext

public java.lang.String getPathContext()

getPathFlash

public java.lang.String getPathFlash()

getPathFriendlyURLPrivateGroup
```
public java.lang.String getPathFriendlyURLPrivateGroup()
```
Returns the URL for the site's private layout set. This method typically returns /group.

Returns:

the URL for the site's private layout set

getPathFriendlyURLPrivateUser
```
public java.lang.String getPathFriendlyURLPrivateUser()
```
Returns the URL for the user's private page set. This method typically returns /user.

Returns:

the URL for the user's private page set

getPathFriendlyURLPublic
```
public java.lang.String getPathFriendlyURLPublic()
```
Returns the URL for the site's public page set. This method typically returns /web.

Returns:

the URL for the site's public page set

getPathImage
```
public java.lang.String getPathImage()
```
Returns the URL for the portal instance's images. This method typically returns /image.

Returns:

the URL for the portal instance's images

getPathJavaScript
```
public java.lang.String getPathJavaScript()
```
Returns the URL for the portal instance's JavaScript resources.

Returns:

the URL for the portal instance's JavaScript resources

getPathMain
```
public java.lang.String getPathMain()
```
Returns the URL for the portal instance's main servlet. This method typically returns /c.

Returns:

the URL for the portal instance's main servlet

getPathSound

public java.lang.String getPathSound()

getPathThemeCss
```
public java.lang.String getPathThemeCss()
```
Returns the URL for the theme's CSS directory.

Returns:

the URL for the theme's CSS directory

getPathThemeImages
```
public java.lang.String getPathThemeImages()
```
Returns the URL for the theme's images.

Returns:

the URL for the theme's images

getPathThemeJavaScript
```
public java.lang.String getPathThemeJavaScript()
```
Returns the URL for the theme's JavaScript directory.

Returns:

the URL for the theme's JavaScript directory

getPathThemeRoot
```
public java.lang.String getPathThemeRoot()
```
Returns the base URL for the theme.

Returns:

the base URL for the theme

getPathThemeTemplates
```
public java.lang.String getPathThemeTemplates()
```
Returns the URL for the theme's templates.

Returns:

the URL for the theme's templates

getPermissionChecker
```
@JSON(include=false)
public PermissionChecker getPermissionChecker()
```
Returns the permission checker, which is used to ensure users making resource requests have the necessary access permissions.

Returns:

the permission checker

getPlid
```
public long getPlid()
```
Returns the primary key of the page.
Historically, "plid" was short for "portlet layout ID", which is the primary key (ID) of the current layout (page).

Returns:

the primary key of the page

getPortalDomain

public java.lang.String getPortalDomain()

getPortalURL
```
public java.lang.String getPortalURL()
```
Returns the portal instance's base URL, which can be configured by setting the web.server.host property in a portal-ext.properties file.

Returns:

the portal instance's base URL

getPortletDisplay

@JSON(include=false)
public PortletDisplay getPortletDisplay()

getPpid
```
public java.lang.String getPpid()
```

getProtocol
```
public java.lang.String getProtocol()
```

getRealCompanyLogo

public java.lang.String getRealCompanyLogo()

getRealCompanyLogoHeight
```
public int getRealCompanyLogoHeight()
```

getRealCompanyLogoWidth
```
public int getRealCompanyLogoWidth()
```

getRealUser
```
public User getRealUser()
```
Returns the logged in user. Since administrative users are able to impersonate other users, this method reveals the identity of the user who actually logged in.

Returns:

the logged in user

See Also:

getUser()

getRealUserId
```
public long getRealUserId()
```
Returns the ID of the logged in user.

Returns:

the ID of the logged in user

See Also:

getRealUser()

getRefererGroup
```
public Group getRefererGroup()
```

getRefererGroupId
```
public long getRefererGroupId()
```

getRefererPlid
```
public long getRefererPlid()
```

getRequest
```
@JSON(include=false)
public javax.servlet.http.HttpServletRequest getRequest()
```
Returns the currently served HTTP servlet request.

Returns:

the currently served HTTP servlet request

getResponse
```
@JSON(include=false)
public javax.servlet.http.HttpServletResponse getResponse()
```
Returns the currently served HTTP servlet response.

Returns:

the currently served HTTP servlet response

getScopeGroup
```
public Group getScopeGroup()
```
Returns the scoped or sub-scoped active group (e.g. site).

Returns:

the scoped or sub-scoped active group

getScopeGroupId
```
public long getScopeGroupId()
```
Returns the ID of the scoped or sub-scoped active group (e.g. site).

Returns:

the ID of the scoped or sub-scoped active group

getScopeGroupName
```
public java.lang.String getScopeGroupName()
                                   throws PortalException
```
Returns the name of the scoped or sub-scoped active group (e.g. site).

Returns:

the name of the scoped or sub-scoped active group

Throws:

PortalException

getScopeLayout

public Layout getScopeLayout()
                      throws PortalException

Throws:: PortalException

getServerName
```
public java.lang.String getServerName()
```
Returns the portal instance's server name, which can be configured by setting the web.server.host property in a portal-ext.properties file.

Returns:

the server name, which can be configured by setting the web.server.host property in a portal-ext.properties file

getServerPort
```
public int getServerPort()
```
Returns the server port, which can be configured by setting the web.server.http.port or web.server.https.port property in a portal-ext.properties file.

Returns:

the server port, which can be configured by setting the web.server.http.port or web.server.https.port property in a portal-ext.properties file

getSessionId
```
public java.lang.String getSessionId()
```
Returns the session ID, or a blank string if the session ID is not available to the application.

Returns:

the session ID, or returns a blank string if the session ID is not available to the application

getSiteDefaultLocale

public java.util.Locale getSiteDefaultLocale()

getSiteGroup
```
public Group getSiteGroup()
```

getSiteGroupId
```
public long getSiteGroupId()
```

getSiteGroupIdOrLiveGroupId

public long getSiteGroupIdOrLiveGroupId()

getSiteGroupName

public java.lang.String getSiteGroupName()
                                  throws PortalException

Throws:: PortalException

getStrictLayoutPortletSetup

public javax.portlet.PortletPreferences getStrictLayoutPortletSetup(Layout layout,
                                                                    java.lang.String portletId)

getTheme
```
public Theme getTheme()
```

getThemeId
```
public java.lang.String getThemeId()
```

getThemeSetting
```
public java.lang.String getThemeSetting(java.lang.String key)
```
Returns the theme's configurable settings, which are declared in liferay-look-and-feel.xml and are configurable in the user interface.

Parameters:

key - the theme's key

Returns:

the theme's configurable settings

getThemeSettings
```
public java.util.Properties getThemeSettings()
```
Returns the theme's configurable settings, which are declared in liferay-look-and-feel.xml and are configurable in the user interface.

Returns:

a list of the theme's configurable settings

getTilesContent

public java.lang.String getTilesContent()

getTilesTitle

public java.lang.String getTilesTitle()

getTimeZone

public java.util.TimeZone getTimeZone()

getUnfilteredLayouts

public java.util.List<Layout> getUnfilteredLayouts()

getURLControlPanel

public java.lang.String getURLControlPanel()

getURLCurrent

public java.lang.String getURLCurrent()

getURLHome
```
public java.lang.String getURLHome()
```

getURLMyAccount

@JSON(include=false)
public javax.portlet.PortletURL getURLMyAccount()

getURLPortal

public java.lang.String getURLPortal()

getURLPublishToLive

@JSON(include=false)
public javax.portlet.PortletURL getURLPublishToLive()

getURLSignIn

public java.lang.String getURLSignIn()

getURLSignOut

public java.lang.String getURLSignOut()

getURLUpdateManager

@JSON(include=false)
public javax.portlet.PortletURL getURLUpdateManager()

getUser
```
public User getUser()
```
The user for which the current request is being handled. Note, that an administrative user can impersonate another user.

Returns:

the user for which the current request is being handled

See Also:

getRealUser()

getUserId
```
public long getUserId()
```
Returns the ID of the user for which the current request is being handled. Note that an administrative user can impersonate another user.

Returns:

the ID of the user for which the current request is being handled

isAddSessionIdToURL
```
public boolean isAddSessionIdToURL()
```

isAjax
```
public boolean isAjax()
```

isAsync
```
public boolean isAsync()
```

isFreeformLayout
```
@Deprecated
public boolean isFreeformLayout()
```
Deprecated. As of Judson (7.1.x), as of 7.1.x, with no direct replacement

isHubAction
```
public boolean isHubAction()
```

isHubPartialAction
```
public boolean isHubPartialAction()
```

isHubResource
```
public boolean isHubResource()
```

isI18n
```
public boolean isI18n()
```

isImpersonated
```
public boolean isImpersonated()
```
Returns true if the user is being impersonated by an administrative user.

Returns:

true if the user is being impersonated by an administrative user; false otherwise

See Also:

getRealUser(), getUser()

isIncludedJs

public boolean isIncludedJs(java.lang.String js)

isIncludePortletCssJs

public boolean isIncludePortletCssJs()

isIsolated
```
public boolean isIsolated()
```

isLifecycleAction
```
public boolean isLifecycleAction()
```

isLifecycleEvent
```
public boolean isLifecycleEvent()
```

isLifecycleRender
```
public boolean isLifecycleRender()
```

isLifecycleResource
```
public boolean isLifecycleResource()
```

isPortletEmbedded

public boolean isPortletEmbedded(long groupId,
                                 Layout layout,
                                 java.lang.String portletId)

isPortletEmbedded

public boolean isPortletEmbedded(java.lang.String portletId)

isSecure
```
public boolean isSecure()
```

isShowControlPanelIcon

public boolean isShowControlPanelIcon()

isShowHomeIcon
```
public boolean isShowHomeIcon()
```

isShowLayoutTemplatesIcon

public boolean isShowLayoutTemplatesIcon()

isShowMyAccountIcon
```
public boolean isShowMyAccountIcon()
```

isShowPageCustomizationIcon

public boolean isShowPageCustomizationIcon()

isShowPageSettingsIcon

public boolean isShowPageSettingsIcon()

isShowPortalIcon
```
public boolean isShowPortalIcon()
```

isShowSignInIcon
```
public boolean isShowSignInIcon()
```

isShowSignOutIcon
```
public boolean isShowSignOutIcon()
```

isShowSiteAdministrationIcon

public boolean isShowSiteAdministrationIcon()

isShowStagingIcon
```
public boolean isShowStagingIcon()
```

isSignedIn
```
public boolean isSignedIn()
```

isStateExclusive
```
public boolean isStateExclusive()
```

isStateMaximized
```
public boolean isStateMaximized()
```

isStatePopUp
```
public boolean isStatePopUp()
```

isThemeCssFastLoad
```
public boolean isThemeCssFastLoad()
```

isThemeImagesFastLoad

public boolean isThemeImagesFastLoad()

isThemeJsBarebone
```
public boolean isThemeJsBarebone()
```

isThemeJsFastLoad
```
public boolean isThemeJsFastLoad()
```

isTilesSelectable
```
public boolean isTilesSelectable()
```

isWidget
```
public boolean isWidget()
```

merge

public ThemeDisplay merge(ThemeDisplay themeDisplay)

Specified by:: merge in interface Mergeable<ThemeDisplay>

setAccount

public void setAccount(Account account)

setAddSessionIdToURL

public void setAddSessionIdToURL(boolean addSessionIdToURL)

setAjax
```
public void setAjax(boolean ajax)
```

setAsync
```
public void setAsync(boolean async)
```

setCDNBaseURL

public void setCDNBaseURL(java.lang.String cdnBase)

setCDNDynamicResourcesHost

public void setCDNDynamicResourcesHost(java.lang.String cdnDynamicResourcesHost)

setCDNHost

public void setCDNHost(java.lang.String cdnHost)

setCompany

public void setCompany(Company company)
                throws PortalException

Throws:: PortalException

setCompanyLogo

public void setCompanyLogo(java.lang.String companyLogo)

setCompanyLogoHeight

public void setCompanyLogoHeight(int companyLogoHeight)

setCompanyLogoWidth

public void setCompanyLogoWidth(int companyLogoWidth)

setContact

public void setContact(Contact contact)

setDevice
```
public void setDevice(Device device)
```

setDoAsGroupId

public void setDoAsGroupId(long doAsGroupId)

setDoAsUserId

public void setDoAsUserId(java.lang.String doAsUserId)

setDoAsUserLanguageId

public void setDoAsUserLanguageId(java.lang.String doAsUserLanguageId)

setFreeformLayout
```
@Deprecated
public void setFreeformLayout(boolean freeformLayout)
```
Deprecated. As of Judson (7.1.x), as of 7.1.x, with no direct replacement

setHubAction

public void setHubAction(boolean hubAction)

setHubPartialAction

public void setHubPartialAction(boolean hubPartialAction)

setHubResource

public void setHubResource(boolean resource)

setI18nLanguageId

public void setI18nLanguageId(java.lang.String i18nLanguageId)

setI18nPath

public void setI18nPath(java.lang.String i18nPath)

setIncludePortletCssJs

public void setIncludePortletCssJs(boolean includePortletCssJs)

setIsolated

public void setIsolated(boolean isolated)

setLanguageId

public void setLanguageId(java.lang.String languageId)

setLayout
```
public void setLayout(Layout layout)
```

setLayouts

public void setLayouts(java.util.List<Layout> layouts)

setLayoutSet

public void setLayoutSet(LayoutSet layoutSet)

setLayoutSetLogo

public void setLayoutSetLogo(java.lang.String layoutSetLogo)

setLayoutTypePortlet

public void setLayoutTypePortlet(LayoutTypePortlet layoutTypePortlet)

setLifecycle

public void setLifecycle(java.lang.String lifecycle)

setLifecycleAction

public void setLifecycleAction(boolean lifecycleAction)

setLifecycleEvent

public void setLifecycleEvent(boolean lifecycleEvent)

setLifecycleRender

public void setLifecycleRender(boolean lifecycleRender)

setLifecycleResource

public void setLifecycleResource(boolean lifecycleResource)

setLocale

public void setLocale(java.util.Locale locale)

setLookAndFeel

public void setLookAndFeel(Theme theme,
                           ColorScheme colorScheme)

setMDRRuleGroupInstance

public void setMDRRuleGroupInstance(MDRRuleGroupInstance mdrRuleGroupInstance)

setPathApplet

public void setPathApplet(java.lang.String pathApplet)

setPathCms

public void setPathCms(java.lang.String pathCms)

setPathColorSchemeImages

public void setPathColorSchemeImages(java.lang.String pathColorSchemeImages)

setPathContext

public void setPathContext(java.lang.String pathContext)

setPathFlash

public void setPathFlash(java.lang.String pathFlash)

setPathFriendlyURLPrivateGroup

public void setPathFriendlyURLPrivateGroup(java.lang.String pathFriendlyURLPrivateGroup)

setPathFriendlyURLPrivateUser

public void setPathFriendlyURLPrivateUser(java.lang.String pathFriendlyURLPrivateUser)

setPathFriendlyURLPublic

public void setPathFriendlyURLPublic(java.lang.String pathFriendlyURLPublic)

setPathImage

public void setPathImage(java.lang.String pathImage)

setPathJavaScript

public void setPathJavaScript(java.lang.String pathJavaScript)

setPathMain

public void setPathMain(java.lang.String pathMain)

setPathSound

public void setPathSound(java.lang.String pathSound)

setPathThemeCss

public void setPathThemeCss(java.lang.String pathThemeCss)

setPathThemeImages

public void setPathThemeImages(java.lang.String pathThemeImages)

setPathThemeJavaScript

public void setPathThemeJavaScript(java.lang.String pathThemeJavaScript)

setPathThemeRoot

public void setPathThemeRoot(java.lang.String pathThemeRoot)

setPathThemeTemplates

public void setPathThemeTemplates(java.lang.String pathThemeTemplates)

setPermissionChecker

public void setPermissionChecker(PermissionChecker permissionChecker)

setPlid
```
public void setPlid(long plid)
```

setPortalDomain

public void setPortalDomain(java.lang.String portalDomain)

setPortalURL

public void setPortalURL(java.lang.String portalURL)

setPpid

public void setPpid(java.lang.String ppid)

setRealCompanyLogo

public void setRealCompanyLogo(java.lang.String realCompanyLogo)

setRealCompanyLogoHeight

public void setRealCompanyLogoHeight(int realCompanyLogoHeight)

setRealCompanyLogoWidth

public void setRealCompanyLogoWidth(int realCompanyLogoWidth)

setRealUser

public void setRealUser(User realUser)

setRefererGroupId

public void setRefererGroupId(long refererGroupId)

setRefererPlid

public void setRefererPlid(long refererPlid)

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest httpServletRequest)

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse httpServletResponse)

setScopeGroupId

public void setScopeGroupId(long scopeGroupId)

setSecure

public void setSecure(boolean secure)

setServerName

public void setServerName(java.lang.String serverName)

setServerPort

public void setServerPort(int serverPort)

setSessionId

public void setSessionId(java.lang.String sessionId)

setShowControlPanelIcon

public void setShowControlPanelIcon(boolean showControlPanelIcon)

setShowHomeIcon

public void setShowHomeIcon(boolean showHomeIcon)

setShowLayoutTemplatesIcon

public void setShowLayoutTemplatesIcon(boolean showLayoutTemplatesIcon)

setShowMyAccountIcon

public void setShowMyAccountIcon(boolean showMyAccountIcon)

setShowPageCustomizationIcon

public void setShowPageCustomizationIcon(boolean showPageCustomizationIcon)

setShowPageSettingsIcon

public void setShowPageSettingsIcon(boolean showPageSettingsIcon)

setShowPortalIcon

public void setShowPortalIcon(boolean showPortalIcon)

setShowSignInIcon

public void setShowSignInIcon(boolean showSignInIcon)

setShowSignOutIcon

public void setShowSignOutIcon(boolean showSignOutIcon)

setShowSiteAdministrationIcon

public void setShowSiteAdministrationIcon(boolean showSiteAdministrationIcon)

setShowStagingIcon

public void setShowStagingIcon(boolean showStagingIcon)

setSignedIn

public void setSignedIn(boolean signedIn)

setSiteDefaultLocale

public void setSiteDefaultLocale(java.util.Locale siteDefaultLocale)

setSiteGroupId

public void setSiteGroupId(long siteGroupId)

setStateExclusive

public void setStateExclusive(boolean stateExclusive)

setStateMaximized

public void setStateMaximized(boolean stateMaximized)

setStatePopUp

public void setStatePopUp(boolean statePopUp)

setThemeCssFastLoad

public void setThemeCssFastLoad(boolean themeCssFastLoad)

setThemeImagesFastLoad

public void setThemeImagesFastLoad(boolean themeImagesFastLoad)

setThemeJsBarebone

public void setThemeJsBarebone(boolean themeJsBarebone)

setThemeJsFastLoad

public void setThemeJsFastLoad(boolean themeJsFastLoad)

setTilesContent

public void setTilesContent(java.lang.String tilesContent)

setTilesSelectable

public void setTilesSelectable(boolean tilesSelectable)

setTilesTitle

public void setTilesTitle(java.lang.String tilesTitle)

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

setUnfilteredLayouts

public void setUnfilteredLayouts(java.util.List<Layout> unfilteredLayouts)

setURLControlPanel

public void setURLControlPanel(java.lang.String urlControlPanel)

setURLCurrent

public void setURLCurrent(java.lang.String urlCurrent)

setURLHome

public void setURLHome(java.lang.String urlHome)

setURLLayoutTemplates

public void setURLLayoutTemplates(java.lang.String urlLayoutTemplates)

setURLPortal

public void setURLPortal(java.lang.String urlPortal)

setURLPublishToLive

public void setURLPublishToLive(javax.portlet.PortletURL urlPublishToLive)

setURLSignIn

public void setURLSignIn(java.lang.String urlSignIn)

setURLSignOut

public void setURLSignOut(java.lang.String urlSignOut)

setUser
```
public void setUser(User user)
```

setWidget

public void setWidget(boolean widget)

split
```
public ThemeDisplay split()
```
Specified by:

split in interface Mergeable<ThemeDisplay>

translate

public java.lang.String translate(java.lang.String key)

translate

public java.lang.String translate(java.lang.String pattern,
                                  java.lang.Object... arguments)

Class ThemeDisplay

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThemeDisplay

Method Detail

clearLayoutFriendlyURL

clone

getAccount

getCDNBaseURL

getCDNDynamicResourcesHost

getCDNHost

getColorScheme

getColorSchemeId

getCompany

getCompanyGroupId

getCompanyId

getCompanyLogo

getCompanyLogoHeight

getCompanyLogoWidth

getContact

getControlPanelGroup

getControlPanelLayout

getDefaultUser

getDefaultUserId

getDevice

getDoAsGroupId

getDoAsUserId

getDoAsUserLanguageId

getI18nLanguageId

getI18nPath

getLanguageId

getLayout

getLayoutFriendlyURL

getLayouts

getLayoutSet

getLayoutSetLogo

getLayoutTypePortlet

getLifecycle

getLocale

getMDRRuleGroupInstance

getPathApplet

getPathCms

getPathColorSchemeImages

getPathContext

getPathFlash

getPathFriendlyURLPrivateGroup

getPathFriendlyURLPrivateUser

getPathFriendlyURLPublic

getPathImage

getPathJavaScript

getPathMain

getPathSound

getPathThemeCss

getPathThemeImages

getPathThemeJavaScript

getPathThemeRoot

getPathThemeTemplates

getPermissionChecker

getPlid

getPortalDomain

getPortalURL

getPortletDisplay

getPpid

getProtocol

getRealCompanyLogo

getRealCompanyLogoHeight

getRealCompanyLogoWidth

getRealUser

getRealUserId

getRefererGroup

getRefererGroupId

getRefererPlid

getRequest

getResponse

getScopeGroup

getScopeGroupId

getScopeGroupName

getScopeLayout