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