Class PortletDisplay

Object
com.liferay.portal.kernel.theme.PortletDisplay
All Implemented Interfaces:
Serializable, Cloneable

public class PortletDisplay extends Object implements Cloneable, Serializable
Provides general configuration methods for the portlet, providing access to the portlet's content, instance, theme, URLs, and more. This class contains contextual information about the currently rendered portlet. An object of this class is only available in the context of a single portlet and is not available in the context of any page.
Author:
Brian Wing Shun Chan, Eduardo Lundgren
See Also:
  • Constructor Details

    • PortletDisplay

      public PortletDisplay()
  • Method Details

    • clone

      public Object clone()
      Overrides:
      clone in class Object
    • copyFrom

      public void copyFrom(PortletDisplay master)
    • copyTo

      public void copyTo(PortletDisplay slave)
    • getColumnCount

      public int getColumnCount()
    • getColumnId

      public String getColumnId()
    • getColumnPos

      public int getColumnPos()
    • getContent

      public com.liferay.petra.string.StringBundler getContent()
    • getCustomCSSClassName

      public String getCustomCSSClassName()
    • getDescription

      public String getDescription()
    • getId

      public String getId()
    • getInstanceId

      public String getInstanceId()
    • getNamespace

      public String getNamespace()
    • getPortletConfigurationIconMenu

      public PortletConfigurationIconMenu getPortletConfigurationIconMenu()
    • getPortletDecoratorId

      public String getPortletDecoratorId()
    • getPortletDisplayName

      public String getPortletDisplayName()
    • getPortletName

      public String getPortletName()
    • getPortletPreferences

      public PortletPreferences getPortletPreferences()
    • getPortletResource

      public String getPortletResource()
    • getPortletToolbar

      public PortletToolbar getPortletToolbar()
    • getResourcePK

      public String getResourcePK()
    • getRootPortletId

      public String getRootPortletId()
    • getThemeDisplay

      public ThemeDisplay getThemeDisplay()
    • getTitle

      public String getTitle()
    • getURLBack

      public String getURLBack()
    • getURLBackTitle

      public String getURLBackTitle()
    • getURLClose

      public String getURLClose()
    • getURLConfiguration

      public String getURLConfiguration()
    • getURLConfigurationJS

      public String getURLConfigurationJS()
    • getURLEdit

      public String getURLEdit()
    • getURLEditDefaults

      public String getURLEditDefaults()
    • getURLEditGuest

      public String getURLEditGuest()
    • getURLExportImport

      public String getURLExportImport()
    • getURLHelp

      public String getURLHelp()
    • getURLMax

      public String getURLMax()
    • getURLMin

      public String getURLMin()
    • getURLPortlet

      public String getURLPortlet()
    • getURLPortletCss

      public String getURLPortletCss()
    • getURLPrint

      public String getURLPrint()
    • getURLRefresh

      public String getURLRefresh()
    • getURLStaging

      public String getURLStaging()
    • isActive

      public boolean isActive()
    • isBeta

      public boolean isBeta()
    • isFocused

      public boolean isFocused()
    • isModeAbout

      public boolean isModeAbout()
    • isModeConfig

      public boolean isModeConfig()
    • isModeEdit

      public boolean isModeEdit()
    • isModeEditDefaults

      public boolean isModeEditDefaults()
    • isModeEditGuest

      public boolean isModeEditGuest()
    • isModeHelp

      public boolean isModeHelp()
    • isModePreview

      public boolean isModePreview()
    • isModePrint

      public boolean isModePrint()
    • isModeView

      public boolean isModeView()
    • isPortletDecorate

      public boolean isPortletDecorate()
    • isRestoreCurrentView

      public boolean isRestoreCurrentView()
    • isShowBackIcon

      public boolean isShowBackIcon()
    • isShowCloseIcon

      public boolean isShowCloseIcon()
    • isShowConfigurationIcon

      public boolean isShowConfigurationIcon()
    • isShowEditDefaultsIcon

      public boolean isShowEditDefaultsIcon()
    • isShowEditGuestIcon

      public boolean isShowEditGuestIcon()
    • isShowEditIcon

      public boolean isShowEditIcon()
    • isShowExportImportIcon

      public boolean isShowExportImportIcon()
    • isShowHelpIcon

      public boolean isShowHelpIcon()
    • isShowMoveIcon

      public boolean isShowMoveIcon()
    • isShowPortletCssIcon

      public boolean isShowPortletCssIcon()
    • isShowPortletIcon

      public boolean isShowPortletIcon()
    • isShowPortletTitle

      public boolean isShowPortletTitle()
    • isShowPortletTopper

      public boolean isShowPortletTopper()
    • isShowPrintIcon

      public boolean isShowPrintIcon()
    • isShowRefreshIcon

      public boolean isShowRefreshIcon()
    • isShowStagingIcon

      public boolean isShowStagingIcon()
    • isStateExclusive

      public boolean isStateExclusive()
    • isStateMax

      public boolean isStateMax()
    • isStateMin

      public boolean isStateMin()
    • isStateNormal

      public boolean isStateNormal()
    • isStatePopUp

      public boolean isStatePopUp()
    • isWebDAVEnabled

      public boolean isWebDAVEnabled()
    • recycle

      public void recycle()
    • setActive

      public void setActive(boolean active)
    • setBeta

      public void setBeta(boolean beta)
    • setColumnCount

      public void setColumnCount(int columnCount)
    • setColumnId

      public void setColumnId(String columnId)
    • setColumnPos

      public void setColumnPos(int columnPos)
    • setContent

      public void setContent(com.liferay.petra.string.StringBundler contentSB)
    • setCustomCSSClassName

      public void setCustomCSSClassName(String customCSSClassName)
    • setDescription

      public void setDescription(String description)
    • setId

      public void setId(String id)
    • setInstanceId

      public void setInstanceId(String instanceId)
    • setModeAbout

      public void setModeAbout(boolean modeAbout)
    • setModeConfig

      public void setModeConfig(boolean modeConfig)
    • setModeEdit

      public void setModeEdit(boolean modeEdit)
    • setModeEditDefaults

      public void setModeEditDefaults(boolean modeEditDefaults)
    • setModeEditGuest

      public void setModeEditGuest(boolean modeEditGuest)
    • setModeHelp

      public void setModeHelp(boolean modeHelp)
    • setModePreview

      public void setModePreview(boolean modePreview)
    • setModePrint

      public void setModePrint(boolean modePrint)
    • setModeView

      public void setModeView(boolean modeView)
    • setNamespace

      public void setNamespace(String namespace)
    • setPortletDecorate

      public void setPortletDecorate(boolean portletDecorate)
    • setPortletDecoratorId

      public void setPortletDecoratorId(String portletDecoratorId)
    • setPortletDisplayName

      public void setPortletDisplayName(String portletDisplayName)
    • setPortletName

      public void setPortletName(String portletName)
    • setPortletPreferences

      public void setPortletPreferences(PortletPreferences portletPreferences)
    • setPortletResource

      public void setPortletResource(String portletResource)
    • setResourcePK

      public void setResourcePK(String resourcePK)
    • setRestoreCurrentView

      public void setRestoreCurrentView(boolean restoreCurrentView)
    • setRootPortletId

      public void setRootPortletId(String rootPortletId)
    • setShowBackIcon

      public void setShowBackIcon(boolean showBackIcon)
    • setShowCloseIcon

      public void setShowCloseIcon(boolean showCloseIcon)
    • setShowConfigurationIcon

      public void setShowConfigurationIcon(boolean showConfigurationIcon)
    • setShowEditDefaultsIcon

      public void setShowEditDefaultsIcon(boolean showEditDefaultsIcon)
    • setShowEditGuestIcon

      public void setShowEditGuestIcon(boolean showEditGuestIcon)
    • setShowEditIcon

      public void setShowEditIcon(boolean showEditIcon)
    • setShowExportImportIcon

      public void setShowExportImportIcon(boolean showExportImportIcon)
    • setShowHelpIcon

      public void setShowHelpIcon(boolean showHelpIcon)
    • setShowMoveIcon

      public void setShowMoveIcon(boolean showMoveIcon)
    • setShowPortletCssIcon

      public void setShowPortletCssIcon(boolean showPortletCssIcon)
    • setShowPortletIcon

      public void setShowPortletIcon(boolean showPortletIcon)
    • setShowPrintIcon

      public void setShowPrintIcon(boolean showPrintIcon)
    • setShowRefreshIcon

      public void setShowRefreshIcon(boolean showRefreshIcon)
    • setShowStagingIcon

      public void setShowStagingIcon(boolean showStagingIcon)
    • setStateExclusive

      public void setStateExclusive(boolean stateExclusive)
    • setStateMax

      public void setStateMax(boolean stateMax)
    • setStateMin

      public void setStateMin(boolean stateMin)
    • setStateNormal

      public void setStateNormal(boolean stateNormal)
    • setStatePopUp

      public void setStatePopUp(boolean statePopUp)
    • setThemeDisplay

      public void setThemeDisplay(ThemeDisplay themeDisplay)
    • setTitle

      public void setTitle(String title)
    • setURLBack

      public void setURLBack(String urlBack)
    • setURLBackTitle

      public void setURLBackTitle(String urlBackTitle)
    • setURLClose

      public void setURLClose(String urlClose)
    • setURLConfiguration

      public void setURLConfiguration(String urlConfiguration)
    • setURLConfigurationJS

      public void setURLConfigurationJS(String urlConfigurationJS)
    • setURLEdit

      public void setURLEdit(String urlEdit)
    • setURLEditDefaults

      public void setURLEditDefaults(String urlEditDefaults)
    • setURLEditGuest

      public void setURLEditGuest(String urlEditGuest)
    • setURLExportImport

      public void setURLExportImport(String urlExportImport)
    • setURLHelp

      public void setURLHelp(String urlHelp)
    • setURLMax

      public void setURLMax(String urlMax)
    • setURLMin

      public void setURLMin(String urlMin)
    • setURLPortlet

      public void setURLPortlet(String urlPortlet)
    • setURLPortletCss

      public void setURLPortletCss(String urlPortletCss)
    • setURLPrint

      public void setURLPrint(String urlPrint)
    • setURLRefresh

      public void setURLRefresh(String urlRefresh)
    • setURLStaging

      public void setURLStaging(String urlStaging)
    • setWebDAVEnabled

      public void setWebDAVEnabled(boolean webDAVEnabled)
    • writeContent

      public void writeContent(Writer writer) throws IOException
      Throws:
      IOException