com.liferay.portal.kernel.theme

Class PortletDisplay

java.lang.Object

com.liferay.portal.kernel.theme.PortletDisplay

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class PortletDisplay
extends java.lang.Object
implements java.lang.Cloneable, java.io.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()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
void	copyFrom(PortletDisplay master)
void	copyTo(PortletDisplay slave)
int	getColumnCount()
java.lang.String	getColumnId()
int	getColumnPos()
StringBundler	getContent()
java.lang.String	getCustomCSSClassName()
java.lang.String	getDescription()
java.lang.String	getId()
java.lang.String	getInstanceId()
java.lang.String	getNamespace()
PortletConfigurationIconMenu	getPortletConfigurationIconMenu()
java.lang.String	getPortletDecoratorId()
java.lang.String	getPortletDisplayName()
<T> T	getPortletInstanceConfiguration(java.lang.Class<T> clazz)
java.lang.String	getPortletName()
java.lang.String	getPortletResource()
javax.portlet.PortletPreferences	getPortletSetup()
PortletToolbar	getPortletToolbar()
java.lang.String	getResourcePK()
java.lang.String	getRootPortletId()
ThemeDisplay	getThemeDisplay()
java.lang.String	getTitle()
java.lang.String	getURLBack()
java.lang.String	getURLClose()
java.lang.String	getURLConfiguration()
java.lang.String	getURLConfigurationJS()
java.lang.String	getURLEdit()
java.lang.String	getURLEditDefaults()
java.lang.String	getURLEditGuest()
java.lang.String	getURLExportImport()
java.lang.String	getURLHelp()
java.lang.String	getURLMax()
java.lang.String	getURLMin()
java.lang.String	getURLPortlet()
java.lang.String	getURLPortletCss()
java.lang.String	getURLPrint()
java.lang.String	getURLRefresh()
java.lang.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(java.lang.String columnId)
void	setColumnPos(int columnPos)
void	setContent(StringBundler contentSB)
void	setCustomCSSClassName(java.lang.String customCSSClassName)
void	setDescription(java.lang.String description)
void	setId(java.lang.String id)
void	setInstanceId(java.lang.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(java.lang.String namespace)
void	setPortletConfigurationIconMenu(PortletConfigurationIconMenu portletConfigurationIconMenu)
void	setPortletDecorate(boolean portletDecorate)
void	setPortletDecoratorId(java.lang.String portletDecoratorId)
void	setPortletDisplayName(java.lang.String portletDisplayName)
void	setPortletName(java.lang.String portletName)
void	setPortletResource(java.lang.String portletResource)
void	setPortletSetup(javax.portlet.PortletPreferences portletSetup)
void	setPortletToolbar(PortletToolbar portletToolbar)
void	setResourcePK(java.lang.String resourcePK)
void	setRestoreCurrentView(boolean restoreCurrentView)
void	setRootPortletId(java.lang.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(java.lang.String title)
void	setURLBack(java.lang.String urlBack)
void	setURLClose(java.lang.String urlClose)
void	setURLConfiguration(java.lang.String urlConfiguration)
void	setURLConfigurationJS(java.lang.String urlConfigurationJS)
void	setURLEdit(java.lang.String urlEdit)
void	setURLEditDefaults(java.lang.String urlEditDefaults)
void	setURLEditGuest(java.lang.String urlEditGuest)
void	setURLExportImport(java.lang.String urlExportImport)
void	setURLHelp(java.lang.String urlHelp)
void	setURLMax(java.lang.String urlMax)
void	setURLMin(java.lang.String urlMin)
void	setURLPortlet(java.lang.String urlPortlet)
void	setURLPortletCss(java.lang.String urlPortletCss)
void	setURLPrint(java.lang.String urlPrint)
void	setURLRefresh(java.lang.String urlRefresh)
void	setURLStaging(java.lang.String urlStaging)
void	setWebDAVEnabled(boolean webDAVEnabled)
void	writeContent(java.io.Writer writer)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletDisplay

public PortletDisplay()

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

copyFrom

public void copyFrom(PortletDisplay master)

copyTo

public void copyTo(PortletDisplay slave)

getColumnCount

public int getColumnCount()

getColumnId

public java.lang.String getColumnId()

getColumnPos

public int getColumnPos()

getContent

public StringBundler getContent()

getCustomCSSClassName

public java.lang.String getCustomCSSClassName()

getDescription

public java.lang.String getDescription()

getId

public java.lang.String getId()

getInstanceId

public java.lang.String getInstanceId()

getNamespace

public java.lang.String getNamespace()

getPortletConfigurationIconMenu

public PortletConfigurationIconMenu getPortletConfigurationIconMenu()

getPortletDecoratorId

public java.lang.String getPortletDecoratorId()

getPortletDisplayName

public java.lang.String getPortletDisplayName()

getPortletInstanceConfiguration

public <T> T getPortletInstanceConfiguration(java.lang.Class<T> clazz)
                                      throws ConfigurationException

Throws:

ConfigurationException

getPortletName

public java.lang.String getPortletName()

getPortletResource

public java.lang.String getPortletResource()

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup()

getPortletToolbar

public PortletToolbar getPortletToolbar()

getResourcePK

public java.lang.String getResourcePK()

getRootPortletId

public java.lang.String getRootPortletId()

getThemeDisplay

public ThemeDisplay getThemeDisplay()

getTitle

public java.lang.String getTitle()

getURLBack

public java.lang.String getURLBack()

getURLClose

public java.lang.String getURLClose()

getURLConfiguration

public java.lang.String getURLConfiguration()

getURLConfigurationJS

public java.lang.String getURLConfigurationJS()

getURLEdit

public java.lang.String getURLEdit()

getURLEditDefaults

public java.lang.String getURLEditDefaults()

getURLEditGuest

public java.lang.String getURLEditGuest()

getURLExportImport

public java.lang.String getURLExportImport()

getURLHelp

public java.lang.String getURLHelp()

getURLMax

public java.lang.String getURLMax()

getURLMin

public java.lang.String getURLMin()

getURLPortlet

public java.lang.String getURLPortlet()

getURLPortletCss

public java.lang.String getURLPortletCss()

getURLPrint

public java.lang.String getURLPrint()

getURLRefresh

public java.lang.String getURLRefresh()

getURLStaging

public java.lang.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(java.lang.String columnId)

setColumnPos

public void setColumnPos(int columnPos)

setContent

public void setContent(StringBundler contentSB)

setCustomCSSClassName

public void setCustomCSSClassName(java.lang.String customCSSClassName)

setDescription

public void setDescription(java.lang.String description)

setId

public void setId(java.lang.String id)

setInstanceId

public void setInstanceId(java.lang.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(java.lang.String namespace)

setPortletConfigurationIconMenu

public void setPortletConfigurationIconMenu(PortletConfigurationIconMenu portletConfigurationIconMenu)

setPortletDecorate

public void setPortletDecorate(boolean portletDecorate)

setPortletDecoratorId

public void setPortletDecoratorId(java.lang.String portletDecoratorId)

setPortletDisplayName

public void setPortletDisplayName(java.lang.String portletDisplayName)

setPortletName

public void setPortletName(java.lang.String portletName)

setPortletResource

public void setPortletResource(java.lang.String portletResource)

setPortletSetup

public void setPortletSetup(javax.portlet.PortletPreferences portletSetup)

setPortletToolbar

public void setPortletToolbar(PortletToolbar portletToolbar)

setResourcePK

public void setResourcePK(java.lang.String resourcePK)

setRestoreCurrentView

public void setRestoreCurrentView(boolean restoreCurrentView)

setRootPortletId

public void setRootPortletId(java.lang.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(java.lang.String title)

setURLBack

public void setURLBack(java.lang.String urlBack)

setURLClose

public void setURLClose(java.lang.String urlClose)

setURLConfiguration

public void setURLConfiguration(java.lang.String urlConfiguration)

setURLConfigurationJS

public void setURLConfigurationJS(java.lang.String urlConfigurationJS)

setURLEdit

public void setURLEdit(java.lang.String urlEdit)

setURLEditDefaults

public void setURLEditDefaults(java.lang.String urlEditDefaults)

setURLEditGuest

public void setURLEditGuest(java.lang.String urlEditGuest)

setURLExportImport

public void setURLExportImport(java.lang.String urlExportImport)

setURLHelp

public void setURLHelp(java.lang.String urlHelp)

setURLMax

public void setURLMax(java.lang.String urlMax)

setURLMin

public void setURLMin(java.lang.String urlMin)

setURLPortlet

public void setURLPortlet(java.lang.String urlPortlet)

setURLPortletCss

public void setURLPortletCss(java.lang.String urlPortletCss)

setURLPrint

public void setURLPrint(java.lang.String urlPrint)

setURLRefresh

public void setURLRefresh(java.lang.String urlRefresh)

setURLStaging

public void setURLStaging(java.lang.String urlStaging)

setWebDAVEnabled

public void setWebDAVEnabled(boolean webDAVEnabled)

writeContent

public void writeContent(java.io.Writer writer)
                  throws java.io.IOException

Throws:

java.io.IOException