PortletDisplay (Liferay 7.0.10 portal-kernel API)

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:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PortletDisplay()

Constructors
Constructor and Description
`PortletDisplay()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`void`	`copyFrom(PortletDisplay master)`
`void`	`copyTo(PortletDisplay slave)`
`int`	`getColumnCount()`
`String`	`getColumnId()`
`int`	`getColumnPos()`
`StringBundler`	`getContent()`
`String`	`getCustomCSSClassName()`
`String`	`getDescription()`
`String`	`getId()`
`String`	`getInstanceId()`
`String`	`getNamespace()`
`PortletConfigurationIconMenu`	`getPortletConfigurationIconMenu()`
`String`	`getPortletDecoratorId()`
`String`	`getPortletDisplayName()`
`<T> T`	`getPortletInstanceConfiguration(Class<T> clazz)`
`String`	`getPortletName()`
`String`	`getPortletResource()`
`PortletPreferences`	`getPortletSetup()`
`PortletToolbar`	`getPortletToolbar()`
`String`	`getResourcePK()`
`String`	`getRootPortletId()`
`ThemeDisplay`	`getThemeDisplay()`
`String`	`getTitle()`
`String`	`getURLBack()`
`String`	`getURLClose()`
`String`	`getURLConfiguration()`
`String`	`getURLConfigurationJS()`
`String`	`getURLEdit()`
`String`	`getURLEditDefaults()`
`String`	`getURLEditGuest()`
`String`	`getURLExportImport()`
`String`	`getURLHelp()`
`String`	`getURLMax()`
`String`	`getURLMin()`
`String`	`getURLPortlet()`
`String`	`getURLPortletCss()`
`String`	`getURLPrint()`
`String`	`getURLRefresh()`
`String`	`getURLStaging()`
`boolean`	`isAccess()` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`boolean`	`isActive()`
`boolean`	`isFocused()`
`boolean`	`isModeAbout()`
`boolean`	`isModeConfig()`
`boolean`	`isModeEdit()`
`boolean`	`isModeEditDefaults()`
`boolean`	`isModeEditGuest()`
`boolean`	`isModeHelp()`
`boolean`	`isModePreview()`
`boolean`	`isModePrint()`
`boolean`	`isModeView()`
`boolean`	`isPortletDecorate()`
`boolean`	`isRestoreCurrentView()`
`boolean`	`isShowBackIcon()`
`boolean`	`isShowCloseIcon()`
`boolean`	`isShowConfigurationIcon()`
`boolean`	`isShowEditDefaultsIcon()`
`boolean`	`isShowEditGuestIcon()`
`boolean`	`isShowEditIcon()`
`boolean`	`isShowExportImportIcon()`
`boolean`	`isShowHelpIcon()`
`boolean`	`isShowMoveIcon()`
`boolean`	`isShowPortletCssIcon()`
`boolean`	`isShowPortletIcon()`
`boolean`	`isShowPrintIcon()`
`boolean`	`isShowRefreshIcon()`
`boolean`	`isShowStagingIcon()`
`boolean`	`isStateExclusive()`
`boolean`	`isStateMax()`
`boolean`	`isStateMin()`
`boolean`	`isStateNormal()`
`boolean`	`isStatePopUp()`
`boolean`	`isWebDAVEnabled()`
`void`	`recycle()`
`void`	`setAccess(boolean access)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`setActive(boolean active)`
`void`	`setColumnCount(int columnCount)`
`void`	`setColumnId(String columnId)`
`void`	`setColumnPos(int columnPos)`
`void`	`setContent(StringBundler contentSB)`
`void`	`setCustomCSSClassName(String customCSSClassName)`
`void`	`setDescription(String description)`
`void`	`setId(String id)`
`void`	`setInstanceId(String instanceId)`
`void`	`setModeAbout(boolean modeAbout)`
`void`	`setModeConfig(boolean modeConfig)`
`void`	`setModeEdit(boolean modeEdit)`
`void`	`setModeEditDefaults(boolean modeEditDefaults)`
`void`	`setModeEditGuest(boolean modeEditGuest)`
`void`	`setModeHelp(boolean modeHelp)`
`void`	`setModePreview(boolean modePreview)`
`void`	`setModePrint(boolean modePrint)`
`void`	`setModeView(boolean modeView)`
`void`	`setNamespace(String namespace)`
`void`	`setPortletConfigurationIconMenu(PortletConfigurationIconMenu portletConfigurationIconMenu)`
`void`	`setPortletDecorate(boolean portletDecorate)`
`void`	`setPortletDecoratorId(String portletDecoratorId)`
`void`	`setPortletDisplayName(String portletDisplayName)`
`void`	`setPortletName(String portletName)`
`void`	`setPortletResource(String portletResource)`
`void`	`setPortletSetup(PortletPreferences portletSetup)`
`void`	`setPortletToolbar(PortletToolbar portletToolbar)`
`void`	`setResourcePK(String resourcePK)`
`void`	`setRestoreCurrentView(boolean restoreCurrentView)`
`void`	`setRootPortletId(String rootPortletId)`
`void`	`setShowBackIcon(boolean showBackIcon)`
`void`	`setShowCloseIcon(boolean showCloseIcon)`
`void`	`setShowConfigurationIcon(boolean showConfigurationIcon)`
`void`	`setShowEditDefaultsIcon(boolean showEditDefaultsIcon)`
`void`	`setShowEditGuestIcon(boolean showEditGuestIcon)`
`void`	`setShowEditIcon(boolean showEditIcon)`
`void`	`setShowExportImportIcon(boolean showExportImportIcon)`
`void`	`setShowHelpIcon(boolean showHelpIcon)`
`void`	`setShowMoveIcon(boolean showMoveIcon)`
`void`	`setShowPortletCssIcon(boolean showPortletCssIcon)`
`void`	`setShowPortletIcon(boolean showPortletIcon)`
`void`	`setShowPrintIcon(boolean showPrintIcon)`
`void`	`setShowRefreshIcon(boolean showRefreshIcon)`
`void`	`setShowStagingIcon(boolean showStagingIcon)`
`void`	`setStateExclusive(boolean stateExclusive)`
`void`	`setStateMax(boolean stateMax)`
`void`	`setStateMin(boolean stateMin)`
`void`	`setStateNormal(boolean stateNormal)`
`void`	`setStatePopUp(boolean statePopUp)`
`void`	`setThemeDisplay(ThemeDisplay themeDisplay)`
`void`	`setTitle(String title)`
`void`	`setURLBack(String urlBack)`
`void`	`setURLClose(String urlClose)`
`void`	`setURLConfiguration(String urlConfiguration)`
`void`	`setURLConfigurationJS(String urlConfigurationJS)`
`void`	`setURLEdit(String urlEdit)`
`void`	`setURLEditDefaults(String urlEditDefaults)`
`void`	`setURLEditGuest(String urlEditGuest)`
`void`	`setURLExportImport(String urlExportImport)`
`void`	`setURLHelp(String urlHelp)`
`void`	`setURLMax(String urlMax)`
`void`	`setURLMin(String urlMin)`
`void`	`setURLPortlet(String urlPortlet)`
`void`	`setURLPortletCss(String urlPortletCss)`
`void`	`setURLPrint(String urlPrint)`
`void`	`setURLRefresh(String urlRefresh)`
`void`	`setURLStaging(String urlStaging)`
`void`	`setWebDAVEnabled(boolean webDAVEnabled)`
`void`	`writeContent(Writer writer)`

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

Constructor Detail
- PortletDisplay
```
public PortletDisplay()
```

Method Detail

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

getPortletInstanceConfiguration

public <T> T getPortletInstanceConfiguration(Class<T> clazz)
                                      throws ConfigurationException

Throws:: ConfigurationException

getPortletName
```
public String getPortletName()
```

getPortletResource
```
public String getPortletResource()
```

getPortletSetup

public PortletPreferences getPortletSetup()

getPortletToolbar

public PortletToolbar getPortletToolbar()

getResourcePK
```
public String getResourcePK()
```

getRootPortletId
```
public String getRootPortletId()
```

getThemeDisplay
```
public ThemeDisplay getThemeDisplay()
```

getTitle
```
public String getTitle()
```

getURLBack
```
public String getURLBack()
```

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

isAccess
```
@Deprecated
public boolean isAccess()
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

isActive
```
public boolean isActive()
```

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

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

setAccess
```
@Deprecated
public void setAccess(boolean access)
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

setActive

public void setActive(boolean active)

setColumnCount

public void setColumnCount(int columnCount)

setColumnId

public void setColumnId(String columnId)

setColumnPos

public void setColumnPos(int columnPos)

setContent

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

setPortletConfigurationIconMenu

public void setPortletConfigurationIconMenu(PortletConfigurationIconMenu portletConfigurationIconMenu)

setPortletDecorate

public void setPortletDecorate(boolean portletDecorate)

setPortletDecoratorId

public void setPortletDecoratorId(String portletDecoratorId)

setPortletDisplayName

public void setPortletDisplayName(String portletDisplayName)

setPortletName

public void setPortletName(String portletName)

setPortletResource

public void setPortletResource(String portletResource)

setPortletSetup

public void setPortletSetup(PortletPreferences portletSetup)

setPortletToolbar

public void setPortletToolbar(PortletToolbar portletToolbar)

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)

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

Class PortletDisplay

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

PortletDisplay

Method Detail

clone

copyFrom

copyTo

getColumnCount

getColumnId

getColumnPos

getContent

getCustomCSSClassName

getDescription

getId

getInstanceId

getNamespace

getPortletConfigurationIconMenu

getPortletDecoratorId

getPortletDisplayName

getPortletInstanceConfiguration

getPortletName

getPortletResource

getPortletSetup

getPortletToolbar

getResourcePK

getRootPortletId

getThemeDisplay

getTitle

getURLBack

getURLClose

getURLConfiguration

getURLConfigurationJS

getURLEdit

getURLEditDefaults

getURLEditGuest

getURLExportImport

getURLHelp

getURLMax

getURLMin

getURLPortlet

getURLPortletCss

getURLPrint

getURLRefresh

getURLStaging

isAccess

isActive

isFocused

isModeAbout

isModeConfig

isModeEdit

isModeEditDefaults

isModeEditGuest

isModeHelp

isModePreview

isModePrint

isModeView

isPortletDecorate

isRestoreCurrentView

isShowBackIcon

isShowCloseIcon

isShowConfigurationIcon

isShowEditDefaultsIcon

isShowEditGuestIcon

isShowEditIcon

isShowExportImportIcon

isShowHelpIcon

isShowMoveIcon

isShowPortletCssIcon

isShowPortletIcon

isShowPrintIcon

isShowRefreshIcon

isShowStagingIcon

isStateExclusive

isStateMax

isStateMin

isStateNormal

isStatePopUp