Java Doc for PortletImpl.java in  » Portal » liferay-portal-4.4.2 » com » liferay » portal » model » impl » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » liferay portal 4.4.2 » com.liferay.portal.model.impl 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.liferay.portal.model.impl.BaseModelImpl
      com.liferay.portal.model.impl.PortletModelImpl
         com.liferay.portal.model.impl.PortletImpl

PortletImpl
public class PortletImpl extends PortletModelImpl implements Portlet(Code)
View Source
author:
   Brian Wing Shun Chan


Field Summary
final public static  StringDEFAULT_PREFERENCES
     Default preferences.
final public static  StringINSTANCE_SEPARATOR
     Instance separator.
final public static  StringLAYOUT_SEPARATOR
     Layout separator.
final public static  StringPLUGIN_TYPE
    
final public static  StringUSER_PRINCIPAL_STRATEGY_SCREEN_NAME
     User principal strategy for screen name.
final public static  StringUSER_PRINCIPAL_STRATEGY_USER_ID
     User principal strategy for screen name.
final public static  StringWAR_SEPARATOR
     War file separator.

Constructor Summary
public  PortletImpl()
     Constructs a portlet with no parameters.
public  PortletImpl(long companyId, String portletId)
     Constructs a portlet with the specified parameters.
public  PortletImpl(String portletId, PluginPackage pluginPackage, PluginSetting pluginSetting, long companyId, String icon, String virtualPath, String strutsPath, String displayName, String portletClass, String configurationActionClass, String indexerClass, String openSearchClass, String schedulerClass, String portletURLClass, String friendlyURLMapperClass, String urlEncoderClass, String portletDataHandlerClass, String portletLayoutListenerClass, String activityTrackerInterpreterClass, String popMessageListenerClass, String defaultPreferences, String prefsValidator, boolean prefsCompanyWide, boolean prefsUniquePerLayout, boolean prefsOwnedByGroup, boolean useDefaultTemplate, boolean showPortletAccessDenied, boolean showPortletInactive, boolean actionURLRedirect, boolean restoreCurrentView, boolean maximizeEdit, boolean maximizeHelp, boolean popUpPrint, boolean layoutCacheable, boolean instanceable, String userPrincipalStrategy, boolean privateRequestAttributes, boolean privateSessionAttributes, int renderWeight, boolean ajaxable, List headerPortalCss, List headerPortletCss, List headerPortalJavaScript, List headerPortletJavaScript, List footerPortalCss, List footerPortletCss, List footerPortalJavaScript, List footerPortletJavaScript, String cssClassWrapper, boolean addDefaultResource, String roles, Set unlinkedRoles, Map roleMappers, boolean system, boolean active, boolean include, Map initParams, Integer expCache, Map portletModes, Set supportedLocales, String resourceBundle, PortletInfo portletInfo, Set userAttributes, Map customUserAttributes, String servletContextName, List servletURLPatterns)
     Constructs a portlet with the specified parameters.

Method Summary
public  Objectclone()
     Creates and returns a copy of this object.
public  intcompareTo(Object obj)
     Compares this portlet to the specified object.
public  booleanequals(Object obj)
     Checks whether this portlet is equal to the specified object.
public  booleangetActionURLRedirect()
     Returns true if an action URL for this portlet should cause an auto redirect.
public  StringgetActivityTrackerInterpreterClass()
     Gets the name of the activity tracker interpreter class of the portlet.
public  ActivityTrackerInterpretergetActivityTrackerInterpreterInstance()
     Gets the name of the activity tracker interpreter instance of the portlet.
public  booleangetAddDefaultResource()
     Returns true if default resources for the portlet are added to a page.
public  booleangetAjaxable()
     Returns true if the portlet can be displayed via Ajax.
public  SetgetAllPortletModes()
     Gets a list of all portlet modes supported by the portlet.
public  PortletgetClonedInstance(String portletId)
     Returns true if the portlet is found in a WAR file.
public  StringgetConfigurationActionClass()
     Gets the configuration action class of the portlet.
public  ConfigurationActiongetConfigurationActionInstance()
     Gets the configuration action instance of the portlet.
public  StringgetContextPath()
     Gets the servlet context path of the portlet.
public  StringgetCssClassWrapper()
     Gets the name of the CSS class that will be injected in the DIV that wraps this portlet.
public  MapgetCustomUserAttributes()
     Gets the custom user attributes of the portlet.
public  PluginSettinggetDefaultPluginSetting()
     Get the default plugin settings of the portlet.
public  StringgetDefaultPreferences()
     Gets the default preferences of the portlet.
public  StringgetDisplayName()
     Gets the display name of the portlet.
public  IntegergetExpCache()
     Gets expiration cache of the portlet.
public  ListgetFooterPortalCss()
     Gets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.
public  ListgetFooterPortalJavaScript()
     Gets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.
public  ListgetFooterPortletCss()
     Gets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.
public  ListgetFooterPortletJavaScript()
     Gets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.
public  StringgetFriendlyURLMapperClass()
     Gets the name of the friendly URL mapper class of the portlet.
public  FriendlyURLMappergetFriendlyURLMapperInstance()
     Gets the friendly URL mapper instance of the portlet.
public  ListgetHeaderPortalCss()
     Gets a list of CSS files that will be referenced from the page's header relative to the portal's context path.
public  ListgetHeaderPortalJavaScript()
     Gets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.
public  ListgetHeaderPortletCss()
     Gets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.
public  ListgetHeaderPortletJavaScript()
     Gets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.
public  StringgetIcon()
     Gets the icon of the portlet.
public  booleangetInclude()
     Returns true to include the portlet and make it available to be made active.
public  StringgetIndexerClass()
     Gets the name of the indexer class of the portlet.
public  MapgetInitParams()
     Gets the init parameters of the portlet.
public static  StringgetInstanceId(String portletId)
     Gets the instance id of the portlet.
public  StringgetInstanceId()
     Gets the instance id of the portlet.
public  booleangetInstanceable()
     Returns true if the portlet can be added multiple times to a layout.
public  booleangetLayoutCacheable()
     Returns true to allow the portlet to be cached within the layout.
public  booleangetMaximizeEdit()
     Returns true if the portlet goes into the maximized state when the user goes into the edit mode.
public  booleangetMaximizeHelp()
     Returns true if the portlet goes into the maximized state when the user goes into the help mode.
public  StringgetOpenSearchClass()
     Gets the name of the open search class of the portlet.
public  StringgetPluginId()
     Gets the plugin id of the portlet.
public  PluginPackagegetPluginPackage()
     Get the package to which the portlet belongs to.
public  StringgetPluginType()
     Gets the plugin type of the portlet.
public  StringgetPopMessageListenerClass()
     Gets the name of the POP message listener class of the portlet.
public  MessageListenergetPopMessageListenerInstance()
     Gets the POP message listener instance of the portlet.
public  booleangetPopUpPrint()
     Returns true if the portlet goes into the pop up state when the user goes into the print mode.
public  StringgetPortletClass()
     Gets the name of the portlet class of the portlet.
public  StringgetPortletDataHandlerClass()
     Gets the name of the portlet data handler class of the portlet.
public  PortletDataHandlergetPortletDataHandlerInstance()
     Gets the portlet data handler instance of the portlet.
public  PortletInfogetPortletInfo()
     Gets the portlet info of the portlet.
public  PortletLayoutListenergetPortletLayoutListener()
     Gets the portlet layout listener of the portlet.
public  StringgetPortletLayoutListenerClass()
     Gets the name of the portlet layout listener class of the portlet.
public  MapgetPortletModes()
     Gets the portlet modes of the portlet.
public  StringgetPortletURLClass()
     Gets the name of the portlet URL class of the portlet.
public  booleangetPreferencesCompanyWide()
     Returns true if preferences are shared across the entire company.
public  booleangetPreferencesOwnedByGroup()
     Returns true if preferences are owned by the group when the portlet is shown in a group layout.
public  booleangetPreferencesUniquePerLayout()
     Returns true if preferences are unique per layout.
public  StringgetPreferencesValidator()
     Gets the name of the preferences validator class of the portlet.
public  booleangetPrivateRequestAttributes()
     Returns true if the portlet does not share request attributes with the portal or portlets from another WAR.
public  booleangetPrivateSessionAttributes()
     Returns true if the portlet does not share session attributes with the portal.
public  intgetRenderWeight()
     Returns the render weight of the portlet.
public  StringgetResourceBundle()
     Gets the resource bundle of the portlet.
public  booleangetRestoreCurrentView()
     Returns true if the portlet restores to the current view from the maximized state.
public  MapgetRoleMappers()
     Gets the role mappers of the portlet.
public  String[]getRolesArray()
     Gets an array of required roles of the portlet.
public static  StringgetRootPortletId(String portletId)
     Gets the root portlet id of the portlet.
public  StringgetRootPortletId()
     Gets the root portlet id of the portlet.
public  StringgetSchedulerClass()
     Gets the name of the scheduler class of the portlet.
public  StringgetServletContextName()
     Gets the servlet context name of the portlet.
public  ListgetServletURLPatterns()
     The servlet url patterns that are part of this application.
public  booleangetShowPortletAccessDenied()
     Returns true if users are shown that they do not have access to the portlet.
public  booleangetShowPortletInactive()
     Returns true if users are shown that the portlet is inactive.
public  booleangetStatic()
     Returns true if the portlet is a static portlet that is cannot be moved.
public  booleangetStaticEnd()
     Returns true if the portlet is a static portlet at the end of a list of portlets.
public  booleangetStaticStart()
     Returns true if the portlet is a static portlet at the start of a list of portlets.
public  StringgetStrutsPath()
     Gets the struts path of the portlet.
public  SetgetSupportedLocales()
     Gets the supported locales of the portlet.
public  booleangetSystem()
     Returns true if the portlet is a system portlet that a user cannot manually add to their page.
public  StringgetURLEncoderClass()
     Gets the name of the URL encoder class of the portlet.
public  URLEncodergetURLEncoderInstance()
     Gets the URL encoder instance of the portlet.
public  SetgetUnlinkedRoles()
     Gets the unlinked roles of the portlet.
public  booleangetUseDefaultTemplate()
     Returns true if the portlet uses the default template.
public  SetgetUserAttributes()
     Gets the user attributes of the portlet.
public  StringgetUserPrincipalStrategy()
     Gets the user principal strategy of the portlet.
public  StringgetVirtualPath()
     Gets the virtual path of the portlet.
public  booleangetWARFile()
     Returns true if the portlet is found in a WAR file.
public  booleanhasAddPortletPermission(long userId)
     Returns true if the user has the permission to add the portlet to a layout.
public  booleanhasMultipleMimeTypes()
     Returns true if the portlet supports more than one mime type.
public  booleanhasPortletMode(String mimeType, PortletMode portletMode)
     Returns true if the portlet supports the specified mime type and portlet mode.
public  booleanhasRoleWithName(String roleName)
     Returns true if the portlet has a role with the specified name.
public  booleanisActionURLRedirect()
     Returns true if an action URL for this portlet should cause an auto redirect.
public  booleanisAddDefaultResource()
     Returns true if default resources for the portlet are added to a page.
public  booleanisAjaxable()
     Returns true if the portlet can be displayed via Ajax.
public  booleanisInclude()
     Returns true to include the portlet and make it available to be made active.
public  booleanisInstanceable()
     Returns true if the portlet can be added multiple times to a layout.
public  booleanisLayoutCacheable()
     Returns true to allow the portlet to be cached within the layout.
public  booleanisMaximizeEdit()
     Returns true if the portlet goes into the maximized state when the user goes into the edit mode.
public  booleanisMaximizeHelp()
     Returns true if the portlet goes into the maximized state when the user goes into the help mode.
public  booleanisPopUpPrint()
     Returns true if the portlet goes into the pop up state when the user goes into the print mode.
public  booleanisPreferencesCompanyWide()
     Returns true if preferences are shared across the entire company.
public  booleanisPreferencesOwnedByGroup()
     Returns true if preferences are owned by the group when the portlet is shown in a group layout.
public  booleanisPreferencesUniquePerLayout()
     Returns true if preferences are unique per layout.
public  booleanisPrivateRequestAttributes()
     Returns true if the portlet does not share request attributes with the portal or portlets from another WAR.
public  booleanisPrivateSessionAttributes()
     Returns true if the portlet does not share session attributes with the portal.
public  booleanisRestoreCurrentView()
     Returns true if the portlet restores to the current view from the maximized state.
public  booleanisShowPortletAccessDenied()
     Returns true if users are shown that they do not have access to the portlet.
public  booleanisShowPortletInactive()
     Returns true if users are shown that the portlet is inactive.
public  booleanisStatic()
     Returns true if the portlet is a static portlet that is cannot be moved.
public  booleanisStaticEnd()
     Returns true if the portlet is a static portlet at the end of a list of portlets.
public  booleanisStaticStart()
     Returns true if the portlet is a static portlet at the start of a list of portlets.
public  booleanisSystem()
     Returns true if the portlet is a system portlet that a user cannot manually add to their page.
public  booleanisUseDefaultTemplate()
     Returns true if the portlet uses the default template.
public  booleanisWARFile()
     Returns true if the portlet is found in a WAR file.
public  voidlinkRoles()
     Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.
public  voidsetActionURLRedirect(boolean actionURLRedirect)
     Sets to true if an action URL for this portlet should cause an auto redirect.
public  voidsetActivityTrackerInterpreterClass(String activityTrackerInterpreterClass)
     Sets the name of the activity tracker interpreter class of the portlet.
public  voidsetAddDefaultResource(boolean addDefaultResource)
     Sets to true if default resources for the portlet are added to a page.
public  voidsetAjaxable(boolean ajaxable)
     Sets to true if the portlet can be displayed via Ajax.
public  voidsetConfigurationActionClass(String configurationActionClass)
     Sets the configuration action class of the portlet.
public  voidsetCssClassWrapper(String cssClassWrapper)
     Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.
public  voidsetCustomUserAttributes(Map customUserAttributes)
     Sets the custom user attributes of the portlet.
public  voidsetDefaultPluginSetting(PluginSetting pluginSetting)
     Sets the default plugin settings of the portlet.
public  voidsetDefaultPreferences(String defaultPreferences)
     Sets the default preferences of the portlet.
public  voidsetDisplayName(String displayName)
     Sets the display name of the portlet.
public  voidsetExpCache(Integer expCache)
     Sets expiration cache of the portlet.
public  voidsetFooterPortalCss(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  voidsetFooterPortalJavaScript(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  voidsetFooterPortletCss(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  voidsetFooterPortletJavaScript(List footerPortletJavaScript)
     Sets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.
public  voidsetFriendlyURLMapperClass(String friendlyURLMapperClass)
     Sets the name of the friendly URL mapper class of the portlet.
public  voidsetHeaderPortalCss(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  voidsetHeaderPortalJavaScript(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  voidsetHeaderPortletCss(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  voidsetHeaderPortletJavaScript(List headerPortletJavaScript)
     Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.
public  voidsetIcon(String icon)
     Sets the icon of the portlet.
public  voidsetInclude(boolean include)
     Sets to true to include the portlet and make it available to be made active.
public  voidsetIndexerClass(String indexerClass)
     Sets the name of the indexer class of the portlet.
public  voidsetInitParams(Map initParams)
     Sets the init parameters of the portlet.
public  voidsetInstanceable(boolean instanceable)
     Sets to true if the portlet can be added multiple times to a layout.
public  voidsetLayoutCacheable(boolean layoutCacheable)
     Sets to true to allow the portlet to be cached within the layout.
public  voidsetMaximizeEdit(boolean maximizeEdit)
     Sets to true if the portlet goes into the maximized state when the user goes into the edit mode.
public  voidsetMaximizeHelp(boolean maximizeHelp)
     Sets to true if the portlet goes into the maximized state when the user goes into the help mode.
public  voidsetOpenSearchClass(String openSearchClass)
     Sets the name of the open search class of the portlet.
public  voidsetPluginPackage(PluginPackage pluginPackage)
     Sets the plugin package to which this portlet belongs to.
public  voidsetPopMessageListenerClass(String popMessageListenerClass)
     Sets the name of the POP message listener class of the portlet.
public  voidsetPopUpPrint(boolean popUpPrint)
     Sets to true if the portlet goes into the pop up state when the user goes into the print mode.
public  voidsetPortletClass(String portletClass)
     Sets the name of the portlet class of the portlet.
public  voidsetPortletDataHandlerClass(String portletDataHandlerClass)
     Sets the name of the portlet data handler class of the portlet.
public  voidsetPortletInfo(PortletInfo portletInfo)
     Sets the portlet info of the portlet.
public  voidsetPortletLayoutListenerClass(String portletLayoutListenerClass)
     Sets the name of the portlet layout listener class of the portlet.
public  voidsetPortletModes(Map portletModes)
     Sets the portlet modes of the portlet.
public  voidsetPortletURLClass(String portletURLClass)
     Sets the name of the portlet URL class of the portlet.
public  voidsetPreferencesCompanyWide(boolean prefsCompanyWide)
     Sets to true if preferences are shared across the entire company.
public  voidsetPreferencesOwnedByGroup(boolean prefsOwnedByGroup)
     Sets to true if preferences are owned by the group when the portlet is shown in a group layout.
public  voidsetPreferencesUniquePerLayout(boolean prefsUniquePerLayout)
     Sets to true if preferences are unique per layout.
public  voidsetPreferencesValidator(String prefsValidator)
     Sets the name of the preferences validator class of the portlet.
public  voidsetPrivateRequestAttributes(boolean privateRequestAttributes)
     Sets to true if the portlet does not share request attributes with the portal or portlets from another WAR.
public  voidsetPrivateSessionAttributes(boolean privateSessionAttributes)
     Sets to true if the portlet does not share session attributes with the portal.
public  voidsetRenderWeight(int renderWeight)
     Sets the render weight of the portlet.
public  voidsetResourceBundle(String resourceBundle)
     Sets the resource bundle of the portlet.
public  voidsetRestoreCurrentView(boolean restoreCurrentView)
     Sets to true if the portlet restores to the current view from the maximized state.
public  voidsetRoleMappers(Map roleMappers)
     Sets the role mappers of the portlet.
public  voidsetRoles(String roles)
     Sets a string of ordered comma delimited portlet ids.
public  voidsetRolesArray(String[] rolesArray)
     Sets an array of required roles of the portlet.
public  voidsetSchedulerClass(String schedulerClass)
     Sets the name of the scheduler class of the portlet.
public  voidsetServletContextName(String servletContextName)
     Sets the servlet context name of the portlet.
public  voidsetServletURLPatterns(List servletURLPatterns)
     The servlet url patterns that are part of this application.
public  voidsetShowPortletAccessDenied(boolean showPortletAccessDenied)
     Sets to true if users are shown that they do not have access to the portlet.
public  voidsetShowPortletInactive(boolean showPortletInactive)
     Sets to true if users are shown that the portlet is inactive.
public  voidsetStatic(boolean staticPortlet)
     Sets to true if the portlet is a static portlet that is cannot be moved.
public  voidsetStaticStart(boolean staticPortletStart)
     Sets to true if the portlet is a static portlet at the start of a list of portlets.
public  voidsetStrutsPath(String strutsPath)
     Sets the struts path of the portlet.
public  voidsetSupportedLocales(Set supportedLocales)
     Sets the supported locales of the portlet.
public  voidsetSystem(boolean system)
     Sets to true if the portlet is a system portlet that a user cannot manually add to their page.
public  voidsetURLEncoderClass(String urlEncoderClass)
     Sets the name of the URL encoder class of the portlet.
public  voidsetUnlinkedRoles(Set unlinkedRoles)
     Sets the unlinked roles of the portlet.
public  voidsetUseDefaultTemplate(boolean useDefaultTemplate)
     Sets to true if the portlet uses the default template.
public  voidsetUserAttributes(Set userAttributes)
     Sets the user attributes of the portlet.
public  voidsetUserPrincipalStrategy(String userPrincipalStrategy)
     Sets the user principal strategy of the portlet.
public  voidsetVirtualPath(String virtualPath)
     Sets the virtual path of the portlet.
public  voidsetWARFile(boolean warFile)
     Sets to true if the portlet is found in a WAR file.

Field Detail
DEFAULT_PREFERENCES
final public static String DEFAULT_PREFERENCES(Code)
Default preferences.



INSTANCE_SEPARATOR
final public static String INSTANCE_SEPARATOR(Code)
Instance separator.



LAYOUT_SEPARATOR
final public static String LAYOUT_SEPARATOR(Code)
Layout separator.



PLUGIN_TYPE
final public static String PLUGIN_TYPE(Code)
Plugin type



USER_PRINCIPAL_STRATEGY_SCREEN_NAME
final public static String USER_PRINCIPAL_STRATEGY_SCREEN_NAME(Code)
User principal strategy for screen name.



USER_PRINCIPAL_STRATEGY_USER_ID
final public static String USER_PRINCIPAL_STRATEGY_USER_ID(Code)
User principal strategy for screen name.



WAR_SEPARATOR
final public static String WAR_SEPARATOR(Code)
War file separator.




Constructor Detail
PortletImpl
public PortletImpl()(Code)
Constructs a portlet with no parameters.



PortletImpl
public PortletImpl(long companyId, String portletId)(Code)
Constructs a portlet with the specified parameters.



PortletImpl
public PortletImpl(String portletId, PluginPackage pluginPackage, PluginSetting pluginSetting, long companyId, String icon, String virtualPath, String strutsPath, String displayName, String portletClass, String configurationActionClass, String indexerClass, String openSearchClass, String schedulerClass, String portletURLClass, String friendlyURLMapperClass, String urlEncoderClass, String portletDataHandlerClass, String portletLayoutListenerClass, String activityTrackerInterpreterClass, String popMessageListenerClass, String defaultPreferences, String prefsValidator, boolean prefsCompanyWide, boolean prefsUniquePerLayout, boolean prefsOwnedByGroup, boolean useDefaultTemplate, boolean showPortletAccessDenied, boolean showPortletInactive, boolean actionURLRedirect, boolean restoreCurrentView, boolean maximizeEdit, boolean maximizeHelp, boolean popUpPrint, boolean layoutCacheable, boolean instanceable, String userPrincipalStrategy, boolean privateRequestAttributes, boolean privateSessionAttributes, int renderWeight, boolean ajaxable, List headerPortalCss, List headerPortletCss, List headerPortalJavaScript, List headerPortletJavaScript, List footerPortalCss, List footerPortletCss, List footerPortalJavaScript, List footerPortletJavaScript, String cssClassWrapper, boolean addDefaultResource, String roles, Set unlinkedRoles, Map roleMappers, boolean system, boolean active, boolean include, Map initParams, Integer expCache, Map portletModes, Set supportedLocales, String resourceBundle, PortletInfo portletInfo, Set userAttributes, Map customUserAttributes, String servletContextName, List servletURLPatterns)(Code)
Constructs a portlet with the specified parameters.




Method Detail
clone
public Object clone()(Code)
Creates and returns a copy of this object. a copy of this object



compareTo
public int compareTo(Object obj)(Code)
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



equals
public boolean equals(Object obj)(Code)
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



getActionURLRedirect
public boolean getActionURLRedirect()(Code)
Returns true if an action URL for this portlet should cause an auto redirect. true if an action URL for this portlet should cause an autoredirect



getActivityTrackerInterpreterClass
public String getActivityTrackerInterpreterClass()(Code)
Gets the name of the activity tracker interpreter class of the portlet. the name of the activity tracker interpreter class of theportlet



getActivityTrackerInterpreterInstance
public ActivityTrackerInterpreter getActivityTrackerInterpreterInstance()(Code)
Gets the name of the activity tracker interpreter instance of the portlet. the name of the activity tracker interpreter instance of theportlet



getAddDefaultResource
public boolean getAddDefaultResource()(Code)
Returns true if default resources for the portlet are added to a page. true if default resources for the portlet are added to apage



getAjaxable
public boolean getAjaxable()(Code)
Returns true if the portlet can be displayed via Ajax. true if the portlet can be displayed via Ajax



getAllPortletModes
public Set getAllPortletModes()(Code)
Gets a list of all portlet modes supported by the portlet. a list of all portlet modes supported by the portlet



getClonedInstance
public Portlet getClonedInstance(String portletId)(Code)
Returns true if the portlet is found in a WAR file.
Parameters:
  portletId - the cloned instance portlet id a cloned instance of the portlet



getConfigurationActionClass
public String getConfigurationActionClass()(Code)
Gets the configuration action class of the portlet. the configuration action class of the portlet



getConfigurationActionInstance
public ConfigurationAction getConfigurationActionInstance()(Code)
Gets the configuration action instance of the portlet. the configuration action instance of the portlet



getContextPath
public String getContextPath()(Code)
Gets the servlet context path of the portlet. the servlet context path of the portlet



getCssClassWrapper
public String getCssClassWrapper()(Code)
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



getCustomUserAttributes
public Map getCustomUserAttributes()(Code)
Gets the custom user attributes of the portlet. custom user attributes of the portlet



getDefaultPluginSetting
public PluginSetting getDefaultPluginSetting()(Code)
Get the default plugin settings of the portlet. the plugin settings



getDefaultPreferences
public String getDefaultPreferences()(Code)
Gets the default preferences of the portlet. the default preferences of the portlet



getDisplayName
public String getDisplayName()(Code)
Gets the display name of the portlet. the display name of the portlet



getExpCache
public Integer getExpCache()(Code)
Gets expiration cache of the portlet. expiration cache of the portlet



getFooterPortalCss
public List getFooterPortalCss()(Code)
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



getFooterPortalJavaScript
public List getFooterPortalJavaScript()(Code)
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



getFooterPortletCss
public List getFooterPortletCss()(Code)
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



getFooterPortletJavaScript
public List getFooterPortletJavaScript()(Code)
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



getFriendlyURLMapperClass
public String getFriendlyURLMapperClass()(Code)
Gets the name of the friendly URL mapper class of the portlet. the name of the friendly URL mapper class of the portlet



getFriendlyURLMapperInstance
public FriendlyURLMapper getFriendlyURLMapperInstance()(Code)
Gets the friendly URL mapper instance of the portlet. the friendly URL mapper instance of the portlet



getHeaderPortalCss
public List getHeaderPortalCss()(Code)
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



getHeaderPortalJavaScript
public List getHeaderPortalJavaScript()(Code)
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



getHeaderPortletCss
public List getHeaderPortletCss()(Code)
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



getHeaderPortletJavaScript
public List getHeaderPortletJavaScript()(Code)
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



getIcon
public String getIcon()(Code)
Gets the icon of the portlet. the icon of the portlet



getInclude
public boolean getInclude()(Code)
Returns true to include the portlet and make it available to be made active. true to include the portlet and make it available to be madeactive



getIndexerClass
public String getIndexerClass()(Code)
Gets the name of the indexer class of the portlet. the name of the indexer class of the portlet



getInitParams
public Map getInitParams()(Code)
Gets the init parameters of the portlet. init parameters of the portlet



getInstanceId
public static String getInstanceId(String portletId)(Code)
Gets the instance id of the portlet.
Parameters:
  portletId - the portlet id of the portlet the instance id of the portlet



getInstanceId
public String getInstanceId()(Code)
Gets the instance id of the portlet. the instance id of the portlet



getInstanceable
public boolean getInstanceable()(Code)
Returns true if the portlet can be added multiple times to a layout. true if the portlet can be added multiple times to a layout



getLayoutCacheable
public boolean getLayoutCacheable()(Code)
Returns true to allow the portlet to be cached within the layout. true if the portlet can be cached within the layout



getMaximizeEdit
public boolean getMaximizeEdit()(Code)
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



getMaximizeHelp
public boolean getMaximizeHelp()(Code)
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



getOpenSearchClass
public String getOpenSearchClass()(Code)
Gets the name of the open search class of the portlet. the name of the open search class of the portlet



getPluginId
public String getPluginId()(Code)
Gets the plugin id of the portlet. the plugin id of the portlet



getPluginPackage
public PluginPackage getPluginPackage()(Code)
Get the package to which the portlet belongs to. the plugin package of the portlet



getPluginType
public String getPluginType()(Code)
Gets the plugin type of the portlet. the plugin type of the portlet



getPopMessageListenerClass
public String getPopMessageListenerClass()(Code)
Gets the name of the POP message listener class of the portlet. the name of the POP message listener class of the portlet



getPopMessageListenerInstance
public MessageListener getPopMessageListenerInstance()(Code)
Gets the POP message listener instance of the portlet. the POP message listener instance of the portlet



getPopUpPrint
public boolean getPopUpPrint()(Code)
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



getPortletClass
public String getPortletClass()(Code)
Gets the name of the portlet class of the portlet. the name of the portlet class of the portlet



getPortletDataHandlerClass
public String getPortletDataHandlerClass()(Code)
Gets the name of the portlet data handler class of the portlet. the name of the portlet data handler class of the portlet



getPortletDataHandlerInstance
public PortletDataHandler getPortletDataHandlerInstance()(Code)
Gets the portlet data handler instance of the portlet. the portlet data handler instance of the portlet



getPortletInfo
public PortletInfo getPortletInfo()(Code)
Gets the portlet info of the portlet. portlet info of the portlet



getPortletLayoutListener
public PortletLayoutListener getPortletLayoutListener()(Code)
Gets the portlet layout listener of the portlet. the name of the portlet layout listener class of the portlet



getPortletLayoutListenerClass
public String getPortletLayoutListenerClass()(Code)
Gets the name of the portlet layout listener class of the portlet. the name of the portlet layout listener class of the portlet



getPortletModes
public Map getPortletModes()(Code)
Gets the portlet modes of the portlet. portlet modes of the portlet



getPortletURLClass
public String getPortletURLClass()(Code)
Gets the name of the portlet URL class of the portlet. the name of the portlet URL class of the portlet



getPreferencesCompanyWide
public boolean getPreferencesCompanyWide()(Code)
Returns true if preferences are shared across the entire company. true if preferences are shared across the entire company



getPreferencesOwnedByGroup
public boolean getPreferencesOwnedByGroup()(Code)
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



getPreferencesValidator
public String getPreferencesValidator()(Code)
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



getRenderWeight
public int getRenderWeight()(Code)
Returns the render weight of the portlet. the render weight of the portlet



getResourceBundle
public String getResourceBundle()(Code)
Gets the resource bundle of the portlet. resource bundle of the portlet



getRestoreCurrentView
public boolean getRestoreCurrentView()(Code)
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



getRoleMappers
public Map getRoleMappers()(Code)
Gets the role mappers of the portlet. role mappers of the portlet



getRolesArray
public String[] getRolesArray()(Code)
Gets an array of required roles of the portlet. an array of required roles of the portlet



getRootPortletId
public static String getRootPortletId(String portletId)(Code)
Gets the root portlet id of the portlet.
Parameters:
  portletId - the portlet id of the portlet the root portlet id of the portlet



getRootPortletId
public String getRootPortletId()(Code)
Gets the root portlet id of the portlet. the root portlet id of the portlet



getSchedulerClass
public String getSchedulerClass()(Code)
Gets the name of the scheduler class of the portlet. the name of the scheduler class of the portlet



getServletContextName
public String getServletContextName()(Code)
Gets the servlet context name of the portlet. the servlet context name of the portlet



getServletURLPatterns
public List getServletURLPatterns()(Code)
The servlet url patterns that are part of this application. The servlet url patterns that are part of this application



getShowPortletAccessDenied
public boolean getShowPortletAccessDenied()(Code)
Returns true if users are shown that they do not have access to the portlet. true if users are shown that they do not have access to theportlet



getShowPortletInactive
public boolean getShowPortletInactive()(Code)
Returns true if users are shown that the portlet is inactive. true if users are shown that the portlet is inactive



getStatic
public boolean getStatic()(Code)
Returns true if the portlet is a static portlet that is cannot be moved. true if the portlet is a static portlet that is cannot bemoved



getStaticEnd
public boolean getStaticEnd()(Code)
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



getStaticStart
public boolean getStaticStart()(Code)
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



getStrutsPath
public String getStrutsPath()(Code)
Gets the struts path of the portlet. the struts path of the portlet



getSupportedLocales
public Set getSupportedLocales()(Code)
Gets the supported locales of the portlet. supported locales of the portlet



getSystem
public boolean getSystem()(Code)
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



getURLEncoderClass
public String getURLEncoderClass()(Code)
Gets the name of the URL encoder class of the portlet. the name of the URL encoder class of the portlet



getURLEncoderInstance
public URLEncoder getURLEncoderInstance()(Code)
Gets the URL encoder instance of the portlet. the URL encoder instance of the portlet



getUnlinkedRoles
public Set getUnlinkedRoles()(Code)
Gets the unlinked roles of the portlet. unlinked roles of the portlet



getUseDefaultTemplate
public boolean getUseDefaultTemplate()(Code)
Returns true if the portlet uses the default template. true if the portlet uses the default template



getUserAttributes
public Set getUserAttributes()(Code)
Gets the user attributes of the portlet. user attributes of the portlet



getUserPrincipalStrategy
public String getUserPrincipalStrategy()(Code)
Gets the user principal strategy of the portlet. the user principal strategy of the portlet



getVirtualPath
public String getVirtualPath()(Code)
Gets the virtual path of the portlet. the virtual path of the portlet



getWARFile
public boolean getWARFile()(Code)
Returns true if the portlet is found in a WAR file. true if the portlet is found in a WAR file



hasAddPortletPermission
public boolean hasAddPortletPermission(long userId)(Code)
Returns true if the user has the permission to add the portlet to a layout. true if the user has the permission to add the portlet to alayout



hasMultipleMimeTypes
public boolean hasMultipleMimeTypes()(Code)
Returns true if the portlet supports more than one mime type. true if the portlet supports more than one mime type



hasPortletMode
public boolean hasPortletMode(String mimeType, PortletMode portletMode)(Code)
Returns true if the portlet supports the specified mime type and portlet mode. true if the portlet supports the specified mime type andportlet mode



hasRoleWithName
public boolean hasRoleWithName(String roleName)(Code)
Returns true if the portlet has a role with the specified name. true if the portlet has a role with the specified name



isActionURLRedirect
public boolean isActionURLRedirect()(Code)
Returns true if an action URL for this portlet should cause an auto redirect. true if an action URL for this portlet should cause an autoredirect



isAddDefaultResource
public boolean isAddDefaultResource()(Code)
Returns true if default resources for the portlet are added to a page. true if default resources for the portlet are added to apage



isAjaxable
public boolean isAjaxable()(Code)
Returns true if the portlet can be displayed via Ajax. true if the portlet can be displayed via Ajax



isInclude
public boolean isInclude()(Code)
Returns true to include the portlet and make it available to be made active. true to include the portlet and make it available to be madeactive



isInstanceable
public boolean isInstanceable()(Code)
Returns true if the portlet can be added multiple times to a layout. true if the portlet can be added multiple times to a layout



isLayoutCacheable
public boolean isLayoutCacheable()(Code)
Returns true to allow the portlet to be cached within the layout. true if the portlet can be cached within the layout



isMaximizeEdit
public boolean isMaximizeEdit()(Code)
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



isMaximizeHelp
public boolean isMaximizeHelp()(Code)
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



isPopUpPrint
public boolean isPopUpPrint()(Code)
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



isPreferencesCompanyWide
public boolean isPreferencesCompanyWide()(Code)
Returns true if preferences are shared across the entire company. true if preferences are shared across the entire company



isPreferencesOwnedByGroup
public boolean isPreferencesOwnedByGroup()(Code)
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



isPrivateRequestAttributes
public boolean isPrivateRequestAttributes()(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



isPrivateSessionAttributes
public boolean isPrivateSessionAttributes()(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



isRestoreCurrentView
public boolean isRestoreCurrentView()(Code)
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



isShowPortletAccessDenied
public boolean isShowPortletAccessDenied()(Code)
Returns true if users are shown that they do not have access to the portlet. true if users are shown that they do not have access to theportlet



isShowPortletInactive
public boolean isShowPortletInactive()(Code)
Returns true if users are shown that the portlet is inactive. true if users are shown that the portlet is inactive



isStatic
public boolean isStatic()(Code)
Returns true if the portlet is a static portlet that is cannot be moved. true if the portlet is a static portlet that is cannot bemoved



isStaticEnd
public boolean isStaticEnd()(Code)
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



isStaticStart
public boolean isStaticStart()(Code)
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



isSystem
public boolean isSystem()(Code)
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



isUseDefaultTemplate
public boolean isUseDefaultTemplate()(Code)
Returns true if the portlet uses the default template. true if the portlet uses the default template



isWARFile
public boolean isWARFile()(Code)
Returns true if the portlet is found in a WAR file. true if the portlet is found in a WAR file



linkRoles
public void linkRoles()(Code)
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



setAjaxable
public void setAjaxable(boolean ajaxable)(Code)
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



setDefaultPluginSetting
public void setDefaultPluginSetting(PluginSetting pluginSetting)(Code)
Sets the default plugin settings of the portlet.
Parameters:
  pluginSetting - the plugin setting



setDefaultPreferences
public void setDefaultPreferences(String defaultPreferences)(Code)
Sets the default preferences of the portlet.
Parameters:
  defaultPreferences - the default preferences of the portlet



setDisplayName
public void setDisplayName(String displayName)(Code)
Sets the display name of the portlet.
Parameters:
  displayName - the display name of the portlet



setExpCache
public void setExpCache(Integer expCache)(Code)
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



setIcon
public void setIcon(String icon)(Code)
Sets the icon of the portlet.
Parameters:
  icon - the icon of the portlet



setInclude
public void setInclude(boolean include)(Code)
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



setInitParams
public void setInitParams(Map initParams)(Code)
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



setPluginPackage
public void setPluginPackage(PluginPackage pluginPackage)(Code)
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



setPortletInfo
public void setPortletInfo(PortletInfo portletInfo)(Code)
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



setRoleMappers
public void setRoleMappers(Map roleMappers)(Code)
Sets the role mappers of the portlet.
Parameters:
  roleMappers - the role mappers of the portlet



setRoles
public void setRoles(String roles)(Code)
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



setSystem
public void setSystem(boolean system)(Code)
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



setWARFile
public void setWARFile(boolean warFile)(Code)
Sets to true if the portlet is found in a WAR file.
Parameters:
  warFile - boolean value for whether the portlet is found in aWAR file



Fields inherited from com.liferay.portal.model.impl.PortletModelImpl
final public static boolean CACHE_ENABLED(Code)(Java Doc)
final public static long LOCK_EXPIRATION_TIME(Code)(Java Doc)
final public static Object[][] TABLE_COLUMNS(Code)(Java Doc)
final public static String TABLE_NAME(Code)(Java Doc)
final public static String TABLE_SQL_CREATE(Code)(Java Doc)
final public static String TABLE_SQL_DROP(Code)(Java Doc)

Methods inherited from com.liferay.portal.model.impl.PortletModelImpl
public Object clone()(Code)(Java Doc)
public int compareTo(Object obj)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public boolean getActive()(Code)(Java Doc)
public long getCompanyId()(Code)(Java Doc)
public long getId()(Code)(Java Doc)
public String getPortletId()(Code)(Java Doc)
public long getPrimaryKey()(Code)(Java Doc)
public Serializable getPrimaryKeyObj()(Code)(Java Doc)
public String getRoles()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isActive()(Code)(Java Doc)
public void setActive(boolean active)(Code)(Java Doc)
public void setCompanyId(long companyId)(Code)(Java Doc)
public void setId(long id)(Code)(Java Doc)
public void setPortletId(String portletId)(Code)(Java Doc)
public void setPrimaryKey(long pk)(Code)(Java Doc)
public void setRoles(String roles)(Code)(Java Doc)
public Portlet toEscapedModel()(Code)(Java Doc)

Methods inherited from com.liferay.portal.model.impl.BaseModelImpl
abstract public Object clone()(Code)(Java Doc)
public boolean isEscapedModel()(Code)(Java Doc)
public boolean isNew()(Code)(Java Doc)
public void setEscapedModel(boolean escapedModel)(Code)(Java Doc)
public boolean setNew(boolean n)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.