|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.liferay.portal.model.PortletWrapper
public class PortletWrapper
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.
This class is a wrapper for Portlet
.
Portlet
,
Serialized FormConstructor Summary | |
---|---|
PortletWrapper(Portlet portlet)
|
Method Summary | |
---|---|
void |
addProcessingEvent(com.liferay.portal.kernel.xml.QName processingEvent)
Adds a supported processing event. |
void |
addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Adds a supported public render parameter. |
void |
addPublishingEvent(com.liferay.portal.kernel.xml.QName publishingEvent)
Adds a supported publishing event. |
java.lang.Object |
clone()
Creates and returns a copy of this object. |
int |
compareTo(Portlet portlet)
Compares this portlet to the specified object. |
boolean |
equals(java.lang.Object obj)
Checks whether this portlet is equal to the specified object. |
boolean |
getActionURLRedirect()
Returns true if an action URL for this portlet should cause an auto redirect. |
boolean |
getActive()
|
boolean |
getAddDefaultResource()
Returns true if default resources for the portlet are added to a page. |
boolean |
getAjaxable()
Returns true if the portlet can be displayed via Ajax. |
java.util.Set<java.lang.String> |
getAllPortletModes()
Gets a list of all portlet modes supported by the portlet. |
java.util.Set<java.lang.String> |
getAllWindowStates()
Gets a list of all window states supported by the portlet. |
Portlet |
getClonedInstance(java.lang.String portletId)
Returns true if the portlet is found in a WAR file. |
long |
getCompanyId()
|
java.lang.String |
getConfigurationActionClass()
Gets the configuration action class of the portlet. |
com.liferay.portal.kernel.portlet.ConfigurationAction |
getConfigurationActionInstance()
Gets the configuration action instance of the portlet. |
java.lang.String |
getContextPath()
Gets the servlet context path of the portlet. |
java.lang.String |
getControlPanelEntryCategory()
Gets the name of the category of the Control Panel where the portlet will be shown. |
java.lang.String |
getControlPanelEntryClass()
Gets the name of the class that will control when the portlet will be shown in the Control Panel. |
ControlPanelEntry |
getControlPanelEntryInstance()
Gets an instance of the class that will control when the portlet will be shown in the Control Panel. |
double |
getControlPanelEntryWeight()
Gets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel. |
java.lang.String |
getCssClassWrapper()
Gets the name of the CSS class that will be injected in the DIV that wraps this portlet. |
PluginSetting |
getDefaultPluginSetting()
Get the default plugin settings of the portlet. |
java.lang.String |
getDefaultPreferences()
Gets the default preferences of the portlet. |
java.lang.String |
getDisplayName()
Gets the display name of the portlet. |
ExpandoBridge |
getExpandoBridge()
|
java.lang.Integer |
getExpCache()
Gets expiration cache of the portlet. |
java.lang.String |
getFacebookIntegration()
Gets the Facebook integration method of the portlet. |
java.util.List<java.lang.String> |
getFooterPortalCss()
Gets a list of CSS files that will be referenced from the page's footer relative to the portal's context path. |
java.util.List<java.lang.String> |
getFooterPortalJavaScript()
Gets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path. |
java.util.List<java.lang.String> |
getFooterPortletCss()
Gets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path. |
java.util.List<java.lang.String> |
getFooterPortletJavaScript()
Gets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path. |
java.lang.String |
getFriendlyURLMapperClass()
Gets the name of the friendly URL mapper class of the portlet. |
com.liferay.portal.kernel.portlet.FriendlyURLMapper |
getFriendlyURLMapperInstance()
Gets the friendly URL mapper instance of the portlet. |
java.util.List<java.lang.String> |
getHeaderPortalCss()
Gets a list of CSS files that will be referenced from the page's header relative to the portal's context path. |
java.util.List<java.lang.String> |
getHeaderPortalJavaScript()
Gets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path. |
java.util.List<java.lang.String> |
getHeaderPortletCss()
Gets a list of CSS files that will be referenced from the page's header relative to the portlet's context path. |
java.util.List<java.lang.String> |
getHeaderPortletJavaScript()
Gets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path. |
java.lang.String |
getIcon()
Gets the icon of the portlet. |
long |
getId()
|
boolean |
getInclude()
Returns true to include the portlet and make it available to be made active. |
java.lang.String |
getIndexerClass()
Gets the name of the indexer class of the portlet. |
com.liferay.portal.kernel.search.Indexer |
getIndexerInstance()
Gets the indexer instance of the portlet. |
java.util.Map<java.lang.String,java.lang.String> |
getInitParams()
Gets the init parameters of the portlet. |
boolean |
getInstanceable()
Returns true if the portlet can be added multiple times to a layout. |
java.lang.String |
getInstanceId()
Gets the instance id of the portlet. |
boolean |
getLayoutCacheable()
Returns true to allow the portlet to be cached within the layout. |
boolean |
getMaximizeEdit()
Returns true if the portlet goes into the maximized state when the user goes into the edit mode. |
boolean |
getMaximizeHelp()
Returns true if the portlet goes into the maximized state when the user goes into the help mode. |
java.lang.String |
getOpenSearchClass()
Gets the name of the open search class of the portlet. |
com.liferay.portal.kernel.search.OpenSearch |
getOpenSearchInstance()
Gets the indexer instance of the portlet. |
java.lang.String |
getPluginId()
Gets the plugin id of the portlet. |
com.liferay.portal.kernel.plugin.PluginPackage |
getPluginPackage()
Get the package to which the portlet belongs to. |
java.lang.String |
getPluginType()
Gets the plugin type of the portlet. |
java.lang.String |
getPollerProcessorClass()
Gets the name of the poller processor class of the portlet. |
com.liferay.portal.kernel.poller.PollerProcessor |
getPollerProcessorInstance()
Gets the poller processor instance of the portlet. |
java.lang.String |
getPopMessageListenerClass()
Gets the name of the POP message listener class of the portlet. |
com.liferay.portal.kernel.pop.MessageListener |
getPopMessageListenerInstance()
Gets the POP message listener instance of the portlet. |
boolean |
getPopUpPrint()
Returns true if the portlet goes into the pop up state when the user goes into the print mode. |
PortletApp |
getPortletApp()
Get the application this portlet belongs to. |
java.lang.String |
getPortletClass()
Gets the name of the portlet class of the portlet. |
java.lang.String |
getPortletDataHandlerClass()
Gets the name of the portlet data handler class of the portlet. |
PortletDataHandler |
getPortletDataHandlerInstance()
Gets the portlet data handler instance of the portlet. |
java.util.Map<java.lang.String,PortletFilter> |
getPortletFilters()
Gets the filters of the portlet. |
java.lang.String |
getPortletId()
|
PortletInfo |
getPortletInfo()
Gets the portlet info of the portlet. |
java.lang.String |
getPortletLayoutListenerClass()
Gets the name of the portlet layout listener class of the portlet. |
com.liferay.portal.kernel.portlet.PortletLayoutListener |
getPortletLayoutListenerInstance()
Gets the portlet layout listener instance of the portlet. |
java.util.Map<java.lang.String,java.util.Set<java.lang.String>> |
getPortletModes()
Gets the portlet modes of the portlet. |
java.lang.String |
getPortletName()
Gets the name of the portlet. |
java.lang.String |
getPortletURLClass()
Gets the name of the portlet URL class of the portlet. |
boolean |
getPreferencesCompanyWide()
Returns true if preferences are shared across the entire company. |
boolean |
getPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the portlet is shown in a group layout. |
boolean |
getPreferencesUniquePerLayout()
Returns true if preferences are unique per layout. |
java.lang.String |
getPreferencesValidator()
Gets the name of the preferences validator class of the portlet. |
long |
getPrimaryKey()
|
java.io.Serializable |
getPrimaryKeyObj()
|
boolean |
getPrivateRequestAttributes()
Returns true if the portlet does not share request attributes with the portal or portlets from another WAR. |
boolean |
getPrivateSessionAttributes()
Returns true if the portlet does not share session attributes with the portal. |
com.liferay.portal.kernel.xml.QName |
getProcessingEvent(java.lang.String uri,
java.lang.String localPart)
Gets the supported processing event from a namespace URI and a local part. |
java.util.Set<com.liferay.portal.kernel.xml.QName> |
getProcessingEvents()
Gets the supported processing events of the portlet. |
PublicRenderParameter |
getPublicRenderParameter(java.lang.String identifier)
Gets the supported public render parameter from an identifier. |
PublicRenderParameter |
getPublicRenderParameter(java.lang.String uri,
java.lang.String localPart)
Gets the supported public render parameter from a namespace URI and a local part. |
java.util.Set<PublicRenderParameter> |
getPublicRenderParameters()
Gets the supported public render parameters of the portlet. |
java.util.Set<com.liferay.portal.kernel.xml.QName> |
getPublishingEvents()
Gets the supported publishing events of the portlet. |
boolean |
getReady()
Returns true if the portlet is ready to be used. |
int |
getRenderWeight()
Returns the render weight of the portlet. |
java.lang.String |
getResourceBundle()
Gets the resource bundle of the portlet. |
boolean |
getRestoreCurrentView()
Returns true if the portlet restores to the current view from the maximized state. |
java.util.Map<java.lang.String,java.lang.String> |
getRoleMappers()
Gets the role mappers of the portlet. |
java.lang.String |
getRoles()
|
java.lang.String[] |
getRolesArray()
Gets an array of required roles of the portlet. |
java.lang.String |
getRootPortletId()
Gets the root portlet id of the portlet. |
java.lang.String |
getSchedulerClass()
Gets the name of the scheduler class of the portlet. |
com.liferay.portal.kernel.job.Scheduler |
getSchedulerInstance()
Gets the scheduler instance of the portlet. |
boolean |
getScopeable()
Returns true if the portlet supports scoping of data. |
boolean |
getShowPortletAccessDenied()
Returns true if users are shown that they do not have access to the portlet. |
boolean |
getShowPortletInactive()
Returns true if users are shown that the portlet is inactive. |
java.lang.String |
getSocialActivityInterpreterClass()
Gets the name of the social activity interpreter class of the portlet. |
SocialActivityInterpreter |
getSocialActivityInterpreterInstance()
Gets the name of the social activity interpreter instance of the portlet. |
java.lang.String |
getSocialRequestInterpreterClass()
Gets the name of the social request interpreter class of the portlet. |
SocialRequestInterpreter |
getSocialRequestInterpreterInstance()
Gets the name of the social request interpreter instance of the portlet. |
boolean |
getStatic()
Returns true if the portlet is a static portlet that is cannot be moved. |
boolean |
getStaticEnd()
Returns true if the portlet is a static portlet at the end of a list of portlets. |
boolean |
getStaticStart()
Returns true if the portlet is a static portlet at the start of a list of portlets. |
java.lang.String |
getStrutsPath()
Gets the struts path of the portlet. |
java.util.Set<java.lang.String> |
getSupportedLocales()
Gets the supported locales of the portlet. |
boolean |
getSystem()
Returns true if the portlet is a system portlet that a user cannot manually add to their page. |
long |
getTimestamp()
Gets the timestamp of the portlet. |
boolean |
getUndeployedPortlet()
Returns true if the portlet is an undeployed portlet. |
java.util.Set<java.lang.String> |
getUnlinkedRoles()
Gets the unlinked roles of the portlet. |
java.lang.String |
getURLEncoderClass()
Gets the name of the URL encoder class of the portlet. |
com.liferay.portal.kernel.servlet.URLEncoder |
getURLEncoderInstance()
Gets the URL encoder instance of the portlet. |
boolean |
getUseDefaultTemplate()
Returns true if the portlet uses the default template. |
java.lang.String |
getUserPrincipalStrategy()
Gets the user principal strategy of the portlet. |
java.lang.String |
getVirtualPath()
Gets the virtual path of the portlet. |
java.lang.String |
getWebDAVStorageClass()
Gets the name of the WebDAV storage class of the portlet. |
WebDAVStorage |
getWebDAVStorageInstance()
Gets the name of the WebDAV storage instance of the portlet. |
java.lang.String |
getWebDAVStorageToken()
Gets the name of the WebDAV storage token of the portlet. |
java.util.Map<java.lang.String,java.util.Set<java.lang.String>> |
getWindowStates()
Gets the window states of the portlet. |
Portlet |
getWrappedPortlet()
|
boolean |
hasAddPortletPermission(long userId)
Returns true if the user has the permission to add the portlet to a layout. |
int |
hashCode()
|
boolean |
hasMultipleMimeTypes()
Returns true if the portlet supports more than one mime type. |
boolean |
hasPortletMode(java.lang.String mimeType,
javax.portlet.PortletMode portletMode)
Returns true if the portlet supports the specified mime type and portlet mode. |
boolean |
hasRoleWithName(java.lang.String roleName)
Returns true if the portlet has a role with the specified name. |
boolean |
hasWindowState(java.lang.String mimeType,
javax.portlet.WindowState windowState)
Returns true if the portlet supports the specified mime type and window state. |
boolean |
isActionURLRedirect()
Returns true if an action URL for this portlet should cause an auto redirect. |
boolean |
isActive()
|
boolean |
isAddDefaultResource()
Returns true if default resources for the portlet are added to a page. |
boolean |
isAjaxable()
Returns true if the portlet can be displayed via Ajax. |
boolean |
isCachedModel()
|
boolean |
isEscapedModel()
|
boolean |
isInclude()
Returns true to include the portlet and make it available to be made active. |
boolean |
isInstanceable()
Returns true if the portlet can be added multiple times to a layout. |
boolean |
isLayoutCacheable()
Returns true to allow the portlet to be cached within the layout. |
boolean |
isMaximizeEdit()
Returns true if the portlet goes into the maximized state when the user goes into the edit mode. |
boolean |
isMaximizeHelp()
Returns true if the portlet goes into the maximized state when the user goes into the help mode. |
boolean |
isNew()
|
boolean |
isPopUpPrint()
Returns true if the portlet goes into the pop up state when the user goes into the print mode. |
boolean |
isPreferencesCompanyWide()
Returns true if preferences are shared across the entire company. |
boolean |
isPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the portlet is shown in a group layout. |
boolean |
isPreferencesUniquePerLayout()
Returns true if preferences are unique per layout. |
boolean |
isPrivateRequestAttributes()
Returns true if the portlet does not share request attributes with the portal or portlets from another WAR. |
boolean |
isPrivateSessionAttributes()
Returns true if the portlet does not share session attributes with the portal. |
boolean |
isReady()
Returns true if the portlet is ready to be used. |
boolean |
isRestoreCurrentView()
Returns true if the portlet restores to the current view from the maximized state. |
boolean |
isScopeable()
Returns true if the portlet supports scoping of data. |
boolean |
isShowPortletAccessDenied()
Returns true if users are shown that they do not have access to the portlet. |
boolean |
isShowPortletInactive()
Returns true if users are shown that the portlet is inactive. |
boolean |
isStatic()
Returns true if the portlet is a static portlet that is cannot be moved. |
boolean |
isStaticEnd()
Returns true if the portlet is a static portlet at the end of a list of portlets. |
boolean |
isStaticStart()
Returns true if the portlet is a static portlet at the start of a list of portlets. |
boolean |
isSystem()
Returns true if the portlet is a system portlet that a user cannot manually add to their page. |
boolean |
isUndeployedPortlet()
Returns true if the portlet is an undeployed portlet. |
boolean |
isUseDefaultTemplate()
Returns true if the portlet uses the default template. |
void |
linkRoles()
Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml. |
void |
setActionURLRedirect(boolean actionURLRedirect)
Set to true if an action URL for this portlet should cause an auto redirect. |
void |
setActive(boolean active)
|
void |
setAddDefaultResource(boolean addDefaultResource)
Set to true if default resources for the portlet are added to a page. |
void |
setAjaxable(boolean ajaxable)
Set to true if the portlet can be displayed via Ajax. |
void |
setCachedModel(boolean cachedModel)
|
void |
setCompanyId(long companyId)
|
void |
setConfigurationActionClass(java.lang.String configurationActionClass)
Sets the configuration action class of the portlet. |
void |
setControlPanelEntryCategory(java.lang.String controlPanelEntryCategory)
Set the name of the category of the Control Panel where the portlet will be shown. |
void |
setControlPanelEntryClass(java.lang.String controlPanelEntryClass)
Sets the name of the class that will control when the portlet will be shown in the Control Panel. |
void |
setControlPanelEntryWeight(double controlPanelEntryWeight)
Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel. |
void |
setCssClassWrapper(java.lang.String cssClassWrapper)
Sets the name of the CSS class that will be injected in the DIV that wraps this portlet. |
void |
setDefaultPluginSetting(PluginSetting pluginSetting)
Sets the default plugin settings of the portlet. |
void |
setDefaultPreferences(java.lang.String defaultPreferences)
Sets the default preferences of the portlet. |
void |
setDisplayName(java.lang.String displayName)
Sets the display name of the portlet. |
void |
setEscapedModel(boolean escapedModel)
|
void |
setExpandoBridgeAttributes(ServiceContext serviceContext)
|
void |
setExpCache(java.lang.Integer expCache)
Sets expiration cache of the portlet. |
void |
setFacebookIntegration(java.lang.String facebookIntegration)
Sets the Facebook integration method of the portlet. |
void |
setFooterPortalCss(java.util.List<java.lang.String> footerPortalCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portal's context path. |
void |
setFooterPortalJavaScript(java.util.List<java.lang.String> footerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path. |
void |
setFooterPortletCss(java.util.List<java.lang.String> footerPortletCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path. |
void |
setFooterPortletJavaScript(java.util.List<java.lang.String> footerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path. |
void |
setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)
Sets the name of the friendly URL mapper class of the portlet. |
void |
setHeaderPortalCss(java.util.List<java.lang.String> headerPortalCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portal's context path. |
void |
setHeaderPortalJavaScript(java.util.List<java.lang.String> headerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path. |
void |
setHeaderPortletCss(java.util.List<java.lang.String> headerPortletCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portlet's context path. |
void |
setHeaderPortletJavaScript(java.util.List<java.lang.String> headerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path. |
void |
setIcon(java.lang.String icon)
Sets the icon of the portlet. |
void |
setId(long id)
|
void |
setInclude(boolean include)
Set to true to include the portlet and make it available to be made active. |
void |
setIndexerClass(java.lang.String indexerClass)
Sets the name of the indexer class of the portlet. |
void |
setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)
Sets the init parameters of the portlet. |
void |
setInstanceable(boolean instanceable)
Set to true if the portlet can be added multiple times to a layout. |
void |
setLayoutCacheable(boolean layoutCacheable)
Set to true to allow the portlet to be cached within the layout. |
void |
setMaximizeEdit(boolean maximizeEdit)
Set to true if the portlet goes into the maximized state when the user goes into the edit mode. |
void |
setMaximizeHelp(boolean maximizeHelp)
Set to true if the portlet goes into the maximized state when the user goes into the help mode. |
boolean |
setNew(boolean n)
|
void |
setOpenSearchClass(java.lang.String openSearchClass)
Sets the name of the open search class of the portlet. |
void |
setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
Sets the plugin package this portlet belongs to. |
void |
setPollerProcessorClass(java.lang.String pollerProcessorClass)
Sets the name of the poller processor class of the portlet. |
void |
setPopMessageListenerClass(java.lang.String popMessageListenerClass)
Sets the name of the POP message listener class of the portlet. |
void |
setPopUpPrint(boolean popUpPrint)
Set to true if the portlet goes into the pop up state when the user goes into the print mode. |
void |
setPortletApp(PortletApp portletApp)
Sets the application this portlet belongs to. |
void |
setPortletClass(java.lang.String portletClass)
Sets the name of the portlet class of the portlet. |
void |
setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)
Sets the name of the portlet data handler class of the portlet. |
void |
setPortletFilters(java.util.Map<java.lang.String,PortletFilter> portletFilters)
Sets the filters of the portlet. |
void |
setPortletId(java.lang.String portletId)
|
void |
setPortletInfo(PortletInfo portletInfo)
Sets the portlet info of the portlet. |
void |
setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)
Sets the name of the portlet layout listener class of the portlet. |
void |
setPortletModes(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes)
Sets the portlet modes of the portlet. |
void |
setPortletName(java.lang.String portletName)
Sets the name of the portlet. |
void |
setPortletURLClass(java.lang.String portletURLClass)
Sets the name of the portlet URL class of the portlet. |
void |
setPreferencesCompanyWide(boolean preferencesCompanyWide)
Set to true if preferences are shared across the entire company. |
void |
setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
Set to true if preferences are owned by the group when the portlet is shown in a group layout. |
void |
setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
Set to true if preferences are unique per layout. |
void |
setPreferencesValidator(java.lang.String preferencesValidator)
Sets the name of the preferences validator class of the portlet. |
void |
setPrimaryKey(long pk)
|
void |
setPrivateRequestAttributes(boolean privateRequestAttributes)
Set to true if the portlet does not share request attributes with the portal or portlets from another WAR. |
void |
setPrivateSessionAttributes(boolean privateSessionAttributes)
Set to true if the portlet does not share session attributes with the portal. |
void |
setProcessingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents)
Sets the supported processing events of the portlet. |
void |
setPublicRenderParameters(java.util.Set<PublicRenderParameter> publicRenderParameters)
Sets the supported public render parameters of the portlet. |
void |
setPublishingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents)
Sets the supported publishing events of the portlet. |
void |
setReady(boolean ready)
Set to true if the portlet is ready to be used. |
void |
setRenderWeight(int renderWeight)
Sets the render weight of the portlet. |
void |
setResourceBundle(java.lang.String resourceBundle)
Sets the resource bundle of the portlet. |
void |
setRestoreCurrentView(boolean restoreCurrentView)
Set to true if the portlet restores to the current view from the maximized state. |
void |
setRoleMappers(java.util.Map<java.lang.String,java.lang.String> roleMappers)
Sets the role mappers of the portlet. |
void |
setRoles(java.lang.String roles)
Sets a string of ordered comma delimited portlet ids. |
void |
setRolesArray(java.lang.String[] rolesArray)
Sets an array of required roles of the portlet. |
void |
setSchedulerClass(java.lang.String schedulerClass)
Sets the name of the scheduler class of the portlet. |
void |
setScopeable(boolean scopeable)
Set to true if the portlet supports scoping of data. |
void |
setShowPortletAccessDenied(boolean showPortletAccessDenied)
Set to true if users are shown that they do not have access to the portlet. |
void |
setShowPortletInactive(boolean showPortletInactive)
Set to true if users are shown that the portlet is inactive. |
void |
setSocialActivityInterpreterClass(java.lang.String socialActivityInterpreterClass)
Sets the name of the social activity interpreter class of the portlet. |
void |
setSocialRequestInterpreterClass(java.lang.String socialRequestInterpreterClass)
Sets the name of the social request interpreter class of the portlet. |
void |
setStatic(boolean staticPortlet)
Set to true if the portlet is a static portlet that is cannot be moved. |
void |
setStaticStart(boolean staticPortletStart)
Set to true if the portlet is a static portlet at the start of a list of portlets. |
void |
setStrutsPath(java.lang.String strutsPath)
Sets the struts path of the portlet. |
void |
setSupportedLocales(java.util.Set<java.lang.String> supportedLocales)
Sets the supported locales of the portlet. |
void |
setSystem(boolean system)
Set to true if the portlet is a system portlet that a user cannot manually add to their page. |
void |
setTimestamp(long timestamp)
Sets the timestamp of the portlet. |
void |
setUndeployedPortlet(boolean undeployedPortlet)
Set to true if the portlet is an undeployed portlet. |
void |
setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles)
Sets the unlinked roles of the portlet. |
void |
setURLEncoderClass(java.lang.String urlEncoderClass)
Sets the name of the URL encoder class of the portlet. |
void |
setUseDefaultTemplate(boolean useDefaultTemplate)
Set to true if the portlet uses the default template. |
void |
setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)
Sets the user principal strategy of the portlet. |
void |
setVirtualPath(java.lang.String virtualPath)
Sets the virtual path of the portlet. |
void |
setWebDAVStorageClass(java.lang.String webDAVStorageClass)
Sets the name of the WebDAV storage class of the portlet. |
void |
setWebDAVStorageToken(java.lang.String webDAVStorageToken)
Sets the name of the WebDAV storage token of the portlet. |
void |
setWindowStates(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates)
Sets the window states of the portlet. |
Portlet |
toEscapedModel()
|
java.lang.String |
toString()
|
java.lang.String |
toXmlString()
|
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PortletWrapper(Portlet portlet)
Method Detail |
---|
public long getPrimaryKey()
getPrimaryKey
in interface PortletModel
public void setPrimaryKey(long pk)
setPrimaryKey
in interface PortletModel
public long getId()
getId
in interface PortletModel
public void setId(long id)
setId
in interface PortletModel
public long getCompanyId()
getCompanyId
in interface PortletModel
public void setCompanyId(long companyId)
setCompanyId
in interface PortletModel
public java.lang.String getPortletId()
getPortletId
in interface PortletModel
public void setPortletId(java.lang.String portletId)
setPortletId
in interface PortletModel
public java.lang.String getRoles()
getRoles
in interface PortletModel
public void setRoles(java.lang.String roles)
Portlet
setRoles
in interface Portlet
setRoles
in interface PortletModel
roles
- a string of ordered comma delimited portlet idspublic boolean getActive()
getActive
in interface PortletModel
public boolean isActive()
isActive
in interface PortletModel
public void setActive(boolean active)
setActive
in interface PortletModel
public boolean isNew()
isNew
in interface BaseModel<Portlet>
isNew
in interface PortletModel
public boolean setNew(boolean n)
setNew
in interface BaseModel<Portlet>
setNew
in interface PortletModel
public boolean isCachedModel()
isCachedModel
in interface BaseModel<Portlet>
isCachedModel
in interface PortletModel
public void setCachedModel(boolean cachedModel)
setCachedModel
in interface BaseModel<Portlet>
setCachedModel
in interface PortletModel
public boolean isEscapedModel()
isEscapedModel
in interface BaseModel<Portlet>
isEscapedModel
in interface PortletModel
public void setEscapedModel(boolean escapedModel)
setEscapedModel
in interface BaseModel<Portlet>
setEscapedModel
in interface PortletModel
public java.io.Serializable getPrimaryKeyObj()
getPrimaryKeyObj
in interface BaseModel<Portlet>
getPrimaryKeyObj
in interface PortletModel
public ExpandoBridge getExpandoBridge()
getExpandoBridge
in interface BaseModel<Portlet>
getExpandoBridge
in interface PortletModel
public void setExpandoBridgeAttributes(ServiceContext serviceContext)
setExpandoBridgeAttributes
in interface BaseModel<Portlet>
setExpandoBridgeAttributes
in interface PortletModel
public java.lang.Object clone()
Portlet
clone
in interface BaseModel<Portlet>
clone
in interface Portlet
clone
in interface PortletModel
clone
in class java.lang.Object
public int compareTo(Portlet portlet)
Portlet
compareTo
in interface Portlet
compareTo
in interface PortletModel
compareTo
in interface java.lang.Comparable<Portlet>
portlet
- the portlet to compare this portlet against
public int hashCode()
hashCode
in interface PortletModel
hashCode
in class java.lang.Object
public Portlet toEscapedModel()
toEscapedModel
in interface BaseModel<Portlet>
toEscapedModel
in interface PortletModel
public java.lang.String toString()
toString
in interface PortletModel
toString
in class java.lang.Object
public java.lang.String toXmlString()
toXmlString
in interface BaseModel<Portlet>
toXmlString
in interface PortletModel
public java.lang.String getRootPortletId()
Portlet
getRootPortletId
in interface Portlet
public java.lang.String getInstanceId()
Portlet
getInstanceId
in interface Portlet
public java.lang.String getPluginId()
Portlet
getPluginId
in interface Portlet
public java.lang.String getPluginType()
Portlet
getPluginType
in interface Portlet
public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()
Portlet
getPluginPackage
in interface Portlet
public void setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
Portlet
setPluginPackage
in interface Portlet
pluginPackage
- the plugin packagepublic PluginSetting getDefaultPluginSetting()
Portlet
getDefaultPluginSetting
in interface Portlet
public void setDefaultPluginSetting(PluginSetting pluginSetting)
Portlet
setDefaultPluginSetting
in interface Portlet
pluginSetting
- the plugin settingpublic long getTimestamp()
Portlet
getTimestamp
in interface Portlet
public void setTimestamp(long timestamp)
Portlet
setTimestamp
in interface Portlet
timestamp
- the timestamp of the portletpublic java.lang.String getIcon()
Portlet
getIcon
in interface Portlet
public void setIcon(java.lang.String icon)
Portlet
setIcon
in interface Portlet
icon
- the icon of the portletpublic java.lang.String getVirtualPath()
Portlet
getVirtualPath
in interface Portlet
public void setVirtualPath(java.lang.String virtualPath)
Portlet
setVirtualPath
in interface Portlet
virtualPath
- the virtual path of the portletpublic java.lang.String getStrutsPath()
Portlet
getStrutsPath
in interface Portlet
public void setStrutsPath(java.lang.String strutsPath)
Portlet
setStrutsPath
in interface Portlet
strutsPath
- the struts path of the portletpublic java.lang.String getPortletName()
Portlet
getPortletName
in interface Portlet
public void setPortletName(java.lang.String portletName)
Portlet
setPortletName
in interface Portlet
portletName
- the name of the portletpublic java.lang.String getDisplayName()
Portlet
getDisplayName
in interface Portlet
public void setDisplayName(java.lang.String displayName)
Portlet
setDisplayName
in interface Portlet
displayName
- the display name of the portletpublic java.lang.String getPortletClass()
Portlet
getPortletClass
in interface Portlet
public void setPortletClass(java.lang.String portletClass)
Portlet
setPortletClass
in interface Portlet
portletClass
- the name of the portlet class of the portletpublic java.lang.String getConfigurationActionClass()
Portlet
getConfigurationActionClass
in interface Portlet
public void setConfigurationActionClass(java.lang.String configurationActionClass)
Portlet
setConfigurationActionClass
in interface Portlet
configurationActionClass
- the configuration action class of the
portletpublic com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()
Portlet
getConfigurationActionInstance
in interface Portlet
public java.lang.String getIndexerClass()
Portlet
getIndexerClass
in interface Portlet
public void setIndexerClass(java.lang.String indexerClass)
Portlet
setIndexerClass
in interface Portlet
indexerClass
- the name of the indexer class of the portletpublic com.liferay.portal.kernel.search.Indexer getIndexerInstance()
Portlet
getIndexerInstance
in interface Portlet
public java.lang.String getOpenSearchClass()
Portlet
getOpenSearchClass
in interface Portlet
public void setOpenSearchClass(java.lang.String openSearchClass)
Portlet
setOpenSearchClass
in interface Portlet
openSearchClass
- the name of the open search class of the portletpublic com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance()
Portlet
getOpenSearchInstance
in interface Portlet
public java.lang.String getSchedulerClass()
Portlet
getSchedulerClass
in interface Portlet
public void setSchedulerClass(java.lang.String schedulerClass)
Portlet
setSchedulerClass
in interface Portlet
schedulerClass
- the name of the scheduler class of the portletpublic com.liferay.portal.kernel.job.Scheduler getSchedulerInstance()
Portlet
getSchedulerInstance
in interface Portlet
public java.lang.String getPortletURLClass()
Portlet
getPortletURLClass
in interface Portlet
public void setPortletURLClass(java.lang.String portletURLClass)
Portlet
setPortletURLClass
in interface Portlet
portletURLClass
- the name of the portlet URL class of the portletpublic java.lang.String getFriendlyURLMapperClass()
Portlet
getFriendlyURLMapperClass
in interface Portlet
public void setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)
Portlet
setFriendlyURLMapperClass
in interface Portlet
friendlyURLMapperClass
- the name of the friendly URL mapper class
of the portletpublic com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()
Portlet
getFriendlyURLMapperInstance
in interface Portlet
public java.lang.String getURLEncoderClass()
Portlet
getURLEncoderClass
in interface Portlet
public void setURLEncoderClass(java.lang.String urlEncoderClass)
Portlet
setURLEncoderClass
in interface Portlet
urlEncoderClass
- the name of the URL encoder class of the portletpublic com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()
Portlet
getURLEncoderInstance
in interface Portlet
public java.lang.String getPortletDataHandlerClass()
Portlet
getPortletDataHandlerClass
in interface Portlet
public void setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)
Portlet
setPortletDataHandlerClass
in interface Portlet
portletDataHandlerClass
- the name of portlet data handler class of
the portletpublic PortletDataHandler getPortletDataHandlerInstance()
Portlet
getPortletDataHandlerInstance
in interface Portlet
public java.lang.String getPortletLayoutListenerClass()
Portlet
getPortletLayoutListenerClass
in interface Portlet
public void setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)
Portlet
setPortletLayoutListenerClass
in interface Portlet
portletLayoutListenerClass
- the name of the portlet layout listener
class of the portletpublic com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance()
Portlet
getPortletLayoutListenerInstance
in interface Portlet
public java.lang.String getPollerProcessorClass()
Portlet
getPollerProcessorClass
in interface Portlet
public void setPollerProcessorClass(java.lang.String pollerProcessorClass)
Portlet
setPollerProcessorClass
in interface Portlet
pollerProcessorClass
- the name of the poller processor class of the
portletpublic com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance()
Portlet
getPollerProcessorInstance
in interface Portlet
public java.lang.String getPopMessageListenerClass()
Portlet
getPopMessageListenerClass
in interface Portlet
public void setPopMessageListenerClass(java.lang.String popMessageListenerClass)
Portlet
setPopMessageListenerClass
in interface Portlet
popMessageListenerClass
- the name of the POP message listener class
of the portletpublic com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance()
Portlet
getPopMessageListenerInstance
in interface Portlet
public java.lang.String getSocialActivityInterpreterClass()
Portlet
getSocialActivityInterpreterClass
in interface Portlet
public void setSocialActivityInterpreterClass(java.lang.String socialActivityInterpreterClass)
Portlet
setSocialActivityInterpreterClass
in interface Portlet
socialActivityInterpreterClass
- the name of the activity
interpreter class of the portletpublic SocialActivityInterpreter getSocialActivityInterpreterInstance()
Portlet
getSocialActivityInterpreterInstance
in interface Portlet
public java.lang.String getSocialRequestInterpreterClass()
Portlet
getSocialRequestInterpreterClass
in interface Portlet
public void setSocialRequestInterpreterClass(java.lang.String socialRequestInterpreterClass)
Portlet
setSocialRequestInterpreterClass
in interface Portlet
socialRequestInterpreterClass
- the name of the request interpreter
class of the portletpublic SocialRequestInterpreter getSocialRequestInterpreterInstance()
Portlet
getSocialRequestInterpreterInstance
in interface Portlet
public java.lang.String getWebDAVStorageToken()
Portlet
getWebDAVStorageToken
in interface Portlet
public void setWebDAVStorageToken(java.lang.String webDAVStorageToken)
Portlet
setWebDAVStorageToken
in interface Portlet
webDAVStorageToken
- the name of the WebDAV storage token of the
portletpublic java.lang.String getWebDAVStorageClass()
Portlet
getWebDAVStorageClass
in interface Portlet
public void setWebDAVStorageClass(java.lang.String webDAVStorageClass)
Portlet
setWebDAVStorageClass
in interface Portlet
webDAVStorageClass
- the name of the WebDAV storage class of the
portletpublic WebDAVStorage getWebDAVStorageInstance()
Portlet
getWebDAVStorageInstance
in interface Portlet
public java.lang.String getControlPanelEntryCategory()
Portlet
getControlPanelEntryCategory
in interface Portlet
public void setControlPanelEntryCategory(java.lang.String controlPanelEntryCategory)
Portlet
setControlPanelEntryCategory
in interface Portlet
controlPanelEntryCategory
- the name of the category of the Control
Panel where the portlet will be shownpublic double getControlPanelEntryWeight()
Portlet
getControlPanelEntryWeight
in interface Portlet
public void setControlPanelEntryWeight(double controlPanelEntryWeight)
Portlet
setControlPanelEntryWeight
in interface Portlet
controlPanelEntryWeight
- the relative weight of the portlet with
respect to the other portlets in the same category of the Control
Panelpublic java.lang.String getControlPanelEntryClass()
Portlet
getControlPanelEntryClass
in interface Portlet
public void setControlPanelEntryClass(java.lang.String controlPanelEntryClass)
Portlet
setControlPanelEntryClass
in interface Portlet
controlPanelEntryClass
- the name of the class that will control
when the portlet will be shown in the Control Panelpublic ControlPanelEntry getControlPanelEntryInstance()
Portlet
getControlPanelEntryInstance
in interface Portlet
public java.lang.String getDefaultPreferences()
Portlet
getDefaultPreferences
in interface Portlet
public void setDefaultPreferences(java.lang.String defaultPreferences)
Portlet
setDefaultPreferences
in interface Portlet
defaultPreferences
- the default preferences of the portletpublic java.lang.String getPreferencesValidator()
Portlet
getPreferencesValidator
in interface Portlet
public void setPreferencesValidator(java.lang.String preferencesValidator)
Portlet
setPreferencesValidator
in interface Portlet
preferencesValidator
- the name of the preferences validator class
of the portletpublic boolean getPreferencesCompanyWide()
Portlet
getPreferencesCompanyWide
in interface Portlet
public boolean isPreferencesCompanyWide()
Portlet
isPreferencesCompanyWide
in interface Portlet
public void setPreferencesCompanyWide(boolean preferencesCompanyWide)
Portlet
setPreferencesCompanyWide
in interface Portlet
preferencesCompanyWide
- boolean value for whether preferences are
shared across the entire companypublic boolean getPreferencesUniquePerLayout()
Portlet
getPreferencesUniquePerLayout
in interface Portlet
public boolean isPreferencesUniquePerLayout()
Portlet
isPreferencesUniquePerLayout
in interface Portlet
public void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
Portlet
setPreferencesUniquePerLayout
in interface Portlet
preferencesUniquePerLayout
- boolean value for whether preferences
are unique per layoutpublic boolean getPreferencesOwnedByGroup()
Portlet
getPreferencesOwnedByGroup
in interface Portlet
public boolean isPreferencesOwnedByGroup()
Portlet
isPreferencesOwnedByGroup
in interface Portlet
public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
Portlet
setPreferencesOwnedByGroup
in interface Portlet
preferencesOwnedByGroup
- boolean value for whether preferences are
owned by the group when the portlet is shown in a group layout or
preferences are owned by the user at all timespublic boolean getUseDefaultTemplate()
Portlet
getUseDefaultTemplate
in interface Portlet
public boolean isUseDefaultTemplate()
Portlet
isUseDefaultTemplate
in interface Portlet
public void setUseDefaultTemplate(boolean useDefaultTemplate)
Portlet
setUseDefaultTemplate
in interface Portlet
useDefaultTemplate
- boolean value for whether the portlet uses the
default templatepublic boolean getShowPortletAccessDenied()
Portlet
getShowPortletAccessDenied
in interface Portlet
public boolean isShowPortletAccessDenied()
Portlet
isShowPortletAccessDenied
in interface Portlet
public void setShowPortletAccessDenied(boolean showPortletAccessDenied)
Portlet
setShowPortletAccessDenied
in interface Portlet
showPortletAccessDenied
- boolean value for whether users are shown
that they do not have access to the portletpublic boolean getShowPortletInactive()
Portlet
getShowPortletInactive
in interface Portlet
public boolean isShowPortletInactive()
Portlet
isShowPortletInactive
in interface Portlet
public void setShowPortletInactive(boolean showPortletInactive)
Portlet
setShowPortletInactive
in interface Portlet
showPortletInactive
- boolean value for whether users are shown that
the portlet is inactivepublic boolean getActionURLRedirect()
Portlet
getActionURLRedirect
in interface Portlet
public boolean isActionURLRedirect()
Portlet
isActionURLRedirect
in interface Portlet
public void setActionURLRedirect(boolean actionURLRedirect)
Portlet
setActionURLRedirect
in interface Portlet
actionURLRedirect
- boolean value for whether an action URL for this
portlet should cause an auto redirectpublic boolean getRestoreCurrentView()
Portlet
getRestoreCurrentView
in interface Portlet
public boolean isRestoreCurrentView()
Portlet
isRestoreCurrentView
in interface Portlet
public void setRestoreCurrentView(boolean restoreCurrentView)
Portlet
setRestoreCurrentView
in interface Portlet
restoreCurrentView
- boolean value for whether the portlet restores
to the current view from the maximized statepublic boolean getMaximizeEdit()
Portlet
getMaximizeEdit
in interface Portlet
public boolean isMaximizeEdit()
Portlet
isMaximizeEdit
in interface Portlet
public void setMaximizeEdit(boolean maximizeEdit)
Portlet
setMaximizeEdit
in interface Portlet
maximizeEdit
- boolean value for whether the portlet goes into the
maximized state when the user goes into the edit modepublic boolean getMaximizeHelp()
Portlet
getMaximizeHelp
in interface Portlet
public boolean isMaximizeHelp()
Portlet
isMaximizeHelp
in interface Portlet
public void setMaximizeHelp(boolean maximizeHelp)
Portlet
setMaximizeHelp
in interface Portlet
maximizeHelp
- boolean value for whether the portlet goes into the
maximized state when the user goes into the help modepublic boolean getPopUpPrint()
Portlet
getPopUpPrint
in interface Portlet
public boolean isPopUpPrint()
Portlet
isPopUpPrint
in interface Portlet
public void setPopUpPrint(boolean popUpPrint)
Portlet
setPopUpPrint
in interface Portlet
popUpPrint
- boolean value for whether the portlet goes into the pop
up state when the user goes into the print modepublic boolean getLayoutCacheable()
Portlet
getLayoutCacheable
in interface Portlet
public boolean isLayoutCacheable()
Portlet
isLayoutCacheable
in interface Portlet
public void setLayoutCacheable(boolean layoutCacheable)
Portlet
setLayoutCacheable
in interface Portlet
layoutCacheable
- boolean value for whether the portlet can be
cached within the layoutpublic boolean getInstanceable()
Portlet
getInstanceable
in interface Portlet
public boolean isInstanceable()
Portlet
isInstanceable
in interface Portlet
public void setInstanceable(boolean instanceable)
Portlet
setInstanceable
in interface Portlet
instanceable
- boolean value for whether the portlet can be added
multiple times to a layoutpublic boolean getScopeable()
Portlet
getScopeable
in interface Portlet
public boolean isScopeable()
Portlet
isScopeable
in interface Portlet
public void setScopeable(boolean scopeable)
Portlet
setScopeable
in interface Portlet
scopeable
- boolean value for whether or not the the portlet
supports scoping of datapublic java.lang.String getUserPrincipalStrategy()
Portlet
getUserPrincipalStrategy
in interface Portlet
public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)
Portlet
setUserPrincipalStrategy
in interface Portlet
userPrincipalStrategy
- the user principal strategy of the portletpublic boolean getPrivateRequestAttributes()
Portlet
getPrivateRequestAttributes
in interface Portlet
public boolean isPrivateRequestAttributes()
Portlet
isPrivateRequestAttributes
in interface Portlet
public void setPrivateRequestAttributes(boolean privateRequestAttributes)
Portlet
setPrivateRequestAttributes
in interface Portlet
privateRequestAttributes
- boolean value for whether the portlet
shares request attributes with the portal or portlets from another
WARpublic boolean getPrivateSessionAttributes()
Portlet
getPrivateSessionAttributes
in interface Portlet
public boolean isPrivateSessionAttributes()
Portlet
isPrivateSessionAttributes
in interface Portlet
public void setPrivateSessionAttributes(boolean privateSessionAttributes)
Portlet
setPrivateSessionAttributes
in interface Portlet
privateSessionAttributes
- boolean value for whether the portlet
shares session attributes with the portalpublic int getRenderWeight()
Portlet
getRenderWeight
in interface Portlet
public void setRenderWeight(int renderWeight)
Portlet
setRenderWeight
in interface Portlet
renderWeight
- int value for the render weight of the portletpublic boolean getAjaxable()
Portlet
getAjaxable
in interface Portlet
public boolean isAjaxable()
Portlet
isAjaxable
in interface Portlet
public void setAjaxable(boolean ajaxable)
Portlet
setAjaxable
in interface Portlet
ajaxable
- boolean value for whether the portlet can be displayed
via Ajaxpublic java.util.List<java.lang.String> getHeaderPortalCss()
Portlet
getHeaderPortalCss
in interface Portlet
public void setHeaderPortalCss(java.util.List<java.lang.String> headerPortalCss)
Portlet
setHeaderPortalCss
in interface Portlet
headerPortalCss
- a list of CSS files that will be referenced from
the page's header relative to the portal's context pathpublic java.util.List<java.lang.String> getHeaderPortletCss()
Portlet
getHeaderPortletCss
in interface Portlet
public void setHeaderPortletCss(java.util.List<java.lang.String> headerPortletCss)
Portlet
setHeaderPortletCss
in interface Portlet
headerPortletCss
- a list of CSS files that will be referenced from
the page's header relative to the portlet's context pathpublic java.util.List<java.lang.String> getHeaderPortalJavaScript()
Portlet
getHeaderPortalJavaScript
in interface Portlet
public void setHeaderPortalJavaScript(java.util.List<java.lang.String> headerPortalJavaScript)
Portlet
setHeaderPortalJavaScript
in interface Portlet
headerPortalJavaScript
- a list of JavaScript files that will be
referenced from the page's header relative to the portal's context
pathpublic java.util.List<java.lang.String> getHeaderPortletJavaScript()
Portlet
getHeaderPortletJavaScript
in interface Portlet
public void setHeaderPortletJavaScript(java.util.List<java.lang.String> headerPortletJavaScript)
Portlet
setHeaderPortletJavaScript
in interface Portlet
headerPortletJavaScript
- a list of JavaScript files that will be
referenced from the page's header relative to the portlet's
context pathpublic java.util.List<java.lang.String> getFooterPortalCss()
Portlet
getFooterPortalCss
in interface Portlet
public void setFooterPortalCss(java.util.List<java.lang.String> footerPortalCss)
Portlet
setFooterPortalCss
in interface Portlet
footerPortalCss
- a list of CSS files that will be referenced from
the page's footer relative to the portal's context pathpublic java.util.List<java.lang.String> getFooterPortletCss()
Portlet
getFooterPortletCss
in interface Portlet
public void setFooterPortletCss(java.util.List<java.lang.String> footerPortletCss)
Portlet
setFooterPortletCss
in interface Portlet
footerPortletCss
- a list of CSS files that will be referenced from
the page's footer relative to the portlet's context pathpublic java.util.List<java.lang.String> getFooterPortalJavaScript()
Portlet
getFooterPortalJavaScript
in interface Portlet
public void setFooterPortalJavaScript(java.util.List<java.lang.String> footerPortalJavaScript)
Portlet
setFooterPortalJavaScript
in interface Portlet
footerPortalJavaScript
- a list of JavaScript files that will be
referenced from the page's footer relative to the portal's context
pathpublic java.util.List<java.lang.String> getFooterPortletJavaScript()
Portlet
getFooterPortletJavaScript
in interface Portlet
public void setFooterPortletJavaScript(java.util.List<java.lang.String> footerPortletJavaScript)
Portlet
setFooterPortletJavaScript
in interface Portlet
footerPortletJavaScript
- a list of JavaScript files that will be
referenced from the page's footer relative to the portlet's
context pathpublic java.lang.String getCssClassWrapper()
Portlet
getCssClassWrapper
in interface Portlet
public void setCssClassWrapper(java.lang.String cssClassWrapper)
Portlet
setCssClassWrapper
in interface Portlet
cssClassWrapper
- the name of the CSS class that will be injected in
the DIV that wraps this portletpublic java.lang.String getFacebookIntegration()
Portlet
getFacebookIntegration
in interface Portlet
public void setFacebookIntegration(java.lang.String facebookIntegration)
Portlet
setFacebookIntegration
in interface Portlet
facebookIntegration
- the Facebook integration method of the portletpublic boolean getAddDefaultResource()
Portlet
getAddDefaultResource
in interface Portlet
public boolean isAddDefaultResource()
Portlet
isAddDefaultResource
in interface Portlet
public void setAddDefaultResource(boolean addDefaultResource)
Portlet
setAddDefaultResource
in interface Portlet
addDefaultResource
- boolean value for whether or not default
resources for the portlet are added to a pagepublic java.lang.String[] getRolesArray()
Portlet
getRolesArray
in interface Portlet
public void setRolesArray(java.lang.String[] rolesArray)
Portlet
setRolesArray
in interface Portlet
rolesArray
- an array of required roles of the portletpublic java.util.Set<java.lang.String> getUnlinkedRoles()
Portlet
getUnlinkedRoles
in interface Portlet
public void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles)
Portlet
setUnlinkedRoles
in interface Portlet
unlinkedRoles
- the unlinked roles of the portletpublic java.util.Map<java.lang.String,java.lang.String> getRoleMappers()
Portlet
getRoleMappers
in interface Portlet
public void setRoleMappers(java.util.Map<java.lang.String,java.lang.String> roleMappers)
Portlet
setRoleMappers
in interface Portlet
roleMappers
- the role mappers of the portletpublic void linkRoles()
Portlet
linkRoles
in interface Portlet
public boolean hasRoleWithName(java.lang.String roleName)
Portlet
hasRoleWithName
in interface Portlet
public boolean hasAddPortletPermission(long userId)
Portlet
hasAddPortletPermission
in interface Portlet
public boolean getSystem()
Portlet
getSystem
in interface Portlet
public boolean isSystem()
Portlet
isSystem
in interface Portlet
public void setSystem(boolean system)
Portlet
setSystem
in interface Portlet
system
- boolean value for whether the portlet is a system portlet
that a user cannot manually add to their pagepublic boolean getInclude()
Portlet
getInclude
in interface Portlet
public boolean isInclude()
Portlet
isInclude
in interface Portlet
public void setInclude(boolean include)
Portlet
setInclude
in interface Portlet
include
- boolean value for whether to include the portlet and make
it available to be made activepublic boolean getReady()
Portlet
true
if the portlet is ready to be used.
getReady
in interface Portlet
true
if the portlet is ready to be usedpublic boolean isReady()
Portlet
true
if the portlet is ready to be used.
isReady
in interface Portlet
true
if the portlet is ready to be usedpublic void setReady(boolean ready)
Portlet
true
if the portlet is ready to be used.
setReady
in interface Portlet
public java.util.Map<java.lang.String,java.lang.String> getInitParams()
Portlet
getInitParams
in interface Portlet
public void setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)
Portlet
setInitParams
in interface Portlet
initParams
- the init parameters of the portletpublic java.lang.Integer getExpCache()
Portlet
getExpCache
in interface Portlet
public void setExpCache(java.lang.Integer expCache)
Portlet
setExpCache
in interface Portlet
expCache
- expiration cache of the portletpublic java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getPortletModes()
Portlet
getPortletModes
in interface Portlet
public void setPortletModes(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes)
Portlet
setPortletModes
in interface Portlet
portletModes
- the portlet modes of the portletpublic boolean hasPortletMode(java.lang.String mimeType, javax.portlet.PortletMode portletMode)
Portlet
hasPortletMode
in interface Portlet
public java.util.Set<java.lang.String> getAllPortletModes()
Portlet
getAllPortletModes
in interface Portlet
public boolean hasMultipleMimeTypes()
Portlet
hasMultipleMimeTypes
in interface Portlet
public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getWindowStates()
Portlet
getWindowStates
in interface Portlet
public void setWindowStates(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates)
Portlet
setWindowStates
in interface Portlet
windowStates
- the window states of the portletpublic boolean hasWindowState(java.lang.String mimeType, javax.portlet.WindowState windowState)
Portlet
hasWindowState
in interface Portlet
public java.util.Set<java.lang.String> getAllWindowStates()
Portlet
getAllWindowStates
in interface Portlet
public java.util.Set<java.lang.String> getSupportedLocales()
Portlet
getSupportedLocales
in interface Portlet
public void setSupportedLocales(java.util.Set<java.lang.String> supportedLocales)
Portlet
setSupportedLocales
in interface Portlet
supportedLocales
- the supported locales of the portletpublic java.lang.String getResourceBundle()
Portlet
getResourceBundle
in interface Portlet
public void setResourceBundle(java.lang.String resourceBundle)
Portlet
setResourceBundle
in interface Portlet
resourceBundle
- the resource bundle of the portletpublic PortletInfo getPortletInfo()
Portlet
getPortletInfo
in interface Portlet
public void setPortletInfo(PortletInfo portletInfo)
Portlet
setPortletInfo
in interface Portlet
portletInfo
- the portlet info of the portletpublic java.util.Map<java.lang.String,PortletFilter> getPortletFilters()
Portlet
getPortletFilters
in interface Portlet
public void setPortletFilters(java.util.Map<java.lang.String,PortletFilter> portletFilters)
Portlet
setPortletFilters
in interface Portlet
portletFilters
- the filters of the portletpublic void addProcessingEvent(com.liferay.portal.kernel.xml.QName processingEvent)
Portlet
addProcessingEvent
in interface Portlet
public com.liferay.portal.kernel.xml.QName getProcessingEvent(java.lang.String uri, java.lang.String localPart)
Portlet
getProcessingEvent
in interface Portlet
public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents()
Portlet
getProcessingEvents
in interface Portlet
public void setProcessingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents)
Portlet
setProcessingEvents
in interface Portlet
processingEvents
- the supported processing events of the portletpublic void addPublishingEvent(com.liferay.portal.kernel.xml.QName publishingEvent)
Portlet
addPublishingEvent
in interface Portlet
public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents()
Portlet
getPublishingEvents
in interface Portlet
public void setPublishingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents)
Portlet
setPublishingEvents
in interface Portlet
publishingEvents
- the supported publishing events of the portletpublic void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Portlet
addPublicRenderParameter
in interface Portlet
publicRenderParameter
- a supported public render parameterpublic PublicRenderParameter getPublicRenderParameter(java.lang.String identifier)
Portlet
getPublicRenderParameter
in interface Portlet
public PublicRenderParameter getPublicRenderParameter(java.lang.String uri, java.lang.String localPart)
Portlet
getPublicRenderParameter
in interface Portlet
public java.util.Set<PublicRenderParameter> getPublicRenderParameters()
Portlet
getPublicRenderParameters
in interface Portlet
public void setPublicRenderParameters(java.util.Set<PublicRenderParameter> publicRenderParameters)
Portlet
setPublicRenderParameters
in interface Portlet
publicRenderParameters
- the supported public render parameters of
the portletpublic java.lang.String getContextPath()
Portlet
getContextPath
in interface Portlet
public PortletApp getPortletApp()
Portlet
getPortletApp
in interface Portlet
public void setPortletApp(PortletApp portletApp)
Portlet
setPortletApp
in interface Portlet
portletApp
- the application this portlet belongs topublic Portlet getClonedInstance(java.lang.String portletId)
Portlet
getClonedInstance
in interface Portlet
portletId
- the cloned instance portlet id
public boolean getStatic()
Portlet
getStatic
in interface Portlet
public boolean isStatic()
Portlet
isStatic
in interface Portlet
public void setStatic(boolean staticPortlet)
Portlet
setStatic
in interface Portlet
staticPortlet
- boolean value for whether the portlet is a static
portlet that cannot be movedpublic boolean getStaticStart()
Portlet
getStaticStart
in interface Portlet
public boolean isStaticStart()
Portlet
isStaticStart
in interface Portlet
public void setStaticStart(boolean staticPortletStart)
Portlet
setStaticStart
in interface Portlet
staticPortletStart
- boolean value for whether the portlet is a
static portlet at the start of a list of portletspublic boolean getStaticEnd()
Portlet
getStaticEnd
in interface Portlet
public boolean isStaticEnd()
Portlet
isStaticEnd
in interface Portlet
public boolean getUndeployedPortlet()
Portlet
getUndeployedPortlet
in interface Portlet
public boolean isUndeployedPortlet()
Portlet
isUndeployedPortlet
in interface Portlet
public void setUndeployedPortlet(boolean undeployedPortlet)
Portlet
setUndeployedPortlet
in interface Portlet
undeployedPortlet
- boolean value for whether the portlet is an
undeployed portletpublic boolean equals(java.lang.Object obj)
Portlet
equals
in interface Portlet
equals
in class java.lang.Object
obj
- the object to compare this portlet against
public Portlet getWrappedPortlet()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |