Liferay 7.0-ce-b4

com.liferay.portal.theme
Class ThemeDisplay

java.lang.Object
  extended by com.liferay.portal.theme.ThemeDisplay
All Implemented Interfaces:
Mergeable<ThemeDisplay>, Serializable, Cloneable

@JSON
@ProviderType
public class ThemeDisplay
extends Object
implements Cloneable, Mergeable<ThemeDisplay>, 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);
 
 

See Also:
Serialized Form

Constructor Summary
ThemeDisplay()
           
 
Method Summary
 Object clone()
           
 Account getAccount()
           
 String getCDNBaseURL()
          Returns the content delivery network (CDN) base URL, or the current portal URL if the CDN base URL is null.
 String getCDNDynamicResourcesHost()
          Returns the content delivery network (CDN) dynamic resources host, or the current portal URL if the CDN dynamic resources host is null.
 String getCDNHost()
           
 ColorScheme getColorScheme()
           
 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.
 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()
           
 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()
           
 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.
 String getDoAsUserLanguageId()
           
 String getFacebookCanvasPageURL()
           
 String getI18nLanguageId()
          Returns the current internationalization language's code.
 String getI18nPath()
          Returns the path element for the current internationalization language.
 String getLanguageId()
          Returns the current language's code.
 Layout getLayout()
          Returns the site's page.
 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.
 String getLayoutSetLogo()
          Returns the path to the site's configured logo, or null if there is no configured logo.
 LayoutTypePortlet getLayoutTypePortlet()
           
 String getLifecycle()
          Returns the numeric portlet lifecycle indicator.
 Locale getLocale()
          Returns the locale used for displaying content.
 MDRRuleGroupInstance getMDRRuleGroupInstance()
           
 String getPathApplet()
           
 String getPathCms()
           
 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.
 String getPathContext()
           
 String getPathFlash()
           
 String getPathFriendlyURLPrivateGroup()
          Returns the URL for the site's private layout set.
 String getPathFriendlyURLPrivateUser()
          Returns the URL for the user's private page set.
 String getPathFriendlyURLPublic()
          Returns the URL for the site's public page set.
 String getPathImage()
          Returns the URL for the portal instance's images.
 String getPathJavaScript()
          Returns the URL for the portal instance's JavaScript resources.
 String getPathMain()
          Returns the URL for the portal instance's main servlet.
 String getPathSound()
           
 String getPathThemeCss()
          Returns the URL for the theme's CSS directory.
 String getPathThemeImages()
          Returns the URL for the theme's images.
 String getPathThemeJavaScript()
          Returns the URL for the theme's JavaScript directory.
 String getPathThemeRoot()
          Returns the base URL for the theme.
 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.
 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()
           
 String getPpid()
           
 String getProtocol()
           
 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).
 String getScopeGroupName()
          Returns the name of the scoped or sub-scoped active group (e.g. site).
 Layout getScopeLayout()
           
 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.
 String getSessionId()
          Returns the session ID, or a blank string if the session ID is not available to the application.
 Locale getSiteDefaultLocale()
           
 Group getSiteGroup()
           
 long getSiteGroupId()
           
 long getSiteGroupIdOrLiveGroupId()
           
 String getSiteGroupName()
           
 Theme getTheme()
           
 String getThemeId()
           
 String getThemeSetting(String key)
          Returns the theme's configurable settings, which are declared in liferay-look-and-feel.xml and are configurable in the user interface.
 Properties getThemeSettings()
          Returns the theme's configurable settings, which are declared in liferay-look-and-feel.xml and are configurable in the user interface.
 String getTilesContent()
           
 String getTilesTitle()
           
 TimeZone getTimeZone()
           
 List<Layout> getUnfilteredLayouts()
           
 String getURLAddContent()
          Deprecated. As of 7.0.0, with no direct replacement
 String getURLControlPanel()
           
 String getURLCurrent()
           
 String getURLHome()
           
 String getURLLayoutTemplates()
          Deprecated. As of 7.0.0, with no direct replacement
 PortletURL getURLMyAccount()
           
 PortletURL getURLPageSettings()
          Deprecated. As of 7.0.0, with no direct replacement
 String getURLPortal()
           
 PortletURL getURLPublishToLive()
           
 String getURLSignIn()
           
 String getURLSignOut()
           
 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 isFacebook()
           
 boolean isFreeformLayout()
           
 boolean isI18n()
           
 boolean isImpersonated()
          Returns true if the user is being impersonated by an administrative user.
 boolean isIncludedJs(String js)
           
 boolean isIncludePortletCssJs()
           
 boolean isIsolated()
           
 boolean isLifecycleAction()
           
 boolean isLifecycleEvent()
           
 boolean isLifecycleRender()
           
 boolean isLifecycleResource()
           
 boolean isSecure()
           
 boolean isShowAddContentIcon()
          Deprecated. As of 7.0.0, with no direct replacement
 boolean isShowAddContentIconPermission()
          Deprecated. As of 7.0.0, with no direct replacement
 boolean isShowControlPanelIcon()
           
 boolean isShowHomeIcon()
           
 boolean isShowLayoutTemplatesIcon()
           
 boolean isShowManageSiteMembershipsIcon()
          Deprecated. As of 6.2.0, replaced by isShowSiteAdministrationIcon()
 boolean isShowMyAccountIcon()
           
 boolean isShowPageCustomizationIcon()
           
 boolean isShowPageSettingsIcon()
           
 boolean isShowPortalIcon()
           
 boolean isShowSignInIcon()
           
 boolean isShowSignOutIcon()
           
 boolean isShowSiteAdministrationIcon()
           
 boolean isShowSiteContentIcon()
          Deprecated. As of 6.2.0, replaced by isShowSiteAdministrationIcon()
 boolean isShowSiteMapSettingsIcon()
          Deprecated. As of 6.2.0, replaced by isShowSiteAdministrationIcon()
 boolean isShowSiteSettingsIcon()
          Deprecated. As of 6.2.0, replaced by isShowSiteAdministrationIcon()
 boolean isShowStagingIcon()
           
 boolean isSignedIn()
           
 boolean isStateExclusive()
           
 boolean isStateMaximized()
           
 boolean isStatePopUp()
           
 boolean isThemeCssFastLoad()
           
 boolean isThemeImagesFastLoad()
           
 boolean isThemeJsBarebone()
           
 boolean isThemeJsFastLoad()
           
 boolean isTilesSelectable()
           
 boolean isWapTheme()
           
 boolean isWidget()
           
 ThemeDisplay merge(ThemeDisplay themeDisplay)
           
 void setAccount(Account account)
           
 void setAddSessionIdToURL(boolean addSessionIdToURL)
           
 void setAjax(boolean ajax)
           
 void setCDNBaseURL(String cdnBase)
           
 void setCDNDynamicResourcesHost(String cdnDynamicResourcesHost)
           
 void setCDNHost(String cdnHost)
           
 void setCompany(Company company)
           
 void setCompanyLogo(String companyLogo)
           
 void setCompanyLogoHeight(int companyLogoHeight)
           
 void setCompanyLogoWidth(int companyLogoWidth)
           
 void setContact(Contact contact)
           
 void setDevice(Device device)
           
 void setDoAsGroupId(long doAsGroupId)
           
 void setDoAsUserId(String doAsUserId)
           
 void setDoAsUserLanguageId(String doAsUserLanguageId)
           
 void setFacebookCanvasPageURL(String facebookCanvasPageURL)
           
 void setFreeformLayout(boolean freeformLayout)
           
 void setI18nLanguageId(String i18nLanguageId)
           
 void setI18nPath(String i18nPath)
           
 void setIncludePortletCssJs(boolean includePortletCssJs)
           
 void setIsolated(boolean isolated)
           
 void setLanguageId(String languageId)
           
 void setLayout(Layout layout)
           
 void setLayouts(List<Layout> layouts)
           
 void setLayoutSet(LayoutSet layoutSet)
           
 void setLayoutSetLogo(String layoutSetLogo)
           
 void setLayoutTypePortlet(LayoutTypePortlet layoutTypePortlet)
           
 void setLifecycle(String lifecycle)
           
 void setLifecycleAction(boolean lifecycleAction)
           
 void setLifecycleEvent(boolean lifecycleEvent)
           
 void setLifecycleRender(boolean lifecycleRender)
           
 void setLifecycleResource(boolean lifecycleResource)
           
 void setLocale(Locale locale)
           
 void setLookAndFeel(Theme theme, ColorScheme colorScheme)
           
 void setMDRRuleGroupInstance(MDRRuleGroupInstance mdrRuleGroupInstance)
           
 void setPathApplet(String pathApplet)
           
 void setPathCms(String pathCms)
           
 void setPathColorSchemeImages(String pathColorSchemeImages)
           
 void setPathContext(String pathContext)
           
 void setPathFlash(String pathFlash)
           
 void setPathFriendlyURLPrivateGroup(String pathFriendlyURLPrivateGroup)
           
 void setPathFriendlyURLPrivateUser(String pathFriendlyURLPrivateUser)
           
 void setPathFriendlyURLPublic(String pathFriendlyURLPublic)
           
 void setPathImage(String pathImage)
           
 void setPathJavaScript(String pathJavaScript)
           
 void setPathMain(String pathMain)
           
 void setPathSound(String pathSound)
           
 void setPathThemeCss(String pathThemeCss)
           
 void setPathThemeImages(String pathThemeImages)
           
 void setPathThemeJavaScript(String pathThemeJavaScript)
           
 void setPathThemeRoot(String pathThemeRoot)
           
 void setPathThemeTemplates(String pathThemeTemplates)
           
 void setPermissionChecker(PermissionChecker permissionChecker)
           
 void setPlid(long plid)
           
 void setPortalURL(String portalURL)
           
 void setPpid(String ppid)
           
 void setRealCompanyLogo(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 request)
           
 void setResponse(javax.servlet.http.HttpServletResponse response)
           
 void setScopeGroupId(long scopeGroupId)
           
 void setSecure(boolean secure)
           
 void setServerName(String serverName)
           
 void setServerPort(int serverPort)
           
 void setSessionId(String sessionId)
           
 void setShowAddContentIcon(boolean showAddContentIcon)
          Deprecated. As of 7.0.0, with no direct replacement
 void setShowAddContentIconPermission(boolean showAddContentIconPermission)
          Deprecated. As of 7.0.0, with no direct replacement
 void setShowControlPanelIcon(boolean showControlPanelIcon)
           
 void setShowHomeIcon(boolean showHomeIcon)
           
 void setShowLayoutTemplatesIcon(boolean showLayoutTemplatesIcon)
           
 void setShowManageSiteMembershipsIcon(boolean showManageSiteMembershipsIcon)
           
 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 setShowSiteMapSettingsIcon(boolean showSiteMapSettingsIcon)
           
 void setShowSiteSettingsIcon(boolean showSiteSettingsIcon)
           
 void setShowStagingIcon(boolean showStagingIcon)
           
 void setSignedIn(boolean signedIn)
           
 void setSiteDefaultLocale(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(String tilesContent)
           
 void setTilesSelectable(boolean tilesSelectable)
           
 void setTilesTitle(String tilesTitle)
           
 void setTimeZone(TimeZone timeZone)
           
 void setUnfilteredLayouts(List<Layout> unfilteredLayouts)
           
 void setURLAddContent(String urlAddContent)
          Deprecated. As of 7.0.0, with no direct replacement
 void setURLControlPanel(String urlControlPanel)
           
 void setURLCurrent(String urlCurrent)
           
 void setURLHome(String urlHome)
           
 void setURLLayoutTemplates(String urlLayoutTemplates)
           
 void setURLMyAccount(PortletURL urlMyAccount)
          Deprecated. As of 7.0.0, with no direct replacement
 void setURLPageSettings(PortletURL urlPageSettings)
          Deprecated. As of 7.0.0, with no direct replacement
 void setURLPortal(String urlPortal)
           
 void setURLPublishToLive(PortletURL urlPublishToLive)
           
 void setURLSignIn(String urlSignIn)
           
 void setURLSignOut(String urlSignOut)
           
 void setURLUpdateManager(PortletURL urlUpdateManager)
          Deprecated. As of 7.0.0, with no direct replacement
 void setUser(User user)
           
 void setWidget(boolean widget)
           
 String translate(String key)
           
 String translate(String pattern, 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

clone

public Object clone()
             throws CloneNotSupportedException
Overrides:
clone in class Object
Throws:
CloneNotSupportedException

getAccount

public Account getAccount()

getCDNBaseURL

public 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 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 String getCDNHost()

getColorScheme

public ColorScheme getColorScheme()

getColorSchemeId

public 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 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()

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 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 String getDoAsUserLanguageId()

getFacebookCanvasPageURL

public String getFacebookCanvasPageURL()

getI18nLanguageId

public 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 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 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

getLayouts

public 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 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 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 Locale getLocale()
Returns the locale used for displaying content.

Returns:
the locale used for displaying content

getMDRRuleGroupInstance

public MDRRuleGroupInstance getMDRRuleGroupInstance()

getPathApplet

public String getPathApplet()

getPathCms

public String getPathCms()

getPathColorSchemeImages

public 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 String getPathContext()

getPathFlash

public String getPathFlash()

getPathFriendlyURLPrivateGroup

public 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 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 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 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 String getPathJavaScript()
Returns the URL for the portal instance's JavaScript resources.

Returns:
the URL for the portal instance's JavaScript resources

getPathMain

public 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 String getPathSound()

getPathThemeCss

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

Returns:
the URL for the theme's CSS directory

getPathThemeImages

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

Returns:
the URL for the theme's images

getPathThemeJavaScript

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

Returns:
the URL for the theme's JavaScript directory

getPathThemeRoot

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

Returns:
the base URL for the theme

getPathThemeTemplates

public 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

getPortalURL

public 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 String getPpid()

getProtocol

public String getProtocol()

getRealCompanyLogo

public 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 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 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 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 Locale getSiteDefaultLocale()

getSiteGroup

public Group getSiteGroup()

getSiteGroupId

public long getSiteGroupId()

getSiteGroupIdOrLiveGroupId

public long getSiteGroupIdOrLiveGroupId()

getSiteGroupName

public String getSiteGroupName()
                        throws PortalException
Throws:
PortalException

getTheme

public Theme getTheme()

getThemeId

public String getThemeId()

getThemeSetting

public String getThemeSetting(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 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 String getTilesContent()

getTilesTitle

public String getTilesTitle()

getTimeZone

public TimeZone getTimeZone()

getUnfilteredLayouts

public List<Layout> getUnfilteredLayouts()

getURLAddContent

@Deprecated
public String getURLAddContent()
Deprecated. As of 7.0.0, with no direct replacement


getURLControlPanel

public String getURLControlPanel()

getURLCurrent

public String getURLCurrent()

getURLHome

public String getURLHome()

getURLLayoutTemplates

@Deprecated
public String getURLLayoutTemplates()
Deprecated. As of 7.0.0, with no direct replacement


getURLMyAccount

@JSON(include=false)
public PortletURL getURLMyAccount()

getURLPageSettings

@Deprecated
@JSON(include=false)
public PortletURL getURLPageSettings()
Deprecated. As of 7.0.0, with no direct replacement


getURLPortal

public String getURLPortal()

getURLPublishToLive

@JSON(include=false)
public PortletURL getURLPublishToLive()

getURLSignIn

public String getURLSignIn()

getURLSignOut

public String getURLSignOut()

getURLUpdateManager

@JSON(include=false)
public 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()

isFacebook

public boolean isFacebook()

isFreeformLayout

public boolean isFreeformLayout()

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(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()

isSecure

public boolean isSecure()

isShowAddContentIcon

@Deprecated
public boolean isShowAddContentIcon()
Deprecated. As of 7.0.0, with no direct replacement


isShowAddContentIconPermission

@Deprecated
public boolean isShowAddContentIconPermission()
Deprecated. As of 7.0.0, with no direct replacement


isShowControlPanelIcon

public boolean isShowControlPanelIcon()

isShowHomeIcon

public boolean isShowHomeIcon()

isShowLayoutTemplatesIcon

public boolean isShowLayoutTemplatesIcon()

isShowManageSiteMembershipsIcon

@Deprecated
public boolean isShowManageSiteMembershipsIcon()
Deprecated. As of 6.2.0, replaced by isShowSiteAdministrationIcon()


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()

isShowSiteContentIcon

@Deprecated
public boolean isShowSiteContentIcon()
Deprecated. As of 6.2.0, replaced by isShowSiteAdministrationIcon()


isShowSiteMapSettingsIcon

@Deprecated
public boolean isShowSiteMapSettingsIcon()
Deprecated. As of 6.2.0, replaced by isShowSiteAdministrationIcon()


isShowSiteSettingsIcon

@Deprecated
public boolean isShowSiteSettingsIcon()
Deprecated. As of 6.2.0, replaced by 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()

isWapTheme

public boolean isWapTheme()

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)

setCDNBaseURL

public void setCDNBaseURL(String cdnBase)

setCDNDynamicResourcesHost

public void setCDNDynamicResourcesHost(String cdnDynamicResourcesHost)

setCDNHost

public void setCDNHost(String cdnHost)

setCompany

public void setCompany(Company company)
                throws PortalException
Throws:
PortalException

setCompanyLogo

public void setCompanyLogo(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(String doAsUserId)

setDoAsUserLanguageId

public void setDoAsUserLanguageId(String doAsUserLanguageId)

setFacebookCanvasPageURL

public void setFacebookCanvasPageURL(String facebookCanvasPageURL)

setFreeformLayout

public void setFreeformLayout(boolean freeformLayout)

setI18nLanguageId

public void setI18nLanguageId(String i18nLanguageId)

setI18nPath

public void setI18nPath(String i18nPath)

setIncludePortletCssJs

public void setIncludePortletCssJs(boolean includePortletCssJs)

setIsolated

public void setIsolated(boolean isolated)

setLanguageId

public void setLanguageId(String languageId)

setLayout

public void setLayout(Layout layout)

setLayouts

public void setLayouts(List<Layout> layouts)

setLayoutSet

public void setLayoutSet(LayoutSet layoutSet)

setLayoutSetLogo

public void setLayoutSetLogo(String layoutSetLogo)

setLayoutTypePortlet

public void setLayoutTypePortlet(LayoutTypePortlet layoutTypePortlet)

setLifecycle

public void setLifecycle(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(Locale locale)

setLookAndFeel

public void setLookAndFeel(Theme theme,
                           ColorScheme colorScheme)

setMDRRuleGroupInstance

public void setMDRRuleGroupInstance(MDRRuleGroupInstance mdrRuleGroupInstance)

setPathApplet

public void setPathApplet(String pathApplet)

setPathCms

public void setPathCms(String pathCms)

setPathColorSchemeImages

public void setPathColorSchemeImages(String pathColorSchemeImages)

setPathContext

public void setPathContext(String pathContext)

setPathFlash

public void setPathFlash(String pathFlash)

setPathFriendlyURLPrivateGroup

public void setPathFriendlyURLPrivateGroup(String pathFriendlyURLPrivateGroup)

setPathFriendlyURLPrivateUser

public void setPathFriendlyURLPrivateUser(String pathFriendlyURLPrivateUser)

setPathFriendlyURLPublic

public void setPathFriendlyURLPublic(String pathFriendlyURLPublic)

setPathImage

public void setPathImage(String pathImage)

setPathJavaScript

public void setPathJavaScript(String pathJavaScript)

setPathMain

public void setPathMain(String pathMain)

setPathSound

public void setPathSound(String pathSound)

setPathThemeCss

public void setPathThemeCss(String pathThemeCss)

setPathThemeImages

public void setPathThemeImages(String pathThemeImages)

setPathThemeJavaScript

public void setPathThemeJavaScript(String pathThemeJavaScript)

setPathThemeRoot

public void setPathThemeRoot(String pathThemeRoot)

setPathThemeTemplates

public void setPathThemeTemplates(String pathThemeTemplates)

setPermissionChecker

public void setPermissionChecker(PermissionChecker permissionChecker)

setPlid

public void setPlid(long plid)

setPortalURL

public void setPortalURL(String portalURL)

setPpid

public void setPpid(String ppid)

setRealCompanyLogo

public void setRealCompanyLogo(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 request)

setResponse

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

setScopeGroupId

public void setScopeGroupId(long scopeGroupId)

setSecure

public void setSecure(boolean secure)

setServerName

public void setServerName(String serverName)

setServerPort

public void setServerPort(int serverPort)

setSessionId

public void setSessionId(String sessionId)

setShowAddContentIcon

@Deprecated
public void setShowAddContentIcon(boolean showAddContentIcon)
Deprecated. As of 7.0.0, with no direct replacement


setShowAddContentIconPermission

@Deprecated
public void setShowAddContentIconPermission(boolean showAddContentIconPermission)
Deprecated. As of 7.0.0, with no direct replacement


setShowControlPanelIcon

public void setShowControlPanelIcon(boolean showControlPanelIcon)

setShowHomeIcon

public void setShowHomeIcon(boolean showHomeIcon)

setShowLayoutTemplatesIcon

public void setShowLayoutTemplatesIcon(boolean showLayoutTemplatesIcon)

setShowManageSiteMembershipsIcon

public void setShowManageSiteMembershipsIcon(boolean showManageSiteMembershipsIcon)

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)

setShowSiteMapSettingsIcon

public void setShowSiteMapSettingsIcon(boolean showSiteMapSettingsIcon)

setShowSiteSettingsIcon

public void setShowSiteSettingsIcon(boolean showSiteSettingsIcon)

setShowStagingIcon

public void setShowStagingIcon(boolean showStagingIcon)

setSignedIn

public void setSignedIn(boolean signedIn)

setSiteDefaultLocale

public void setSiteDefaultLocale(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(String tilesContent)

setTilesSelectable

public void setTilesSelectable(boolean tilesSelectable)

setTilesTitle

public void setTilesTitle(String tilesTitle)

setTimeZone

public void setTimeZone(TimeZone timeZone)

setUnfilteredLayouts

public void setUnfilteredLayouts(List<Layout> unfilteredLayouts)

setURLAddContent

@Deprecated
public void setURLAddContent(String urlAddContent)
Deprecated. As of 7.0.0, with no direct replacement


setURLControlPanel

public void setURLControlPanel(String urlControlPanel)

setURLCurrent

public void setURLCurrent(String urlCurrent)

setURLHome

public void setURLHome(String urlHome)

setURLLayoutTemplates

public void setURLLayoutTemplates(String urlLayoutTemplates)

setURLMyAccount

@Deprecated
public void setURLMyAccount(PortletURL urlMyAccount)
Deprecated. As of 7.0.0, with no direct replacement


setURLPageSettings

@Deprecated
public void setURLPageSettings(PortletURL urlPageSettings)
Deprecated. As of 7.0.0, with no direct replacement


setURLPortal

public void setURLPortal(String urlPortal)

setURLPublishToLive

public void setURLPublishToLive(PortletURL urlPublishToLive)

setURLSignIn

public void setURLSignIn(String urlSignIn)

setURLSignOut

public void setURLSignOut(String urlSignOut)

setURLUpdateManager

@Deprecated
public void setURLUpdateManager(PortletURL urlUpdateManager)
Deprecated. As of 7.0.0, with no direct replacement


setUser

public void setUser(User user)
             throws PortalException
Throws:
PortalException

setWidget

public void setWidget(boolean widget)

translate

public String translate(String key)

translate

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

Liferay 7.0-ce-b4