|
Liferay 6.0.4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.model.PortletWrapper
public class PortletWrapper
This class is a wrapper for Portlet.
Portlet,
Serialized Form| Constructor Summary | |
|---|---|
PortletWrapper(Portlet portlet)
|
|
| Method Summary | |
|---|---|
void |
addProcessingEvent(QName processingEvent)
Adds a supported processing event. |
void |
addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Adds a supported public render parameter. |
void |
addPublishingEvent(QName publishingEvent)
Adds a supported publishing event. |
void |
addSchedulerEntry(SchedulerEntry schedulerEntry)
Adds a scheduler entry. |
Object |
clone()
Creates and returns a copy of this object. |
int |
compareTo(Portlet portlet)
Compares this portlet to the specified object. |
boolean |
equals(Object obj)
Checks whether this portlet is equal to the specified object. |
boolean |
getActionURLRedirect()
Returns true if an action URL for this portlet should cause
an auto redirect. |
boolean |
getActive()
Gets the active of this portlet. |
boolean |
getAddDefaultResource()
Returns true if default resources for the portlet are added
to a page. |
boolean |
getAjaxable()
Returns true if the portlet can be displayed via Ajax. |
Set<String> |
getAllPortletModes()
Gets a list of all portlet modes supported by the portlet. |
Set<String> |
getAllWindowStates()
Gets a list of all window states supported by the portlet. |
List<String> |
getAssetRendererFactoryClasses()
Gets the names of the classes that represent asset types associated to the portlet. |
List<AssetRendererFactory> |
getAssetRendererFactoryInstances()
Gets the asset type instances of the portlet. |
Portlet |
getClonedInstance(String portletId)
Returns true if the portlet is found in a WAR file. |
long |
getCompanyId()
Gets the company id of this portlet. |
String |
getConfigurationActionClass()
Gets the configuration action class of the portlet. |
ConfigurationAction |
getConfigurationActionInstance()
Gets the configuration action instance of the portlet. |
String |
getContextPath()
Gets the servlet context path of the portlet. |
String |
getControlPanelEntryCategory()
Gets the name of the category of the Control Panel where the portlet will be shown. |
String |
getControlPanelEntryClass()
Gets the name of the class that will control when the portlet will be shown in the Control Panel. |
ControlPanelEntry |
getControlPanelEntryInstance()
Gets an instance of the class that will control when the portlet will be shown in the Control Panel. |
double |
getControlPanelEntryWeight()
Gets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel. |
String |
getCssClassWrapper()
Gets the name of the CSS class that will be injected in the DIV that wraps this portlet. |
List<String> |
getCustomAttributesDisplayClasses()
Gets the names of the classes that represent custom attribute displays associated to the portlet. |
List<CustomAttributesDisplay> |
getCustomAttributesDisplayInstances()
Gets the custom attribute display instances of the portlet. |
PluginSetting |
getDefaultPluginSetting()
Get the default plugin settings of the portlet. |
String |
getDefaultPreferences()
Gets the default preferences of the portlet. |
String |
getDisplayName()
Gets the display name of the portlet. |
ExpandoBridge |
getExpandoBridge()
Gets the expando bridge for this model instance. |
Integer |
getExpCache()
Gets expiration cache of the portlet. |
String |
getFacebookIntegration()
Gets the Facebook integration method of the portlet. |
List<String> |
getFooterPortalCss()
Gets a list of CSS files that will be referenced from the page's footer relative to the portal's context path. |
List<String> |
getFooterPortalJavaScript()
Gets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path. |
List<String> |
getFooterPortletCss()
Gets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path. |
List<String> |
getFooterPortletJavaScript()
Gets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path. |
String |
getFriendlyURLMapperClass()
Gets the name of the friendly URL mapper class of the portlet. |
FriendlyURLMapper |
getFriendlyURLMapperInstance()
Gets the friendly URL mapper instance of the portlet. |
String |
getFriendlyURLMapping()
Gets the name of the friendly URL mapping of the portlet. |
String |
getFriendlyURLRoutes()
Gets the class loader resource path to the friendly URL routes of the portlet. |
List<String> |
getHeaderPortalCss()
Gets a list of CSS files that will be referenced from the page's header relative to the portal's context path. |
List<String> |
getHeaderPortalJavaScript()
Gets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path. |
List<String> |
getHeaderPortletCss()
Gets a list of CSS files that will be referenced from the page's header relative to the portlet's context path. |
List<String> |
getHeaderPortletJavaScript()
Gets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path. |
String |
getIcon()
Gets the icon of the portlet. |
long |
getId()
Gets the id of this portlet. |
boolean |
getInclude()
Returns true to include the portlet and make it available to
be made active. |
String |
getIndexerClass()
Gets the name of the indexer class of the portlet. |
Indexer |
getIndexerInstance()
Gets the indexer instance of the portlet. |
Map<String,String> |
getInitParams()
Gets the init parameters of the portlet. |
boolean |
getInstanceable()
Returns true if the portlet can be added multiple times to a
layout. |
String |
getInstanceId()
Gets the instance id of the portlet. |
boolean |
getLayoutCacheable()
Returns true to allow the portlet to be cached within the
layout. |
boolean |
getMaximizeEdit()
Returns true if the portlet goes into the maximized state
when the user goes into the edit mode. |
boolean |
getMaximizeHelp()
Returns true if the portlet goes into the maximized state
when the user goes into the help mode. |
String |
getOpenSearchClass()
Gets the name of the open search class of the portlet. |
OpenSearch |
getOpenSearchInstance()
Gets the indexer instance of the portlet. |
String |
getPluginId()
Gets the plugin id of the portlet. |
PluginPackage |
getPluginPackage()
Get the package to which the portlet belongs to. |
String |
getPluginType()
Gets the plugin type of the portlet. |
String |
getPollerProcessorClass()
Gets the name of the poller processor class of the portlet. |
PollerProcessor |
getPollerProcessorInstance()
Gets the poller processor instance of the portlet. |
String |
getPopMessageListenerClass()
Gets the name of the POP message listener class of the portlet. |
MessageListener |
getPopMessageListenerInstance()
Gets the POP message listener instance of the portlet. |
boolean |
getPopUpPrint()
Returns true if the portlet goes into the pop up state when
the user goes into the print mode. |
PortletApp |
getPortletApp()
Get the application this portlet belongs to. |
String |
getPortletClass()
Gets the name of the portlet class of the portlet. |
String |
getPortletDataHandlerClass()
Gets the name of the portlet data handler class of the portlet. |
PortletDataHandler |
getPortletDataHandlerInstance()
Gets the portlet data handler instance of the portlet. |
Map<String,PortletFilter> |
getPortletFilters()
Gets the filters of the portlet. |
String |
getPortletId()
Gets the portlet id of this portlet. |
PortletInfo |
getPortletInfo()
Gets the portlet info of the portlet. |
String |
getPortletLayoutListenerClass()
Gets the name of the portlet layout listener class of the portlet. |
PortletLayoutListener |
getPortletLayoutListenerInstance()
Gets the portlet layout listener instance of the portlet. |
Map<String,Set<String>> |
getPortletModes()
Gets the portlet modes of the portlet. |
String |
getPortletName()
Gets the name of the portlet. |
String |
getPortletURLClass()
Gets the name of the portlet URL class of the portlet. |
boolean |
getPreferencesCompanyWide()
Returns true if preferences are shared across the entire
company. |
boolean |
getPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the
portlet is shown in a group layout. |
boolean |
getPreferencesUniquePerLayout()
Returns true if preferences are unique per layout. |
String |
getPreferencesValidator()
Gets the name of the preferences validator class of the portlet. |
long |
getPrimaryKey()
Gets the primary key of this portlet. |
Serializable |
getPrimaryKeyObj()
Gets the primary key of this model instance. |
boolean |
getPrivateRequestAttributes()
Returns true if the portlet does not share request
attributes with the portal or portlets from another WAR. |
boolean |
getPrivateSessionAttributes()
Returns true if the portlet does not share session
attributes with the portal. |
QName |
getProcessingEvent(String uri,
String localPart)
Gets the supported processing event from a namespace URI and a local part. |
Set<QName> |
getProcessingEvents()
Gets the supported processing events of the portlet. |
PublicRenderParameter |
getPublicRenderParameter(String identifier)
Gets the supported public render parameter from an identifier. |
PublicRenderParameter |
getPublicRenderParameter(String uri,
String localPart)
Gets the supported public render parameter from a namespace URI and a local part. |
Set<PublicRenderParameter> |
getPublicRenderParameters()
Gets the supported public render parameters of the portlet. |
Set<QName> |
getPublishingEvents()
Gets the supported publishing events of the portlet. |
boolean |
getRemoteable()
Returns true if the portlet supports remoting. |
int |
getRenderWeight()
Returns the render weight of the portlet. |
String |
getResourceBundle()
Gets the resource bundle of the portlet. |
boolean |
getRestoreCurrentView()
Returns true if the portlet restores to the current view
from the maximized state. |
Map<String,String> |
getRoleMappers()
Gets the role mappers of the portlet. |
String |
getRoles()
Gets the roles of this portlet. |
String[] |
getRolesArray()
Gets an array of required roles of the portlet. |
String |
getRootPortletId()
Gets the root portlet id of the portlet. |
List<SchedulerEntry> |
getSchedulerEntries()
Gets the scheduler entries of the portlet. |
boolean |
getScopeable()
Returns true if the portlet supports scoping of data. |
boolean |
getShowPortletAccessDenied()
Returns true if users are shown that they do not have access
to the portlet. |
boolean |
getShowPortletInactive()
Returns true if users are shown that the portlet is
inactive. |
String |
getSocialActivityInterpreterClass()
Gets the name of the social activity interpreter class of the portlet. |
SocialActivityInterpreter |
getSocialActivityInterpreterInstance()
Gets the name of the social activity interpreter instance of the portlet. |
String |
getSocialRequestInterpreterClass()
Gets the name of the social request interpreter class of the portlet. |
SocialRequestInterpreter |
getSocialRequestInterpreterInstance()
Gets the name of the social request interpreter instance of the portlet. |
boolean |
getStatic()
Returns true if the portlet is a static portlet that is
cannot be moved. |
boolean |
getStaticEnd()
Returns true if the portlet is a static portlet at the end
of a list of portlets. |
boolean |
getStaticStart()
Returns true if the portlet is a static portlet at the start
of a list of portlets. |
String |
getStrutsPath()
Gets the struts path of the portlet. |
Set<String> |
getSupportedLocales()
Gets the supported locales of the portlet. |
boolean |
getSystem()
Returns true if the portlet is a system portlet that a user
cannot manually add to their page. |
long |
getTimestamp()
Gets the timestamp of the portlet. |
boolean |
getUndeployedPortlet()
Returns true if the portlet is an undeployed portlet. |
Set<String> |
getUnlinkedRoles()
Gets the unlinked roles of the portlet. |
String |
getURLEncoderClass()
Gets the name of the URL encoder class of the portlet. |
URLEncoder |
getURLEncoderInstance()
Gets the URL encoder instance of the portlet. |
boolean |
getUseDefaultTemplate()
Returns true if the portlet uses the default template. |
String |
getUserPrincipalStrategy()
Gets the user principal strategy of the portlet. |
String |
getVirtualPath()
Gets the virtual path of the portlet. |
String |
getWebDAVStorageClass()
Gets the name of the WebDAV storage class of the portlet. |
WebDAVStorage |
getWebDAVStorageInstance()
Gets the name of the WebDAV storage instance of the portlet. |
String |
getWebDAVStorageToken()
Gets the name of the WebDAV storage token of the portlet. |
Map<String,Set<String>> |
getWindowStates()
Gets the window states of the portlet. |
List<String> |
getWorkflowHandlerClasses()
Gets the names of the classes that represent workflow handlers associated to the portlet. |
List<WorkflowHandler> |
getWorkflowHandlerInstances()
Gets the workflow handler instances of the portlet. |
Portlet |
getWrappedPortlet()
|
String |
getXmlRpcMethodClass()
Gets the name of the XML-RPC method class of the portlet. |
Method |
getXmlRpcMethodInstance()
Gets the name of the XML-RPC method instance of the portlet. |
boolean |
hasAddPortletPermission(long userId)
Returns true if the user has the permission to add the
portlet to a layout. |
int |
hashCode()
|
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 |
isActive()
Determines whether this portlet is active. |
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 |
isCachedModel()
Determines if this model instance was retrieved from the entity cache. |
boolean |
isEscapedModel()
Determines if this model instance is escaped. |
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 |
isNew()
Determines if this model instance does not yet exist in the database. |
boolean |
isPopUpPrint()
Returns true if the portlet goes into the pop up state when
the user goes into the print mode. |
boolean |
isPreferencesCompanyWide()
Returns true if preferences are shared across the entire
company. |
boolean |
isPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the
portlet is shown in a group layout. |
boolean |
isPreferencesUniquePerLayout()
Returns true if preferences are unique per layout. |
boolean |
isPrivateRequestAttributes()
Returns true if the portlet does not share request
attributes with the portal or portlets from another WAR. |
boolean |
isPrivateSessionAttributes()
Returns true if the portlet does not share session
attributes with the portal. |
boolean |
isRemoteable()
Returns true if the portlet supports remoting. |
boolean |
isRestoreCurrentView()
Returns true if the portlet restores to the current view
from the maximized state. |
boolean |
isScopeable()
Returns true if the portlet supports scoping of data. |
boolean |
isShowPortletAccessDenied()
Returns true if users are shown that they do not have access
to the portlet. |
boolean |
isShowPortletInactive()
Returns true if users are shown that the portlet is
inactive. |
boolean |
isStatic()
Returns true if the portlet is a static portlet that is
cannot be moved. |
boolean |
isStaticEnd()
Returns true if the portlet is a static portlet at the end
of a list of portlets. |
boolean |
isStaticStart()
Returns true if the portlet is a static portlet at the start
of a list of portlets. |
boolean |
isSystem()
Returns true if the portlet is a system portlet that a user
cannot manually add to their page. |
boolean |
isUndeployedPortlet()
Returns true if the portlet is an undeployed portlet. |
boolean |
isUseDefaultTemplate()
Returns true if the portlet uses the default template. |
void |
linkRoles()
Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml. |
void |
setActionURLRedirect(boolean actionURLRedirect)
Set to true if an action URL for this portlet should cause
an auto redirect. |
void |
setActive(boolean active)
Sets whether this {$entity.humanName} is active. |
void |
setAddDefaultResource(boolean addDefaultResource)
Set to true if default resources for the portlet are added
to a page. |
void |
setAjaxable(boolean ajaxable)
Set to true if the portlet can be displayed via Ajax. |
void |
setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)
Sets the name of the classes that represent asset types associated to the portlet. |
void |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache. |
void |
setCompanyId(long companyId)
Sets the company id of this portlet. |
void |
setConfigurationActionClass(String configurationActionClass)
Sets the configuration action class of the portlet. |
void |
setControlPanelEntryCategory(String controlPanelEntryCategory)
Set the name of the category of the Control Panel where the portlet will be shown. |
void |
setControlPanelEntryClass(String controlPanelEntryClass)
Sets the name of the class that will control when the portlet will be shown in the Control Panel. |
void |
setControlPanelEntryWeight(double controlPanelEntryWeight)
Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel. |
void |
setCssClassWrapper(String cssClassWrapper)
Sets the name of the CSS class that will be injected in the DIV that wraps this portlet. |
void |
setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)
Sets the name of the classes that represent custom attribute displays associated to the portlet. |
void |
setDefaultPluginSetting(PluginSetting pluginSetting)
Sets the default plugin settings of the portlet. |
void |
setDefaultPreferences(String defaultPreferences)
Sets the default preferences of the portlet. |
void |
setDisplayName(String displayName)
Sets the display name of the portlet. |
void |
setEscapedModel(boolean escapedModel)
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe. |
void |
setExpandoBridgeAttributes(ServiceContext serviceContext)
Sets the expando bridge attributes for this model instance to the attributes stored in the service context. |
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 |
setId(long id)
Sets the id of this portlet. |
void |
setInclude(boolean include)
Set to true to include the portlet and make it available to
be made active. |
void |
setIndexerClass(String indexerClass)
Sets the name of the indexer class of the portlet. |
void |
setInitParams(Map<String,String> initParams)
Sets the init parameters of the portlet. |
void |
setInstanceable(boolean instanceable)
Set to true if the portlet can be added multiple times to a
layout. |
void |
setLayoutCacheable(boolean layoutCacheable)
Set to true to allow the portlet to be cached within the
layout. |
void |
setMaximizeEdit(boolean maximizeEdit)
Set to true if the portlet goes into the maximized state
when the user goes into the edit mode. |
void |
setMaximizeHelp(boolean maximizeHelp)
Set to true if the portlet goes into the maximized state
when the user goes into the help mode. |
void |
setNew(boolean n)
Sets whether this model instance does not yet exist in the database. |
void |
setOpenSearchClass(String openSearchClass)
Sets the name of the open search class of the portlet. |
void |
setPluginPackage(PluginPackage pluginPackage)
Sets the plugin package this portlet belongs to. |
void |
setPollerProcessorClass(String pollerProcessorClass)
Sets the name of the poller processor class of the portlet. |
void |
setPopMessageListenerClass(String popMessageListenerClass)
Sets the name of the POP message listener class of the portlet. |
void |
setPopUpPrint(boolean popUpPrint)
Set to true if the portlet goes into the pop up state when
the user goes into the print mode. |
void |
setPortletApp(PortletApp portletApp)
Sets the application this portlet belongs to. |
void |
setPortletClass(String portletClass)
Sets the name of the portlet class of the portlet. |
void |
setPortletDataHandlerClass(String portletDataHandlerClass)
Sets the name of the portlet data handler class of the portlet. |
void |
setPortletFilters(Map<String,PortletFilter> portletFilters)
Sets the filters of the portlet. |
void |
setPortletId(String portletId)
Sets the portlet id of this 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 |
setPrimaryKey(long pk)
Sets the primary key of this portlet |
void |
setPrivateRequestAttributes(boolean privateRequestAttributes)
Set to true if the portlet does not share request attributes
with the portal or portlets from another WAR. |
void |
setPrivateSessionAttributes(boolean privateSessionAttributes)
Set to true if the portlet does not share session attributes
with the portal. |
void |
setProcessingEvents(Set<QName> processingEvents)
Sets the supported processing events of the portlet. |
void |
setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)
Sets the supported public render parameters of the portlet. |
void |
setPublishingEvents(Set<QName> publishingEvents)
Sets the supported publishing events of the portlet. |
void |
setRemoteable(boolean remoteable)
Set to true if the portlet supports remoting |
void |
setRenderWeight(int renderWeight)
Sets the render weight of the portlet. |
void |
setResourceBundle(String resourceBundle)
Sets the resource bundle of the portlet. |
void |
setRestoreCurrentView(boolean restoreCurrentView)
Set to true if the portlet restores to the current view from
the maximized state. |
void |
setRoleMappers(Map<String,String> roleMappers)
Sets the role mappers of the portlet. |
void |
setRoles(String roles)
Sets a string of ordered comma delimited portlet ids. |
void |
setRolesArray(String[] rolesArray)
Sets an array of required roles of the portlet. |
void |
setSchedulerEntries(List<SchedulerEntry> schedulerEntries)
Sets the scheduler entries of the portlet. |
void |
setScopeable(boolean scopeable)
Set to true if the portlet supports scoping of data. |
void |
setShowPortletAccessDenied(boolean showPortletAccessDenied)
Set to true if users are shown that they do not have access
to the portlet. |
void |
setShowPortletInactive(boolean showPortletInactive)
Set to true if users are shown that the portlet is inactive. |
void |
setSocialActivityInterpreterClass(String socialActivityInterpreterClass)
Sets the name of the social activity interpreter class of the portlet. |
void |
setSocialRequestInterpreterClass(String socialRequestInterpreterClass)
Sets the name of the social request interpreter class of the portlet. |
void |
setStatic(boolean staticPortlet)
Set to true if the portlet is a static portlet that is
cannot be moved. |
void |
setStaticStart(boolean staticPortletStart)
Set to true if the portlet is a static portlet at the start
of a list of portlets. |
void |
setStrutsPath(String strutsPath)
Sets the struts path of the portlet. |
void |
setSupportedLocales(Set<String> supportedLocales)
Sets the supported locales of the portlet. |
void |
setSystem(boolean system)
Set to true if the portlet is a system portlet that a user
cannot manually add to their page. |
void |
setTimestamp(long timestamp)
Sets the timestamp of the portlet. |
void |
setUndeployedPortlet(boolean undeployedPortlet)
Set to true if the portlet is an undeployed portlet. |
void |
setUnlinkedRoles(Set<String> unlinkedRoles)
Sets the unlinked roles of the portlet. |
void |
setURLEncoderClass(String urlEncoderClass)
Sets the name of the URL encoder class of the portlet. |
void |
setUseDefaultTemplate(boolean useDefaultTemplate)
Set to true if the portlet uses the default template. |
void |
setUserPrincipalStrategy(String userPrincipalStrategy)
Sets the user principal strategy of the portlet. |
void |
setVirtualPath(String virtualPath)
Sets the virtual path of the portlet. |
void |
setWebDAVStorageClass(String webDAVStorageClass)
Sets the name of the WebDAV storage class of the portlet. |
void |
setWebDAVStorageToken(String webDAVStorageToken)
Sets the name of the WebDAV storage token of the portlet. |
void |
setWindowStates(Map<String,Set<String>> windowStates)
Sets the window states of the portlet. |
void |
setWorkflowHandlerClasses(List<String> workflowHandlerClasses)
Sets the name of the classes that represent workflow handlers associated to the portlet. |
void |
setXmlRpcMethodClass(String xmlRpcMethodClass)
Sets the name of the XML-RPC method class of the portlet. |
Portlet |
toEscapedModel()
Gets a copy of this portlet as an escaped model instance by wrapping it with an AutoEscapeBeanHandler. |
String |
toString()
|
String |
toXmlString()
Gets the XML representation of this model instance. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public PortletWrapper(Portlet portlet)
| Method Detail |
|---|
public long getPrimaryKey()
PortletModel
getPrimaryKey in interface PortletModelpublic void setPrimaryKey(long pk)
PortletModel
setPrimaryKey in interface PortletModelpk - the primary key of this portletpublic long getId()
PortletModel
getId in interface PortletModelpublic void setId(long id)
PortletModel
setId in interface PortletModelid - the id of this portletpublic long getCompanyId()
PortletModel
getCompanyId in interface PortletModelpublic void setCompanyId(long companyId)
PortletModel
setCompanyId in interface PortletModelcompanyId - the company id of this portletpublic String getPortletId()
PortletModel
getPortletId in interface PortletModelpublic void setPortletId(String portletId)
PortletModel
setPortletId in interface PortletModelportletId - the portlet id of this portletpublic String getRoles()
PortletModel
getRoles in interface PortletModelpublic void setRoles(String roles)
Portlet
setRoles in interface PortletsetRoles in interface PortletModelroles - a string of ordered comma delimited portlet idspublic boolean getActive()
PortletModel
getActive in interface PortletModelpublic boolean isActive()
PortletModel
isActive in interface PortletModelpublic void setActive(boolean active)
PortletModel
setActive in interface PortletModelactive - the active of this portletpublic Portlet toEscapedModel()
PortletModelAutoEscapeBeanHandler.
toEscapedModel in interface PortletModelAutoEscapeBeanHandlerpublic boolean isNew()
BaseModel
isNew in interface BaseModel<Portlet>isNew in interface PortletModeltrue if this model instance does not yet exist in
the database; false otherwisepublic void setNew(boolean n)
BaseModel
setNew in interface BaseModel<Portlet>setNew in interface PortletModeln - whether this model instance does not yet exist in the databasepublic boolean isCachedModel()
BaseModel
isCachedModel in interface BaseModel<Portlet>isCachedModel in interface PortletModeltrue if this model instance was retrieved from the
entity cache; false otherwiseBaseModel.setCachedModel(boolean)public void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel in interface BaseModel<Portlet>setCachedModel in interface PortletModelcachedModel - whether this model instance was retrieved from the
entity cacheEntityCachepublic boolean isEscapedModel()
BaseModel
isEscapedModel in interface BaseModel<Portlet>isEscapedModel in interface PortletModeltrue if this model instance is escaped;
false otherwiseBaseModel.setEscapedModel(boolean)public void setEscapedModel(boolean escapedModel)
BaseModel
A model instance can be made escaped by wrapping it with an HTML auto
escape handler using its toEscapedModel method. For example,
UserModel.toEscapedModel().
setEscapedModel in interface BaseModel<Portlet>setEscapedModel in interface PortletModelescapedModel - whether this model instance is escapedAutoEscapeBeanHandlerpublic Serializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj in interface BaseModel<Portlet>getPrimaryKeyObj in interface PortletModelpublic ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge in interface BaseModel<Portlet>getExpandoBridge in interface PortletModelpublic void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes in interface BaseModel<Portlet>setExpandoBridgeAttributes in interface PortletModelserviceContext - the service context to retrieve the expando bridge
attributes fromServiceContext.getExpandoBridgeAttributes(
)public Object clone()
Portlet
clone in interface BaseModel<Portlet>clone in interface Portletclone in interface PortletModelclone in class Objectpublic int compareTo(Portlet portlet)
Portlet
compareTo in interface PortletcompareTo in interface PortletModelcompareTo in interface Comparable<Portlet>portlet - the portlet to compare this portlet against
public int hashCode()
hashCode in interface PortletModelhashCode in class Objectpublic String toString()
toString in interface PortletModeltoString in class Objectpublic String toXmlString()
BaseModel
toXmlString in interface BaseModel<Portlet>toXmlString in interface PortletModelpublic String getRootPortletId()
Portlet
getRootPortletId in interface Portletpublic String getInstanceId()
Portlet
getInstanceId in interface Portletpublic String getPluginId()
Portlet
getPluginId in interface Portletpublic String getPluginType()
Portlet
getPluginType in interface Portletpublic PluginPackage getPluginPackage()
Portlet
getPluginPackage in interface Portletpublic void setPluginPackage(PluginPackage pluginPackage)
Portlet
setPluginPackage in interface PortletpluginPackage - the plugin packagepublic PluginSetting getDefaultPluginSetting()
Portlet
getDefaultPluginSetting in interface Portletpublic void setDefaultPluginSetting(PluginSetting pluginSetting)
Portlet
setDefaultPluginSetting in interface PortletpluginSetting - the plugin settingpublic long getTimestamp()
Portlet
getTimestamp in interface Portletpublic void setTimestamp(long timestamp)
Portlet
setTimestamp in interface Portlettimestamp - the timestamp of the portletpublic String getIcon()
Portlet
getIcon in interface Portletpublic void setIcon(String icon)
Portlet
setIcon in interface Portleticon - the icon of the portletpublic String getVirtualPath()
Portlet
getVirtualPath in interface Portletpublic void setVirtualPath(String virtualPath)
Portlet
setVirtualPath in interface PortletvirtualPath - the virtual path of the portletpublic String getStrutsPath()
Portlet
getStrutsPath in interface Portletpublic void setStrutsPath(String strutsPath)
Portlet
setStrutsPath in interface PortletstrutsPath - the struts path of the portletpublic String getPortletName()
Portlet
getPortletName in interface Portletpublic void setPortletName(String portletName)
Portlet
setPortletName in interface PortletportletName - the name of the portletpublic String getDisplayName()
Portlet
getDisplayName in interface Portletpublic void setDisplayName(String displayName)
Portlet
setDisplayName in interface PortletdisplayName - the display name of the portletpublic String getPortletClass()
Portlet
getPortletClass in interface Portletpublic void setPortletClass(String portletClass)
Portlet
setPortletClass in interface PortletportletClass - the name of the portlet class of the portletpublic String getConfigurationActionClass()
Portlet
getConfigurationActionClass in interface Portletpublic void setConfigurationActionClass(String configurationActionClass)
Portlet
setConfigurationActionClass in interface PortletconfigurationActionClass - the configuration action class of the
portletpublic ConfigurationAction getConfigurationActionInstance()
Portlet
getConfigurationActionInstance in interface Portletpublic String getIndexerClass()
Portlet
getIndexerClass in interface Portletpublic void setIndexerClass(String indexerClass)
Portlet
setIndexerClass in interface PortletindexerClass - the name of the indexer class of the portletpublic Indexer getIndexerInstance()
Portlet
getIndexerInstance in interface Portletpublic String getOpenSearchClass()
Portlet
getOpenSearchClass in interface Portletpublic void setOpenSearchClass(String openSearchClass)
Portlet
setOpenSearchClass in interface PortletopenSearchClass - the name of the open search class of the portletpublic OpenSearch getOpenSearchInstance()
Portlet
getOpenSearchInstance in interface Portletpublic void addSchedulerEntry(SchedulerEntry schedulerEntry)
Portlet
addSchedulerEntry in interface Portletpublic List<SchedulerEntry> getSchedulerEntries()
Portlet
getSchedulerEntries in interface Portletpublic void setSchedulerEntries(List<SchedulerEntry> schedulerEntries)
Portlet
setSchedulerEntries in interface PortletschedulerEntries - the scheduler entries of the portletpublic String getPortletURLClass()
Portlet
getPortletURLClass in interface Portletpublic void setPortletURLClass(String portletURLClass)
Portlet
setPortletURLClass in interface PortletportletURLClass - the name of the portlet URL class of the portletpublic String getFriendlyURLMapperClass()
Portlet
getFriendlyURLMapperClass in interface Portletpublic void setFriendlyURLMapperClass(String friendlyURLMapperClass)
Portlet
setFriendlyURLMapperClass in interface PortletfriendlyURLMapperClass - the name of the friendly URL mapper class
of the portletpublic FriendlyURLMapper getFriendlyURLMapperInstance()
Portlet
getFriendlyURLMapperInstance in interface Portletpublic String getFriendlyURLMapping()
Portlet
getFriendlyURLMapping in interface Portletpublic void setFriendlyURLMapping(String friendlyURLMapping)
Portlet
setFriendlyURLMapping in interface PortletfriendlyURLMapping - the name of the friendly URL mapping of the
portletpublic String getFriendlyURLRoutes()
Portlet
getFriendlyURLRoutes in interface Portletpublic void setFriendlyURLRoutes(String friendlyURLRoutes)
Portlet
setFriendlyURLRoutes in interface PortletfriendlyURLRoutes - the class loader resource path to the friendly
URL routes of the portletpublic String getURLEncoderClass()
Portlet
getURLEncoderClass in interface Portletpublic void setURLEncoderClass(String urlEncoderClass)
Portlet
setURLEncoderClass in interface PortleturlEncoderClass - the name of the URL encoder class of the portletpublic URLEncoder getURLEncoderInstance()
Portlet
getURLEncoderInstance in interface Portletpublic String getPortletDataHandlerClass()
Portlet
getPortletDataHandlerClass in interface Portletpublic void setPortletDataHandlerClass(String portletDataHandlerClass)
Portlet
setPortletDataHandlerClass in interface PortletportletDataHandlerClass - the name of portlet data handler class of
the portletpublic PortletDataHandler getPortletDataHandlerInstance()
Portlet
getPortletDataHandlerInstance in interface Portletpublic String getPortletLayoutListenerClass()
Portlet
getPortletLayoutListenerClass in interface Portletpublic void setPortletLayoutListenerClass(String portletLayoutListenerClass)
Portlet
setPortletLayoutListenerClass in interface PortletportletLayoutListenerClass - the name of the portlet layout listener
class of the portletpublic PortletLayoutListener getPortletLayoutListenerInstance()
Portlet
getPortletLayoutListenerInstance in interface Portletpublic String getPollerProcessorClass()
Portlet
getPollerProcessorClass in interface Portletpublic void setPollerProcessorClass(String pollerProcessorClass)
Portlet
setPollerProcessorClass in interface PortletpollerProcessorClass - the name of the poller processor class of the
portletpublic PollerProcessor getPollerProcessorInstance()
Portlet
getPollerProcessorInstance in interface Portletpublic String getPopMessageListenerClass()
Portlet
getPopMessageListenerClass in interface Portletpublic void setPopMessageListenerClass(String popMessageListenerClass)
Portlet
setPopMessageListenerClass in interface PortletpopMessageListenerClass - the name of the POP message listener class
of the portletpublic MessageListener getPopMessageListenerInstance()
Portlet
getPopMessageListenerInstance in interface Portletpublic String getSocialActivityInterpreterClass()
Portlet
getSocialActivityInterpreterClass in interface Portletpublic void setSocialActivityInterpreterClass(String socialActivityInterpreterClass)
Portlet
setSocialActivityInterpreterClass in interface PortletsocialActivityInterpreterClass - the name of the activity
interpreter class of the portletpublic SocialActivityInterpreter getSocialActivityInterpreterInstance()
Portlet
getSocialActivityInterpreterInstance in interface Portletpublic String getSocialRequestInterpreterClass()
Portlet
getSocialRequestInterpreterClass in interface Portletpublic void setSocialRequestInterpreterClass(String socialRequestInterpreterClass)
Portlet
setSocialRequestInterpreterClass in interface PortletsocialRequestInterpreterClass - the name of the request interpreter
class of the portletpublic SocialRequestInterpreter getSocialRequestInterpreterInstance()
Portlet
getSocialRequestInterpreterInstance in interface Portletpublic String getWebDAVStorageToken()
Portlet
getWebDAVStorageToken in interface Portletpublic void setWebDAVStorageToken(String webDAVStorageToken)
Portlet
setWebDAVStorageToken in interface PortletwebDAVStorageToken - the name of the WebDAV storage token of the
portletpublic String getWebDAVStorageClass()
Portlet
getWebDAVStorageClass in interface Portletpublic void setWebDAVStorageClass(String webDAVStorageClass)
Portlet
setWebDAVStorageClass in interface PortletwebDAVStorageClass - the name of the WebDAV storage class of the
portletpublic WebDAVStorage getWebDAVStorageInstance()
Portlet
getWebDAVStorageInstance in interface Portletpublic String getXmlRpcMethodClass()
Portlet
getXmlRpcMethodClass in interface Portletpublic void setXmlRpcMethodClass(String xmlRpcMethodClass)
Portlet
setXmlRpcMethodClass in interface PortletxmlRpcMethodClass - the name of the XML-RPC method class of the
portletpublic Method getXmlRpcMethodInstance()
Portlet
getXmlRpcMethodInstance in interface Portletpublic String getControlPanelEntryCategory()
Portlet
getControlPanelEntryCategory in interface Portletpublic void setControlPanelEntryCategory(String controlPanelEntryCategory)
Portlet
setControlPanelEntryCategory in interface PortletcontrolPanelEntryCategory - the name of the category of the Control
Panel where the portlet will be shownpublic double getControlPanelEntryWeight()
Portlet
getControlPanelEntryWeight in interface Portletpublic void setControlPanelEntryWeight(double controlPanelEntryWeight)
Portlet
setControlPanelEntryWeight in interface PortletcontrolPanelEntryWeight - the relative weight of the portlet with
respect to the other portlets in the same category of the Control
Panelpublic String getControlPanelEntryClass()
Portlet
getControlPanelEntryClass in interface Portletpublic void setControlPanelEntryClass(String controlPanelEntryClass)
Portlet
setControlPanelEntryClass in interface PortletcontrolPanelEntryClass - the name of the class that will control
when the portlet will be shown in the Control Panelpublic ControlPanelEntry getControlPanelEntryInstance()
Portlet
getControlPanelEntryInstance in interface Portletpublic List<String> getAssetRendererFactoryClasses()
Portlet
getAssetRendererFactoryClasses in interface Portletpublic void setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)
Portlet
setAssetRendererFactoryClasses in interface PortletassetRendererFactoryClasses - the names of the classes that
represent asset types associated to the portletpublic List<AssetRendererFactory> getAssetRendererFactoryInstances()
Portlet
getAssetRendererFactoryInstances in interface Portletpublic List<String> getCustomAttributesDisplayClasses()
Portlet
getCustomAttributesDisplayClasses in interface Portletpublic void setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)
Portlet
setCustomAttributesDisplayClasses in interface PortletcustomAttributesDisplayClasses - the names of the classes that
represent custom attribute displays associated to the portletpublic List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()
Portlet
getCustomAttributesDisplayInstances in interface Portletpublic List<String> getWorkflowHandlerClasses()
Portlet
getWorkflowHandlerClasses in interface Portletpublic void setWorkflowHandlerClasses(List<String> workflowHandlerClasses)
Portlet
setWorkflowHandlerClasses in interface PortletworkflowHandlerClasses - the names of the classes that represent
workflow handlers associated to the portletpublic List<WorkflowHandler> getWorkflowHandlerInstances()
Portlet
getWorkflowHandlerInstances in interface Portletpublic String getDefaultPreferences()
Portlet
getDefaultPreferences in interface Portletpublic void setDefaultPreferences(String defaultPreferences)
Portlet
setDefaultPreferences in interface PortletdefaultPreferences - the default preferences of the portletpublic String getPreferencesValidator()
Portlet
getPreferencesValidator in interface Portletpublic void setPreferencesValidator(String preferencesValidator)
Portlet
setPreferencesValidator in interface PortletpreferencesValidator - the name of the preferences validator class
of the portletpublic boolean getPreferencesCompanyWide()
Portlettrue if preferences are shared across the entire
company.
getPreferencesCompanyWide in interface Portlettrue if preferences are shared across the entire
companypublic boolean isPreferencesCompanyWide()
Portlettrue if preferences are shared across the entire
company.
isPreferencesCompanyWide in interface Portlettrue if preferences are shared across the entire
companypublic void setPreferencesCompanyWide(boolean preferencesCompanyWide)
Portlettrue if preferences are shared across the entire
company.
setPreferencesCompanyWide in interface PortletpreferencesCompanyWide - boolean value for whether preferences are
shared across the entire companypublic boolean getPreferencesUniquePerLayout()
Portlettrue if preferences are unique per layout.
getPreferencesUniquePerLayout in interface Portlettrue if preferences are unique per layoutpublic boolean isPreferencesUniquePerLayout()
Portlettrue if preferences are unique per layout.
isPreferencesUniquePerLayout in interface Portlettrue if preferences are unique per layoutpublic void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
Portlettrue if preferences are unique per layout.
setPreferencesUniquePerLayout in interface PortletpreferencesUniquePerLayout - boolean value for whether preferences
are unique per layoutpublic boolean getPreferencesOwnedByGroup()
Portlettrue if preferences are owned by the group when the
portlet is shown in a group layout. Returns false if
preferences are owned by the user at all times.
getPreferencesOwnedByGroup in interface Portlettrue 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()
Portlettrue if preferences are owned by the group when the
portlet is shown in a group layout. Returns false if
preferences are owned by the user at all times.
isPreferencesOwnedByGroup in interface Portlettrue 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)
Portlettrue if preferences are owned by the group when the
portlet is shown in a group layout. Set to false if
preferences are owned by the user at all times.
setPreferencesOwnedByGroup in interface PortletpreferencesOwnedByGroup - 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()
Portlettrue if the portlet uses the default template.
getUseDefaultTemplate in interface Portlettrue if the portlet uses the default templatepublic boolean isUseDefaultTemplate()
Portlettrue if the portlet uses the default template.
isUseDefaultTemplate in interface Portlettrue if the portlet uses the default templatepublic void setUseDefaultTemplate(boolean useDefaultTemplate)
Portlettrue if the portlet uses the default template.
setUseDefaultTemplate in interface PortletuseDefaultTemplate - boolean value for whether the portlet uses the
default templatepublic boolean getShowPortletAccessDenied()
Portlettrue if users are shown that they do not have access
to the portlet.
getShowPortletAccessDenied in interface Portlettrue if users are shown that they do not have access
to the portletpublic boolean isShowPortletAccessDenied()
Portlettrue if users are shown that they do not have access
to the portlet.
isShowPortletAccessDenied in interface Portlettrue if users are shown that they do not have access
to the portletpublic void setShowPortletAccessDenied(boolean showPortletAccessDenied)
Portlettrue if users are shown that they do not have access
to the portlet.
setShowPortletAccessDenied in interface PortletshowPortletAccessDenied - boolean value for whether users are shown
that they do not have access to the portletpublic boolean getShowPortletInactive()
Portlettrue if users are shown that the portlet is
inactive.
getShowPortletInactive in interface Portlettrue if users are shown that the portlet is inactivepublic boolean isShowPortletInactive()
Portlettrue if users are shown that the portlet is
inactive.
isShowPortletInactive in interface Portlettrue if users are shown that the portlet is inactivepublic void setShowPortletInactive(boolean showPortletInactive)
Portlettrue if users are shown that the portlet is inactive.
setShowPortletInactive in interface PortletshowPortletInactive - boolean value for whether users are shown that
the portlet is inactivepublic boolean getActionURLRedirect()
Portlettrue if an action URL for this portlet should cause
an auto redirect.
getActionURLRedirect in interface Portlettrue if an action URL for this portlet should cause
an auto redirectpublic boolean isActionURLRedirect()
Portlettrue if an action URL for this portlet should cause
an auto redirect.
isActionURLRedirect in interface Portlettrue if an action URL for this portlet should cause
an auto redirectpublic void setActionURLRedirect(boolean actionURLRedirect)
Portlettrue if an action URL for this portlet should cause
an auto redirect.
setActionURLRedirect in interface PortletactionURLRedirect - boolean value for whether an action URL for this
portlet should cause an auto redirectpublic boolean getRestoreCurrentView()
Portlettrue if the portlet restores to the current view
from the maximized state.
getRestoreCurrentView in interface Portlettrue if the portlet restores to the current view
from the maximized statepublic boolean isRestoreCurrentView()
Portlettrue if the portlet restores to the current view
from the maximized state.
isRestoreCurrentView in interface Portlettrue if the portlet restores to the current view
from the maximized statepublic void setRestoreCurrentView(boolean restoreCurrentView)
Portlettrue if the portlet restores to the current view from
the maximized state.
setRestoreCurrentView in interface PortletrestoreCurrentView - boolean value for whether the portlet restores
to the current view from the maximized statepublic boolean getMaximizeEdit()
Portlettrue if the portlet goes into the maximized state
when the user goes into the edit mode.
getMaximizeEdit in interface Portlettrue if the portlet goes into the maximized state
when the user goes into the edit modepublic boolean isMaximizeEdit()
Portlettrue if the portlet goes into the maximized state
when the user goes into the edit mode.
isMaximizeEdit in interface Portlettrue if the portlet goes into the maximized state
when the user goes into the edit modepublic void setMaximizeEdit(boolean maximizeEdit)
Portlettrue if the portlet goes into the maximized state
when the user goes into the edit mode.
setMaximizeEdit in interface PortletmaximizeEdit - boolean value for whether the portlet goes into the
maximized state when the user goes into the edit modepublic boolean getMaximizeHelp()
Portlettrue if the portlet goes into the maximized state
when the user goes into the help mode.
getMaximizeHelp in interface Portlettrue if the portlet goes into the maximized state
when the user goes into the help modepublic boolean isMaximizeHelp()
Portlettrue if the portlet goes into the maximized state
when the user goes into the help mode.
isMaximizeHelp in interface Portlettrue if the portlet goes into the maximized state
when the user goes into the help modepublic void setMaximizeHelp(boolean maximizeHelp)
Portlettrue if the portlet goes into the maximized state
when the user goes into the help mode.
setMaximizeHelp in interface PortletmaximizeHelp - boolean value for whether the portlet goes into the
maximized state when the user goes into the help modepublic boolean getPopUpPrint()
Portlettrue if the portlet goes into the pop up state when
the user goes into the print mode.
getPopUpPrint in interface Portlettrue if the portlet goes into the pop up state when
the user goes into the print modepublic boolean isPopUpPrint()
Portlettrue if the portlet goes into the pop up state when
the user goes into the print mode.
isPopUpPrint in interface Portlettrue if the portlet goes into the pop up state when
the user goes into the print modepublic void setPopUpPrint(boolean popUpPrint)
Portlettrue if the portlet goes into the pop up state when
the user goes into the print mode.
setPopUpPrint in interface PortletpopUpPrint - boolean value for whether the portlet goes into the pop
up state when the user goes into the print modepublic boolean getLayoutCacheable()
Portlettrue to allow the portlet to be cached within the
layout.
getLayoutCacheable in interface Portlettrue if the portlet can be cached within the layoutpublic boolean isLayoutCacheable()
Portlettrue to allow the portlet to be cached within the
layout.
isLayoutCacheable in interface Portlettrue if the portlet can be cached within the layoutpublic void setLayoutCacheable(boolean layoutCacheable)
Portlettrue to allow the portlet to be cached within the
layout.
setLayoutCacheable in interface PortletlayoutCacheable - boolean value for whether the portlet can be
cached within the layoutpublic boolean getInstanceable()
Portlettrue if the portlet can be added multiple times to a
layout.
getInstanceable in interface Portlettrue if the portlet can be added multiple times to a
layoutpublic boolean isInstanceable()
Portlettrue if the portlet can be added multiple times to a
layout.
isInstanceable in interface Portlettrue if the portlet can be added multiple times to a
layoutpublic void setInstanceable(boolean instanceable)
Portlettrue if the portlet can be added multiple times to a
layout.
setInstanceable in interface Portletinstanceable - boolean value for whether the portlet can be added
multiple times to a layoutpublic boolean getRemoteable()
Portlettrue if the portlet supports remoting.
getRemoteable in interface Portlettrue if the portlet supports remotingpublic boolean isRemoteable()
Portlettrue if the portlet supports remoting.
isRemoteable in interface Portlettrue if the portlet supports remotingpublic void setRemoteable(boolean remoteable)
Portlettrue if the portlet supports remoting
setRemoteable in interface Portletremoteable - boolean value for whether or not the the portlet
supports remotingpublic boolean getScopeable()
Portlettrue if the portlet supports scoping of data.
getScopeable in interface Portlettrue if the portlet supports scoping of datapublic boolean isScopeable()
Portlettrue if the portlet supports scoping of data.
isScopeable in interface Portlettrue if the portlet supports scoping of datapublic void setScopeable(boolean scopeable)
Portlettrue if the portlet supports scoping of data.
setScopeable in interface Portletscopeable - boolean value for whether or not the the portlet
supports scoping of datapublic String getUserPrincipalStrategy()
Portlet
getUserPrincipalStrategy in interface Portletpublic void setUserPrincipalStrategy(String userPrincipalStrategy)
Portlet
setUserPrincipalStrategy in interface PortletuserPrincipalStrategy - the user principal strategy of the portletpublic boolean getPrivateRequestAttributes()
Portlettrue if the portlet does not share request
attributes with the portal or portlets from another WAR.
getPrivateRequestAttributes in interface Portlettrue if the portlet does not share request
attributes with the portal or portlets from another WARpublic boolean isPrivateRequestAttributes()
Portlettrue if the portlet does not share request
attributes with the portal or portlets from another WAR.
isPrivateRequestAttributes in interface Portlettrue if the portlet does not share request
attributes with the portal or portlets from another WARpublic void setPrivateRequestAttributes(boolean privateRequestAttributes)
Portlettrue if the portlet does not share request attributes
with the portal or portlets from another WAR.
setPrivateRequestAttributes in interface PortletprivateRequestAttributes - boolean value for whether the portlet
shares request attributes with the portal or portlets from another
WARpublic boolean getPrivateSessionAttributes()
Portlettrue if the portlet does not share session
attributes with the portal.
getPrivateSessionAttributes in interface Portlettrue if the portlet does not share session
attributes with the portalpublic boolean isPrivateSessionAttributes()
Portlettrue if the portlet does not share session
attributes with the portal.
isPrivateSessionAttributes in interface Portlettrue if the portlet does not share session
attributes with the portalpublic void setPrivateSessionAttributes(boolean privateSessionAttributes)
Portlettrue if the portlet does not share session attributes
with the portal.
setPrivateSessionAttributes in interface PortletprivateSessionAttributes - boolean value for whether the portlet
shares session attributes with the portalpublic int getRenderWeight()
Portlet
getRenderWeight in interface Portletpublic void setRenderWeight(int renderWeight)
Portlet
setRenderWeight in interface PortletrenderWeight - int value for the render weight of the portletpublic boolean getAjaxable()
Portlettrue if the portlet can be displayed via Ajax.
getAjaxable in interface Portlettrue if the portlet can be displayed via Ajaxpublic boolean isAjaxable()
Portlettrue if the portlet can be displayed via Ajax.
isAjaxable in interface Portlettrue if the portlet can be displayed via Ajaxpublic void setAjaxable(boolean ajaxable)
Portlettrue if the portlet can be displayed via Ajax.
setAjaxable in interface Portletajaxable - boolean value for whether the portlet can be displayed
via Ajaxpublic List<String> getHeaderPortalCss()
Portlet
getHeaderPortalCss in interface Portletpublic void setHeaderPortalCss(List<String> headerPortalCss)
Portlet
setHeaderPortalCss in interface PortletheaderPortalCss - a list of CSS files that will be referenced from
the page's header relative to the portal's context pathpublic List<String> getHeaderPortletCss()
Portlet
getHeaderPortletCss in interface Portletpublic void setHeaderPortletCss(List<String> headerPortletCss)
Portlet
setHeaderPortletCss in interface PortletheaderPortletCss - a list of CSS files that will be referenced from
the page's header relative to the portlet's context pathpublic List<String> getHeaderPortalJavaScript()
Portlet
getHeaderPortalJavaScript in interface Portletpublic void setHeaderPortalJavaScript(List<String> headerPortalJavaScript)
Portlet
setHeaderPortalJavaScript in interface PortletheaderPortalJavaScript - a list of JavaScript files that will be
referenced from the page's header relative to the portal's context
pathpublic List<String> getHeaderPortletJavaScript()
Portlet
getHeaderPortletJavaScript in interface Portletpublic void setHeaderPortletJavaScript(List<String> headerPortletJavaScript)
Portlet
setHeaderPortletJavaScript in interface PortletheaderPortletJavaScript - a list of JavaScript files that will be
referenced from the page's header relative to the portlet's
context pathpublic List<String> getFooterPortalCss()
Portlet
getFooterPortalCss in interface Portletpublic void setFooterPortalCss(List<String> footerPortalCss)
Portlet
setFooterPortalCss in interface PortletfooterPortalCss - a list of CSS files that will be referenced from
the page's footer relative to the portal's context pathpublic List<String> getFooterPortletCss()
Portlet
getFooterPortletCss in interface Portletpublic void setFooterPortletCss(List<String> footerPortletCss)
Portlet
setFooterPortletCss in interface PortletfooterPortletCss - a list of CSS files that will be referenced from
the page's footer relative to the portlet's context pathpublic List<String> getFooterPortalJavaScript()
Portlet
getFooterPortalJavaScript in interface Portletpublic void setFooterPortalJavaScript(List<String> footerPortalJavaScript)
Portlet
setFooterPortalJavaScript in interface PortletfooterPortalJavaScript - a list of JavaScript files that will be
referenced from the page's footer relative to the portal's context
pathpublic List<String> getFooterPortletJavaScript()
Portlet
getFooterPortletJavaScript in interface Portletpublic void setFooterPortletJavaScript(List<String> footerPortletJavaScript)
Portlet
setFooterPortletJavaScript in interface PortletfooterPortletJavaScript - a list of JavaScript files that will be
referenced from the page's footer relative to the portlet's
context pathpublic String getCssClassWrapper()
Portlet
getCssClassWrapper in interface Portletpublic void setCssClassWrapper(String cssClassWrapper)
Portlet
setCssClassWrapper in interface PortletcssClassWrapper - the name of the CSS class that will be injected in
the DIV that wraps this portletpublic String getFacebookIntegration()
Portlet
getFacebookIntegration in interface Portletpublic void setFacebookIntegration(String facebookIntegration)
Portlet
setFacebookIntegration in interface PortletfacebookIntegration - the Facebook integration method of the portletpublic boolean getAddDefaultResource()
Portlettrue if default resources for the portlet are added
to a page.
getAddDefaultResource in interface Portlettrue if default resources for the portlet are added
to a pagepublic boolean isAddDefaultResource()
Portlettrue if default resources for the portlet are added
to a page.
isAddDefaultResource in interface Portlettrue if default resources for the portlet are added
to a pagepublic void setAddDefaultResource(boolean addDefaultResource)
Portlettrue if default resources for the portlet are added
to a page.
setAddDefaultResource in interface PortletaddDefaultResource - boolean value for whether or not default
resources for the portlet are added to a pagepublic String[] getRolesArray()
Portlet
getRolesArray in interface Portletpublic void setRolesArray(String[] rolesArray)
Portlet
setRolesArray in interface PortletrolesArray - an array of required roles of the portletpublic Set<String> getUnlinkedRoles()
Portlet
getUnlinkedRoles in interface Portletpublic void setUnlinkedRoles(Set<String> unlinkedRoles)
Portlet
setUnlinkedRoles in interface PortletunlinkedRoles - the unlinked roles of the portletpublic Map<String,String> getRoleMappers()
Portlet
getRoleMappers in interface Portletpublic void setRoleMappers(Map<String,String> roleMappers)
Portlet
setRoleMappers in interface PortletroleMappers - the role mappers of the portletpublic void linkRoles()
Portlet
linkRoles in interface Portletpublic boolean hasRoleWithName(String roleName)
Portlettrue if the portlet has a role with the specified
name.
hasRoleWithName in interface Portlettrue if the portlet has a role with the specified
namepublic boolean hasAddPortletPermission(long userId)
Portlettrue if the user has the permission to add the
portlet to a layout.
hasAddPortletPermission in interface Portlettrue if the user has the permission to add the
portlet to a layoutpublic boolean getSystem()
Portlettrue if the portlet is a system portlet that a user
cannot manually add to their page.
getSystem in interface Portlettrue if the portlet is a system portlet that a user
cannot manually add to their pagepublic boolean isSystem()
Portlettrue if the portlet is a system portlet that a user
cannot manually add to their page.
isSystem in interface Portlettrue if the portlet is a system portlet that a user
cannot manually add to their pagepublic void setSystem(boolean system)
Portlettrue if the portlet is a system portlet that a user
cannot manually add to their page.
setSystem in interface Portletsystem - boolean value for whether the portlet is a system portlet
that a user cannot manually add to their pagepublic boolean getInclude()
Portlettrue to include the portlet and make it available to
be made active.
getInclude in interface Portlettrue to include the portlet and make it available to
be made activepublic boolean isInclude()
Portlettrue to include the portlet and make it available to
be made active.
isInclude in interface Portlettrue to include the portlet and make it available to
be made activepublic void setInclude(boolean include)
Portlettrue to include the portlet and make it available to
be made active.
setInclude in interface Portletinclude - boolean value for whether to include the portlet and make
it available to be made activepublic Map<String,String> getInitParams()
Portlet
getInitParams in interface Portletpublic void setInitParams(Map<String,String> initParams)
Portlet
setInitParams in interface PortletinitParams - the init parameters of the portletpublic Integer getExpCache()
Portlet
getExpCache in interface Portletpublic void setExpCache(Integer expCache)
Portlet
setExpCache in interface PortletexpCache - expiration cache of the portletpublic Map<String,Set<String>> getPortletModes()
Portlet
getPortletModes in interface Portletpublic void setPortletModes(Map<String,Set<String>> portletModes)
Portlet
setPortletModes in interface PortletportletModes - the portlet modes of the portlet
public boolean hasPortletMode(String mimeType,
PortletMode portletMode)
Portlettrue if the portlet supports the specified mime type
and portlet mode.
hasPortletMode in interface Portlettrue if the portlet supports the specified mime type
and portlet modepublic Set<String> getAllPortletModes()
Portlet
getAllPortletModes in interface Portletpublic boolean hasMultipleMimeTypes()
Portlettrue if the portlet supports more than one mime
type.
hasMultipleMimeTypes in interface Portlettrue if the portlet supports more than one mime typepublic Map<String,Set<String>> getWindowStates()
Portlet
getWindowStates in interface Portletpublic void setWindowStates(Map<String,Set<String>> windowStates)
Portlet
setWindowStates in interface PortletwindowStates - the window states of the portlet
public boolean hasWindowState(String mimeType,
WindowState windowState)
Portlettrue if the portlet supports the specified mime type
and window state.
hasWindowState in interface Portlettrue if the portlet supports the specified mime type
and window statepublic Set<String> getAllWindowStates()
Portlet
getAllWindowStates in interface Portletpublic Set<String> getSupportedLocales()
Portlet
getSupportedLocales in interface Portletpublic void setSupportedLocales(Set<String> supportedLocales)
Portlet
setSupportedLocales in interface PortletsupportedLocales - the supported locales of the portletpublic String getResourceBundle()
Portlet
getResourceBundle in interface Portletpublic void setResourceBundle(String resourceBundle)
Portlet
setResourceBundle in interface PortletresourceBundle - the resource bundle of the portletpublic PortletInfo getPortletInfo()
Portlet
getPortletInfo in interface Portletpublic void setPortletInfo(PortletInfo portletInfo)
Portlet
setPortletInfo in interface PortletportletInfo - the portlet info of the portletpublic Map<String,PortletFilter> getPortletFilters()
Portlet
getPortletFilters in interface Portletpublic void setPortletFilters(Map<String,PortletFilter> portletFilters)
Portlet
setPortletFilters in interface PortletportletFilters - the filters of the portletpublic void addProcessingEvent(QName processingEvent)
Portlet
addProcessingEvent in interface Portlet
public QName getProcessingEvent(String uri,
String localPart)
Portlet
getProcessingEvent in interface Portletpublic Set<QName> getProcessingEvents()
Portlet
getProcessingEvents in interface Portletpublic void setProcessingEvents(Set<QName> processingEvents)
Portlet
setProcessingEvents in interface PortletprocessingEvents - the supported processing events of the portletpublic void addPublishingEvent(QName publishingEvent)
Portlet
addPublishingEvent in interface Portletpublic Set<QName> getPublishingEvents()
Portlet
getPublishingEvents in interface Portletpublic void setPublishingEvents(Set<QName> publishingEvents)
Portlet
setPublishingEvents in interface PortletpublishingEvents - the supported publishing events of the portletpublic void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Portlet
addPublicRenderParameter in interface PortletpublicRenderParameter - a supported public render parameterpublic PublicRenderParameter getPublicRenderParameter(String identifier)
Portlet
getPublicRenderParameter in interface Portlet
public PublicRenderParameter getPublicRenderParameter(String uri,
String localPart)
Portlet
getPublicRenderParameter in interface Portletpublic Set<PublicRenderParameter> getPublicRenderParameters()
Portlet
getPublicRenderParameters in interface Portletpublic void setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)
Portlet
setPublicRenderParameters in interface PortletpublicRenderParameters - the supported public render parameters of
the portletpublic String getContextPath()
Portlet
getContextPath in interface Portletpublic PortletApp getPortletApp()
Portlet
getPortletApp in interface Portletpublic void setPortletApp(PortletApp portletApp)
Portlet
setPortletApp in interface PortletportletApp - the application this portlet belongs topublic Portlet getClonedInstance(String portletId)
Portlettrue if the portlet is found in a WAR file.
getClonedInstance in interface PortletportletId - the cloned instance portlet id
public boolean getStatic()
Portlettrue if the portlet is a static portlet that is
cannot be moved.
getStatic in interface Portlettrue if the portlet is a static portlet that is
cannot be movedpublic boolean isStatic()
Portlettrue if the portlet is a static portlet that is
cannot be moved.
isStatic in interface Portlettrue if the portlet is a static portlet that is
cannot be movedpublic void setStatic(boolean staticPortlet)
Portlettrue if the portlet is a static portlet that is
cannot be moved.
setStatic in interface PortletstaticPortlet - boolean value for whether the portlet is a static
portlet that cannot be movedpublic boolean getStaticStart()
Portlettrue if the portlet is a static portlet at the start
of a list of portlets.
getStaticStart in interface Portlettrue if the portlet is a static portlet at the start
of a list of portletspublic boolean isStaticStart()
Portlettrue if the portlet is a static portlet at the start
of a list of portlets.
isStaticStart in interface Portlettrue if the portlet is a static portlet at the start
of a list of portletspublic void setStaticStart(boolean staticPortletStart)
Portlettrue if the portlet is a static portlet at the start
of a list of portlets.
setStaticStart in interface PortletstaticPortletStart - boolean value for whether the portlet is a
static portlet at the start of a list of portletspublic boolean getStaticEnd()
Portlettrue if the portlet is a static portlet at the end
of a list of portlets.
getStaticEnd in interface Portlettrue if the portlet is a static portlet at the end
of a list of portletspublic boolean isStaticEnd()
Portlettrue if the portlet is a static portlet at the end
of a list of portlets.
isStaticEnd in interface Portlettrue if the portlet is a static portlet at the end
of a list of portletspublic boolean getUndeployedPortlet()
Portlettrue if the portlet is an undeployed portlet.
getUndeployedPortlet in interface Portlettrue if the portlet is a placeholder of an
undeployed portletpublic boolean isUndeployedPortlet()
Portlettrue if the portlet is an undeployed portlet.
isUndeployedPortlet in interface Portlettrue if the portlet is a placeholder of an
undeployed portletpublic void setUndeployedPortlet(boolean undeployedPortlet)
Portlettrue if the portlet is an undeployed portlet.
setUndeployedPortlet in interface PortletundeployedPortlet - boolean value for whether the portlet is an
undeployed portletpublic boolean equals(Object obj)
Portlet
equals in interface Portletequals in class Objectobj - the object to compare this portlet against
true if the portlet is equal to the specified objectpublic Portlet getWrappedPortlet()
|
Liferay 6.0.4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||