|
|||||||||
| 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 Form| Constructor Summary | |
|---|---|
PortletWrapper(Portlet portlet)
|
|
| Method Summary | |
|---|---|
void |
addProcessingEvent(QName processingEvent)
Adds a supported processing event. |
void |
addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Adds a supported public render parameter. |
void |
addPublishingEvent(QName publishingEvent)
Adds a supported publishing event. |
void |
addSchedulerEntry(SchedulerEntry schedulerEntry)
Adds a scheduler entry. |
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. |
java.util.List<java.lang.String> |
getAssetRendererFactoryClasses()
Gets the names of the classes that represent asset types associated to the portlet. |
java.util.List<AssetRendererFactory> |
getAssetRendererFactoryInstances()
Gets the asset type instances of 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. |
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. |
java.util.List<java.lang.String> |
getCustomAttributesDisplayClasses()
Gets the names of the classes that represent custom attribute displays associated to the portlet. |
java.util.List<CustomAttributesDisplay> |
getCustomAttributesDisplayInstances()
Gets the custom attribute display instances of the 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. |
FriendlyURLMapper |
getFriendlyURLMapperInstance()
Gets the friendly URL mapper instance of the portlet. |
java.lang.String |
getFriendlyURLRoutes()
Gets the class loader resource path to the friendly URL routes 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. |
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. |
OpenSearch |
getOpenSearchInstance()
Gets the indexer instance of the portlet. |
java.lang.String |
getPluginId()
Gets the plugin id of the portlet. |
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. |
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. |
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. |
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. |
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<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<QName> |
getPublishingEvents()
Gets the supported publishing events of the portlet. |
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.util.List<SchedulerEntry> |
getSchedulerEntries()
Gets the scheduler entries 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. |
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. |
java.util.List<java.lang.String> |
getWorkflowHandlerClasses()
Gets the names of the classes that represent workflow handlers associated to the portlet. |
java.util.List<WorkflowHandler> |
getWorkflowHandlerInstances()
Gets the workflow handler instances of the portlet. |
Portlet |
getWrappedPortlet()
|
java.lang.String |
getXmlRpcMethodClass()
Gets the name of the XML-RPC method class of the portlet. |
Method |
getXmlRpcMethodInstance()
Gets the name of the XML-RPC method instance of the portlet. |
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 |
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 |
setAssetRendererFactoryClasses(java.util.List<java.lang.String> assetRendererFactoryClasses)
Sets the name of the classes that represent asset types associated to the portlet. |
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 |
setCustomAttributesDisplayClasses(java.util.List<java.lang.String> customAttributesDisplayClasses)
Sets the name of the classes that represent custom attribute displays associated to the 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 |
setFriendlyURLRoutes(java.lang.String friendlyURLRoutes)
Sets the class loader resource path to the friendly URL routes 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(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<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<QName> publishingEvents)
Sets the supported publishing events of the portlet. |
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 |
setSchedulerEntries(java.util.List<SchedulerEntry> schedulerEntries)
Sets the scheduler entries 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. |
void |
setWorkflowHandlerClasses(java.util.List<java.lang.String> workflowHandlerClasses)
Sets the name of the classes that represent workflow handlers associated to the portlet. |
void |
setXmlRpcMethodClass(java.lang.String xmlRpcMethodClass)
Sets the name of the XML-RPC method class 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 PortletModelpublic void setPrimaryKey(long pk)
setPrimaryKey in interface PortletModelpublic long getId()
getId in interface PortletModelpublic void setId(long id)
setId in interface PortletModelpublic long getCompanyId()
getCompanyId in interface PortletModelpublic void setCompanyId(long companyId)
setCompanyId in interface PortletModelpublic java.lang.String getPortletId()
getPortletId in interface PortletModelpublic void setPortletId(java.lang.String portletId)
setPortletId in interface PortletModelpublic java.lang.String getRoles()
getRoles in interface PortletModelpublic void setRoles(java.lang.String roles)
Portlet
setRoles in interface PortletsetRoles in interface PortletModelroles - a string of ordered comma delimited portlet idspublic boolean getActive()
getActive in interface PortletModelpublic boolean isActive()
isActive in interface PortletModelpublic void setActive(boolean active)
setActive in interface PortletModelpublic Portlet toEscapedModel()
toEscapedModel in interface PortletModelpublic boolean isNew()
isNew in interface BaseModel<Portlet>isNew in interface PortletModelpublic boolean setNew(boolean n)
setNew in interface BaseModel<Portlet>setNew in interface PortletModelpublic boolean isCachedModel()
isCachedModel in interface BaseModel<Portlet>isCachedModel in interface PortletModelpublic void setCachedModel(boolean cachedModel)
setCachedModel in interface BaseModel<Portlet>setCachedModel in interface PortletModelpublic boolean isEscapedModel()
isEscapedModel in interface BaseModel<Portlet>isEscapedModel in interface PortletModelpublic void setEscapedModel(boolean escapedModel)
setEscapedModel in interface BaseModel<Portlet>setEscapedModel in interface PortletModelpublic java.io.Serializable getPrimaryKeyObj()
getPrimaryKeyObj in interface BaseModel<Portlet>getPrimaryKeyObj in interface PortletModelpublic ExpandoBridge getExpandoBridge()
getExpandoBridge in interface BaseModel<Portlet>getExpandoBridge in interface PortletModelpublic void setExpandoBridgeAttributes(ServiceContext serviceContext)
setExpandoBridgeAttributes in interface BaseModel<Portlet>setExpandoBridgeAttributes in interface PortletModelpublic java.lang.Object clone()
Portlet
clone in interface BaseModel<Portlet>clone in interface Portletclone in interface PortletModelclone in class java.lang.Objectpublic int compareTo(Portlet portlet)
Portlet
compareTo in interface PortletcompareTo in interface PortletModelcompareTo in interface java.lang.Comparable<Portlet>portlet - the portlet to compare this portlet against
public int hashCode()
hashCode in interface PortletModelhashCode in class java.lang.Objectpublic java.lang.String toString()
toString in interface PortletModeltoString in class java.lang.Objectpublic java.lang.String toXmlString()
toXmlString in interface BaseModel<Portlet>toXmlString in interface PortletModelpublic java.lang.String getRootPortletId()
Portlet
getRootPortletId in interface Portletpublic java.lang.String getInstanceId()
Portlet
getInstanceId in interface Portletpublic java.lang.String getPluginId()
Portlet
getPluginId in interface Portletpublic java.lang.String getPluginType()
Portlet
getPluginType in interface Portletpublic PluginPackage getPluginPackage()
Portlet
getPluginPackage in interface Portletpublic void setPluginPackage(PluginPackage pluginPackage)
Portlet
setPluginPackage in interface PortletpluginPackage - the plugin packagepublic PluginSetting getDefaultPluginSetting()
Portlet
getDefaultPluginSetting in interface Portletpublic void setDefaultPluginSetting(PluginSetting pluginSetting)
Portlet
setDefaultPluginSetting in interface PortletpluginSetting - the plugin settingpublic long getTimestamp()
Portlet
getTimestamp in interface Portletpublic void setTimestamp(long timestamp)
Portlet
setTimestamp in interface Portlettimestamp - the timestamp of the portletpublic java.lang.String getIcon()
Portlet
getIcon in interface Portletpublic void setIcon(java.lang.String icon)
Portlet
setIcon in interface Portleticon - the icon of the portletpublic java.lang.String getVirtualPath()
Portlet
getVirtualPath in interface Portletpublic void setVirtualPath(java.lang.String virtualPath)
Portlet
setVirtualPath in interface PortletvirtualPath - the virtual path of the portletpublic java.lang.String getStrutsPath()
Portlet
getStrutsPath in interface Portletpublic void setStrutsPath(java.lang.String strutsPath)
Portlet
setStrutsPath in interface PortletstrutsPath - the struts path of the portletpublic java.lang.String getPortletName()
Portlet
getPortletName in interface Portletpublic void setPortletName(java.lang.String portletName)
Portlet
setPortletName in interface PortletportletName - the name of the portletpublic java.lang.String getDisplayName()
Portlet
getDisplayName in interface Portletpublic void setDisplayName(java.lang.String displayName)
Portlet
setDisplayName in interface PortletdisplayName - the display name of the portletpublic java.lang.String getPortletClass()
Portlet
getPortletClass in interface Portletpublic void setPortletClass(java.lang.String portletClass)
Portlet
setPortletClass in interface PortletportletClass - the name of the portlet class of the portletpublic java.lang.String getConfigurationActionClass()
Portlet
getConfigurationActionClass in interface Portletpublic void setConfigurationActionClass(java.lang.String configurationActionClass)
Portlet
setConfigurationActionClass in interface PortletconfigurationActionClass - the configuration action class of the
portletpublic ConfigurationAction getConfigurationActionInstance()
Portlet
getConfigurationActionInstance in interface Portletpublic java.lang.String getIndexerClass()
Portlet
getIndexerClass in interface Portletpublic void setIndexerClass(java.lang.String indexerClass)
Portlet
setIndexerClass in interface PortletindexerClass - the name of the indexer class of the portletpublic Indexer getIndexerInstance()
Portlet
getIndexerInstance in interface Portletpublic java.lang.String getOpenSearchClass()
Portlet
getOpenSearchClass in interface Portletpublic void setOpenSearchClass(java.lang.String openSearchClass)
Portlet
setOpenSearchClass in interface PortletopenSearchClass - the name of the open search class of the portletpublic OpenSearch getOpenSearchInstance()
Portlet
getOpenSearchInstance in interface Portletpublic void addSchedulerEntry(SchedulerEntry schedulerEntry)
Portlet
addSchedulerEntry in interface Portletpublic java.util.List<SchedulerEntry> getSchedulerEntries()
Portlet
getSchedulerEntries in interface Portletpublic void setSchedulerEntries(java.util.List<SchedulerEntry> schedulerEntries)
Portlet
setSchedulerEntries in interface PortletschedulerEntries - the scheduler entries of the portletpublic java.lang.String getPortletURLClass()
Portlet
getPortletURLClass in interface Portletpublic void setPortletURLClass(java.lang.String portletURLClass)
Portlet
setPortletURLClass in interface PortletportletURLClass - the name of the portlet URL class of the portletpublic java.lang.String getFriendlyURLMapperClass()
Portlet
getFriendlyURLMapperClass in interface Portletpublic void setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)
Portlet
setFriendlyURLMapperClass in interface PortletfriendlyURLMapperClass - the name of the friendly URL plugin class
of the portletpublic FriendlyURLMapper getFriendlyURLMapperInstance()
Portlet
getFriendlyURLMapperInstance in interface Portletpublic java.lang.String getFriendlyURLRoutes()
Portlet
getFriendlyURLRoutes in interface Portletpublic void setFriendlyURLRoutes(java.lang.String friendlyURLRoutes)
Portlet
setFriendlyURLRoutes in interface PortletfriendlyURLRoutes - the class loader resource path to the friendly
URL routes of the portletpublic java.lang.String getURLEncoderClass()
Portlet
getURLEncoderClass in interface Portletpublic void setURLEncoderClass(java.lang.String urlEncoderClass)
Portlet
setURLEncoderClass in interface PortleturlEncoderClass - the name of the URL encoder class of the portletpublic URLEncoder getURLEncoderInstance()
Portlet
getURLEncoderInstance in interface Portletpublic java.lang.String getPortletDataHandlerClass()
Portlet
getPortletDataHandlerClass in interface Portletpublic void setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)
Portlet
setPortletDataHandlerClass in interface PortletportletDataHandlerClass - the name of portlet data handler class of
the portletpublic PortletDataHandler getPortletDataHandlerInstance()
Portlet
getPortletDataHandlerInstance in interface Portletpublic java.lang.String getPortletLayoutListenerClass()
Portlet
getPortletLayoutListenerClass in interface Portletpublic void setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)
Portlet
setPortletLayoutListenerClass in interface PortletportletLayoutListenerClass - the name of the portlet layout listener
class of the portletpublic PortletLayoutListener getPortletLayoutListenerInstance()
Portlet
getPortletLayoutListenerInstance in interface Portletpublic java.lang.String getPollerProcessorClass()
Portlet
getPollerProcessorClass in interface Portletpublic void setPollerProcessorClass(java.lang.String pollerProcessorClass)
Portlet
setPollerProcessorClass in interface PortletpollerProcessorClass - the name of the poller processor class of the
portletpublic PollerProcessor getPollerProcessorInstance()
Portlet
getPollerProcessorInstance in interface Portletpublic java.lang.String getPopMessageListenerClass()
Portlet
getPopMessageListenerClass in interface Portletpublic void setPopMessageListenerClass(java.lang.String popMessageListenerClass)
Portlet
setPopMessageListenerClass in interface PortletpopMessageListenerClass - the name of the POP message listener class
of the portletpublic MessageListener getPopMessageListenerInstance()
Portlet
getPopMessageListenerInstance in interface Portletpublic java.lang.String getSocialActivityInterpreterClass()
Portlet
getSocialActivityInterpreterClass in interface Portletpublic void setSocialActivityInterpreterClass(java.lang.String socialActivityInterpreterClass)
Portlet
setSocialActivityInterpreterClass in interface PortletsocialActivityInterpreterClass - the name of the activity
interpreter class of the portletpublic SocialActivityInterpreter getSocialActivityInterpreterInstance()
Portlet
getSocialActivityInterpreterInstance in interface Portletpublic java.lang.String getSocialRequestInterpreterClass()
Portlet
getSocialRequestInterpreterClass in interface Portletpublic void setSocialRequestInterpreterClass(java.lang.String socialRequestInterpreterClass)
Portlet
setSocialRequestInterpreterClass in interface PortletsocialRequestInterpreterClass - the name of the request interpreter
class of the portletpublic SocialRequestInterpreter getSocialRequestInterpreterInstance()
Portlet
getSocialRequestInterpreterInstance in interface Portletpublic java.lang.String getWebDAVStorageToken()
Portlet
getWebDAVStorageToken in interface Portletpublic void setWebDAVStorageToken(java.lang.String webDAVStorageToken)
Portlet
setWebDAVStorageToken in interface PortletwebDAVStorageToken - the name of the WebDAV storage token of the
portletpublic java.lang.String getWebDAVStorageClass()
Portlet
getWebDAVStorageClass in interface Portletpublic void setWebDAVStorageClass(java.lang.String webDAVStorageClass)
Portlet
setWebDAVStorageClass in interface PortletwebDAVStorageClass - the name of the WebDAV storage class of the
portletpublic WebDAVStorage getWebDAVStorageInstance()
Portlet
getWebDAVStorageInstance in interface Portletpublic java.lang.String getXmlRpcMethodClass()
Portlet
getXmlRpcMethodClass in interface Portletpublic void setXmlRpcMethodClass(java.lang.String xmlRpcMethodClass)
Portlet
setXmlRpcMethodClass in interface PortletxmlRpcMethodClass - the name of the XML-RPC method class of the
portletpublic Method getXmlRpcMethodInstance()
Portlet
getXmlRpcMethodInstance in interface Portletpublic java.lang.String getControlPanelEntryCategory()
Portlet
getControlPanelEntryCategory in interface Portletpublic void setControlPanelEntryCategory(java.lang.String controlPanelEntryCategory)
Portlet
setControlPanelEntryCategory in interface PortletcontrolPanelEntryCategory - the name of the category of the Control
Panel where the portlet will be shownpublic double getControlPanelEntryWeight()
Portlet
getControlPanelEntryWeight in interface Portletpublic void setControlPanelEntryWeight(double controlPanelEntryWeight)
Portlet
setControlPanelEntryWeight in interface PortletcontrolPanelEntryWeight - 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 Portletpublic void setControlPanelEntryClass(java.lang.String controlPanelEntryClass)
Portlet
setControlPanelEntryClass in interface PortletcontrolPanelEntryClass - the name of the class that will control
when the portlet will be shown in the Control Panelpublic ControlPanelEntry getControlPanelEntryInstance()
Portlet
getControlPanelEntryInstance in interface Portletpublic java.util.List<java.lang.String> getAssetRendererFactoryClasses()
Portlet
getAssetRendererFactoryClasses in interface Portletpublic void setAssetRendererFactoryClasses(java.util.List<java.lang.String> assetRendererFactoryClasses)
Portlet
setAssetRendererFactoryClasses in interface PortletassetRendererFactoryClasses - the names of the classes that
represent asset types associated to the portletpublic java.util.List<AssetRendererFactory> getAssetRendererFactoryInstances()
Portlet
getAssetRendererFactoryInstances in interface Portletpublic java.util.List<java.lang.String> getCustomAttributesDisplayClasses()
Portlet
getCustomAttributesDisplayClasses in interface Portletpublic void setCustomAttributesDisplayClasses(java.util.List<java.lang.String> customAttributesDisplayClasses)
Portlet
setCustomAttributesDisplayClasses in interface PortletcustomAttributesDisplayClasses - the names of the classes that
represent custom attribute displays associated to the portletpublic java.util.List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()
Portlet
getCustomAttributesDisplayInstances in interface Portletpublic java.util.List<java.lang.String> getWorkflowHandlerClasses()
Portlet
getWorkflowHandlerClasses in interface Portletpublic void setWorkflowHandlerClasses(java.util.List<java.lang.String> workflowHandlerClasses)
Portlet
setWorkflowHandlerClasses in interface PortletworkflowHandlerClasses - the names of the classes that represent
workflow handlers associated to the portletpublic java.util.List<WorkflowHandler> getWorkflowHandlerInstances()
Portlet
getWorkflowHandlerInstances in interface Portletpublic java.lang.String getDefaultPreferences()
Portlet
getDefaultPreferences in interface Portletpublic void setDefaultPreferences(java.lang.String defaultPreferences)
Portlet
setDefaultPreferences in interface PortletdefaultPreferences - the default preferences of the portletpublic java.lang.String getPreferencesValidator()
Portlet
getPreferencesValidator in interface Portletpublic void setPreferencesValidator(java.lang.String preferencesValidator)
Portlet
setPreferencesValidator in interface PortletpreferencesValidator - the name of the preferences validator class
of the portletpublic boolean getPreferencesCompanyWide()
Portlet
getPreferencesCompanyWide in interface Portletpublic boolean isPreferencesCompanyWide()
Portlet
isPreferencesCompanyWide in interface Portletpublic void setPreferencesCompanyWide(boolean preferencesCompanyWide)
Portlet
setPreferencesCompanyWide in interface PortletpreferencesCompanyWide - boolean value for whether preferences are
shared across the entire companypublic boolean getPreferencesUniquePerLayout()
Portlet
getPreferencesUniquePerLayout in interface Portletpublic boolean isPreferencesUniquePerLayout()
Portlet
isPreferencesUniquePerLayout in interface Portletpublic void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
Portlet
setPreferencesUniquePerLayout in interface PortletpreferencesUniquePerLayout - boolean value for whether preferences
are unique per layoutpublic boolean getPreferencesOwnedByGroup()
Portlet
getPreferencesOwnedByGroup in interface Portletpublic boolean isPreferencesOwnedByGroup()
Portlet
isPreferencesOwnedByGroup in interface Portletpublic void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
Portlet
setPreferencesOwnedByGroup in interface PortletpreferencesOwnedByGroup - 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 Portletpublic boolean isUseDefaultTemplate()
Portlet
isUseDefaultTemplate in interface Portletpublic void setUseDefaultTemplate(boolean useDefaultTemplate)
Portlet
setUseDefaultTemplate in interface PortletuseDefaultTemplate - boolean value for whether the portlet uses the
default templatepublic boolean getShowPortletAccessDenied()
Portlet
getShowPortletAccessDenied in interface Portletpublic boolean isShowPortletAccessDenied()
Portlet
isShowPortletAccessDenied in interface Portletpublic void setShowPortletAccessDenied(boolean showPortletAccessDenied)
Portlet
setShowPortletAccessDenied in interface PortletshowPortletAccessDenied - boolean value for whether users are shown
that they do not have access to the portletpublic boolean getShowPortletInactive()
Portlet
getShowPortletInactive in interface Portletpublic boolean isShowPortletInactive()
Portlet
isShowPortletInactive in interface Portletpublic void setShowPortletInactive(boolean showPortletInactive)
Portlet
setShowPortletInactive in interface PortletshowPortletInactive - boolean value for whether users are shown that
the portlet is inactivepublic boolean getActionURLRedirect()
Portlet
getActionURLRedirect in interface Portletpublic boolean isActionURLRedirect()
Portlet
isActionURLRedirect in interface Portletpublic void setActionURLRedirect(boolean actionURLRedirect)
Portlet
setActionURLRedirect in interface PortletactionURLRedirect - boolean value for whether an action URL for this
portlet should cause an auto redirectpublic boolean getRestoreCurrentView()
Portlet
getRestoreCurrentView in interface Portletpublic boolean isRestoreCurrentView()
Portlet
isRestoreCurrentView in interface Portletpublic void setRestoreCurrentView(boolean restoreCurrentView)
Portlet
setRestoreCurrentView in interface PortletrestoreCurrentView - boolean value for whether the portlet restores
to the current view from the maximized statepublic boolean getMaximizeEdit()
Portlet
getMaximizeEdit in interface Portletpublic boolean isMaximizeEdit()
Portlet
isMaximizeEdit in interface Portletpublic void setMaximizeEdit(boolean maximizeEdit)
Portlet
setMaximizeEdit in interface PortletmaximizeEdit - 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 Portletpublic boolean isMaximizeHelp()
Portlet
isMaximizeHelp in interface Portletpublic void setMaximizeHelp(boolean maximizeHelp)
Portlet
setMaximizeHelp in interface PortletmaximizeHelp - 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 Portletpublic boolean isPopUpPrint()
Portlet
isPopUpPrint in interface Portletpublic void setPopUpPrint(boolean popUpPrint)
Portlet
setPopUpPrint in interface PortletpopUpPrint - 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 Portletpublic boolean isLayoutCacheable()
Portlet
isLayoutCacheable in interface Portletpublic void setLayoutCacheable(boolean layoutCacheable)
Portlet
setLayoutCacheable in interface PortletlayoutCacheable - boolean value for whether the portlet can be
cached within the layoutpublic boolean getInstanceable()
Portlet
getInstanceable in interface Portletpublic boolean isInstanceable()
Portlet
isInstanceable in interface Portletpublic void setInstanceable(boolean instanceable)
Portlet
setInstanceable in interface Portletinstanceable - boolean value for whether the portlet can be added
multiple times to a layoutpublic boolean getScopeable()
Portlet
getScopeable in interface Portletpublic boolean isScopeable()
Portlet
isScopeable in interface Portletpublic void setScopeable(boolean scopeable)
Portlet
setScopeable in interface Portletscopeable - boolean value for whether or not the the portlet
supports scoping of datapublic java.lang.String getUserPrincipalStrategy()
Portlet
getUserPrincipalStrategy in interface Portletpublic void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)
Portlet
setUserPrincipalStrategy in interface PortletuserPrincipalStrategy - the user principal strategy of the portletpublic boolean getPrivateRequestAttributes()
Portlet
getPrivateRequestAttributes in interface Portletpublic boolean isPrivateRequestAttributes()
Portlet
isPrivateRequestAttributes in interface Portletpublic void setPrivateRequestAttributes(boolean privateRequestAttributes)
Portlet
setPrivateRequestAttributes in interface PortletprivateRequestAttributes - boolean value for whether the portlet
shares request attributes with the portal or portlets from another
WARpublic boolean getPrivateSessionAttributes()
Portlet
getPrivateSessionAttributes in interface Portletpublic boolean isPrivateSessionAttributes()
Portlet
isPrivateSessionAttributes in interface Portletpublic void setPrivateSessionAttributes(boolean privateSessionAttributes)
Portlet
setPrivateSessionAttributes in interface PortletprivateSessionAttributes - boolean value for whether the portlet
shares session attributes with the portalpublic int getRenderWeight()
Portlet
getRenderWeight in interface Portletpublic void setRenderWeight(int renderWeight)
Portlet
setRenderWeight in interface PortletrenderWeight - int value for the render weight of the portletpublic boolean getAjaxable()
Portlet
getAjaxable in interface Portletpublic boolean isAjaxable()
Portlet
isAjaxable in interface Portletpublic void setAjaxable(boolean ajaxable)
Portlet
setAjaxable in interface Portletajaxable - boolean value for whether the portlet can be displayed
via Ajaxpublic java.util.List<java.lang.String> getHeaderPortalCss()
Portlet
getHeaderPortalCss in interface Portletpublic void setHeaderPortalCss(java.util.List<java.lang.String> headerPortalCss)
Portlet
setHeaderPortalCss in interface PortletheaderPortalCss - 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 Portletpublic void setHeaderPortletCss(java.util.List<java.lang.String> headerPortletCss)
Portlet
setHeaderPortletCss in interface PortletheaderPortletCss - 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 Portletpublic void setHeaderPortalJavaScript(java.util.List<java.lang.String> headerPortalJavaScript)
Portlet
setHeaderPortalJavaScript in interface PortletheaderPortalJavaScript - 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 Portletpublic void setHeaderPortletJavaScript(java.util.List<java.lang.String> headerPortletJavaScript)
Portlet
setHeaderPortletJavaScript in interface PortletheaderPortletJavaScript - 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 Portletpublic void setFooterPortalCss(java.util.List<java.lang.String> footerPortalCss)
Portlet
setFooterPortalCss in interface PortletfooterPortalCss - 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 Portletpublic void setFooterPortletCss(java.util.List<java.lang.String> footerPortletCss)
Portlet
setFooterPortletCss in interface PortletfooterPortletCss - 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 Portletpublic void setFooterPortalJavaScript(java.util.List<java.lang.String> footerPortalJavaScript)
Portlet
setFooterPortalJavaScript in interface PortletfooterPortalJavaScript - 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 Portletpublic void setFooterPortletJavaScript(java.util.List<java.lang.String> footerPortletJavaScript)
Portlet
setFooterPortletJavaScript in interface PortletfooterPortletJavaScript - 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 Portletpublic void setCssClassWrapper(java.lang.String cssClassWrapper)
Portlet
setCssClassWrapper in interface PortletcssClassWrapper - 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 Portletpublic void setFacebookIntegration(java.lang.String facebookIntegration)
Portlet
setFacebookIntegration in interface PortletfacebookIntegration - the Facebook integration method of the portletpublic boolean getAddDefaultResource()
Portlet
getAddDefaultResource in interface Portletpublic boolean isAddDefaultResource()
Portlet
isAddDefaultResource in interface Portletpublic void setAddDefaultResource(boolean addDefaultResource)
Portlet
setAddDefaultResource in interface PortletaddDefaultResource - boolean value for whether or not default
resources for the portlet are added to a pagepublic java.lang.String[] getRolesArray()
Portlet
getRolesArray in interface Portletpublic void setRolesArray(java.lang.String[] rolesArray)
Portlet
setRolesArray in interface PortletrolesArray - an array of required roles of the portletpublic java.util.Set<java.lang.String> getUnlinkedRoles()
Portlet
getUnlinkedRoles in interface Portletpublic void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles)
Portlet
setUnlinkedRoles in interface PortletunlinkedRoles - the unlinked roles of the portletpublic java.util.Map<java.lang.String,java.lang.String> getRoleMappers()
Portlet
getRoleMappers in interface Portletpublic void setRoleMappers(java.util.Map<java.lang.String,java.lang.String> roleMappers)
Portlet
setRoleMappers in interface PortletroleMappers - the role mappers of the portletpublic void linkRoles()
Portlet
linkRoles in interface Portletpublic boolean hasRoleWithName(java.lang.String roleName)
Portlet
hasRoleWithName in interface Portletpublic boolean hasAddPortletPermission(long userId)
Portlet
hasAddPortletPermission in interface Portletpublic boolean getSystem()
Portlet
getSystem in interface Portletpublic boolean isSystem()
Portlet
isSystem in interface Portletpublic void setSystem(boolean system)
Portlet
setSystem in interface Portletsystem - 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 Portletpublic boolean isInclude()
Portlet
isInclude in interface Portletpublic void setInclude(boolean include)
Portlet
setInclude in interface Portletinclude - boolean value for whether to include the portlet and make
it available to be made activepublic java.util.Map<java.lang.String,java.lang.String> getInitParams()
Portlet
getInitParams in interface Portletpublic void setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)
Portlet
setInitParams in interface PortletinitParams - the init parameters of the portletpublic java.lang.Integer getExpCache()
Portlet
getExpCache in interface Portletpublic void setExpCache(java.lang.Integer expCache)
Portlet
setExpCache in interface PortletexpCache - expiration cache of the portletpublic java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getPortletModes()
Portlet
getPortletModes in interface Portletpublic void setPortletModes(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes)
Portlet
setPortletModes in interface PortletportletModes - the portlet modes of the portlet
public boolean hasPortletMode(java.lang.String mimeType,
javax.portlet.PortletMode portletMode)
Portlet
hasPortletMode in interface Portletpublic java.util.Set<java.lang.String> getAllPortletModes()
Portlet
getAllPortletModes in interface Portletpublic boolean hasMultipleMimeTypes()
Portlet
hasMultipleMimeTypes in interface Portletpublic java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getWindowStates()
Portlet
getWindowStates in interface Portletpublic void setWindowStates(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates)
Portlet
setWindowStates in interface PortletwindowStates - the window states of the portlet
public boolean hasWindowState(java.lang.String mimeType,
javax.portlet.WindowState windowState)
Portlet
hasWindowState in interface Portletpublic java.util.Set<java.lang.String> getAllWindowStates()
Portlet
getAllWindowStates in interface Portletpublic java.util.Set<java.lang.String> getSupportedLocales()
Portlet
getSupportedLocales in interface Portletpublic void setSupportedLocales(java.util.Set<java.lang.String> supportedLocales)
Portlet
setSupportedLocales in interface PortletsupportedLocales - the supported locales of the portletpublic java.lang.String getResourceBundle()
Portlet
getResourceBundle in interface Portletpublic void setResourceBundle(java.lang.String resourceBundle)
Portlet
setResourceBundle in interface PortletresourceBundle - the resource bundle of the portletpublic PortletInfo getPortletInfo()
Portlet
getPortletInfo in interface Portletpublic void setPortletInfo(PortletInfo portletInfo)
Portlet
setPortletInfo in interface PortletportletInfo - the portlet info of the portletpublic java.util.Map<java.lang.String,PortletFilter> getPortletFilters()
Portlet
getPortletFilters in interface Portletpublic void setPortletFilters(java.util.Map<java.lang.String,PortletFilter> portletFilters)
Portlet
setPortletFilters in interface PortletportletFilters - the filters of the portletpublic void addProcessingEvent(QName processingEvent)
Portlet
addProcessingEvent in interface Portlet
public QName getProcessingEvent(java.lang.String uri,
java.lang.String localPart)
Portlet
getProcessingEvent in interface Portletpublic java.util.Set<QName> getProcessingEvents()
Portlet
getProcessingEvents in interface Portletpublic void setProcessingEvents(java.util.Set<QName> processingEvents)
Portlet
setProcessingEvents in interface PortletprocessingEvents - the supported processing events of the portletpublic void addPublishingEvent(QName publishingEvent)
Portlet
addPublishingEvent in interface Portletpublic java.util.Set<QName> getPublishingEvents()
Portlet
getPublishingEvents in interface Portletpublic void setPublishingEvents(java.util.Set<QName> publishingEvents)
Portlet
setPublishingEvents in interface PortletpublishingEvents - the supported publishing events of the portletpublic void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Portlet
addPublicRenderParameter in interface PortletpublicRenderParameter - 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 Portletpublic java.util.Set<PublicRenderParameter> getPublicRenderParameters()
Portlet
getPublicRenderParameters in interface Portletpublic void setPublicRenderParameters(java.util.Set<PublicRenderParameter> publicRenderParameters)
Portlet
setPublicRenderParameters in interface PortletpublicRenderParameters - the supported public render parameters of
the portletpublic java.lang.String getContextPath()
Portlet
getContextPath in interface Portletpublic PortletApp getPortletApp()
Portlet
getPortletApp in interface Portletpublic void setPortletApp(PortletApp portletApp)
Portlet
setPortletApp in interface PortletportletApp - the application this portlet belongs topublic Portlet getClonedInstance(java.lang.String portletId)
Portlet
getClonedInstance in interface PortletportletId - the cloned instance portlet id
public boolean getStatic()
Portlet
getStatic in interface Portletpublic boolean isStatic()
Portlet
isStatic in interface Portletpublic void setStatic(boolean staticPortlet)
Portlet
setStatic in interface PortletstaticPortlet - boolean value for whether the portlet is a static
portlet that cannot be movedpublic boolean getStaticStart()
Portlet
getStaticStart in interface Portletpublic boolean isStaticStart()
Portlet
isStaticStart in interface Portletpublic void setStaticStart(boolean staticPortletStart)
Portlet
setStaticStart in interface PortletstaticPortletStart - boolean value for whether the portlet is a
static portlet at the start of a list of portletspublic boolean getStaticEnd()
Portlet
getStaticEnd in interface Portletpublic boolean isStaticEnd()
Portlet
isStaticEnd in interface Portletpublic boolean getUndeployedPortlet()
Portlet
getUndeployedPortlet in interface Portletpublic boolean isUndeployedPortlet()
Portlet
isUndeployedPortlet in interface Portletpublic void setUndeployedPortlet(boolean undeployedPortlet)
Portlet
setUndeployedPortlet in interface PortletundeployedPortlet - boolean value for whether the portlet is an
undeployed portletpublic boolean equals(java.lang.Object obj)
Portlet
equals in interface Portletequals in class java.lang.Objectobj - 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 | ||||||||