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