setFooterPortalCss(List footerPortalCss) Sets a list of CSS files that will be referenced from the page's footer
relative to the portal's context path.
public void
setFooterPortalJavaScript(List footerPortalJavaScript) Sets a list of JavaScript files that will be referenced from the page's
footer relative to the portal's context path.
public void
setFooterPortletCss(List footerPortletCss) Sets a list of CSS files that will be referenced from the page's footer
relative to the portlet's context path.
public void
setFooterPortletJavaScript(List footerPortletJavaScript) Sets a list of JavaScript files that will be referenced from the page's
footer relative to the portlet's context path.
setHeaderPortalCss(List headerPortalCss) Sets a list of CSS files that will be referenced from the page's header
relative to the portal's context path.
public void
setHeaderPortalJavaScript(List headerPortalJavaScript) Sets a list of JavaScript files that will be referenced from the page's
header relative to the portal's context path.
public void
setHeaderPortletCss(List headerPortletCss) Sets a list of CSS files that will be referenced from the page's header
relative to the portlet's context path.
public void
setHeaderPortletJavaScript(List headerPortletJavaScript) Sets a list of JavaScript files that will be referenced from the page's
header relative to the portlet's context path.
setPrivateRequestAttributes(boolean privateRequestAttributes) Sets to true if the portlet does not share request attributes with the
portal or portlets from another WAR.
public void
setPrivateSessionAttributes(boolean privateSessionAttributes) Sets to true if the portlet does not share session attributes with the
portal.
public void
setRenderWeight(int renderWeight) Sets the render weight of the portlet.
Compares this portlet to the specified object.
Parameters: obj - the object to compare this portlet against the value 0 if the argument portlet is equal to thisportlet; a value less than -1 if this portlet is less thanthe portlet argument; and 1 if this portlet is greater thanthe portlet argument
Checks whether this portlet is equal to the specified object.
Parameters: obj - the object to compare this portlet against true if the portlet is equal to the specified object
Gets the name of the CSS class that will be injected in the DIV that
wraps this portlet.
the name of the CSS class that will be injected in the DIVthat wraps this portlet
Gets a list of CSS files that will be referenced from the page's footer
relative to the portal's context path.
a list of CSS files that will be referenced from the page'sfooter relative to the portal's context path
Gets a list of JavaScript files that will be referenced from the page's
footer relative to the portal's context path.
a list of JavaScript files that will be referenced from thepage's footer relative to the portal's context path
Gets a list of CSS files that will be referenced from the page's footer
relative to the portlet's context path.
a list of CSS files that will be referenced from the page'sfooter relative to the portlet's context path
Gets a list of JavaScript files that will be referenced from the page's
footer relative to the portlet's context path.
a list of JavaScript files that will be referenced from thepage's footer relative to the portlet's context path
Gets a list of CSS files that will be referenced from the page's header
relative to the portal's context path.
a list of CSS files that will be referenced from the page'sheader relative to the portal's context path
Gets a list of JavaScript files that will be referenced from the page's
header relative to the portal's context path.
a list of JavaScript files that will be referenced from thepage's header relative to the portal's context path
Gets a list of CSS files that will be referenced from the page's header
relative to the portlet's context path.
a list of CSS files that will be referenced from the page'sheader relative to the portlet's context path
Gets a list of JavaScript files that will be referenced from the page's
header relative to the portlet's context path.
a list of JavaScript files that will be referenced from thepage's header relative to the portlet's context path
Returns 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 theuser goes into the edit mode
Returns 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 theuser goes into the help mode
Returns 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 usergoes into the print mode
Returns 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 portletis shown in a group layout; false if preferences are ownedby the user at all times.
getPreferencesUniquePerLayout
public boolean getPreferencesUniquePerLayout()(Code)
Returns true if preferences are unique per layout.
true if preferences are unique per layout
Gets the name of the preferences validator class of the portlet.
the name of the preferences validator class of the portlet
getPrivateRequestAttributes
public boolean getPrivateRequestAttributes()(Code)
Returns 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 withthe portal or portlets from another WAR
getPrivateSessionAttributes
public boolean getPrivateSessionAttributes()(Code)
Returns true if the portlet does not share session attributes with the
portal.
true if the portlet does not share session attributes withthe portal
Returns true if the portlet restores to the current view from the
maximized state.
true if the portlet restores to the current view from themaximized state
Returns 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 alist of portlets
Returns 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 alist of portlets
Returns 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 cannotmanually add to their page
Returns 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 theuser goes into the edit mode
Returns 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 theuser goes into the help mode
Returns 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 usergoes into the print mode
Returns 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 portletis shown in a group layout; false if preferences are ownedby the user at all times.
isPreferencesUniquePerLayout
public boolean isPreferencesUniquePerLayout()(Code)
Returns true if preferences are unique per layout.
true if preferences are unique per layout
Returns 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 withthe portal or portlets from another WAR
Returns true if the portlet restores to the current view from the
maximized state.
true if the portlet restores to the current view from themaximized state
Returns 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 alist of portlets
Returns 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 alist of portlets
Returns 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 cannotmanually add to their page
Link the role names set in portlet.xml with the Liferay roles set in
liferay-portlet.xml.
setActionURLRedirect
public void setActionURLRedirect(boolean actionURLRedirect)(Code)
Sets to true if an action URL for this portlet should cause an auto
redirect.
Parameters: actionURLRedirect - boolean value for whether an action URLfor this portlet should cause an auto redirect
setActivityTrackerInterpreterClass
public void setActivityTrackerInterpreterClass(String activityTrackerInterpreterClass)(Code)
Sets the name of the activity tracker interpreter class of the portlet.
Parameters: activityTrackerInterpreterClass - the name of the activitytracker interpreter class of the portlet
setAddDefaultResource
public void setAddDefaultResource(boolean addDefaultResource)(Code)
Sets to true if default resources for the portlet are added to a page.
Parameters: addDefaultResource - boolean value for whether or not defaultresources for the portlet are added to a page
Sets to true if the portlet can be displayed via Ajax.
Parameters: ajaxable - boolean value for whether the portlet can bedisplayed via Ajax
setConfigurationActionClass
public void setConfigurationActionClass(String configurationActionClass)(Code)
Sets the configuration action class of the portlet.
Parameters: configurationActionClass - the configuration action class ofthe portlet
setCssClassWrapper
public void setCssClassWrapper(String cssClassWrapper)(Code)
Sets the name of the CSS class that will be injected in the DIV that
wraps this portlet.
Parameters: cssClassWrapper - the name of the CSS class that will beinjected in the DIV that wraps this portlet
setCustomUserAttributes
public void setCustomUserAttributes(Map customUserAttributes)(Code)
Sets the custom user attributes of the portlet.
Parameters: customUserAttributes - the custom user attributes of theportlet
Sets expiration cache of the portlet.
Parameters: expCache - expiration cache of the portlet
setFooterPortalCss
public void setFooterPortalCss(List footerPortalCss)(Code)
Sets a list of CSS files that will be referenced from the page's footer
relative to the portal's context path.
Parameters: footerPortalCss - a list of CSS files that will be referencedfrom the page's footer relative to the portal's context path
setFooterPortalJavaScript
public void setFooterPortalJavaScript(List footerPortalJavaScript)(Code)
Sets a list of JavaScript files that will be referenced from the page's
footer relative to the portal's context path.
Parameters: footerPortalJavaScript - a list of JavaScript files that willbe referenced from the page's footer relative to theportal's context path
setFooterPortletCss
public void setFooterPortletCss(List footerPortletCss)(Code)
Sets a list of CSS files that will be referenced from the page's footer
relative to the portlet's context path.
Parameters: footerPortletCss - a list of CSS files that will be referencedfrom the page's footer relative to the portlet's contextpath
setFooterPortletJavaScript
public void setFooterPortletJavaScript(List footerPortletJavaScript)(Code)
Sets a list of JavaScript files that will be referenced from the page's
footer relative to the portlet's context path.
Parameters: footerPortletJavaScript - a list of JavaScript files that willbe referenced from the page's footer relative to theportlet's context path
setFriendlyURLMapperClass
public void setFriendlyURLMapperClass(String friendlyURLMapperClass)(Code)
Sets the name of the friendly URL mapper class of the portlet.
Parameters: friendlyURLMapperClass - the name of the friendly URL pluginclass of the portlet
setHeaderPortalCss
public void setHeaderPortalCss(List headerPortalCss)(Code)
Sets a list of CSS files that will be referenced from the page's header
relative to the portal's context path.
Parameters: headerPortalCss - a list of CSS files that will be referencedfrom the page's header relative to the portal's context path
setHeaderPortalJavaScript
public void setHeaderPortalJavaScript(List headerPortalJavaScript)(Code)
Sets a list of JavaScript files that will be referenced from the page's
header relative to the portal's context path.
Parameters: headerPortalJavaScript - a list of JavaScript files that willbe referenced from the page's header relative to theportal's context path
setHeaderPortletCss
public void setHeaderPortletCss(List headerPortletCss)(Code)
Sets a list of CSS files that will be referenced from the page's header
relative to the portlet's context path.
Parameters: headerPortletCss - a list of CSS files that will be referencedfrom the page's header relative to the portlet's contextpath
setHeaderPortletJavaScript
public void setHeaderPortletJavaScript(List headerPortletJavaScript)(Code)
Sets a list of JavaScript files that will be referenced from the page's
header relative to the portlet's context path.
Parameters: headerPortletJavaScript - a list of JavaScript files that willbe referenced from the page's header relative to theportlet's context path
Sets to true to include the portlet and make it available to be made
active.
Parameters: include - boolean value for whether to include the portlet andmake it available to be made active
setIndexerClass
public void setIndexerClass(String indexerClass)(Code)
Sets the name of the indexer class of the portlet.
Parameters: indexerClass - the name of the indexer class of the portlet
Sets the init parameters of the portlet.
Parameters: initParams - the init parameters of the portlet
setInstanceable
public void setInstanceable(boolean instanceable)(Code)
Sets to true if the portlet can be added multiple times to a layout.
Parameters: instanceable - boolean value for whether the portlet can beadded multiple times to a layout
setLayoutCacheable
public void setLayoutCacheable(boolean layoutCacheable)(Code)
Sets to true to allow the portlet to be cached within the layout.
Parameters: layoutCacheable - boolean value for whether the portlet can becached within the layout
setMaximizeEdit
public void setMaximizeEdit(boolean maximizeEdit)(Code)
Sets to true if the portlet goes into the maximized state when the user
goes into the edit mode.
Parameters: maximizeEdit - boolean value for whether the portlet goes intothe maximized state when the user goes into the edit mode
setMaximizeHelp
public void setMaximizeHelp(boolean maximizeHelp)(Code)
Sets to true if the portlet goes into the maximized state when the user
goes into the help mode.
Parameters: maximizeHelp - boolean value for whether the portlet goes intothe maximized state when the user goes into the help mode
setOpenSearchClass
public void setOpenSearchClass(String openSearchClass)(Code)
Sets the name of the open search class of the portlet.
Parameters: openSearchClass - the name of the open search class of theportlet
Sets the plugin package to which this portlet belongs to.
Parameters: pluginPackage - the plugin package
setPopMessageListenerClass
public void setPopMessageListenerClass(String popMessageListenerClass)(Code)
Sets the name of the POP message listener class of the portlet.
Parameters: popMessageListenerClass - the name of the POP message listenerclass of the portlet
setPopUpPrint
public void setPopUpPrint(boolean popUpPrint)(Code)
Sets to true if the portlet goes into the pop up state when the user goes
into the print mode.
Parameters: popUpPrint - boolean value for whether the portlet goes intothe pop up state when the user goes into the print mode
setPortletClass
public void setPortletClass(String portletClass)(Code)
Sets the name of the portlet class of the portlet.
Parameters: portletClass - the name of the portlet class of the portlet
setPortletDataHandlerClass
public void setPortletDataHandlerClass(String portletDataHandlerClass)(Code)
Sets the name of the portlet data handler class of the portlet.
Parameters: portletDataHandlerClass - the name of portlet data handlerclass of the portlet
Sets the portlet info of the portlet.
Parameters: portletInfo - the portlet info of the portlet
setPortletLayoutListenerClass
public void setPortletLayoutListenerClass(String portletLayoutListenerClass)(Code)
Sets the name of the portlet layout listener class of the portlet.
Parameters: portletLayoutListenerClass - the name of the portlet layoutlistener class of the portlet
setPortletModes
public void setPortletModes(Map portletModes)(Code)
Sets the portlet modes of the portlet.
Parameters: portletModes - the portlet modes of the portlet
setPortletURLClass
public void setPortletURLClass(String portletURLClass)(Code)
Sets the name of the portlet URL class of the portlet.
Parameters: portletURLClass - the name of the portlet URL class of theportlet
setPreferencesCompanyWide
public void setPreferencesCompanyWide(boolean prefsCompanyWide)(Code)
Sets to true if preferences are shared across the entire company.
Parameters: prefsCompanyWide - boolean value for whether preferencesare shared across the entire company
setPreferencesOwnedByGroup
public void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup)(Code)
Sets to true if preferences are owned by the group when the portlet is
shown in a group layout. Sets to false if preferences are owned by the
user at all times.
Parameters: prefsOwnedByGroup - boolean value for whether preferences areowned by the group when the portlet is shown in a grouplayout or preferences are owned by the user at all times
setPreferencesUniquePerLayout
public void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout)(Code)
Sets to true if preferences are unique per layout.
Parameters: prefsUniquePerLayout - boolean value for whether preferencesare unique per layout
setPreferencesValidator
public void setPreferencesValidator(String prefsValidator)(Code)
Sets the name of the preferences validator class of the portlet.
Parameters: prefsValidator - the name of the preferences validator classof the portlet
setPrivateRequestAttributes
public void setPrivateRequestAttributes(boolean privateRequestAttributes)(Code)
Sets to true if the portlet does not share request attributes with the
portal or portlets from another WAR.
Parameters: privateRequestAttributes - boolean value for whether theportlet shares request attributes with the portal orportlets from another WAR
setPrivateSessionAttributes
public void setPrivateSessionAttributes(boolean privateSessionAttributes)(Code)
Sets to true if the portlet does not share session attributes with the
portal.
Parameters: privateSessionAttributes - boolean value for whether theportlet shares session attributes with the portal
setRenderWeight
public void setRenderWeight(int renderWeight)(Code)
Sets the render weight of the portlet.
Parameters: renderWeight - int value for the render weight of the portlet
setResourceBundle
public void setResourceBundle(String resourceBundle)(Code)
Sets the resource bundle of the portlet.
Parameters: resourceBundle - the resource bundle of the portlet
setRestoreCurrentView
public void setRestoreCurrentView(boolean restoreCurrentView)(Code)
Sets to true if the portlet restores to the current view from the
maximized state.
Parameters: restoreCurrentView - boolean value for whether the portletrestores to the current view from the maximized state
Sets a string of ordered comma delimited portlet ids.
Parameters: roles - a string of ordered comma delimited portlet ids
setRolesArray
public void setRolesArray(String[] rolesArray)(Code)
Sets an array of required roles of the portlet.
Parameters: rolesArray - an array of required roles of the portlet
setSchedulerClass
public void setSchedulerClass(String schedulerClass)(Code)
Sets the name of the scheduler class of the portlet.
Parameters: schedulerClass - the name of the scheduler class of theportlet
setServletContextName
public void setServletContextName(String servletContextName)(Code)
Sets the servlet context name of the portlet.
Parameters: servletContextName - the servlet context name of the portlet
setServletURLPatterns
public void setServletURLPatterns(List servletURLPatterns)(Code)
The servlet url patterns that are part of this application.
Parameters: servletURLPatterns - servlet url patterns that are part ofthis application
setShowPortletAccessDenied
public void setShowPortletAccessDenied(boolean showPortletAccessDenied)(Code)
Sets to true if users are shown that they do not have access to the
portlet.
Parameters: showPortletAccessDenied - boolean value for whether users areshown that they do not have access to the portlet
setShowPortletInactive
public void setShowPortletInactive(boolean showPortletInactive)(Code)
Sets to true if users are shown that the portlet is inactive.
Parameters: showPortletInactive - boolean value for whether users areshown that the portlet is inactive
setStatic
public void setStatic(boolean staticPortlet)(Code)
Sets to true if the portlet is a static portlet that is cannot be moved.
Parameters: staticPortlet - boolean value for whether the portlet is astatic portlet that cannot be moved
setStaticStart
public void setStaticStart(boolean staticPortletStart)(Code)
Sets to true if the portlet is a static portlet at the start of a list of
portlets.
Parameters: staticPortletStart - boolean value for whether the portlet isa static portlet at the start of a list of portlets
setStrutsPath
public void setStrutsPath(String strutsPath)(Code)
Sets the struts path of the portlet.
Parameters: strutsPath - the struts path of the portlet
setSupportedLocales
public void setSupportedLocales(Set supportedLocales)(Code)
Sets the supported locales of the portlet.
Parameters: supportedLocales - the supported locales of the portlet
Sets to true if the portlet is a system portlet that a user cannot
manually add to their page.
Parameters: system - boolean value for whether the portlet is a systemportlet that a user cannot manually add to their page
setURLEncoderClass
public void setURLEncoderClass(String urlEncoderClass)(Code)
Sets the name of the URL encoder class of the portlet.
Parameters: urlEncoderClass - the name of the URL encoder class of theportlet
setUnlinkedRoles
public void setUnlinkedRoles(Set unlinkedRoles)(Code)
Sets the unlinked roles of the portlet.
Parameters: unlinkedRoles - the unlinked roles of the portlet
setUseDefaultTemplate
public void setUseDefaultTemplate(boolean useDefaultTemplate)(Code)
Sets to true if the portlet uses the default template.
Parameters: useDefaultTemplate - boolean value for whether the portletuses the default template
setUserAttributes
public void setUserAttributes(Set userAttributes)(Code)
Sets the user attributes of the portlet.
Parameters: userAttributes - the user attributes of the portlet
setUserPrincipalStrategy
public void setUserPrincipalStrategy(String userPrincipalStrategy)(Code)
Sets the user principal strategy of the portlet.
Parameters: userPrincipalStrategy - the user principal strategy of theportlet
setVirtualPath
public void setVirtualPath(String virtualPath)(Code)
Sets the virtual path of the portlet.
Parameters: virtualPath - the virtual path of the portlet