Package com.liferay.portal.kernel.theme
Class PortletDisplay
Object
com.liferay.portal.kernel.theme.PortletDisplay
- All Implemented Interfaces:
Serializable,Cloneable
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()voidcopyFrom(PortletDisplay master) voidcopyTo(PortletDisplay slave) intintcom.liferay.petra.string.StringBundlergetId()getTitle()booleanisActive()booleanisBeta()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanvoidrecycle()voidsetActive(boolean active) voidsetBeta(boolean beta) voidsetColumnCount(int columnCount) voidsetColumnId(String columnId) voidsetColumnPos(int columnPos) voidsetContent(com.liferay.petra.string.StringBundler contentSB) voidsetCustomCSSClassName(String customCSSClassName) voidsetDescription(String description) voidvoidsetInstanceId(String instanceId) voidsetModeAbout(boolean modeAbout) voidsetModeConfig(boolean modeConfig) voidsetModeEdit(boolean modeEdit) voidsetModeEditDefaults(boolean modeEditDefaults) voidsetModeEditGuest(boolean modeEditGuest) voidsetModeHelp(boolean modeHelp) voidsetModePreview(boolean modePreview) voidsetModePrint(boolean modePrint) voidsetModeView(boolean modeView) voidsetNamespace(String namespace) voidsetPortletDecorate(boolean portletDecorate) voidsetPortletDecoratorId(String portletDecoratorId) voidsetPortletDisplayName(String portletDisplayName) voidsetPortletName(String portletName) voidsetPortletPreferences(PortletPreferences portletPreferences) voidsetPortletResource(String portletResource) voidsetResourcePK(String resourcePK) voidsetRestoreCurrentView(boolean restoreCurrentView) voidsetRootPortletId(String rootPortletId) voidsetShowBackIcon(boolean showBackIcon) voidsetShowCloseIcon(boolean showCloseIcon) voidsetShowConfigurationIcon(boolean showConfigurationIcon) voidsetShowEditDefaultsIcon(boolean showEditDefaultsIcon) voidsetShowEditGuestIcon(boolean showEditGuestIcon) voidsetShowEditIcon(boolean showEditIcon) voidsetShowExportImportIcon(boolean showExportImportIcon) voidsetShowHelpIcon(boolean showHelpIcon) voidsetShowMoveIcon(boolean showMoveIcon) voidsetShowPortletCssIcon(boolean showPortletCssIcon) voidsetShowPortletIcon(boolean showPortletIcon) voidsetShowPrintIcon(boolean showPrintIcon) voidsetShowRefreshIcon(boolean showRefreshIcon) voidsetShowStagingIcon(boolean showStagingIcon) voidsetStateExclusive(boolean stateExclusive) voidsetStateMax(boolean stateMax) voidsetStateMin(boolean stateMin) voidsetStateNormal(boolean stateNormal) voidsetStatePopUp(boolean statePopUp) voidsetThemeDisplay(ThemeDisplay themeDisplay) voidvoidsetURLBack(String urlBack) voidsetURLBackTitle(String urlBackTitle) voidsetURLClose(String urlClose) voidsetURLConfiguration(String urlConfiguration) voidsetURLConfigurationJS(String urlConfigurationJS) voidsetURLEdit(String urlEdit) voidsetURLEditDefaults(String urlEditDefaults) voidsetURLEditGuest(String urlEditGuest) voidsetURLExportImport(String urlExportImport) voidsetURLHelp(String urlHelp) voidvoidvoidsetURLPortlet(String urlPortlet) voidsetURLPortletCss(String urlPortletCss) voidsetURLPrint(String urlPrint) voidsetURLRefresh(String urlRefresh) voidsetURLStaging(String urlStaging) voidsetWebDAVEnabled(boolean webDAVEnabled) voidwriteContent(Writer writer)
-
Constructor Details
-
PortletDisplay
public PortletDisplay()
-
-
Method Details
-
clone
-
copyFrom
-
copyTo
-
getColumnCount
public int getColumnCount() -
getColumnId
-
getColumnPos
public int getColumnPos() -
getContent
public com.liferay.petra.string.StringBundler getContent() -
getCustomCSSClassName
-
getDescription
-
getId
-
getInstanceId
-
getNamespace
-
getPortletConfigurationIconMenu
-
getPortletDecoratorId
-
getPortletDisplayName
-
getPortletName
-
getPortletPreferences
-
getPortletResource
-
getPortletToolbar
-
getResourcePK
-
getRootPortletId
-
getThemeDisplay
-
getTitle
-
getURLBack
-
getURLBackTitle
-
getURLClose
-
getURLConfiguration
-
getURLConfigurationJS
-
getURLEdit
-
getURLEditDefaults
-
getURLEditGuest
-
getURLExportImport
-
getURLHelp
-
getURLMax
-
getURLMin
-
getURLPortlet
-
getURLPortletCss
-
getURLPrint
-
getURLRefresh
-
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
-
setColumnPos
public void setColumnPos(int columnPos) -
setContent
public void setContent(com.liferay.petra.string.StringBundler contentSB) -
setCustomCSSClassName
-
setDescription
-
setId
-
setInstanceId
-
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
-
setPortletDecorate
public void setPortletDecorate(boolean portletDecorate) -
setPortletDecoratorId
-
setPortletDisplayName
-
setPortletName
-
setPortletPreferences
-
setPortletResource
-
setResourcePK
-
setRestoreCurrentView
public void setRestoreCurrentView(boolean restoreCurrentView) -
setRootPortletId
-
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
-
setTitle
-
setURLBack
-
setURLBackTitle
-
setURLClose
-
setURLConfiguration
-
setURLConfigurationJS
-
setURLEdit
-
setURLEditDefaults
-
setURLEditGuest
-
setURLExportImport
-
setURLHelp
-
setURLMax
-
setURLMin
-
setURLPortlet
-
setURLPortletCss
-
setURLPrint
-
setURLRefresh
-
setURLStaging
-
setWebDAVEnabled
public void setWebDAVEnabled(boolean webDAVEnabled) -
writeContent
- Throws:
IOException
-