Top Description Methods
javax.portlet.annotations

public @Interface CustomPortletMode

extends Annotation
Annotations
@Retention:RUNTIME
@Target:ANNOTATION_TYPE
Imports
java.lang.annotation.Retention, .Target
This annotation is used within composite portlet configuration annotations to represent a custom portlet mode. It cannot be used as a stand-alone portlet annotation.
Since
3.0

Method Summary

Modifier and TypeMethod and Description
public LocaleString[]

Returns:

The custom portlet mode description
description()

Provides locale-specific text describing the custom portlet mode for use by the portal application or by tools.
public String

Returns:

The custom portlet mode name
name()

The custom portlet mode name.
public boolean

Returns:

The portal managed flag setting
portalManaged()

The portal managed flag.
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

descriptionback to summary
public LocaleString[] description()

Provides locale-specific text describing the custom portlet mode for use by the portal application or by tools.
Returns:LocaleString[]

The custom portlet mode description

nameback to summary
public String name()

The custom portlet mode name.

The name by which the portlet mode is identified.

Returns:String

The custom portlet mode name

portalManagedback to summary
public boolean portalManaged()

The portal managed flag.

If set to true, the custom portlet mode will be managed by the portal. If set to false, the custom portlet mode will be managed by the portlet.

Returns:boolean

The portal managed flag setting