Package com.liferay.portal.model.impl
Class PortletImpl
Object
com.liferay.portal.kernel.model.impl.BaseModelImpl<com.liferay.portal.kernel.model.Portlet>
com.liferay.portal.model.impl.PortletModelImpl
com.liferay.portal.model.impl.PortletBaseImpl
com.liferay.portal.model.impl.PortletImpl
- All Implemented Interfaces:
com.liferay.portal.kernel.model.BaseModel<com.liferay.portal.kernel.model.Portlet>
,com.liferay.portal.kernel.model.ClassedModel
,com.liferay.portal.kernel.model.MVCCModel
,com.liferay.portal.kernel.model.PersistedModel
,com.liferay.portal.kernel.model.Portlet
,com.liferay.portal.kernel.model.PortletModel
,com.liferay.portal.kernel.model.ShardedModel
,Serializable
,Cloneable
,Comparable<com.liferay.portal.kernel.model.Portlet>
- Author:
- Brian Wing Shun Chan
- See Also:
-
Field Summary
Fields inherited from class com.liferay.portal.model.impl.PortletModelImpl
COLUMN_BITMASK_ENABLED, COMPANYID_COLUMN_BITMASK, DATA_SOURCE, ENTITY_CACHE_ENABLED, FINDER_CACHE_ENABLED, ID_COLUMN_BITMASK, LOCK_EXPIRATION_TIME, ORDER_BY_JPQL, ORDER_BY_SQL, PORTLETID_COLUMN_BITMASK, SESSION_FACTORY, TABLE_COLUMNS, TABLE_COLUMNS_MAP, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, TX_MANAGER
Fields inherited from interface com.liferay.portal.kernel.model.Portlet
ID_ACCESSOR, PORTLET_ID_ACCESSOR
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a portlet with no parameters.PortletImpl
(long companyId, String portletId) Constructs a portlet with the specified parameters.PortletImpl
(String portletId, com.liferay.portal.kernel.model.Portlet rootPortlet, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage, com.liferay.portal.kernel.model.PluginSetting defaultPluginSetting, long companyId, String icon, String virtualPath, String strutsPath, String parentStrutsPath, String portletName, String displayName, Set<String> categoryNames, String portletClass, String configurationActionClass, List<String> indexerClasses, String openSearchClass, List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries, String portletURLClass, String friendlyURLMapperClass, String friendlyURLMapping, String friendlyURLRoutes, String urlEncoderClass, String portletDataHandlerClass, List<String> stagedModelDataHandlerClasses, String templateHandlerClass, String portletConfigurationListenerClass, String portletLayoutListenerClass, String popMessageListenerClass, List<String> socialActivityInterpreterClasses, String socialRequestInterpreterClass, String userNotificationDefinitions, List<String> userNotificationHandlerClasses, String webDAVStorageToken, String webDAVStorageClass, String xmlRpcMethodClass, String controlPanelEntryCategory, double controlPanelEntryWeight, String controlPanelEntryClass, List<String> assetRendererFactoryClasses, List<String> customAttributesDisplayClasses, String permissionPropagatorClass, List<String> trashHandlerClasses, List<String> workflowHandlerClasses, String defaultPreferences, String preferencesValidator, boolean preferencesCompanyWide, boolean preferencesUniquePerLayout, boolean preferencesOwnedByGroup, boolean useDefaultTemplate, boolean showPortletAccessDenied, boolean showPortletInactive, boolean actionURLRedirect, boolean restoreCurrentView, boolean maximizeEdit, boolean maximizeHelp, boolean popUpPrint, boolean layoutCacheable, boolean instanceable, boolean scopeable, boolean singlePageApplication, String userPrincipalStrategy, boolean privateRequestAttributes, boolean privateSessionAttributes, Set<String> autopropagatedParameters, boolean requiresNamespacedParameters, int actionTimeout, int renderTimeout, int renderWeight, boolean ajaxable, List<String> headerPortalCss, List<String> headerPortletCss, List<String> headerPortalJavaScript, List<String> headerPortletJavaScript, List<String> headerRequestAttributePrefixes, int headerTimeout, List<String> footerPortalCss, List<String> footerPortletCss, List<String> footerPortalJavaScript, List<String> footerPortletJavaScript, boolean partialActionServeResource, boolean portletDependencyCssEnabled, boolean portletDependencyJavaScriptEnabled, List<com.liferay.portal.kernel.model.portlet.PortletDependency> portletDependencies, String cssClassWrapper, boolean addDefaultResource, String roles, Set<String> unlinkedRoles, Map<String, String> roleMappers, boolean system, boolean active, boolean include, Map<String, String> initParams, Integer expCache, boolean asyncSupported, int multipartFileSizeThreshold, String multipartLocation, long multipartMaxFileSize, long multipartMaxRequestSize, Map<String, Set<String>> portletModes, Map<String, Set<String>> windowStates, Set<String> supportedLocales, String resourceBundle, com.liferay.portal.kernel.model.PortletInfo portletInfo, Map<String, com.liferay.portal.kernel.model.PortletFilter> portletFilters, Set<com.liferay.portal.kernel.xml.QName> processingEvents, Set<com.liferay.portal.kernel.xml.QName> publishingEvents, Set<com.liferay.portal.kernel.model.PublicRenderParameter> publicRenderParameters, com.liferay.portal.kernel.model.PortletApp portletApp) Constructs a portlet with the specified parameters. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addApplicationType
(com.liferay.portal.kernel.application.type.ApplicationType applicationType) Adds an application type.void
addPortletDependency
(com.liferay.portal.kernel.model.portlet.PortletDependency portletDependency) Adds a portlet CSS/JavaScript resource dependency.void
addProcessingEvent
(com.liferay.portal.kernel.xml.QName processingEvent) Adds a processing event.void
addPublicRenderParameter
(com.liferay.portal.kernel.model.PublicRenderParameter publicRenderParameter) Adds a public render parameter.void
addPublishingEvent
(com.liferay.portal.kernel.xml.QName publishingEvent) Adds a publishing event.void
addSchedulerEntry
(com.liferay.portal.kernel.scheduler.SchedulerEntry schedulerEntry) Adds a scheduler entry.clone()
Creates and returns a copy of this object.int
compareTo
(com.liferay.portal.kernel.model.Portlet portlet) Compares this portlet to the specified object.boolean
Checks whether this portlet is equal to the specified object.int
Returns the action timeout of the portlet.boolean
Returnstrue
if an action URL for this portlet should cause an auto redirect.boolean
Returnstrue
if default resources for the portlet are added to a page.boolean
Returnstrue
if the portlet can be displayed via Ajax.Returns the portlet modes of the portlet.Returns the window states of the portlet.Set<com.liferay.portal.kernel.application.type.ApplicationType>
Returns the application types of the portlet.Returns the names of the classes that represent asset types associated with the portlet.Returns the names of the parameters that will be automatically propagated through the portlet.Returns the category names of the portlet.com.liferay.portal.kernel.model.Portlet
getClonedInstance
(String portletId) Returnstrue
if the portlet is found in a WAR file.Returns the configuration action class of the portlet.com.liferay.portal.kernel.portlet.ConfigurationAction
Returns the configuration action instance of the portlet.Returns the servlet context name of the portlet.Returns the servlet context path of the portlet.Returns the name of the category of the Control Panel where the portlet will be shown.Returns the name of the class that will control when the portlet will be shown in the Control Panel.com.liferay.portal.kernel.portlet.ControlPanelEntry
Returns an instance of the class that will control when the portlet will be shown in the Control Panel.double
Returns the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.Returns the name of the CSS class that will be injected in the DIV that wraps this portlet.Returns the names of the classes that represent custom attribute displays associated with the portlet.List<com.liferay.expando.kernel.model.CustomAttributesDisplay>
Returns the custom attribute display instances of the portlet.com.liferay.portal.kernel.model.PluginSetting
Get the default plugin settings of the portlet.Returns the default preferences of the portlet.Returns the display name of the portlet.Returns expiration cache of the portlet.Returns a list of CSS files that will be referenced from the page's footer relative to the portal's context path.Returns a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.Returns a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.Returns a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.Returns the name of the friendly URL mapper class of the portlet.com.liferay.portal.kernel.portlet.FriendlyURLMapper
Returns the friendly URL mapper instance of the portlet.Returns the name of the friendly URL mapping of the portlet.getFriendlyURLMapping
(boolean lookUpFriendlyURLMapper) Returns the class loader resource path to the friendly URL routes of the portlet.Returns a list of CSS files that will be referenced from the page's header relative to the portal's context path.Returns a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.Returns a list of CSS files that will be referenced from the page's header relative to the portlet's context path.Returns a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.Returns a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet.int
Returns the header timeout of the portlet.getIcon()
Returns the icon of the portlet.boolean
Returnstrue
to include the portlet and make it available to be made active.Returns the names of the classes that represent indexers associated with the portlet.List<com.liferay.portal.kernel.search.Indexer<?>>
Returns the indexer instances of the portlet.Returns the init parameters of the portlet.boolean
Returnstrue
if the portlet can be added multiple times to a layout.Returns the instance ID of the portlet.boolean
Returnstrue
to allow the portlet to be cached within the layout.boolean
Returnstrue
if the portlet goes into the maximized state when the user goes into the edit mode.boolean
Returnstrue
if the portlet goes into the maximized state when the user goes into the help mode.int
Returns the maximum size of buffered bytes before storing occurs.Returns the directory for storing uploaded files.long
Returns the maximum number of bytes permitted for an uploaded file.long
Returns the maximum number of bytes permitted for a multipart request.Returns the name of the open search class of the portlet.com.liferay.portal.kernel.search.OpenSearch
Returns the indexer instance of the portlet.Returns the parent struts path of the portlet.Returns the name of the permission propagator class of the portlet.com.liferay.portal.kernel.security.permission.propagator.PermissionPropagator
Returns the permission propagator instance of the portlet.Returns the plugin ID of the portlet.com.liferay.portal.kernel.plugin.PluginPackage
Returns this portlet's plugin package.Returns the plugin type of the portlet.Returns the name of the POP message listener class of the portlet.com.liferay.portal.kernel.pop.MessageListener
Returns the POP message listener instance of the portlet.boolean
Returnstrue
if the portlet goes into the pop up state when the user goes into the print mode.com.liferay.portal.kernel.model.PortletApp
Returns this portlet's application.Returns the name of the portlet class of the portlet.com.liferay.portal.kernel.portlet.PortletConfigurationListener
Returns the name of the portlet data handler class of the portlet.com.liferay.exportimport.kernel.lar.PortletDataHandler
Returns the portlet data handler instance of the portlet.List<com.liferay.portal.kernel.model.portlet.PortletDependency>
Returns the portlet's CSS/JavaScript resource dependencies.Returns the filters of the portlet.com.liferay.portal.kernel.model.PortletInfo
Returns the portlet info of the portlet.Returns the name of the portlet layout listener class of the portlet.com.liferay.portal.kernel.portlet.PortletLayoutListener
Returns the portlet layout listener instance of the portlet.Returns the portlet modes of the portlet.Returns the name of the portlet.Returns the name of the portlet URL class of the portlet.boolean
Returnstrue
if preferences are shared across the entire company.boolean
Returnstrue
if preferences are owned by the group when the portlet is shown in a group layout.boolean
Returnstrue
if preferences are unique per layout.Returns the name of the preferences validator class of the portlet.boolean
Returnstrue
if the portlet does not share request attributes with the portal or portlets from another WAR.boolean
Returnstrue
if the portlet does not share session attributes with the portal.com.liferay.portal.kernel.xml.QName
getProcessingEvent
(String uri, String localPart) Returns the processing event from a namespace URI and a local part.Set<com.liferay.portal.kernel.xml.QName>
Returns the processing events of the portlet.com.liferay.portal.kernel.model.PublicRenderParameter
getPublicRenderParameter
(String identifier) Returns the public render parameter from an identifier.com.liferay.portal.kernel.model.PublicRenderParameter
getPublicRenderParameter
(String uri, String localPart) Returns the spublic render parameter from a namespace URI and a local part.Set<com.liferay.portal.kernel.model.PublicRenderParameter>
Returns the public render parameters of the portlet.Set<com.liferay.portal.kernel.xml.QName>
Returns the publishing events of the portlet.boolean
getReady()
Returnstrue
if the portlet is ready to be used.int
Returns the render timeout of the portlet.int
Returns the render weight of the portlet.Returns the resource bundle of the portlet.boolean
Returnstrue
if the portlet restores to the current view from the maximized state.Returns the role mappers of the portlet.String[]
Returns an array of required roles of the portlet.com.liferay.portal.kernel.model.Portlet
Returns the root portlet of this portlet instance.Returns the root portlet ID of the portlet.List<com.liferay.portal.kernel.scheduler.SchedulerEntry>
Returns the scheduler entries of the portlet.boolean
Returnstrue
if the portlet supports scoping of data.boolean
Returnstrue
if users are shown that they do not have access to the portlet.boolean
Returnstrue
if users are shown that the portlet is inactive.boolean
Returnstrue
if the portlet uses Single Page Application.Returns the names of the classes that represent social activity interpreters associated with the portlet.List<com.liferay.social.kernel.model.SocialActivityInterpreter>
Returns the social activity interpreter instances of the portlet.Returns the name of the social request interpreter class of the portlet.com.liferay.social.kernel.model.SocialRequestInterpreter
Returns the name of the social request interpreter instance of the portlet.Returns the names of the classes that represent staged model data handlers associated with the portlet.List<com.liferay.exportimport.kernel.lar.StagedModelDataHandler<?>>
Returns the staged model data handler instances of the portlet.boolean
Returnstrue
if the portlet is a static portlet that is cannot be moved.boolean
Returnstrue
if the portlet is a static portlet at the end of a list of portlets.Returns the path for static resources served by this portlet.boolean
Returnstrue
if the portlet is a static portlet at the start of a list of portlets.Returns the struts path of the portlet.Returns the supported locales of the portlet.boolean
Returnstrue
if the portlet is a system portlet that a user cannot manually add to their page.Returns the name of the template handler class of the portlet.com.liferay.portal.kernel.template.TemplateHandler
Returns the template handler instance of the portlet.long
Returns the timestamp of the portlet.Returns the names of the classes that represent trash handlers associated with the portlet.List<com.liferay.portal.kernel.trash.TrashHandler>
Returns the trash handler instances of the portlet.boolean
Returnstrue
if the portlet is an undeployed portlet.Returns the unlinked roles of the portlet.Returns the name of the URL encoder class of the portlet.com.liferay.portal.kernel.servlet.URLEncoder
Returns the URL encoder instance of the portlet.boolean
Returnstrue
if the portlet uses the default template.long
Returns the user ID of the portlet.Returns the class loader resource path to the use notification definitions of the portlet.Returns the names of the classes that represent user notification handlers associated with the portlet.List<com.liferay.portal.kernel.notifications.UserNotificationHandler>
Returns the user notification handler instances of the portlet.Returns the user principal strategy of the portlet.Returns the virtual path of the portlet.Returns the name of the WebDAV storage class of the portlet.com.liferay.portal.kernel.webdav.WebDAVStorage
Returns the name of the WebDAV storage instance of the portlet.Returns the name of the WebDAV storage token of the portlet.Returns the window states of the portlet.Returns the names of the classes that represent workflow handlers associated with the portlet.List<com.liferay.portal.kernel.workflow.WorkflowHandler<?>>
Returns the workflow handler instances of the portlet.Returns the name of the XML-RPC method class of the portlet.com.liferay.portal.kernel.xmlrpc.Method
Returns the name of the XML-RPC method instance of the portlet.boolean
hasAddPortletPermission
(long userId) Returnstrue
if the user has the permission to add the portlet to a layout.boolean
boolean
boolean
boolean
int
hashCode()
boolean
boolean
boolean
boolean
boolean
Returnstrue
if the portlet supports more than one mime type.boolean
hasPortletMode
(String mimeType, PortletMode portletMode) Returnstrue
if the portlet supports the specified mime type and portlet mode.boolean
hasRoleWithName
(String roleName) Returnstrue
if the portlet has a role with the specified name.boolean
hasWindowState
(String mimeType, WindowState windowState) Returnstrue
if the portlet supports the specified mime type and window state.boolean
Returnstrue
if an action URL for this portlet should cause an auto redirect.boolean
Returnstrue
if default resources for the portlet are added to a page.boolean
Returnstrue
if the portlet can be displayed via Ajax.boolean
Returnstrue
if the portlet supports asynchronous processing in resource requests.boolean
boolean
Returnstrue
to include the portlet and make it available to be made active.boolean
Returnstrue
if the portlet can be added multiple times to a layout.boolean
Returnstrue
to allow the portlet to be cached within the layout.boolean
Returnstrue
if the portlet goes into the maximized state when the user goes into the edit mode.boolean
Returnstrue
if the portlet goes into the maximized state when the user goes into the help mode.boolean
Returnstrue
if the portlet'sserveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a different portlet on the same portal page.boolean
Returnstrue
if the portlet goes into the pop up state when the user goes into the print mode.boolean
Returnstrue
if the CSS resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.boolean
Returnstrue
if the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.boolean
Returnstrue
if preferences are shared across the entire company.boolean
Returnstrue
if preferences are owned by the group when the portlet is shown in a group layout.boolean
Returnstrue
if preferences are unique per layout.boolean
Returnstrue
if the portlet does not share request attributes with the portal or portlets from another WAR.boolean
Returnstrue
if the portlet does not share session attributes with the portal.boolean
isReady()
Returnstrue
if the portlet is ready to be used.boolean
Returnstrue
if the portlet will only process namespaced parameters.boolean
Returnstrue
if the portlet restores to the current view from the maximized state.boolean
Returnstrue
if the portlet supports scoping of data.boolean
Returnstrue
if users are shown that they do not have access to the portlet.boolean
Returnstrue
if users are shown that the portlet is inactive.boolean
Returnstrue
if the portlet uses Single Page Application.boolean
isStatic()
Returnstrue
if the portlet is a static portlet that is cannot be moved.boolean
Returnstrue
if the portlet is a static portlet at the end of a list of portlets.boolean
Returnstrue
if the portlet is a static portlet at the start of a list of portlets.boolean
isSystem()
Returnstrue
if the portlet is a system portlet that a user cannot manually add to their page.boolean
Returnstrue
if the portlet is an undeployed portlet.boolean
Returnstrue
if the portlet uses the default template.void
Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.void
setActionTimeout
(int actionTimeout) Sets the action timeout of the portlet.void
setActionURLRedirect
(boolean actionURLRedirect) Set totrue
if an action URL for this portlet should cause an auto redirect.void
setAddDefaultResource
(boolean addDefaultResource) Set totrue
if default resources for the portlet are added to a page.void
setAjaxable
(boolean ajaxable) Set totrue
if the portlet can be displayed via Ajax.void
setApplicationTypes
(Set<com.liferay.portal.kernel.application.type.ApplicationType> applicationTypes) Sets the application types of the portlet.void
setAssetRendererFactoryClasses
(List<String> assetRendererFactoryClasses) Sets the names of the classes that represent asset types associated with the portlet.void
setAsyncSupported
(boolean asyncSupported) Set totrue
if the portlet supports asynchronous processing in resource requests.void
setAutopropagatedParameters
(Set<String> autopropagatedParameters) Sets the names of the parameters that will be automatically propagated through the portlet.void
setCategoryNames
(Set<String> categoryNames) Sets the category names of the portlet.void
setConfigurationActionClass
(String configurationActionClass) Sets the configuration action class of the portlet.void
setControlPanelEntryCategory
(String controlPanelEntryCategory) Set the name of the category of the Control Panel where the portlet will be shown.void
setControlPanelEntryClass
(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
(String cssClassWrapper) Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.void
setCustomAttributesDisplayClasses
(List<String> customAttributesDisplayClasses) Sets the names of the classes that represent custom attribute displays associated with the portlet.void
setDefaultPluginSetting
(com.liferay.portal.kernel.model.PluginSetting pluginSetting) Sets the default plugin settings of the portlet.void
setDefaultPreferences
(String defaultPreferences) Sets the default preferences of the portlet.void
setDisplayName
(String displayName) Sets the display name of the portlet.void
setExpCache
(Integer expCache) Sets expiration cache of the portlet.void
setFooterPortalCss
(List<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
(List<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
(List<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
(List<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
(String friendlyURLMapperClass) Sets the name of the friendly URL mapper class of the portlet.void
setFriendlyURLMapping
(String friendlyURLMapping) Sets the name of the friendly URL mapping of the portlet.void
setFriendlyURLRoutes
(String friendlyURLRoutes) Sets the class loader resource path to the friendly URL routes of the portlet.void
setHeaderPortalCss
(List<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
(List<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
(List<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
(List<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
setHeaderRequestAttributePrefixes
(List<String> headerRequestAttributePrefixes) Sets a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet.void
setHeaderTimeout
(int headerTimeout) Sets the header timeout of the portlet.void
Sets the icon of the portlet.void
setInclude
(boolean include) Set totrue
to include the portlet and make it available to be made active.void
setIndexerClasses
(List<String> indexerClasses) Sets the names of the classes that represent indexers associated with the portlet.void
setInitParams
(Map<String, String> initParams) Sets the init parameters of the portlet.void
setInstanceable
(boolean instanceable) Set totrue
if the portlet can be added multiple times to a layout.void
setLayoutCacheable
(boolean layoutCacheable) Set totrue
to allow the portlet to be cached within the layout.void
setMaximizeEdit
(boolean maximizeEdit) Set totrue
if the portlet goes into the maximized state when the user goes into the edit mode.void
setMaximizeHelp
(boolean maximizeHelp) Set totrue
if the portlet goes into the maximized state when the user goes into the help mode.void
setMultipartFileSizeThreshold
(int multipartFileSizeThreshold) Sets the maximum size of buffered bytes before storing occurs.void
setMultipartLocation
(String multipartLocation) Sets the directory for storing uploaded files.void
setMultipartMaxFileSize
(long multipartMaxFileSize) Sets the maximum number of bytes permitted for an uploaded file.void
setMultipartMaxRequestSize
(long multipartMaxRequestSize) Sets the maximum number of bytes permitted for a multipart request.void
setOpenSearchClass
(String openSearchClass) Sets the name of the open search class of the portlet.void
setParentStrutsPath
(String parentStrutsPath) Sets the parent struts path of the portlet.void
setPartialActionServeResource
(boolean partialActionServeResource) Sets whether the portlet's serve resource should be invoked during a partial action triggered by a different portlet on the same portal page.void
setPermissionPropagatorClass
(String permissionPropagatorClass) Sets the name of the permission propagator class of the portlet.void
setPluginPackage
(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) Sets this portlet's plugin package.void
setPopMessageListenerClass
(String popMessageListenerClass) Sets the name of the POP message listener class of the portlet.void
setPopUpPrint
(boolean popUpPrint) Sets whether the portlet goes into the pop up state when the user goes into the print mode.void
setPortletApp
(com.liferay.portal.kernel.model.PortletApp portletApp) Sets this portlet's application.void
setPortletClass
(String portletClass) Sets the name of the portlet class of the portlet.void
setPortletConfigurationListenerClass
(String portletConfigurationListenerClass) void
setPortletDataHandlerClass
(String portletDataHandlerClass) Sets the name of the portlet data handler class of the portlet.void
setPortletDependencyCssEnabled
(boolean portletDependencyCssEnabled) Sets whether the CSS resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.void
setPortletDependencyJavaScriptEnabled
(boolean portletDependencyJavaScriptEnabled) Sets whether the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.void
setPortletFilters
(Map<String, com.liferay.portal.kernel.model.PortletFilter> portletFilters) Sets the filters of the portlet.void
setPortletId
(String portletId) void
setPortletInfo
(com.liferay.portal.kernel.model.PortletInfo portletInfo) Sets the portlet info of the portlet.void
setPortletLayoutListenerClass
(String portletLayoutListenerClass) Sets the name of the portlet layout listener class of the portlet.void
setPortletModes
(Map<String, Set<String>> portletModes) Sets the portlet modes of the portlet.void
setPortletName
(String portletName) Sets the name of the portlet.void
setPortletURLClass
(String portletURLClass) Sets the name of the portlet URL class of the portlet.void
setPreferencesCompanyWide
(boolean preferencesCompanyWide) Set totrue
if preferences are shared across the entire company.void
setPreferencesOwnedByGroup
(boolean preferencesOwnedByGroup) Set totrue
if preferences are owned by the group when the portlet is shown in a group layout.void
setPreferencesUniquePerLayout
(boolean preferencesUniquePerLayout) Set totrue
if preferences are unique per layout.void
setPreferencesValidator
(String preferencesValidator) Sets the name of the preferences validator class of the portlet.void
setPrivateRequestAttributes
(boolean privateRequestAttributes) Set totrue
if the portlet does not share request attributes with the portal or portlets from another WAR.void
setPrivateSessionAttributes
(boolean privateSessionAttributes) Set totrue
if the portlet does not share session attributes with the portal.void
setProcessingEvents
(Set<com.liferay.portal.kernel.xml.QName> processingEvents) Sets the processing events of the portlet.void
setPublicRenderParameters
(Set<com.liferay.portal.kernel.model.PublicRenderParameter> publicRenderParameters) Sets the public render parameters of the portlet.void
setPublishingEvents
(Set<com.liferay.portal.kernel.xml.QName> publishingEvents) Sets the publishing events of the portlet.void
setReady
(boolean ready) Set totrue
if the portlet is ready to be used.void
setRenderTimeout
(int renderTimeout) Sets the render timeout of the portlet.void
setRenderWeight
(int renderWeight) Sets the render weight of the portlet.void
setRequiresNamespacedParameters
(boolean requiresNamespacedParameters) Set totrue
if the portlet will only process namespaced parameters.void
setResourceBundle
(String resourceBundle) Sets the resource bundle of the portlet.void
setRestoreCurrentView
(boolean restoreCurrentView) Set totrue
if the portlet restores to the current view from the maximized state.void
setRoleMappers
(Map<String, String> roleMappers) Sets the role mappers of the portlet.void
Sets a string of ordered comma delimited portlet IDs.void
setRolesArray
(String[] rolesArray) Sets an array of required roles of the portlet.void
setSchedulerEntries
(List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries) Sets the scheduler entries of the portlet.void
setScopeable
(boolean scopeable) Set totrue
if the portlet supports scoping of data.void
setShowPortletAccessDenied
(boolean showPortletAccessDenied) Set totrue
if users are shown that they do not have access to the portlet.void
setShowPortletInactive
(boolean showPortletInactive) Set totrue
if users are shown that the portlet is inactive.void
setSinglePageApplication
(boolean singlePageApplication) Set totrue
if the portlet uses Single Page Application.void
setSocialActivityInterpreterClasses
(List<String> socialActivityInterpreterClasses) Sets the names of the classes that represent social activity interpreters associated with the portlet.void
setSocialRequestInterpreterClass
(String socialRequestInterpreterClass) Sets the name of the social request interpreter class of the portlet.void
setStagedModelDataHandlerClasses
(List<String> stagedModelDataHandlerClasses) Sets the names of the classes that represent staged model data handlers associated with the portlet.void
setStatic
(boolean staticPortlet) Set totrue
if the portlet is a static portlet that is cannot be moved.void
setStaticStart
(boolean staticPortletStart) Set totrue
if the portlet is a static portlet at the start of a list of portlets.void
setStrutsPath
(String strutsPath) Sets the struts path of the portlet.void
setSupportedLocales
(Set<String> supportedLocales) Sets the supported locales of the portlet.void
setSystem
(boolean system) Set totrue
if the portlet is a system portlet that a user cannot manually add to their page.void
setTemplateHandlerClass
(String templateHandlerClass) Sets the name of the template handler class of the portlet.void
setTrashHandlerClasses
(List<String> trashHandlerClasses) Sets the names of the classes that represent trash handlers associated to the portlet.void
setUndeployedPortlet
(boolean undeployedPortlet) Set totrue
if the portlet is an undeployed portlet.void
setUnlinkedRoles
(Set<String> unlinkedRoles) Sets the unlinked roles of the portlet.void
setURLEncoderClass
(String urlEncoderClass) Sets the name of the URL encoder class of the portlet.void
setUseDefaultTemplate
(boolean useDefaultTemplate) Set totrue
if the portlet uses the default template.void
setUserNotificationDefinitions
(String userNotificationDefinitions) Sets the class loader resource path to the user notification definitions of the portlet.void
setUserNotificationHandlerClasses
(List<String> userNotificationHandlerClasses) Sets the names of the classes that represent user notification handlers associated with the portlet.void
setUserPrincipalStrategy
(String userPrincipalStrategy) Sets the user principal strategy of the portlet.void
setVirtualPath
(String virtualPath) Sets the virtual path of the portlet.void
setWebDAVStorageClass
(String webDAVStorageClass) Sets the name of the WebDAV storage class of the portlet.void
setWebDAVStorageToken
(String webDAVStorageToken) Sets the name of the WebDAV storage token of the portlet.void
setWindowStates
(Map<String, Set<String>> windowStates) Sets the window states of the portlet.void
setWorkflowHandlerClasses
(List<String> workflowHandlerClasses) Sets the names of the classes that represent workflow handlers associated to the portlet.void
setXmlRpcMethodClass
(String xmlRpcMethodClass) Sets the name of the XML-RPC method class of the portlet.void
Methods inherited from class com.liferay.portal.model.impl.PortletBaseImpl
persist
Methods inherited from class com.liferay.portal.model.impl.PortletModelImpl
cloneWithOriginalValues, getActive, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getColumnBitmask, getColumnBitmask, getColumnOriginalValue, getColumnValue, getCompanyId, getExpandoBridge, getId, getModelAttributes, getModelClass, getModelClassName, getMvccVersion, getOriginalCompanyId, getOriginalPortletId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, isActive, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setActive, setCompanyId, setExpandoBridgeAttributes, setId, setModelAttributes, setMvccVersion, setPrimaryKey, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString
Methods inherited from class com.liferay.portal.kernel.model.impl.BaseModelImpl
getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, toUnescapedModel
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface com.liferay.portal.kernel.model.PortletModel
cloneWithOriginalValues, getActive, getCompanyId, getId, getMvccVersion, getPortletId, getPrimaryKey, getRoles, isActive, setActive, setCompanyId, setId, setMvccVersion, setPrimaryKey, toXmlString
-
Constructor Details
-
PortletImpl
public PortletImpl()Constructs a portlet with no parameters. -
PortletImpl
Constructs a portlet with the specified parameters. -
PortletImpl
public PortletImpl(String portletId, com.liferay.portal.kernel.model.Portlet rootPortlet, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage, com.liferay.portal.kernel.model.PluginSetting defaultPluginSetting, long companyId, String icon, String virtualPath, String strutsPath, String parentStrutsPath, String portletName, String displayName, Set<String> categoryNames, String portletClass, String configurationActionClass, List<String> indexerClasses, String openSearchClass, List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries, String portletURLClass, String friendlyURLMapperClass, String friendlyURLMapping, String friendlyURLRoutes, String urlEncoderClass, String portletDataHandlerClass, List<String> stagedModelDataHandlerClasses, String templateHandlerClass, String portletConfigurationListenerClass, String portletLayoutListenerClass, String popMessageListenerClass, List<String> socialActivityInterpreterClasses, String socialRequestInterpreterClass, String userNotificationDefinitions, List<String> userNotificationHandlerClasses, String webDAVStorageToken, String webDAVStorageClass, String xmlRpcMethodClass, String controlPanelEntryCategory, double controlPanelEntryWeight, String controlPanelEntryClass, List<String> assetRendererFactoryClasses, List<String> customAttributesDisplayClasses, String permissionPropagatorClass, List<String> trashHandlerClasses, List<String> workflowHandlerClasses, String defaultPreferences, String preferencesValidator, boolean preferencesCompanyWide, boolean preferencesUniquePerLayout, boolean preferencesOwnedByGroup, boolean useDefaultTemplate, boolean showPortletAccessDenied, boolean showPortletInactive, boolean actionURLRedirect, boolean restoreCurrentView, boolean maximizeEdit, boolean maximizeHelp, boolean popUpPrint, boolean layoutCacheable, boolean instanceable, boolean scopeable, boolean singlePageApplication, String userPrincipalStrategy, boolean privateRequestAttributes, boolean privateSessionAttributes, Set<String> autopropagatedParameters, boolean requiresNamespacedParameters, int actionTimeout, int renderTimeout, int renderWeight, boolean ajaxable, List<String> headerPortalCss, List<String> headerPortletCss, List<String> headerPortalJavaScript, List<String> headerPortletJavaScript, List<String> headerRequestAttributePrefixes, int headerTimeout, List<String> footerPortalCss, List<String> footerPortletCss, List<String> footerPortalJavaScript, List<String> footerPortletJavaScript, boolean partialActionServeResource, boolean portletDependencyCssEnabled, boolean portletDependencyJavaScriptEnabled, List<com.liferay.portal.kernel.model.portlet.PortletDependency> portletDependencies, String cssClassWrapper, boolean addDefaultResource, String roles, Set<String> unlinkedRoles, Map<String, String> roleMappers, boolean system, boolean active, boolean include, Map<String, String> initParams, Integer expCache, boolean asyncSupported, int multipartFileSizeThreshold, String multipartLocation, long multipartMaxFileSize, long multipartMaxRequestSize, Map<String, Set<String>> portletModes, Map<String, Set<String>> windowStates, Set<String> supportedLocales, String resourceBundle, com.liferay.portal.kernel.model.PortletInfo portletInfo, Map<String, com.liferay.portal.kernel.model.PortletFilter> portletFilters, Set<com.liferay.portal.kernel.xml.QName> processingEvents, Set<com.liferay.portal.kernel.xml.QName> publishingEvents, Set<com.liferay.portal.kernel.model.PublicRenderParameter> publicRenderParameters, com.liferay.portal.kernel.model.PortletApp portletApp) Constructs a portlet with the specified parameters.
-
-
Method Details
-
addApplicationType
public void addApplicationType(com.liferay.portal.kernel.application.type.ApplicationType applicationType) Adds an application type.- Parameters:
applicationType
- an application type
-
addPortletDependency
public void addPortletDependency(com.liferay.portal.kernel.model.portlet.PortletDependency portletDependency) Adds a portlet CSS/JavaScript resource dependency.- Parameters:
portletDependency
- the portlet CSS/JavaScript resource dependency
-
addProcessingEvent
public void addProcessingEvent(com.liferay.portal.kernel.xml.QName processingEvent) Adds a processing event. -
addPublicRenderParameter
public void addPublicRenderParameter(com.liferay.portal.kernel.model.PublicRenderParameter publicRenderParameter) Adds a public render parameter.- Parameters:
publicRenderParameter
- a public render parameter
-
addPublishingEvent
public void addPublishingEvent(com.liferay.portal.kernel.xml.QName publishingEvent) Adds a publishing event. -
addSchedulerEntry
public void addSchedulerEntry(com.liferay.portal.kernel.scheduler.SchedulerEntry schedulerEntry) Adds a scheduler entry. -
clone
Creates and returns a copy of this object.- Specified by:
clone
in interfacecom.liferay.portal.kernel.model.BaseModel<com.liferay.portal.kernel.model.Portlet>
- Specified by:
clone
in interfacecom.liferay.portal.kernel.model.Portlet
- Overrides:
clone
in classPortletModelImpl
- Returns:
- a copy of this object
-
compareTo
public int compareTo(com.liferay.portal.kernel.model.Portlet portlet) Compares this portlet to the specified object.- Specified by:
compareTo
in interfaceComparable<com.liferay.portal.kernel.model.Portlet>
- Specified by:
compareTo
in interfacecom.liferay.portal.kernel.model.Portlet
- Overrides:
compareTo
in classPortletModelImpl
- Parameters:
portlet
- the portlet to compare this portlet against- Returns:
- the value 0 if the argument portlet is equal to this portlet; a value less than -1 if this portlet is less than the portlet argument; and 1 if this portlet is greater than the portlet argument
-
equals
Checks whether this portlet is equal to the specified object.- Specified by:
equals
in interfacecom.liferay.portal.kernel.model.Portlet
- Overrides:
equals
in classPortletModelImpl
- Parameters:
object
- the object to compare this portlet against- Returns:
true
if the portlet is equal to the specified object
-
getActionTimeout
public int getActionTimeout()Returns the action timeout of the portlet.- Returns:
- the action timeout of the portlet
-
getActionURLRedirect
public boolean getActionURLRedirect()Returnstrue
if an action URL for this portlet should cause an auto redirect.- Returns:
true
if an action URL for this portlet should cause an auto redirect
-
getAddDefaultResource
public boolean getAddDefaultResource()Returnstrue
if default resources for the portlet are added to a page.- Returns:
true
if default resources for the portlet are added to a page
-
getAjaxable
public boolean getAjaxable()Returnstrue
if the portlet can be displayed via Ajax.- Returns:
true
if the portlet can be displayed via Ajax
-
getAllPortletModes
Returns the portlet modes of the portlet.- Returns:
- the portlet modes of the portlet
-
getAllWindowStates
Returns the window states of the portlet.- Returns:
- the window states of the portlet
-
getApplicationTypes
Returns the application types of the portlet.- Returns:
- the application types of the portlet
-
getAssetRendererFactoryClasses
Returns the names of the classes that represent asset types associated with the portlet.- Returns:
- the names of the classes that represent asset types associated with the portlet
-
getAutopropagatedParameters
Returns the names of the parameters that will be automatically propagated through the portlet.- Returns:
- the names of the parameters that will be automatically propagated through the portlet
-
getCategoryNames
Returns the category names of the portlet.- Returns:
- the category names of the portlet
-
getClonedInstance
Returnstrue
if the portlet is found in a WAR file.- Parameters:
portletId
- the cloned instance portlet ID- Returns:
- a cloned instance of the portlet
-
getConfigurationActionClass
Returns the configuration action class of the portlet.- Returns:
- the configuration action class of the portlet
-
getConfigurationActionInstance
public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()Returns the configuration action instance of the portlet.- Returns:
- the configuration action instance of the portlet
-
getContextName
Returns the servlet context name of the portlet.- Returns:
- the servlet context name of the portlet
-
getContextPath
Returns the servlet context path of the portlet.- Returns:
- the servlet context path of the portlet
-
getControlPanelEntryCategory
Returns the name of the category of the Control Panel where the portlet will be shown.- Returns:
- the name of the category of the Control Panel where the portlet will be shown
-
getControlPanelEntryClass
Returns the name of the class that will control when the portlet will be shown in the Control Panel.- Returns:
- the name of the class that will control when the portlet will be shown in the Control Panel
-
getControlPanelEntryInstance
public com.liferay.portal.kernel.portlet.ControlPanelEntry getControlPanelEntryInstance()Returns an instance of the class that will control when the portlet will be shown in the Control Panel.- Returns:
- the instance of the class that will control when the portlet will be shown in the Control Panel
-
getControlPanelEntryWeight
public double getControlPanelEntryWeight()Returns the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.- Returns:
- the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel
-
getCssClassWrapper
Returns the name of the CSS class that will be injected in the DIV that wraps this portlet.- Returns:
- the name of the CSS class that will be injected in the DIV that wraps this portlet
-
getCustomAttributesDisplayClasses
Returns the names of the classes that represent custom attribute displays associated with the portlet.- Returns:
- the names of the classes that represent asset types associated with the portlet
-
getCustomAttributesDisplayInstances
public List<com.liferay.expando.kernel.model.CustomAttributesDisplay> getCustomAttributesDisplayInstances()Returns the custom attribute display instances of the portlet.- Returns:
- the custom attribute display instances of the portlet
-
getDefaultPluginSetting
public com.liferay.portal.kernel.model.PluginSetting getDefaultPluginSetting()Get the default plugin settings of the portlet.- Returns:
- the plugin settings
-
getDefaultPreferences
Returns the default preferences of the portlet.- Returns:
- the default preferences of the portlet
-
getDisplayName
Returns the display name of the portlet.- Returns:
- the display name of the portlet
-
getExpCache
Returns expiration cache of the portlet.- Returns:
- expiration cache of the portlet
-
getFriendlyURLMapperClass
Returns the name of the friendly URL mapper class of the portlet.- Returns:
- the name of the friendly URL mapper class of the portlet
-
getFriendlyURLMapperInstance
public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()Returns the friendly URL mapper instance of the portlet.- Returns:
- the friendly URL mapper instance of the portlet
-
getFriendlyURLMapping
Returns the name of the friendly URL mapping of the portlet.- Returns:
- the name of the friendly URL mapping of the portlet
-
getFriendlyURLMapping
-
getFriendlyURLRoutes
Returns the class loader resource path to the friendly URL routes of the portlet.- Returns:
- the class loader resource path to the friendly URL routes of the portlet
-
getHeaderPortalCss
Returns a list of CSS files that will be referenced from the page's header relative to the portal's context path.- Returns:
- a list of CSS files that will be referenced from the page's header relative to the portal's context path
-
getHeaderPortalJavaScript
Returns a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.- Returns:
- a list of JavaScript files that will be referenced from the page's header relative to the portal's context path
-
getHeaderPortletCss
Returns a list of CSS files that will be referenced from the page's header relative to the portlet's context path.- Returns:
- a list of CSS files that will be referenced from the page's header relative to the portlet's context path
-
getHeaderPortletJavaScript
Returns a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.- Returns:
- a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path
-
getHeaderRequestAttributePrefixes
Returns a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.- Returns:
- a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.
-
getHeaderTimeout
public int getHeaderTimeout()Returns the header timeout of the portlet.- Returns:
- the header timeout of the portlet
-
getIcon
Returns the icon of the portlet.- Returns:
- the icon of the portlet
-
getInclude
public boolean getInclude()Returnstrue
to include the portlet and make it available to be made active.- Returns:
true
to include the portlet and make it available to be made active
-
getIndexerClasses
Returns the names of the classes that represent indexers associated with the portlet.- Returns:
- the names of the classes that represent indexers associated with the portlet
-
getIndexerInstances
Returns the indexer instances of the portlet.- Returns:
- the indexer instances of the portlet
-
getInitParams
Returns the init parameters of the portlet.- Returns:
- init parameters of the portlet
-
getInstanceable
public boolean getInstanceable()Returnstrue
if the portlet can be added multiple times to a layout.- Returns:
true
if the portlet can be added multiple times to a layout
-
getInstanceId
Returns the instance ID of the portlet.- Returns:
- the instance ID of the portlet
-
getLayoutCacheable
public boolean getLayoutCacheable()Returnstrue
to allow the portlet to be cached within the layout.- Returns:
true
if the portlet can be cached within the layout
-
getMaximizeEdit
public boolean getMaximizeEdit()Returnstrue
if the portlet goes into the maximized state when the user goes into the edit mode.- Returns:
true
if the portlet goes into the maximized state when the user goes into the edit mode
-
getMaximizeHelp
public boolean getMaximizeHelp()Returnstrue
if the portlet goes into the maximized state when the user goes into the help mode.- Returns:
true
if the portlet goes into the maximized state when the user goes into the help mode
-
getMultipartFileSizeThreshold
public int getMultipartFileSizeThreshold()Returns the maximum size of buffered bytes before storing occurs.- Returns:
- the maximum size of buffered bytes before storing occurs
-
getMultipartLocation
Returns the directory for storing uploaded files.- Returns:
- the directory for storing uploaded files
-
getMultipartMaxFileSize
public long getMultipartMaxFileSize()Returns the maximum number of bytes permitted for an uploaded file.- Returns:
- the maximum number of bytes permitted for an uploaded file
-
getMultipartMaxRequestSize
public long getMultipartMaxRequestSize()Returns the maximum number of bytes permitted for a multipart request.- Returns:
- the maximum number of bytes permitted for a multipart request
-
getOpenSearchClass
Returns the name of the open search class of the portlet.- Returns:
- the name of the open search class of the portlet
-
getOpenSearchInstance
public com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance()Returns the indexer instance of the portlet.- Returns:
- the indexer instance of the portlet
-
getParentStrutsPath
Returns the parent struts path of the portlet.- Returns:
- the parent struts path of the portlet.
-
getPermissionPropagatorClass
Returns the name of the permission propagator class of the portlet.- Returns:
- the name of the permission propagator class of the portlet
-
getPermissionPropagatorInstance
public com.liferay.portal.kernel.security.permission.propagator.PermissionPropagator getPermissionPropagatorInstance()Returns the permission propagator instance of the portlet.- Returns:
- the permission propagator instance of the portlet
-
getPluginId
Returns the plugin ID of the portlet.- Returns:
- the plugin ID of the portlet
-
getPluginPackage
public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()Returns this portlet's plugin package.- Returns:
- this portlet's plugin package
-
getPluginType
Returns the plugin type of the portlet.- Returns:
- the plugin type of the portlet
-
getPopMessageListenerClass
Returns the name of the POP message listener class of the portlet.- Returns:
- the name of the POP message listener class of the portlet
-
getPopMessageListenerInstance
public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance()Returns the POP message listener instance of the portlet.- Returns:
- the POP message listener instance of the portlet
-
getPopUpPrint
public boolean getPopUpPrint()Returnstrue
if the portlet goes into the pop up state when the user goes into the print mode.- Returns:
true
if the portlet goes into the pop up state when the user goes into the print mode
-
getPortletApp
public com.liferay.portal.kernel.model.PortletApp getPortletApp()Returns this portlet's application.- Returns:
- this portlet's application
-
getPortletClass
Returns the name of the portlet class of the portlet.- Returns:
- the name of the portlet class of the portlet
-
getPortletConfigurationListenerClass
-
getPortletConfigurationListenerInstance
public com.liferay.portal.kernel.portlet.PortletConfigurationListener getPortletConfigurationListenerInstance() -
getPortletDataHandlerClass
Returns the name of the portlet data handler class of the portlet.- Returns:
- the name of the portlet data handler class of the portlet
-
getPortletDataHandlerInstance
public com.liferay.exportimport.kernel.lar.PortletDataHandler getPortletDataHandlerInstance()Returns the portlet data handler instance of the portlet.- Returns:
- the portlet data handler instance of the portlet
-
getPortletDependencies
Returns the portlet's CSS/JavaScript resource dependencies.- Returns:
- the portlet's CSS/JavaScript resource dependencies
-
getPortletFilters
Returns the filters of the portlet.- Returns:
- filters of the portlet
-
getPortletInfo
public com.liferay.portal.kernel.model.PortletInfo getPortletInfo()Returns the portlet info of the portlet.- Returns:
- portlet info of the portlet
-
getPortletLayoutListenerClass
Returns the name of the portlet layout listener class of the portlet.- Returns:
- the name of the portlet layout listener class of the portlet
-
getPortletLayoutListenerInstance
public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance()Returns the portlet layout listener instance of the portlet.- Returns:
- the portlet layout listener instance of the portlet
-
getPortletModes
Returns the portlet modes of the portlet.- Returns:
- portlet modes of the portlet
-
getPortletName
Returns the name of the portlet.- Returns:
- the display name of the portlet
-
getPortletURLClass
Returns the name of the portlet URL class of the portlet.- Returns:
- the name of the portlet URL class of the portlet
-
getPreferencesCompanyWide
public boolean getPreferencesCompanyWide()Returnstrue
if preferences are shared across the entire company.- Returns:
true
if preferences are shared across the entire company
-
getPreferencesOwnedByGroup
public boolean getPreferencesOwnedByGroup()Returnstrue
if preferences are owned by the group when the portlet is shown in a group layout. Returnsfalse
if preferences are owned by the user at all times.- Returns:
true
if preferences are owned by the group when the portlet is shown in a group layout;false
if preferences are owned by the user at all times.
-
getPreferencesUniquePerLayout
public boolean getPreferencesUniquePerLayout()Returnstrue
if preferences are unique per layout.- Returns:
true
if preferences are unique per layout
-
getPreferencesValidator
Returns the name of the preferences validator class of the portlet.- Returns:
- the name of the preferences validator class of the portlet
-
getPrivateRequestAttributes
public boolean getPrivateRequestAttributes()Returnstrue
if the portlet does not share request attributes with the portal or portlets from another WAR.- Returns:
true
if the portlet does not share request attributes with the portal or portlets from another WAR
-
getPrivateSessionAttributes
public boolean getPrivateSessionAttributes()Returnstrue
if the portlet does not share session attributes with the portal.- Returns:
true
if the portlet does not share session attributes with the portal
-
getProcessingEvent
Returns the processing event from a namespace URI and a local part.- Parameters:
uri
- the namespace URIlocalPart
- the local part- Returns:
- the processing event from a namespace URI and a local part
-
getProcessingEvents
Returns the processing events of the portlet.- Returns:
- the processing events of the portlet
-
getPublicRenderParameter
public com.liferay.portal.kernel.model.PublicRenderParameter getPublicRenderParameter(String identifier) Returns the public render parameter from an identifier.- Parameters:
identifier
- the identifier- Returns:
- the public render parameter from an identifier
-
getPublicRenderParameter
public com.liferay.portal.kernel.model.PublicRenderParameter getPublicRenderParameter(String uri, String localPart) Returns the spublic render parameter from a namespace URI and a local part.- Parameters:
uri
- the namespace URIlocalPart
- the local part- Returns:
- the spublic render parameter from a namespace URI and a local part
-
getPublicRenderParameters
Returns the public render parameters of the portlet.- Returns:
- the public render parameters of the portlet
-
getPublishingEvents
Returns the publishing events of the portlet.- Returns:
- the publishing events of the portlet
-
getReady
public boolean getReady()Returnstrue
if the portlet is ready to be used.- Returns:
true
if the portlet is ready to be used
-
getRenderTimeout
public int getRenderTimeout()Returns the render timeout of the portlet.- Returns:
- the render timeout of the portlet
-
getRenderWeight
public int getRenderWeight()Returns the render weight of the portlet.- Returns:
- the render weight of the portlet
-
getResourceBundle
Returns the resource bundle of the portlet.- Returns:
- resource bundle of the portlet
-
getRestoreCurrentView
public boolean getRestoreCurrentView()Returnstrue
if the portlet restores to the current view from the maximized state.- Returns:
true
if the portlet restores to the current view from the maximized state
-
getRoleMappers
Returns the role mappers of the portlet.- Returns:
- role mappers of the portlet
-
getRolesArray
Returns an array of required roles of the portlet.- Returns:
- an array of required roles of the portlet
-
getRootPortlet
public com.liferay.portal.kernel.model.Portlet getRootPortlet()Returns the root portlet of this portlet instance.- Returns:
- the root portlet of this portlet instance
-
getRootPortletId
Returns the root portlet ID of the portlet.- Returns:
- the root portlet ID of the portlet
-
getSchedulerEntries
Returns the scheduler entries of the portlet.- Returns:
- the scheduler entries of the portlet
-
getScopeable
public boolean getScopeable()Returnstrue
if the portlet supports scoping of data.- Returns:
true
if the portlet supports scoping of data
-
getShowPortletAccessDenied
public boolean getShowPortletAccessDenied()Returnstrue
if users are shown that they do not have access to the portlet.- Returns:
true
if users are shown that they do not have access to the portlet
-
getShowPortletInactive
public boolean getShowPortletInactive()Returnstrue
if users are shown that the portlet is inactive.- Returns:
true
if users are shown that the portlet is inactive
-
getSinglePageApplication
public boolean getSinglePageApplication()Returnstrue
if the portlet uses Single Page Application.- Returns:
true
if the portlet uses Single Page Application
-
getSocialActivityInterpreterClasses
Returns the names of the classes that represent social activity interpreters associated with the portlet.- Returns:
- the names of the classes that represent social activity interpreters associated with the portlet
-
getSocialActivityInterpreterInstances
public List<com.liferay.social.kernel.model.SocialActivityInterpreter> getSocialActivityInterpreterInstances()Returns the social activity interpreter instances of the portlet.- Returns:
- the social activity interpreter instances of the portlet
-
getSocialRequestInterpreterClass
Returns the name of the social request interpreter class of the portlet.- Returns:
- the name of the social request interpreter class of the portlet
-
getSocialRequestInterpreterInstance
public com.liferay.social.kernel.model.SocialRequestInterpreter getSocialRequestInterpreterInstance()Returns the name of the social request interpreter instance of the portlet.- Returns:
- the name of the social request interpreter instance of the portlet
-
getStagedModelDataHandlerClasses
Returns the names of the classes that represent staged model data handlers associated with the portlet.- Returns:
- the names of the classes that represent staged model data handlers associated with the portlet
-
getStagedModelDataHandlerInstances
public List<com.liferay.exportimport.kernel.lar.StagedModelDataHandler<?>> getStagedModelDataHandlerInstances()Returns the staged model data handler instances of the portlet.- Returns:
- the staged model data handler instances of the portlet
-
getStatic
public boolean getStatic()Returnstrue
if the portlet is a static portlet that is cannot be moved.- Returns:
true
if the portlet is a static portlet that is cannot be moved
-
getStaticEnd
public boolean getStaticEnd()Returnstrue
if the portlet is a static portlet at the end of a list of portlets.- Returns:
true
if the portlet is a static portlet at the end of a list of portlets
-
getStaticResourcePath
Returns the path for static resources served by this portlet.- Returns:
- the path for static resources served by this portlet
-
getStaticStart
public boolean getStaticStart()Returnstrue
if the portlet is a static portlet at the start of a list of portlets.- Returns:
true
if the portlet is a static portlet at the start of a list of portlets
-
getStrutsPath
Returns the struts path of the portlet.- Returns:
- the struts path of the portlet
-
getSupportedLocales
Returns the supported locales of the portlet.- Returns:
- the supported locales of the portlet
-
getSystem
public boolean getSystem()Returnstrue
if the portlet is a system portlet that a user cannot manually add to their page.- Returns:
true
if the portlet is a system portlet that a user cannot manually add to their page
-
getTemplateHandlerClass
Returns the name of the template handler class of the portlet.- Returns:
- the name of the template handler class of the portlet
-
getTemplateHandlerInstance
public com.liferay.portal.kernel.template.TemplateHandler getTemplateHandlerInstance()Returns the template handler instance of the portlet.- Returns:
- the template handler instance of the portlet
-
getTimestamp
public long getTimestamp()Returns the timestamp of the portlet.- Returns:
- the timestamp of the portlet
-
getTrashHandlerClasses
Returns the names of the classes that represent trash handlers associated with the portlet.- Returns:
- the names of the classes that represent trash handlers associated with the portlet
-
getTrashHandlerInstances
Returns the trash handler instances of the portlet.- Returns:
- the trash handler instances of the portlet
-
getUndeployedPortlet
public boolean getUndeployedPortlet()Returnstrue
if the portlet is an undeployed portlet.- Returns:
true
if the portlet is a placeholder of an undeployed portlet
-
getUnlinkedRoles
Returns the unlinked roles of the portlet.- Returns:
- unlinked roles of the portlet
-
getURLEncoderClass
Returns the name of the URL encoder class of the portlet.- Returns:
- the name of the URL encoder class of the portlet
-
getURLEncoderInstance
public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()Returns the URL encoder instance of the portlet.- Returns:
- the URL encoder instance of the portlet
-
getUseDefaultTemplate
public boolean getUseDefaultTemplate()Returnstrue
if the portlet uses the default template.- Returns:
true
if the portlet uses the default template
-
getUserId
public long getUserId()Returns the user ID of the portlet. This only applies when the portlet is added by a user in a customizable layout.- Returns:
- the user ID of the portlet
-
getUserNotificationDefinitions
Returns the class loader resource path to the use notification definitions of the portlet.- Returns:
- the class loader resource path to the use notification definitions of the portlet
-
getUserNotificationHandlerClasses
Returns the names of the classes that represent user notification handlers associated with the portlet.- Returns:
- the names of the classes that represent user notification handlers associated with the portlet
-
getUserNotificationHandlerInstances
public List<com.liferay.portal.kernel.notifications.UserNotificationHandler> getUserNotificationHandlerInstances()Returns the user notification handler instances of the portlet.- Returns:
- the user notification handler instances of the portlet
-
getUserPrincipalStrategy
Returns the user principal strategy of the portlet.- Returns:
- the user principal strategy of the portlet
-
getVirtualPath
Returns the virtual path of the portlet.- Returns:
- the virtual path of the portlet
-
getWebDAVStorageClass
Returns the name of the WebDAV storage class of the portlet.- Returns:
- the name of the WebDAV storage class of the portlet
-
getWebDAVStorageInstance
public com.liferay.portal.kernel.webdav.WebDAVStorage getWebDAVStorageInstance()Returns the name of the WebDAV storage instance of the portlet.- Returns:
- the name of the WebDAV storage instance of the portlet
-
getWebDAVStorageToken
Returns the name of the WebDAV storage token of the portlet.- Returns:
- the name of the WebDAV storage token of the portlet
-
getWindowStates
Returns the window states of the portlet.- Returns:
- window states of the portlet
-
getWorkflowHandlerClasses
Returns the names of the classes that represent workflow handlers associated with the portlet.- Returns:
- the names of the classes that represent workflow handlers associated with the portlet
-
getWorkflowHandlerInstances
Returns the workflow handler instances of the portlet.- Returns:
- the workflow handler instances of the portlet
-
getXmlRpcMethodClass
Returns the name of the XML-RPC method class of the portlet.- Returns:
- the name of the XML-RPC method class of the portlet
-
getXmlRpcMethodInstance
public com.liferay.portal.kernel.xmlrpc.Method getXmlRpcMethodInstance()Returns the name of the XML-RPC method instance of the portlet.- Returns:
- the name of the XML-RPC method instance of the portlet
-
hasAddPortletPermission
public boolean hasAddPortletPermission(long userId) Returnstrue
if the user has the permission to add the portlet to a layout.- Parameters:
userId
- the primary key of the user- Returns:
true
if the user has the permission to add the portlet to a layout
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.liferay.portal.kernel.model.Portlet
- Overrides:
hashCode
in classPortletModelImpl
-
hasHeaderPortalCss
public boolean hasHeaderPortalCss() -
hasHeaderPortalJavaScript
public boolean hasHeaderPortalJavaScript() -
hasHeaderPortletCss
public boolean hasHeaderPortletCss() -
hasHeaderPortletJavaScript
public boolean hasHeaderPortletJavaScript() -
hasMultipleMimeTypes
public boolean hasMultipleMimeTypes()Returnstrue
if the portlet supports more than one mime type.- Returns:
true
if the portlet supports more than one mime type
-
hasPortletMode
Returnstrue
if the portlet supports the specified mime type and portlet mode.- Parameters:
mimeType
- the mime typeportletMode
- the portlet mode- Returns:
true
if the portlet supports the specified mime type and portlet mode
-
hasRoleWithName
Returnstrue
if the portlet has a role with the specified name.- Parameters:
roleName
- the role name- Returns:
true
if the portlet has a role with the specified name
-
hasWindowState
Returnstrue
if the portlet supports the specified mime type and window state.- Parameters:
mimeType
- the mime typewindowState
- the window state- Returns:
true
if the portlet supports the specified mime type and window state
-
isActionURLRedirect
public boolean isActionURLRedirect()Returnstrue
if an action URL for this portlet should cause an auto redirect.- Returns:
true
if an action URL for this portlet should cause an auto redirect
-
isAddDefaultResource
public boolean isAddDefaultResource()Returnstrue
if default resources for the portlet are added to a page.- Returns:
true
if default resources for the portlet are added to a page
-
isAjaxable
public boolean isAjaxable()Returnstrue
if the portlet can be displayed via Ajax.- Returns:
true
if the portlet can be displayed via Ajax
-
isAsyncSupported
public boolean isAsyncSupported()Returnstrue
if the portlet supports asynchronous processing in resource requests.- Returns:
true
if the portlet supports asynchrounous processing in resource requests
-
isFullPageDisplayable
public boolean isFullPageDisplayable() -
isInclude
public boolean isInclude()Returnstrue
to include the portlet and make it available to be made active.- Returns:
true
to include the portlet and make it available to be made active
-
isInstanceable
public boolean isInstanceable()Returnstrue
if the portlet can be added multiple times to a layout.- Returns:
true
if the portlet can be added multiple times to a layout
-
isLayoutCacheable
public boolean isLayoutCacheable()Returnstrue
to allow the portlet to be cached within the layout.- Returns:
true
if the portlet can be cached within the layout
-
isMaximizeEdit
public boolean isMaximizeEdit()Returnstrue
if the portlet goes into the maximized state when the user goes into the edit mode.- Returns:
true
if the portlet goes into the maximized state when the user goes into the edit mode
-
isMaximizeHelp
public boolean isMaximizeHelp()Returnstrue
if the portlet goes into the maximized state when the user goes into the help mode.- Returns:
true
if the portlet goes into the maximized state when the user goes into the help mode
-
isPartialActionServeResource
public boolean isPartialActionServeResource()Returnstrue
if the portlet'sserveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a different portlet on the same portal page.- Returns:
true
if the portlet'sserveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a different portlet on the same portal page
-
isPopUpPrint
public boolean isPopUpPrint()Returnstrue
if the portlet goes into the pop up state when the user goes into the print mode.- Returns:
true
if the portlet goes into the pop up state when the user goes into the print mode
-
isPortletDependencyCssEnabled
public boolean isPortletDependencyCssEnabled()Returnstrue
if the CSS resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.- Returns:
true
if the specified CSS resource dependencies are to be referenced in the page's header
-
isPortletDependencyJavaScriptEnabled
public boolean isPortletDependencyJavaScriptEnabled()Returnstrue
if the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.- Returns:
true
if the specified JavaScript resource dependencies are to be referenced in the page's header
-
isPreferencesCompanyWide
public boolean isPreferencesCompanyWide()Returnstrue
if preferences are shared across the entire company.- Returns:
true
if preferences are shared across the entire company
-
isPreferencesOwnedByGroup
public boolean isPreferencesOwnedByGroup()Returnstrue
if preferences are owned by the group when the portlet is shown in a group layout. Returnsfalse
if preferences are owned by the user at all times.- Returns:
true
if preferences are owned by the group when the portlet is shown in a group layout;false
if preferences are owned by the user at all times.
-
isPreferencesUniquePerLayout
public boolean isPreferencesUniquePerLayout()Returnstrue
if preferences are unique per layout.- Returns:
true
if preferences are unique per layout
-
isPrivateRequestAttributes
public boolean isPrivateRequestAttributes()Returnstrue
if the portlet does not share request attributes with the portal or portlets from another WAR.- Returns:
true
if the portlet does not share request attributes with the portal or portlets from another WAR
-
isPrivateSessionAttributes
public boolean isPrivateSessionAttributes()Returnstrue
if the portlet does not share session attributes with the portal.- Returns:
true
if the portlet does not share session attributes with the portal
-
isReady
public boolean isReady()Returnstrue
if the portlet is ready to be used.- Returns:
true
if the portlet is ready to be used
-
isRequiresNamespacedParameters
public boolean isRequiresNamespacedParameters()Returnstrue
if the portlet will only process namespaced parameters.- Returns:
true
if the portlet will only process namespaced parameters
-
isRestoreCurrentView
public boolean isRestoreCurrentView()Returnstrue
if the portlet restores to the current view from the maximized state.- Returns:
true
if the portlet restores to the current view from the maximized state
-
isScopeable
public boolean isScopeable()Returnstrue
if the portlet supports scoping of data.- Returns:
true
if the portlet supports scoping of data
-
isShowPortletAccessDenied
public boolean isShowPortletAccessDenied()Returnstrue
if users are shown that they do not have access to the portlet.- Returns:
true
if users are shown that they do not have access to the portlet
-
isShowPortletInactive
public boolean isShowPortletInactive()Returnstrue
if users are shown that the portlet is inactive.- Returns:
true
if users are shown that the portlet is inactive
-
isSinglePageApplication
public boolean isSinglePageApplication()Returnstrue
if the portlet uses Single Page Application.- Returns:
true
if the portlet uses Single Page Application
-
isStatic
public boolean isStatic()Returnstrue
if the portlet is a static portlet that is cannot be moved.- Returns:
true
if the portlet is a static portlet that is cannot be moved
-
isStaticEnd
public boolean isStaticEnd()Returnstrue
if the portlet is a static portlet at the end of a list of portlets.- Returns:
true
if the portlet is a static portlet at the end of a list of portlets
-
isStaticStart
public boolean isStaticStart()Returnstrue
if the portlet is a static portlet at the start of a list of portlets.- Returns:
true
if the portlet is a static portlet at the start of a list of portlets
-
isSystem
public boolean isSystem()Returnstrue
if the portlet is a system portlet that a user cannot manually add to their page.- Returns:
true
if the portlet is a system portlet that a user cannot manually add to their page
-
isUndeployedPortlet
public boolean isUndeployedPortlet()Returnstrue
if the portlet is an undeployed portlet.- Returns:
true
if the portlet is a placeholder of an undeployed portlet
-
isUseDefaultTemplate
public boolean isUseDefaultTemplate()Returnstrue
if the portlet uses the default template.- Returns:
true
if the portlet uses the default template
-
linkRoles
public void linkRoles()Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml. -
setActionTimeout
public void setActionTimeout(int actionTimeout) Sets the action timeout of the portlet.- Parameters:
actionTimeout
- the action timeout of the portlet
-
setActionURLRedirect
public void setActionURLRedirect(boolean actionURLRedirect) Set totrue
if an action URL for this portlet should cause an auto redirect.- Parameters:
actionURLRedirect
- boolean value for whether an action URL for this portlet should cause an auto redirect
-
setAddDefaultResource
public void setAddDefaultResource(boolean addDefaultResource) Set totrue
if default resources for the portlet are added to a page.- Parameters:
addDefaultResource
- boolean value for whether or not default resources for the portlet are added to a page
-
setAjaxable
public void setAjaxable(boolean ajaxable) Set totrue
if the portlet can be displayed via Ajax.- Parameters:
ajaxable
- boolean value for whether the portlet can be displayed via Ajax
-
setApplicationTypes
public void setApplicationTypes(Set<com.liferay.portal.kernel.application.type.ApplicationType> applicationTypes) Sets the application types of the portlet.- Parameters:
applicationTypes
- the application types of the portlet
-
setAssetRendererFactoryClasses
Sets the names of the classes that represent asset types associated with the portlet.- Parameters:
assetRendererFactoryClasses
- the names of the classes that represent asset types associated with the portlet
-
setAsyncSupported
public void setAsyncSupported(boolean asyncSupported) Set totrue
if the portlet supports asynchronous processing in resource requests.- Parameters:
asyncSupported
- boolean value for whether the portlet supports asynchronous processing in resource requests
-
setAutopropagatedParameters
Sets the names of the parameters that will be automatically propagated through the portlet.- Parameters:
autopropagatedParameters
- the names of the parameters that will be automatically propagated through the portlet
-
setCategoryNames
Sets the category names of the portlet.- Parameters:
categoryNames
- the category names of the portlet
-
setConfigurationActionClass
Sets the configuration action class of the portlet.- Parameters:
configurationActionClass
- the configuration action class of the portlet
-
setControlPanelEntryCategory
Set the name of the category of the Control Panel where the portlet will be shown.- Parameters:
controlPanelEntryCategory
- the name of the category of the Control Panel where the portlet will be shown
-
setControlPanelEntryClass
Sets the name of the class that will control when the portlet will be shown in the Control Panel.- Parameters:
controlPanelEntryClass
- the name of the class that will control when the portlet will be shown in the Control Panel
-
setControlPanelEntryWeight
public 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.- Parameters:
controlPanelEntryWeight
- the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel
-
setCssClassWrapper
Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.- Parameters:
cssClassWrapper
- the name of the CSS class that will be injected in the DIV that wraps this portlet
-
setCustomAttributesDisplayClasses
Sets the names of the classes that represent custom attribute displays associated with the portlet.- Parameters:
customAttributesDisplayClasses
- the names of the classes that represent custom attribute displays associated with the portlet
-
setDefaultPluginSetting
public void setDefaultPluginSetting(com.liferay.portal.kernel.model.PluginSetting pluginSetting) Sets the default plugin settings of the portlet.- Parameters:
pluginSetting
- the plugin setting
-
setDefaultPreferences
Sets the default preferences of the portlet.- Parameters:
defaultPreferences
- the default preferences of the portlet
-
setDisplayName
Sets the display name of the portlet.- Parameters:
displayName
- the display name of the portlet
-
setExpCache
Sets expiration cache of the portlet.- Parameters:
expCache
- expiration cache of the portlet
-
setFriendlyURLMapperClass
Sets the name of the friendly URL mapper class of the portlet.- Parameters:
friendlyURLMapperClass
- the name of the friendly URL mapper class of the portlet
-
setFriendlyURLMapping
Sets the name of the friendly URL mapping of the portlet.- Parameters:
friendlyURLMapping
- the name of the friendly URL mapping of the portlet
-
setFriendlyURLRoutes
Sets the class loader resource path to the friendly URL routes of the portlet.- Parameters:
friendlyURLRoutes
- the class loader resource path to the friendly URL routes of the portlet
-
setHeaderPortalCss
Sets a list of CSS files that will be referenced from the page's header relative to the portal's context path.- Parameters:
headerPortalCss
- a list of CSS files that will be referenced from the page's header relative to the portal's context path
-
setHeaderPortalJavaScript
Sets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.- Parameters:
headerPortalJavaScript
- a list of JavaScript files that will be referenced from the page's header relative to the portal's context path
-
setHeaderPortletCss
Sets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.- Parameters:
headerPortletCss
- a list of CSS files that will be referenced from the page's header relative to the portlet's context path
-
setHeaderPortletJavaScript
Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.- Parameters:
headerPortletJavaScript
- a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path
-
setHeaderRequestAttributePrefixes
Sets a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.- Parameters:
headerRequestAttributePrefixes
- a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.
-
setHeaderTimeout
public void setHeaderTimeout(int headerTimeout) Sets the header timeout of the portlet.- Parameters:
headerTimeout
- the header timeout of the portlet
-
setIcon
Sets the icon of the portlet.- Parameters:
icon
- the icon of the portlet
-
setInclude
public void setInclude(boolean include) Set totrue
to include the portlet and make it available to be made active.- Parameters:
include
- boolean value for whether to include the portlet and make it available to be made active
-
setIndexerClasses
Sets the names of the classes that represent indexers associated with the portlet.- Parameters:
indexerClasses
- the names of the classes that represent indexers associated with the portlet
-
setInitParams
Sets the init parameters of the portlet.- Parameters:
initParams
- the init parameters of the portlet
-
setInstanceable
public void setInstanceable(boolean instanceable) Set totrue
if the portlet can be added multiple times to a layout.- Parameters:
instanceable
- boolean value for whether the portlet can be added multiple times to a layout
-
setLayoutCacheable
public void setLayoutCacheable(boolean layoutCacheable) Set totrue
to allow the portlet to be cached within the layout.- Parameters:
layoutCacheable
- boolean value for whether the portlet can be cached within the layout
-
setMaximizeEdit
public void setMaximizeEdit(boolean maximizeEdit) Set totrue
if the portlet goes into the maximized state when the user goes into the edit mode.- Parameters:
maximizeEdit
- boolean value for whether the portlet goes into the maximized state when the user goes into the edit mode
-
setMaximizeHelp
public void setMaximizeHelp(boolean maximizeHelp) Set totrue
if the portlet goes into the maximized state when the user goes into the help mode.- Parameters:
maximizeHelp
- boolean value for whether the portlet goes into the maximized state when the user goes into the help mode
-
setMultipartFileSizeThreshold
public void setMultipartFileSizeThreshold(int multipartFileSizeThreshold) Sets the maximum size of buffered bytes before storing occurs.- Parameters:
multipartFileSizeThreshold
- the maximum size of buffered bytes before storing occurs
-
setMultipartLocation
Sets the directory for storing uploaded files.- Parameters:
multipartLocation
- the directory for storing uploaded files
-
setMultipartMaxFileSize
public void setMultipartMaxFileSize(long multipartMaxFileSize) Sets the maximum number of bytes permitted for an uploaded file.- Parameters:
multipartMaxFileSize
- the maximum number of bytes permitted for an uploaded file
-
setMultipartMaxRequestSize
public void setMultipartMaxRequestSize(long multipartMaxRequestSize) Sets the maximum number of bytes permitted for a multipart request.- Parameters:
multipartMaxRequestSize
- the maximum number of bytes permitted for a multipart request
-
setOpenSearchClass
Sets the name of the open search class of the portlet.- Parameters:
openSearchClass
- the name of the open search class of the portlet
-
setParentStrutsPath
Sets the parent struts path of the portlet.- Parameters:
parentStrutsPath
- the parent struts path of the portlet
-
setPartialActionServeResource
public void setPartialActionServeResource(boolean partialActionServeResource) Sets whether the portlet's serve resource should be invoked during a partial action triggered by a different portlet on the same portal page.- Parameters:
partialActionServeResource
- whether the portlet'sserveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a different portlet on the same portal page
-
setPermissionPropagatorClass
Sets the name of the permission propagator class of the portlet. -
setPluginPackage
public void setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) Sets this portlet's plugin package.- Parameters:
pluginPackage
- this portlet's plugin package
-
setPopMessageListenerClass
Sets the name of the POP message listener class of the portlet.- Parameters:
popMessageListenerClass
- the name of the POP message listener class of the portlet
-
setPopUpPrint
public void setPopUpPrint(boolean popUpPrint) Sets whether the portlet goes into the pop up state when the user goes into the print mode.- Parameters:
popUpPrint
- whether the portlet goes into the pop up state when the user goes into the print mode
-
setPortletApp
public void setPortletApp(com.liferay.portal.kernel.model.PortletApp portletApp) Sets this portlet's application.- Parameters:
portletApp
- this portlet's application
-
setPortletClass
Sets the name of the portlet class of the portlet.- Parameters:
portletClass
- the name of the portlet class of the portlet
-
setPortletConfigurationListenerClass
-
setPortletDataHandlerClass
Sets the name of the portlet data handler class of the portlet.- Parameters:
portletDataHandlerClass
- the name of portlet data handler class of the portlet
-
setPortletDependencyCssEnabled
public void setPortletDependencyCssEnabled(boolean portletDependencyCssEnabled) Sets whether the CSS resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.- Parameters:
portletDependencyCssEnabled
- whether the CSS resource dependencies that are specified inportlet.xml
,
-
setPortletDependencyJavaScriptEnabled
public void setPortletDependencyJavaScriptEnabled(boolean portletDependencyJavaScriptEnabled) Sets whether the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.- Parameters:
portletDependencyJavaScriptEnabled
- whether the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header
-
setPortletFilters
public void setPortletFilters(Map<String, com.liferay.portal.kernel.model.PortletFilter> portletFilters) Sets the filters of the portlet.- Parameters:
portletFilters
- the filters of the portlet
-
setPortletId
- Specified by:
setPortletId
in interfacecom.liferay.portal.kernel.model.PortletModel
- Overrides:
setPortletId
in classPortletModelImpl
-
setPortletInfo
public void setPortletInfo(com.liferay.portal.kernel.model.PortletInfo portletInfo) Sets the portlet info of the portlet.- Parameters:
portletInfo
- the portlet info of the portlet
-
setPortletLayoutListenerClass
Sets the name of the portlet layout listener class of the portlet.- Parameters:
portletLayoutListenerClass
- the name of the portlet layout listener class of the portlet
-
setPortletModes
Sets the portlet modes of the portlet.- Parameters:
portletModes
- the portlet modes of the portlet
-
setPortletName
Sets the name of the portlet.- Parameters:
portletName
- the name of the portlet
-
setPortletURLClass
Sets the name of the portlet URL class of the portlet.- Parameters:
portletURLClass
- the name of the portlet URL class of the portlet
-
setPreferencesCompanyWide
public void setPreferencesCompanyWide(boolean preferencesCompanyWide) Set totrue
if preferences are shared across the entire company.- Parameters:
preferencesCompanyWide
- boolean value for whether preferences are shared across the entire company
-
setPreferencesOwnedByGroup
public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup) Set totrue
if preferences are owned by the group when the portlet is shown in a group layout. Set tofalse
if preferences are owned by the user at all times.- Parameters:
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 times
-
setPreferencesUniquePerLayout
public void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout) Set totrue
if preferences are unique per layout.- Parameters:
preferencesUniquePerLayout
- boolean value for whether preferences are unique per layout
-
setPreferencesValidator
Sets the name of the preferences validator class of the portlet.- Parameters:
preferencesValidator
- the name of the preferences validator class of the portlet
-
setPrivateRequestAttributes
public void setPrivateRequestAttributes(boolean privateRequestAttributes) Set totrue
if the portlet does not share request attributes with the portal or portlets from another WAR.- Parameters:
privateRequestAttributes
- boolean value for whether the portlet shares request attributes with the portal or portlets from another WAR
-
setPrivateSessionAttributes
public void setPrivateSessionAttributes(boolean privateSessionAttributes) Set totrue
if the portlet does not share session attributes with the portal.- Parameters:
privateSessionAttributes
- boolean value for whether the portlet shares session attributes with the portal
-
setProcessingEvents
Sets the processing events of the portlet.- Parameters:
processingEvents
- the processing events of the portlet
-
setPublicRenderParameters
public void setPublicRenderParameters(Set<com.liferay.portal.kernel.model.PublicRenderParameter> publicRenderParameters) Sets the public render parameters of the portlet.- Parameters:
publicRenderParameters
- the public render parameters of the portlet
-
setPublishingEvents
Sets the publishing events of the portlet.- Parameters:
publishingEvents
- the publishing events of the portlet
-
setReady
public void setReady(boolean ready) Set totrue
if the portlet is ready to be used.- Parameters:
ready
- whether the portlet is ready to be used
-
setRenderTimeout
public void setRenderTimeout(int renderTimeout) Sets the render timeout of the portlet.- Parameters:
renderTimeout
- the render timeout of the portlet
-
setRenderWeight
public void setRenderWeight(int renderWeight) Sets the render weight of the portlet.- Parameters:
renderWeight
- int value for the render weight of the portlet
-
setRequiresNamespacedParameters
public void setRequiresNamespacedParameters(boolean requiresNamespacedParameters) Set totrue
if the portlet will only process namespaced parameters.- Parameters:
requiresNamespacedParameters
- boolean value for whether the portlet will only process namespaced parameters
-
setResourceBundle
Sets the resource bundle of the portlet.- Parameters:
resourceBundle
- the resource bundle of the portlet
-
setRestoreCurrentView
public void setRestoreCurrentView(boolean restoreCurrentView) Set totrue
if the portlet restores to the current view from the maximized state.- Parameters:
restoreCurrentView
- boolean value for whether the portlet restores to the current view from the maximized state
-
setRoleMappers
Sets the role mappers of the portlet.- Parameters:
roleMappers
- the role mappers of the portlet
-
setRoles
Sets a string of ordered comma delimited portlet IDs.- Specified by:
setRoles
in interfacecom.liferay.portal.kernel.model.PortletModel
- Overrides:
setRoles
in classPortletModelImpl
- Parameters:
roles
- a string of ordered comma delimited portlet IDs
-
setRolesArray
Sets an array of required roles of the portlet.- Parameters:
rolesArray
- an array of required roles of the portlet
-
setSchedulerEntries
public void setSchedulerEntries(List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries) Sets the scheduler entries of the portlet.- Parameters:
schedulerEntries
- the scheduler entries of the portlet
-
setScopeable
public void setScopeable(boolean scopeable) Set totrue
if the portlet supports scoping of data.- Parameters:
scopeable
- boolean value for whether or not the the portlet supports scoping of data
-
setShowPortletAccessDenied
public void setShowPortletAccessDenied(boolean showPortletAccessDenied) Set totrue
if users are shown that they do not have access to the portlet.- Parameters:
showPortletAccessDenied
- boolean value for whether users are shown that they do not have access to the portlet
-
setShowPortletInactive
public void setShowPortletInactive(boolean showPortletInactive) Set totrue
if users are shown that the portlet is inactive.- Parameters:
showPortletInactive
- boolean value for whether users are shown that the portlet is inactive
-
setSinglePageApplication
public void setSinglePageApplication(boolean singlePageApplication) Set totrue
if the portlet uses Single Page Application.- Parameters:
singlePageApplication
- boolean value for whether or not the the portlet uses Single Page Application
-
setSocialActivityInterpreterClasses
Sets the names of the classes that represent social activity interpreters associated with the portlet.- Parameters:
socialActivityInterpreterClasses
- the names of the classes that represent social activity interpreters associated with the portlet
-
setSocialRequestInterpreterClass
Sets the name of the social request interpreter class of the portlet.- Parameters:
socialRequestInterpreterClass
- the name of the request interpreter class of the portlet
-
setStagedModelDataHandlerClasses
Sets the names of the classes that represent staged model data handlers associated with the portlet.- Parameters:
stagedModelDataHandlerClasses
- the names of the classes that represent staged model data handlers associated with the portlet
-
setStatic
public void setStatic(boolean staticPortlet) Set totrue
if the portlet is a static portlet that is cannot be moved.- Parameters:
staticPortlet
- boolean value for whether the portlet is a static portlet that cannot be moved
-
setStaticStart
public void setStaticStart(boolean staticPortletStart) Set totrue
if the portlet is a static portlet at the start of a list of portlets.- Parameters:
staticPortletStart
- boolean value for whether the portlet is a static portlet at the start of a list of portlets
-
setStrutsPath
Sets the struts path of the portlet.- Parameters:
strutsPath
- the struts path of the portlet
-
setSupportedLocales
Sets the supported locales of the portlet.- Parameters:
supportedLocales
- the supported locales of the portlet
-
setSystem
public void setSystem(boolean system) Set totrue
if the portlet is a system portlet that a user cannot manually add to their page.- Parameters:
system
- boolean value for whether the portlet is a system portlet that a user cannot manually add to their page
-
setTemplateHandlerClass
Sets the name of the template handler class of the portlet.- Parameters:
templateHandlerClass
- the name of template handler class of the portlet
-
setTrashHandlerClasses
Sets the names of the classes that represent trash handlers associated to the portlet.- Parameters:
trashHandlerClasses
- the names of the classes that represent trash handlers associated with the portlet
-
setUndeployedPortlet
public void setUndeployedPortlet(boolean undeployedPortlet) Set totrue
if the portlet is an undeployed portlet.- Parameters:
undeployedPortlet
- boolean value for whether the portlet is an undeployed portlet
-
setUnlinkedRoles
Sets the unlinked roles of the portlet.- Parameters:
unlinkedRoles
- the unlinked roles of the portlet
-
setURLEncoderClass
Sets the name of the URL encoder class of the portlet.- Parameters:
urlEncoderClass
- the name of the URL encoder class of the portlet
-
setUseDefaultTemplate
public void setUseDefaultTemplate(boolean useDefaultTemplate) Set totrue
if the portlet uses the default template.- Parameters:
useDefaultTemplate
- boolean value for whether the portlet uses the default template
-
setUserNotificationDefinitions
Sets the class loader resource path to the user notification definitions of the portlet.- Parameters:
userNotificationDefinitions
- the class loader resource path to the user notification definitions of the portlet
-
setUserNotificationHandlerClasses
Sets the names of the classes that represent user notification handlers associated with the portlet.- Parameters:
userNotificationHandlerClasses
- the names of the classes that represent user notification handlers associated with the portlet
-
setUserPrincipalStrategy
Sets the user principal strategy of the portlet.- Parameters:
userPrincipalStrategy
- the user principal strategy of the portlet
-
setVirtualPath
Sets the virtual path of the portlet.- Parameters:
virtualPath
- the virtual path of the portlet
-
setWebDAVStorageClass
Sets the name of the WebDAV storage class of the portlet.- Parameters:
webDAVStorageClass
- the name of the WebDAV storage class of the portlet
-
setWebDAVStorageToken
Sets the name of the WebDAV storage token of the portlet.- Parameters:
webDAVStorageToken
- the name of the WebDAV storage token of the portlet
-
setWindowStates
Sets the window states of the portlet.- Parameters:
windowStates
- the window states of the portlet
-
setWorkflowHandlerClasses
Sets the names of the classes that represent workflow handlers associated to the portlet.- Parameters:
workflowHandlerClasses
- the names of the classes that represent workflow handlers associated with the portlet
-
setXmlRpcMethodClass
Sets the name of the XML-RPC method class of the portlet.- Parameters:
xmlRpcMethodClass
- the name of the XML-RPC method class of the portlet
-
unsetReady
public void unsetReady()
-