|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType public interface Portlet
The extended model interface for the Portlet service. Represents a row in the "Portlet" database table, with each column mapped to a property of this class.
PortletModel,
PortletImpl,
PortletModelImpl| Field Summary | |
|---|---|
static Accessor<Portlet,Long> |
ID_ACCESSOR
|
static Accessor<Portlet,String> |
PORTLET_ID_ACCESSOR
|
| Method Summary | |
|---|---|
void |
addApplicationType(ApplicationType applicationType)
Adds an application type. |
void |
addProcessingEvent(QName processingEvent)
Adds a processing event. |
void |
addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Adds a public render parameter. |
void |
addPublishingEvent(QName publishingEvent)
Adds a publishing event. |
void |
addSchedulerEntry(SchedulerEntry schedulerEntry)
Adds a scheduler entry. |
boolean |
equals(Object obj)
Checks whether this portlet is equal to the specified object. |
int |
getActionTimeout()
Returns the action timeout of the portlet. |
boolean |
getActionURLRedirect()
Returns true if an action URL for this portlet should cause
an auto redirect. |
boolean |
getAddDefaultResource()
Returns true if default resources for the portlet are added
to a page. |
boolean |
getAjaxable()
Returns true if the portlet can be displayed via Ajax. |
Set<String> |
getAllPortletModes()
Returns the portlet modes of the portlet. |
Set<String> |
getAllWindowStates()
Returns the window states of the portlet. |
Set<ApplicationType> |
getApplicationTypes()
Returns the application types of the portlet. |
List<String> |
getAssetRendererFactoryClasses()
Returns the names of the classes that represent asset types associated with the portlet. |
List<AssetRendererFactory<?>> |
getAssetRendererFactoryInstances()
Returns the asset type instances of the portlet. |
List<String> |
getAtomCollectionAdapterClasses()
Returns the names of the classes that represent atom collection adapters associated with the portlet. |
List<AtomCollectionAdapter<?>> |
getAtomCollectionAdapterInstances()
Returns the atom collection adapter instances of the portlet. |
Set<String> |
getAutopropagatedParameters()
Returns the names of the parameters that will be automatically propagated through the portlet. |
Portlet |
getClonedInstance(String portletId)
Returns true if the portlet is found in a WAR file. |
String |
getConfigurationActionClass()
Returns the configuration action class of the portlet. |
ConfigurationAction |
getConfigurationActionInstance()
Returns the configuration action instance of the portlet. |
String |
getContextName()
Returns the servlet context name of the portlet. |
String |
getContextPath()
Returns the servlet context path of the portlet. |
String |
getControlPanelEntryCategory()
Returns the name of the category of the Control Panel where the portlet will be shown. |
String |
getControlPanelEntryClass()
Returns the name of the class that will control when the portlet will be shown in the Control Panel. |
ControlPanelEntry |
getControlPanelEntryInstance()
Returns an instance of the class that will control when the portlet will be shown in the Control Panel. |
double |
getControlPanelEntryWeight()
Returns the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel. |
String |
getCssClassWrapper()
Returns the name of the CSS class that will be injected in the DIV that wraps this portlet. |
List<String> |
getCustomAttributesDisplayClasses()
Returns the names of the classes that represent custom attribute displays associated with the portlet. |
List<CustomAttributesDisplay> |
getCustomAttributesDisplayInstances()
Returns the custom attribute display instances of the portlet. |
PluginSetting |
getDefaultPluginSetting()
Get the default plugin settings of the portlet. |
String |
getDefaultPreferences()
Returns the default preferences of the portlet. |
String |
getDisplayName()
Returns the display name of the portlet. |
Integer |
getExpCache()
Returns expiration cache of the portlet. |
String |
getFacebookIntegration()
Returns the Facebook integration method of the portlet. |
List<String> |
getFooterPortalCss()
Returns a list of CSS files that will be referenced from the page's footer relative to the portal's context path. |
List<String> |
getFooterPortalJavaScript()
Returns a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path. |
List<String> |
getFooterPortletCss()
Returns a list of CSS files that will be referenced from the page's footer relative to the portlet's context path. |
List<String> |
getFooterPortletJavaScript()
Returns a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path. |
String |
getFriendlyURLMapperClass()
Returns the name of the friendly URL mapper class of the portlet. |
FriendlyURLMapper |
getFriendlyURLMapperInstance()
Returns the friendly URL mapper instance of the portlet. |
String |
getFriendlyURLMapping()
Returns the name of the friendly URL mapping of the portlet. |
String |
getFriendlyURLRoutes()
Returns the class loader resource path to the friendly URL routes of the portlet. |
List<String> |
getHeaderPortalCss()
Returns a list of CSS files that will be referenced from the page's header relative to the portal's context path. |
List<String> |
getHeaderPortalJavaScript()
Returns a list of JavaScript files that will be referenced from the page's header relative to the portal's context path. |
List<String> |
getHeaderPortletCss()
Returns a list of CSS files that will be referenced from the page's header relative to the portlet's context path. |
List<String> |
getHeaderPortletJavaScript()
Returns a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path. |
String |
getIcon()
Returns the icon of the portlet. |
boolean |
getInclude()
Returns true to include the portlet and make it available to
be made active. |
List<String> |
getIndexerClasses()
Returns the names of the classes that represent indexers associated with the portlet. |
List<Indexer<?>> |
getIndexerInstances()
Returns the indexer instances of the portlet. |
Map<String,String> |
getInitParams()
Returns the init parameters of the portlet. |
boolean |
getInstanceable()
Returns true if the portlet can be added multiple times to a
layout. |
String |
getInstanceId()
Returns the instance ID of the portlet. |
boolean |
getLayoutCacheable()
Returns true to allow the portlet to be cached within the
layout. |
boolean |
getMaximizeEdit()
Returns true if the portlet goes into the maximized state
when the user goes into the edit mode. |
boolean |
getMaximizeHelp()
Returns true if the portlet goes into the maximized state
when the user goes into the help mode. |
String |
getOpenSearchClass()
Returns the name of the open search class of the portlet. |
OpenSearch |
getOpenSearchInstance()
Returns the indexer instance of the portlet. |
String |
getParentStrutsPath()
Returns the parent struts path of the portlet. |
String |
getPermissionPropagatorClass()
Returns the name of the permission propagator class of the portlet. |
PermissionPropagator |
getPermissionPropagatorInstance()
Returns the permission propagator instance of the portlet. |
String |
getPluginId()
Returns the plugin ID of the portlet. |
PluginPackage |
getPluginPackage()
Returns this portlet's plugin package. |
String |
getPluginType()
Returns the plugin type of the portlet. |
String |
getPollerProcessorClass()
Returns the name of the poller processor class of the portlet. |
PollerProcessor |
getPollerProcessorInstance()
Returns the poller processor instance of the portlet. |
String |
getPopMessageListenerClass()
Returns the name of the POP message listener class of the portlet. |
MessageListener |
getPopMessageListenerInstance()
Returns the POP message listener instance of the portlet. |
boolean |
getPopUpPrint()
Returns true if the portlet goes into the pop up state when
the user goes into the print mode. |
PortletApp |
getPortletApp()
Returns this portlet's application. |
String |
getPortletClass()
Returns the name of the portlet class of the portlet. |
String |
getPortletDataHandlerClass()
Returns the name of the portlet data handler class of the portlet. |
PortletDataHandler |
getPortletDataHandlerInstance()
Returns the portlet data handler instance of the portlet. |
Map<String,PortletFilter> |
getPortletFilters()
Returns the filters of the portlet. |
PortletInfo |
getPortletInfo()
Returns the portlet info of the portlet. |
String |
getPortletLayoutListenerClass()
Returns the name of the portlet layout listener class of the portlet. |
PortletLayoutListener |
getPortletLayoutListenerInstance()
Returns the portlet layout listener instance of the portlet. |
Map<String,Set<String>> |
getPortletModes()
Returns the portlet modes of the portlet. |
String |
getPortletName()
Returns the name of the portlet. |
String |
getPortletURLClass()
Returns the name of the portlet URL class of the portlet. |
boolean |
getPreferencesCompanyWide()
Returns true if preferences are shared across the entire
company. |
boolean |
getPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the
portlet is shown in a group layout. |
boolean |
getPreferencesUniquePerLayout()
Returns true if preferences are unique per layout. |
String |
getPreferencesValidator()
Returns the name of the preferences validator class of the portlet. |
boolean |
getPrivateRequestAttributes()
Returns true if the portlet does not share request
attributes with the portal or portlets from another WAR. |
boolean |
getPrivateSessionAttributes()
Returns true if the portlet does not share session
attributes with the portal. |
QName |
getProcessingEvent(String uri,
String localPart)
Returns the processing event from a namespace URI and a local part. |
Set<QName> |
getProcessingEvents()
Returns the processing events of the portlet. |
PublicRenderParameter |
getPublicRenderParameter(String identifier)
Returns the public render parameter from an identifier. |
PublicRenderParameter |
getPublicRenderParameter(String uri,
String localPart)
Returns the spublic render parameter from a namespace URI and a local part. |
Set<PublicRenderParameter> |
getPublicRenderParameters()
Returns the public render parameters of the portlet. |
Set<QName> |
getPublishingEvents()
Returns the publishing events of the portlet. |
boolean |
getReady()
Returns true if the portlet is ready to be used. |
boolean |
getRemoteable()
Returns true if the portlet supports remoting. |
int |
getRenderTimeout()
Returns the render timeout of the portlet. |
int |
getRenderWeight()
Returns the render weight of the portlet. |
String |
getResourceBundle()
Returns the resource bundle of the portlet. |
boolean |
getRestoreCurrentView()
Returns true if the portlet restores to the current view
from the maximized state. |
Map<String,String> |
getRoleMappers()
Returns the role mappers of the portlet. |
String[] |
getRolesArray()
Returns an array of required roles of the portlet. |
Portlet |
getRootPortlet()
Returns the root portlet of this portlet instance. |
String |
getRootPortletId()
Returns the root portlet ID of the portlet. |
List<SchedulerEntry> |
getSchedulerEntries()
Returns the scheduler entries of the portlet. |
boolean |
getScopeable()
Returns true if the portlet supports scoping of data. |
boolean |
getShowPortletAccessDenied()
Returns true if users are shown that they do not have access
to the portlet. |
boolean |
getShowPortletInactive()
Returns true if users are shown that the portlet is
inactive. |
boolean |
getSinglePageApplication()
Returns true if the portlet uses Single Page Application. |
List<String> |
getSocialActivityInterpreterClasses()
Returns the names of the classes that represent social activity interpreters associated with the portlet. |
List<SocialActivityInterpreter> |
getSocialActivityInterpreterInstances()
Returns the social activity interpreter instances of the portlet. |
String |
getSocialRequestInterpreterClass()
Returns the name of the social request interpreter class of the portlet. |
SocialRequestInterpreter |
getSocialRequestInterpreterInstance()
Returns the name of the social request interpreter instance of the portlet. |
List<String> |
getStagedModelDataHandlerClasses()
Returns the names of the classes that represent staged model data handlers associated with the portlet. |
List<StagedModelDataHandler<?>> |
getStagedModelDataHandlerInstances()
Returns the staged model data handler instances of the portlet. |
boolean |
getStatic()
Returns true if the portlet is a static portlet that is
cannot be moved. |
boolean |
getStaticEnd()
Returns true if the portlet is a static portlet at the end
of a list of portlets. |
String |
getStaticResourcePath()
Returns the path for static resources served by this portlet. |
boolean |
getStaticStart()
Returns true if the portlet is a static portlet at the start
of a list of portlets. |
String |
getStrutsPath()
Returns the struts path of the portlet. |
Set<String> |
getSupportedLocales()
Returns the supported locales of the portlet. |
boolean |
getSystem()
Returns true if the portlet is a system portlet that a user
cannot manually add to their page. |
String |
getTemplateHandlerClass()
Returns the name of the template handler class of the portlet. |
TemplateHandler |
getTemplateHandlerInstance()
Returns the template handler instance of the portlet. |
long |
getTimestamp()
Returns the timestamp of the portlet. |
List<String> |
getTrashHandlerClasses()
Returns the names of the classes that represent trash handlers associated with the portlet. |
List<TrashHandler> |
getTrashHandlerInstances()
Returns the trash handler instances of the portlet. |
boolean |
getUndeployedPortlet()
Returns true if the portlet is an undeployed portlet. |
Set<String> |
getUnlinkedRoles()
Returns the unlinked roles of the portlet. |
String |
getURLEncoderClass()
Returns the name of the URL encoder class of the portlet. |
URLEncoder |
getURLEncoderInstance()
Returns the URL encoder instance of the portlet. |
boolean |
getUseDefaultTemplate()
Returns true if the portlet uses the default template. |
long |
getUserId()
Returns the user ID of the portlet. |
String |
getUserNotificationDefinitions()
Returns the class loader resource path to the use notification definitions of the portlet. |
List<String> |
getUserNotificationHandlerClasses()
Returns the names of the classes that represent user notification handlers associated with the portlet. |
List<UserNotificationHandler> |
getUserNotificationHandlerInstances()
Returns the user notification handler instances of the portlet. |
String |
getUserPrincipalStrategy()
Returns the user principal strategy of the portlet. |
String |
getVirtualPath()
Returns the virtual path of the portlet. |
String |
getWebDAVStorageClass()
Returns the name of the WebDAV storage class of the portlet. |
WebDAVStorage |
getWebDAVStorageInstance()
Returns the name of the WebDAV storage instance of the portlet. |
String |
getWebDAVStorageToken()
Returns the name of the WebDAV storage token of the portlet. |
Map<String,Set<String>> |
getWindowStates()
Returns the window states of the portlet. |
List<String> |
getWorkflowHandlerClasses()
Returns the names of the classes that represent workflow handlers associated with the portlet. |
List<WorkflowHandler<?>> |
getWorkflowHandlerInstances()
Returns the workflow handler instances of the portlet. |
String |
getXmlRpcMethodClass()
Returns the name of the XML-RPC method class of the portlet. |
Method |
getXmlRpcMethodInstance()
Returns the name of the XML-RPC method instance of the portlet. |
boolean |
hasAddPortletPermission(long userId)
Returns true if the user has the permission to add the
portlet to a layout. |
boolean |
hasFooterPortalCss()
|
boolean |
hasFooterPortalJavaScript()
|
boolean |
hasFooterPortletCss()
|
boolean |
hasFooterPortletJavaScript()
|
boolean |
hasHeaderPortalCss()
|
boolean |
hasHeaderPortalJavaScript()
|
boolean |
hasHeaderPortletCss()
|
boolean |
hasHeaderPortletJavaScript()
|
boolean |
hasMultipleMimeTypes()
Returns true if the portlet supports more than one mime
type. |
boolean |
hasPortletMode(String mimeType,
PortletMode portletMode)
Returns true if the portlet supports the specified mime type
and portlet mode. |
boolean |
hasRoleWithName(String roleName)
Returns true if the portlet has a role with the specified
name. |
boolean |
hasWindowState(String mimeType,
WindowState windowState)
Returns true if the portlet supports the specified mime type
and window state. |
boolean |
isActionURLRedirect()
Returns true if an action URL for this portlet should cause
an auto redirect. |
boolean |
isAddDefaultResource()
Returns true if default resources for the portlet are added
to a page. |
boolean |
isAjaxable()
Returns true if the portlet can be displayed via Ajax. |
boolean |
isFullPageDisplayable()
|
boolean |
isInclude()
Returns true to include the portlet and make it available to
be made active. |
boolean |
isInstanceable()
Returns true if the portlet can be added multiple times to a
layout. |
boolean |
isLayoutCacheable()
Returns true to allow the portlet to be cached within the
layout. |
boolean |
isMaximizeEdit()
Returns true if the portlet goes into the maximized state
when the user goes into the edit mode. |
boolean |
isMaximizeHelp()
Returns true if the portlet goes into the maximized state
when the user goes into the help mode. |
boolean |
isPopUpPrint()
Returns true if the portlet goes into the pop up state when
the user goes into the print mode. |
boolean |
isPreferencesCompanyWide()
Returns true if preferences are shared across the entire
company. |
boolean |
isPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the
portlet is shown in a group layout. |
boolean |
isPreferencesUniquePerLayout()
Returns true if preferences are unique per layout. |
boolean |
isPrivateRequestAttributes()
Returns true if the portlet does not share request
attributes with the portal or portlets from another WAR. |
boolean |
isPrivateSessionAttributes()
Returns true if the portlet does not share session
attributes with the portal. |
boolean |
isReady()
Returns true if the portlet is ready to be used. |
boolean |
isRemoteable()
Returns true if the portlet supports remoting. |
boolean |
isRequiresNamespacedParameters()
Returns true if the portlet will only process namespaced
parameters. |
boolean |
isRestoreCurrentView()
Returns true if the portlet restores to the current view
from the maximized state. |
boolean |
isScopeable()
Returns true if the portlet supports scoping of data. |
boolean |
isShowPortletAccessDenied()
Returns true if users are shown that they do not have access
to the portlet. |
boolean |
isShowPortletInactive()
Returns true if users are shown that the portlet is
inactive. |
boolean |
isSinglePageApplication()
Returns true if the portlet uses Single Page Application. |
boolean |
isStatic()
Returns true if the portlet is a static portlet that is
cannot be moved. |
boolean |
isStaticEnd()
Returns true if the portlet is a static portlet at the end
of a list of portlets. |
boolean |
isStaticStart()
Returns true if the portlet is a static portlet at the start
of a list of portlets. |
boolean |
isSystem()
Returns true if the portlet is a system portlet that a user
cannot manually add to their page. |
boolean |
isUndeployedPortlet()
Returns true if the portlet is an undeployed portlet. |
boolean |
isUseDefaultTemplate()
Returns true if the portlet uses the default template. |
void |
linkRoles()
Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml. |
void |
setActionTimeout(int actionTimeout)
Sets the action timeout of the portlet. |
void |
setActionURLRedirect(boolean actionURLRedirect)
Set to true if an action URL for this portlet should cause
an auto redirect. |
void |
setAddDefaultResource(boolean addDefaultResource)
Set to true if default resources for the portlet are added
to a page. |
void |
setAjaxable(boolean ajaxable)
Set to true if the portlet can be displayed via Ajax. |
void |
setApplicationTypes(Set<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 |
setAtomCollectionAdapterClasses(List<String> atomCollectionAdapterClasses)
Sets the names of the classes that represent atom collection adapters associated with the portlet. |
void |
setAutopropagatedParameters(Set<String> autopropagatedParameters)
Sets the names of the parameters that will be automatically propagated through 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(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 |
setFacebookIntegration(String facebookIntegration)
Sets the Facebook integration method 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 |
setIcon(String icon)
Sets the icon of the portlet. |
void |
setInclude(boolean include)
Set to true 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 to true if the portlet can be added multiple times to a
layout. |
void |
setLayoutCacheable(boolean layoutCacheable)
Set to true to allow the portlet to be cached within the
layout. |
void |
setMaximizeEdit(boolean maximizeEdit)
Set to true if the portlet goes into the maximized state
when the user goes into the edit mode. |
void |
setMaximizeHelp(boolean maximizeHelp)
Set to true if the portlet goes into the maximized state
when the user goes into the help mode. |
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 |
setPermissionPropagatorClass(String permissionPropagatorClass)
Sets the name of the permission propagator class of the portlet. |
void |
setPluginPackage(PluginPackage pluginPackage)
Sets this portlet's plugin package. |
void |
setPollerProcessorClass(String pollerProcessorClass)
Sets the name of the poller processor class of the portlet. |
void |
setPopMessageListenerClass(String popMessageListenerClass)
Sets the name of the POP message listener class of the portlet. |
void |
setPopUpPrint(boolean popUpPrint)
Set to true if the portlet goes into the pop up state when
the user goes into the print mode. |
void |
setPortletApp(PortletApp portletApp)
Sets this portlet's application. |
void |
setPortletClass(String portletClass)
Sets the name of the portlet class of the portlet. |
void |
setPortletDataHandlerClass(String portletDataHandlerClass)
Sets the name of the portlet data handler class of the portlet. |
void |
setPortletFilters(Map<String,PortletFilter> portletFilters)
Sets the filters of the portlet. |
void |
setPortletInfo(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 to true if preferences are shared across the entire
company. |
void |
setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
Set to true if preferences are owned by the group when the
portlet is shown in a group layout. |
void |
setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
Set to true if preferences are unique per layout. |
void |
setPreferencesValidator(String preferencesValidator)
Sets the name of the preferences validator class of the portlet. |
void |
setPrivateRequestAttributes(boolean privateRequestAttributes)
Set to true if the portlet does not share request attributes
with the portal or portlets from another WAR. |
void |
setPrivateSessionAttributes(boolean privateSessionAttributes)
Set to true if the portlet does not share session attributes
with the portal. |
void |
setProcessingEvents(Set<QName> processingEvents)
Sets the processing events of the portlet. |
void |
setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)
Sets the public render parameters of the portlet. |
void |
setPublishingEvents(Set<QName> publishingEvents)
Sets the publishing events of the portlet. |
void |
setReady(boolean ready)
Set to true if the portlet is ready to be used. |
void |
setRemoteable(boolean remoteable)
Set to true if the portlet supports remoting |
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 to true if the portlet will only process namespaced
parameters. |
void |
setResourceBundle(String resourceBundle)
Sets the resource bundle of the portlet. |
void |
setRestoreCurrentView(boolean restoreCurrentView)
Set to true if the portlet restores to the current view from
the maximized state. |
void |
setRoleMappers(Map<String,String> roleMappers)
Sets the role mappers of the portlet. |
void |
setRolesArray(String[] rolesArray)
Sets an array of required roles of the portlet. |
void |
setSchedulerEntries(List<SchedulerEntry> schedulerEntries)
Sets the scheduler entries of the portlet. |
void |
setScopeable(boolean scopeable)
Set to true if the portlet supports scoping of data. |
void |
setShowPortletAccessDenied(boolean showPortletAccessDenied)
Set to true if users are shown that they do not have access
to the portlet. |
void |
setShowPortletInactive(boolean showPortletInactive)
Set to true if users are shown that the portlet is inactive. |
void |
setSinglePageApplication(boolean singlePageApplication)
Set to true 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 to true if the portlet is a static portlet that is
cannot be moved. |
void |
setStaticStart(boolean staticPortletStart)
Set to true if the portlet is a static portlet at the start
of a list of portlets. |
void |
setStrutsPath(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 to true 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 to true 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 to true 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 |
unsetReady()
|
| Methods inherited from interface com.liferay.portal.model.PortletModel |
|---|
clone, compareTo, getActive, getCompanyId, getExpandoBridge, getId, getMvccVersion, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, isCachedModel, isEscapedModel, isNew, setActive, setCachedModel, setCompanyId, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setId, setMvccVersion, setNew, setPortletId, setPrimaryKey, setPrimaryKeyObj, setRoles, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString |
| Methods inherited from interface com.liferay.portal.model.BaseModel |
|---|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes |
| Methods inherited from interface com.liferay.portal.model.ClassedModel |
|---|
getModelClass, getModelClassName |
| Methods inherited from interface com.liferay.portal.model.PersistedModel |
|---|
persist |
| Field Detail |
|---|
static final Accessor<Portlet,Long> ID_ACCESSOR
static final Accessor<Portlet,String> PORTLET_ID_ACCESSOR
| Method Detail |
|---|
void addApplicationType(ApplicationType applicationType)
applicationType - an application typevoid addProcessingEvent(QName processingEvent)
void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
publicRenderParameter - a public render parametervoid addPublishingEvent(QName publishingEvent)
void addSchedulerEntry(SchedulerEntry schedulerEntry)
boolean equals(Object obj)
equals in class Objectobj - the object to compare this portlet against
true if the portlet is equal to the specified objectint getActionTimeout()
boolean getActionURLRedirect()
true if an action URL for this portlet should cause
an auto redirect.
true if an action URL for this portlet should cause
an auto redirectboolean getAddDefaultResource()
true if default resources for the portlet are added
to a page.
true if default resources for the portlet are added
to a pageboolean getAjaxable()
true if the portlet can be displayed via Ajax.
true if the portlet can be displayed via AjaxSet<String> getAllPortletModes()
Set<String> getAllWindowStates()
Set<ApplicationType> getApplicationTypes()
List<String> getAssetRendererFactoryClasses()
List<AssetRendererFactory<?>> getAssetRendererFactoryInstances()
List<String> getAtomCollectionAdapterClasses()
List<AtomCollectionAdapter<?>> getAtomCollectionAdapterInstances()
Set<String> getAutopropagatedParameters()
Portlet getClonedInstance(String portletId)
true if the portlet is found in a WAR file.
portletId - the cloned instance portlet ID
String getConfigurationActionClass()
ConfigurationAction getConfigurationActionInstance()
String getContextName()
String getContextPath()
String getControlPanelEntryCategory()
String getControlPanelEntryClass()
ControlPanelEntry getControlPanelEntryInstance()
double getControlPanelEntryWeight()
String getCssClassWrapper()
List<String> getCustomAttributesDisplayClasses()
List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()
PluginSetting getDefaultPluginSetting()
String getDefaultPreferences()
String getDisplayName()
Integer getExpCache()
String getFacebookIntegration()
List<String> getFooterPortalCss()
List<String> getFooterPortalJavaScript()
List<String> getFooterPortletCss()
List<String> getFooterPortletJavaScript()
String getFriendlyURLMapperClass()
FriendlyURLMapper getFriendlyURLMapperInstance()
String getFriendlyURLMapping()
String getFriendlyURLRoutes()
List<String> getHeaderPortalCss()
List<String> getHeaderPortalJavaScript()
List<String> getHeaderPortletCss()
List<String> getHeaderPortletJavaScript()
String getIcon()
boolean getInclude()
true to include the portlet and make it available to
be made active.
true to include the portlet and make it available to
be made activeList<String> getIndexerClasses()
List<Indexer<?>> getIndexerInstances()
Map<String,String> getInitParams()
boolean getInstanceable()
true if the portlet can be added multiple times to a
layout.
true if the portlet can be added multiple times to a
layoutString getInstanceId()
boolean getLayoutCacheable()
true to allow the portlet to be cached within the
layout.
true if the portlet can be cached within the layoutboolean getMaximizeEdit()
true if the portlet goes into the maximized state
when the user goes into the edit mode.
true if the portlet goes into the maximized state
when the user goes into the edit modeboolean getMaximizeHelp()
true if the portlet goes into the maximized state
when the user goes into the help mode.
true if the portlet goes into the maximized state
when the user goes into the help modeString getOpenSearchClass()
OpenSearch getOpenSearchInstance()
String getParentStrutsPath()
String getPermissionPropagatorClass()
PermissionPropagator getPermissionPropagatorInstance()
String getPluginId()
PluginPackage getPluginPackage()
String getPluginType()
String getPollerProcessorClass()
PollerProcessor getPollerProcessorInstance()
String getPopMessageListenerClass()
MessageListener getPopMessageListenerInstance()
boolean getPopUpPrint()
true if the portlet goes into the pop up state when
the user goes into the print mode.
true if the portlet goes into the pop up state when
the user goes into the print modePortletApp getPortletApp()
String getPortletClass()
String getPortletDataHandlerClass()
PortletDataHandler getPortletDataHandlerInstance()
Map<String,PortletFilter> getPortletFilters()
PortletInfo getPortletInfo()
String getPortletLayoutListenerClass()
PortletLayoutListener getPortletLayoutListenerInstance()
Map<String,Set<String>> getPortletModes()
String getPortletName()
String getPortletURLClass()
boolean getPreferencesCompanyWide()
true if preferences are shared across the entire
company.
true if preferences are shared across the entire
companyboolean getPreferencesOwnedByGroup()
true if preferences are owned by the group when the
portlet is shown in a group layout. Returns false if
preferences are owned by the user at all times.
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.boolean getPreferencesUniquePerLayout()
true if preferences are unique per layout.
true if preferences are unique per layoutString getPreferencesValidator()
boolean getPrivateRequestAttributes()
true if the portlet does not share request
attributes with the portal or portlets from another WAR.
true if the portlet does not share request
attributes with the portal or portlets from another WARboolean getPrivateSessionAttributes()
true if the portlet does not share session
attributes with the portal.
true if the portlet does not share session
attributes with the portal
QName getProcessingEvent(String uri,
String localPart)
uri - the namespace URIlocalPart - the local part
Set<QName> getProcessingEvents()
PublicRenderParameter getPublicRenderParameter(String identifier)
identifier - the identifier
PublicRenderParameter getPublicRenderParameter(String uri,
String localPart)
uri - the namespace URIlocalPart - the local part
Set<PublicRenderParameter> getPublicRenderParameters()
Set<QName> getPublishingEvents()
boolean getReady()
true if the portlet is ready to be used.
true if the portlet is ready to be usedboolean getRemoteable()
true if the portlet supports remoting.
true if the portlet supports remotingint getRenderTimeout()
int getRenderWeight()
String getResourceBundle()
boolean getRestoreCurrentView()
true if the portlet restores to the current view
from the maximized state.
true if the portlet restores to the current view
from the maximized stateMap<String,String> getRoleMappers()
String[] getRolesArray()
Portlet getRootPortlet()
String getRootPortletId()
List<SchedulerEntry> getSchedulerEntries()
boolean getScopeable()
true if the portlet supports scoping of data.
true if the portlet supports scoping of databoolean getShowPortletAccessDenied()
true if users are shown that they do not have access
to the portlet.
true if users are shown that they do not have access
to the portletboolean getShowPortletInactive()
true if users are shown that the portlet is
inactive.
true if users are shown that the portlet is inactiveboolean getSinglePageApplication()
true if the portlet uses Single Page Application.
true if the portlet uses Single Page ApplicationList<String> getSocialActivityInterpreterClasses()
List<SocialActivityInterpreter> getSocialActivityInterpreterInstances()
String getSocialRequestInterpreterClass()
SocialRequestInterpreter getSocialRequestInterpreterInstance()
List<String> getStagedModelDataHandlerClasses()
List<StagedModelDataHandler<?>> getStagedModelDataHandlerInstances()
boolean getStatic()
true if the portlet is a static portlet that is
cannot be moved.
true if the portlet is a static portlet that is
cannot be movedboolean getStaticEnd()
true if the portlet is a static portlet at the end
of a list of portlets.
true if the portlet is a static portlet at the end
of a list of portletsString getStaticResourcePath()
boolean getStaticStart()
true if the portlet is a static portlet at the start
of a list of portlets.
true if the portlet is a static portlet at the start
of a list of portletsString getStrutsPath()
Set<String> getSupportedLocales()
boolean getSystem()
true if the portlet is a system portlet that a user
cannot manually add to their page.
true if the portlet is a system portlet that a user
cannot manually add to their pageString getTemplateHandlerClass()
TemplateHandler getTemplateHandlerInstance()
long getTimestamp()
List<String> getTrashHandlerClasses()
List<TrashHandler> getTrashHandlerInstances()
boolean getUndeployedPortlet()
true if the portlet is an undeployed portlet.
true if the portlet is a placeholder of an
undeployed portletSet<String> getUnlinkedRoles()
String getURLEncoderClass()
URLEncoder getURLEncoderInstance()
boolean getUseDefaultTemplate()
true if the portlet uses the default template.
true if the portlet uses the default templatelong getUserId()
String getUserNotificationDefinitions()
List<String> getUserNotificationHandlerClasses()
List<UserNotificationHandler> getUserNotificationHandlerInstances()
String getUserPrincipalStrategy()
String getVirtualPath()
String getWebDAVStorageClass()
WebDAVStorage getWebDAVStorageInstance()
String getWebDAVStorageToken()
Map<String,Set<String>> getWindowStates()
List<String> getWorkflowHandlerClasses()
List<WorkflowHandler<?>> getWorkflowHandlerInstances()
String getXmlRpcMethodClass()
Method getXmlRpcMethodInstance()
boolean hasAddPortletPermission(long userId)
true if the user has the permission to add the
portlet to a layout.
userId - the primary key of the user
true if the user has the permission to add the
portlet to a layoutboolean hasFooterPortalCss()
boolean hasFooterPortalJavaScript()
boolean hasFooterPortletCss()
boolean hasFooterPortletJavaScript()
boolean hasHeaderPortalCss()
boolean hasHeaderPortalJavaScript()
boolean hasHeaderPortletCss()
boolean hasHeaderPortletJavaScript()
boolean hasMultipleMimeTypes()
true if the portlet supports more than one mime
type.
true if the portlet supports more than one mime type
boolean hasPortletMode(String mimeType,
PortletMode portletMode)
true if the portlet supports the specified mime type
and portlet mode.
mimeType - the mime typeportletMode - the portlet mode
true if the portlet supports the specified mime type
and portlet modeboolean hasRoleWithName(String roleName)
true if the portlet has a role with the specified
name.
roleName - the role name
true if the portlet has a role with the specified
name
boolean hasWindowState(String mimeType,
WindowState windowState)
true if the portlet supports the specified mime type
and window state.
mimeType - the mime typewindowState - the window state
true if the portlet supports the specified mime type
and window stateboolean isActionURLRedirect()
true if an action URL for this portlet should cause
an auto redirect.
true if an action URL for this portlet should cause
an auto redirectboolean isAddDefaultResource()
true if default resources for the portlet are added
to a page.
true if default resources for the portlet are added
to a pageboolean isAjaxable()
true if the portlet can be displayed via Ajax.
true if the portlet can be displayed via Ajaxboolean isFullPageDisplayable()
boolean isInclude()
true to include the portlet and make it available to
be made active.
true to include the portlet and make it available to
be made activeboolean isInstanceable()
true if the portlet can be added multiple times to a
layout.
true if the portlet can be added multiple times to a
layoutboolean isLayoutCacheable()
true to allow the portlet to be cached within the
layout.
true if the portlet can be cached within the layoutboolean isMaximizeEdit()
true if the portlet goes into the maximized state
when the user goes into the edit mode.
true if the portlet goes into the maximized state
when the user goes into the edit modeboolean isMaximizeHelp()
true if the portlet goes into the maximized state
when the user goes into the help mode.
true if the portlet goes into the maximized state
when the user goes into the help modeboolean isPopUpPrint()
true if the portlet goes into the pop up state when
the user goes into the print mode.
true if the portlet goes into the pop up state when
the user goes into the print modeboolean isPreferencesCompanyWide()
true if preferences are shared across the entire
company.
true if preferences are shared across the entire
companyboolean isPreferencesOwnedByGroup()
true if preferences are owned by the group when the
portlet is shown in a group layout. Returns false if
preferences are owned by the user at all times.
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.boolean isPreferencesUniquePerLayout()
true if preferences are unique per layout.
true if preferences are unique per layoutboolean isPrivateRequestAttributes()
true if the portlet does not share request
attributes with the portal or portlets from another WAR.
true if the portlet does not share request
attributes with the portal or portlets from another WARboolean isPrivateSessionAttributes()
true if the portlet does not share session
attributes with the portal.
true if the portlet does not share session
attributes with the portalboolean isReady()
true if the portlet is ready to be used.
true if the portlet is ready to be usedboolean isRemoteable()
true if the portlet supports remoting.
true if the portlet supports remotingboolean isRequiresNamespacedParameters()
true if the portlet will only process namespaced
parameters.
true if the portlet will only process namespaced
parametersboolean isRestoreCurrentView()
true if the portlet restores to the current view
from the maximized state.
true if the portlet restores to the current view
from the maximized stateboolean isScopeable()
true if the portlet supports scoping of data.
true if the portlet supports scoping of databoolean isShowPortletAccessDenied()
true if users are shown that they do not have access
to the portlet.
true if users are shown that they do not have access
to the portletboolean isShowPortletInactive()
true if users are shown that the portlet is
inactive.
true if users are shown that the portlet is inactiveboolean isSinglePageApplication()
true if the portlet uses Single Page Application.
true if the portlet uses Single Page Applicationboolean isStatic()
true if the portlet is a static portlet that is
cannot be moved.
true if the portlet is a static portlet that is
cannot be movedboolean isStaticEnd()
true if the portlet is a static portlet at the end
of a list of portlets.
true if the portlet is a static portlet at the end
of a list of portletsboolean isStaticStart()
true if the portlet is a static portlet at the start
of a list of portlets.
true if the portlet is a static portlet at the start
of a list of portletsboolean isSystem()
true if the portlet is a system portlet that a user
cannot manually add to their page.
true if the portlet is a system portlet that a user
cannot manually add to their pageboolean isUndeployedPortlet()
true if the portlet is an undeployed portlet.
true if the portlet is a placeholder of an
undeployed portletboolean isUseDefaultTemplate()
true if the portlet uses the default template.
true if the portlet uses the default templatevoid linkRoles()
void setActionTimeout(int actionTimeout)
actionTimeout - the action timeout of the portletvoid setActionURLRedirect(boolean actionURLRedirect)
true if an action URL for this portlet should cause
an auto redirect.
actionURLRedirect - boolean value for whether an action URL for this
portlet should cause an auto redirectvoid setAddDefaultResource(boolean addDefaultResource)
true if default resources for the portlet are added
to a page.
addDefaultResource - boolean value for whether or not default
resources for the portlet are added to a pagevoid setAjaxable(boolean ajaxable)
true if the portlet can be displayed via Ajax.
ajaxable - boolean value for whether the portlet can be displayed
via Ajaxvoid setApplicationTypes(Set<ApplicationType> applicationTypes)
applicationTypes - the application types of the portletvoid setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)
assetRendererFactoryClasses - the names of the classes that
represent asset types associated with the portletvoid setAtomCollectionAdapterClasses(List<String> atomCollectionAdapterClasses)
atomCollectionAdapterClasses - the names of the classes that
represent atom collection adapters associated with the portletvoid setAutopropagatedParameters(Set<String> autopropagatedParameters)
autopropagatedParameters - the names of the parameters that will be
automatically propagated through the portletvoid setConfigurationActionClass(String configurationActionClass)
configurationActionClass - the configuration action class of the
portletvoid setControlPanelEntryCategory(String controlPanelEntryCategory)
controlPanelEntryCategory - the name of the category of the Control
Panel where the portlet will be shownvoid setControlPanelEntryClass(String controlPanelEntryClass)
controlPanelEntryClass - the name of the class that will control
when the portlet will be shown in the Control Panelvoid setControlPanelEntryWeight(double controlPanelEntryWeight)
controlPanelEntryWeight - the relative weight of the portlet with
respect to the other portlets in the same category of the Control
Panelvoid setCssClassWrapper(String cssClassWrapper)
cssClassWrapper - the name of the CSS class that will be injected in
the DIV that wraps this portletvoid setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)
customAttributesDisplayClasses - the names of the classes that
represent custom attribute displays associated with the portletvoid setDefaultPluginSetting(PluginSetting pluginSetting)
pluginSetting - the plugin settingvoid setDefaultPreferences(String defaultPreferences)
defaultPreferences - the default preferences of the portletvoid setDisplayName(String displayName)
displayName - the display name of the portletvoid setExpCache(Integer expCache)
expCache - expiration cache of the portletvoid setFacebookIntegration(String facebookIntegration)
facebookIntegration - the Facebook integration method of the portletvoid setFooterPortalCss(List<String> footerPortalCss)
footerPortalCss - a list of CSS files that will be referenced from
the page's footer relative to the portal's context pathvoid setFooterPortalJavaScript(List<String> footerPortalJavaScript)
footerPortalJavaScript - a list of JavaScript files that will be
referenced from the page's footer relative to the portal's context
pathvoid setFooterPortletCss(List<String> footerPortletCss)
footerPortletCss - a list of CSS files that will be referenced from
the page's footer relative to the portlet's context pathvoid setFooterPortletJavaScript(List<String> footerPortletJavaScript)
footerPortletJavaScript - a list of JavaScript files that will be
referenced from the page's footer relative to the portlet's
context pathvoid setFriendlyURLMapperClass(String friendlyURLMapperClass)
friendlyURLMapperClass - the name of the friendly URL mapper class
of the portletvoid setFriendlyURLMapping(String friendlyURLMapping)
friendlyURLMapping - the name of the friendly URL mapping of the
portletvoid setFriendlyURLRoutes(String friendlyURLRoutes)
friendlyURLRoutes - the class loader resource path to the friendly
URL routes of the portletvoid setHeaderPortalCss(List<String> headerPortalCss)
headerPortalCss - a list of CSS files that will be referenced from
the page's header relative to the portal's context pathvoid setHeaderPortalJavaScript(List<String> headerPortalJavaScript)
headerPortalJavaScript - a list of JavaScript files that will be
referenced from the page's header relative to the portal's context
pathvoid setHeaderPortletCss(List<String> headerPortletCss)
headerPortletCss - a list of CSS files that will be referenced from
the page's header relative to the portlet's context pathvoid setHeaderPortletJavaScript(List<String> headerPortletJavaScript)
headerPortletJavaScript - a list of JavaScript files that will be
referenced from the page's header relative to the portlet's
context pathvoid setIcon(String icon)
icon - the icon of the portletvoid setInclude(boolean include)
true to include the portlet and make it available to
be made active.
include - boolean value for whether to include the portlet and make
it available to be made activevoid setIndexerClasses(List<String> indexerClasses)
indexerClasses - the names of the classes that represent indexers
associated with the portletvoid setInitParams(Map<String,String> initParams)
initParams - the init parameters of the portletvoid setInstanceable(boolean instanceable)
true if the portlet can be added multiple times to a
layout.
instanceable - boolean value for whether the portlet can be added
multiple times to a layoutvoid setLayoutCacheable(boolean layoutCacheable)
true to allow the portlet to be cached within the
layout.
layoutCacheable - boolean value for whether the portlet can be
cached within the layoutvoid setMaximizeEdit(boolean maximizeEdit)
true if the portlet goes into the maximized state
when the user goes into the edit mode.
maximizeEdit - boolean value for whether the portlet goes into the
maximized state when the user goes into the edit modevoid setMaximizeHelp(boolean maximizeHelp)
true if the portlet goes into the maximized state
when the user goes into the help mode.
maximizeHelp - boolean value for whether the portlet goes into the
maximized state when the user goes into the help modevoid setOpenSearchClass(String openSearchClass)
openSearchClass - the name of the open search class of the portletvoid setParentStrutsPath(String parentStrutsPath)
parentStrutsPath - the parent struts path of the portletvoid setPermissionPropagatorClass(String permissionPropagatorClass)
void setPluginPackage(PluginPackage pluginPackage)
pluginPackage - this portlet's plugin packagevoid setPollerProcessorClass(String pollerProcessorClass)
pollerProcessorClass - the name of the poller processor class of the
portletvoid setPopMessageListenerClass(String popMessageListenerClass)
popMessageListenerClass - the name of the POP message listener class
of the portletvoid setPopUpPrint(boolean popUpPrint)
true if the portlet goes into the pop up state when
the user goes into the print mode.
popUpPrint - boolean value for whether the portlet goes into the pop
up state when the user goes into the print modevoid setPortletApp(PortletApp portletApp)
portletApp - this portlet's applicationvoid setPortletClass(String portletClass)
portletClass - the name of the portlet class of the portletvoid setPortletDataHandlerClass(String portletDataHandlerClass)
portletDataHandlerClass - the name of portlet data handler class of
the portletvoid setPortletFilters(Map<String,PortletFilter> portletFilters)
portletFilters - the filters of the portletvoid setPortletInfo(PortletInfo portletInfo)
portletInfo - the portlet info of the portletvoid setPortletLayoutListenerClass(String portletLayoutListenerClass)
portletLayoutListenerClass - the name of the portlet layout listener
class of the portletvoid setPortletModes(Map<String,Set<String>> portletModes)
portletModes - the portlet modes of the portletvoid setPortletName(String portletName)
portletName - the name of the portletvoid setPortletURLClass(String portletURLClass)
portletURLClass - the name of the portlet URL class of the portletvoid setPreferencesCompanyWide(boolean preferencesCompanyWide)
true if preferences are shared across the entire
company.
preferencesCompanyWide - boolean value for whether preferences are
shared across the entire companyvoid setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
true if preferences are owned by the group when the
portlet is shown in a group layout. Set to false if
preferences are owned by the user at all times.
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 timesvoid setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
true if preferences are unique per layout.
preferencesUniquePerLayout - boolean value for whether preferences
are unique per layoutvoid setPreferencesValidator(String preferencesValidator)
preferencesValidator - the name of the preferences validator class
of the portletvoid setPrivateRequestAttributes(boolean privateRequestAttributes)
true if the portlet does not share request attributes
with the portal or portlets from another WAR.
privateRequestAttributes - boolean value for whether the portlet
shares request attributes with the portal or portlets from another
WARvoid setPrivateSessionAttributes(boolean privateSessionAttributes)
true if the portlet does not share session attributes
with the portal.
privateSessionAttributes - boolean value for whether the portlet
shares session attributes with the portalvoid setProcessingEvents(Set<QName> processingEvents)
processingEvents - the processing events of the portletvoid setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)
publicRenderParameters - the public render parameters of the portletvoid setPublishingEvents(Set<QName> publishingEvents)
publishingEvents - the publishing events of the portletvoid setReady(boolean ready)
true if the portlet is ready to be used.
ready - whether the portlet is ready to be usedvoid setRemoteable(boolean remoteable)
true if the portlet supports remoting
remoteable - boolean value for whether or not the the portlet
supports remotingvoid setRenderTimeout(int renderTimeout)
renderTimeout - the render timeout of the portletvoid setRenderWeight(int renderWeight)
renderWeight - int value for the render weight of the portletvoid setRequiresNamespacedParameters(boolean requiresNamespacedParameters)
true if the portlet will only process namespaced
parameters.
requiresNamespacedParameters - boolean value for whether the portlet
will only process namespaced parametersvoid setResourceBundle(String resourceBundle)
resourceBundle - the resource bundle of the portletvoid setRestoreCurrentView(boolean restoreCurrentView)
true if the portlet restores to the current view from
the maximized state.
restoreCurrentView - boolean value for whether the portlet restores
to the current view from the maximized statevoid setRoleMappers(Map<String,String> roleMappers)
roleMappers - the role mappers of the portletvoid setRolesArray(String[] rolesArray)
rolesArray - an array of required roles of the portletvoid setSchedulerEntries(List<SchedulerEntry> schedulerEntries)
schedulerEntries - the scheduler entries of the portletvoid setScopeable(boolean scopeable)
true if the portlet supports scoping of data.
scopeable - boolean value for whether or not the the portlet
supports scoping of datavoid setShowPortletAccessDenied(boolean showPortletAccessDenied)
true if users are shown that they do not have access
to the portlet.
showPortletAccessDenied - boolean value for whether users are shown
that they do not have access to the portletvoid setShowPortletInactive(boolean showPortletInactive)
true if users are shown that the portlet is inactive.
showPortletInactive - boolean value for whether users are shown that
the portlet is inactivevoid setSinglePageApplication(boolean singlePageApplication)
true if the portlet uses Single Page Application.
singlePageApplication - boolean value for whether or not the the
portlet uses Single Page Applicationvoid setSocialActivityInterpreterClasses(List<String> socialActivityInterpreterClasses)
socialActivityInterpreterClasses - the names of the classes that
represent social activity interpreters associated with the portletvoid setSocialRequestInterpreterClass(String socialRequestInterpreterClass)
socialRequestInterpreterClass - the name of the request interpreter
class of the portletvoid setStagedModelDataHandlerClasses(List<String> stagedModelDataHandlerClasses)
stagedModelDataHandlerClasses - the names of the classes that
represent staged model data handlers associated with the portletvoid setStatic(boolean staticPortlet)
true if the portlet is a static portlet that is
cannot be moved.
staticPortlet - boolean value for whether the portlet is a static
portlet that cannot be movedvoid setStaticStart(boolean staticPortletStart)
true if the portlet is a static portlet at the start
of a list of portlets.
staticPortletStart - boolean value for whether the portlet is a
static portlet at the start of a list of portletsvoid setStrutsPath(String strutsPath)
strutsPath - the struts path of the portletvoid setSupportedLocales(Set<String> supportedLocales)
supportedLocales - the supported locales of the portletvoid setSystem(boolean system)
true if the portlet is a system portlet that a user
cannot manually add to their page.
system - boolean value for whether the portlet is a system portlet
that a user cannot manually add to their pagevoid setTemplateHandlerClass(String templateHandlerClass)
templateHandlerClass - the name of template handler class of the
portletvoid setTrashHandlerClasses(List<String> trashHandlerClasses)
trashHandlerClasses - the names of the classes that represent trash
handlers associated with the portletvoid setUndeployedPortlet(boolean undeployedPortlet)
true if the portlet is an undeployed portlet.
undeployedPortlet - boolean value for whether the portlet is an
undeployed portletvoid setUnlinkedRoles(Set<String> unlinkedRoles)
unlinkedRoles - the unlinked roles of the portletvoid setURLEncoderClass(String urlEncoderClass)
urlEncoderClass - the name of the URL encoder class of the portletvoid setUseDefaultTemplate(boolean useDefaultTemplate)
true if the portlet uses the default template.
useDefaultTemplate - boolean value for whether the portlet uses the
default templatevoid setUserNotificationDefinitions(String userNotificationDefinitions)
userNotificationDefinitions - the class loader resource path to the
user notification definitions of the portletvoid setUserNotificationHandlerClasses(List<String> userNotificationHandlerClasses)
userNotificationHandlerClasses - the names of the classes that
represent user notification handlers associated with the portletvoid setUserPrincipalStrategy(String userPrincipalStrategy)
userPrincipalStrategy - the user principal strategy of the portletvoid setVirtualPath(String virtualPath)
virtualPath - the virtual path of the portletvoid setWebDAVStorageClass(String webDAVStorageClass)
webDAVStorageClass - the name of the WebDAV storage class of the
portletvoid setWebDAVStorageToken(String webDAVStorageToken)
webDAVStorageToken - the name of the WebDAV storage token of the
portletvoid setWindowStates(Map<String,Set<String>> windowStates)
windowStates - the window states of the portletvoid setWorkflowHandlerClasses(List<String> workflowHandlerClasses)
workflowHandlerClasses - the names of the classes that represent
workflow handlers associated with the portletvoid setXmlRpcMethodClass(String xmlRpcMethodClass)
xmlRpcMethodClass - the name of the XML-RPC method class of the
portletvoid unsetReady()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||