Top Description Methods
javax.portlet.annotations

public @Interface PortletApplication

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
Imports
java.lang.annotation.Retention, .Target
Annotation for the portlet application configuration. These configuration parameters also appear in the portlet deployment descriptor.

The portlet deployment descriptor can continue to be used. Values of configuration parameters appearing in the deployment descriptor have precedence over the corresponding values defined in the annotation.

Since
3.0

Method Summary

Modifier and TypeMethod and Description
public CustomPortletMode[]

Returns:

The custom portlet modes
customPortletModes()

The custom portlet modes defined for this portlet.
public CustomWindowState[]

Returns:

The custom window states
customWindowStates()

The custom window states defined for this portlet.
public String

Returns:

The default namespace URI.
defaultNamespaceURI()

The default QName namespace URI.
public EventDefinition[]

Returns:

The event definitions
events()

The events defined for the portlet.
public PublicRenderParameterDefinition[]

Returns:

The array of public render parameters.
publicParams()

The public render parameters used by the portlet.
public String

Returns:

The resource bundle name
resourceBundle()

The resource bundle name for this portlet.
public RuntimeOption[]

Returns:

An array of portlet container runtime options
runtimeOptions()

The portlet container runtime options.
public UserAttribute[]

Returns:

The user attribute declarations
userAttributes()

The user aattribute declarations.
public String

Returns:

The portlet API version
version()

The portlet API version required by this portlet application.
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

customPortletModesback to summary
public CustomPortletMode[] customPortletModes()

The custom portlet modes defined for this portlet.
Returns:CustomPortletMode[]

The custom portlet modes

customWindowStatesback to summary
public CustomWindowState[] customWindowStates()

The custom window states defined for this portlet.
Returns:CustomWindowState[]

The custom window states

defaultNamespaceURIback to summary
public String defaultNamespaceURI()

The default QName namespace URI.

The default namespace URI is used when no namespace URI is specified when declaring a QName for a public render parameter or portlet event.

Returns:String

The default namespace URI.

eventsback to summary
public EventDefinition[] events()

The events defined for the portlet. This includes the processing events as well as the publishing events.

The publishing event QNames are specified in the ActionMethod and EventMethod annotations. The processing event QNames are specified in the ActionMethod and EventMethod annotations.

Returns:EventDefinition[]

The event definitions

See Also
PortletQName, ActionMethod, EventMethod
publicParamsback to summary
public PublicRenderParameterDefinition[] publicParams()

The public render parameters used by the portlet.
Returns:PublicRenderParameterDefinition[]

The array of public render parameters.

resourceBundleback to summary
public String resourceBundle()

The resource bundle name for this portlet. Name of the resource bundle containing the language specific portlet information in different languages.

the file name is specified without the language specific part (e.g. _en) or the file extension.

Returns:String

The resource bundle name

runtimeOptionsback to summary
public RuntimeOption[] runtimeOptions()

The portlet container runtime options.
Returns:RuntimeOption[]

An array of portlet container runtime options

userAttributesback to summary
public UserAttribute[] userAttributes()

The user aattribute declarations.
Returns:UserAttribute[]

The user attribute declarations

versionback to summary
public String version()

The portlet API version required by this portlet application.
Returns:String

The portlet API version