User Documentation

One Minute Introduction

Two Minute Introduction

Your own plugin

Coffee Break Introduction

Property substitution

FAQ

IDE Integration

Doclipse

Maven Integration

Maven2 Plugin

Maven1 Plugin

Plugins

Project Information

Mailing lists

Source Repositories

Open Issues

Team

Developer Documentation

Feeds
Print
PortletTags

@portlet tags

@portlet.locale

Defines a portlet's locale support. This tag may be used multiple times

to define multiple locales.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
locale false Any value   no   The locale supported by the portlet.

@portlet.portlet-info

Defines locale-specific portlet information.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
title false Any value   no   The locale-specific portlet title.
short-title false Any value   no   The locale-specific portlet short title.
keywords false Any value   no   The locale-specific portlet keywords.

@portlet.portlet-init-param

Defines a portlet initialization parameter.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The parameter name.
value true Any value   no   The parameter value.
keywords false Any value   no   The parameter description.

@portlet.portlet

Defines basic portlet information.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
description false Any value   no   Portlet description
display-name true Any value   no   Display name
name false Any value   no   Portlet name
expiration-cache false Any value   no   Expiration cache (in seconds)

@portlet.preferences

Defines mime-type support for the portlet.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The preference name.
value true Any value   no   The preference's default value;
read-only false true, false   no   Specifies that the preference is read-only. Defaults to false.

@portlet.preferences-validator

Assigns a preferences validator to a portlet.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
validator-class true Any value   no   The fully-qualified class name of the class that implements

javax.portlet.PreferencesValidator.

@portlet.resource-bundle

Defines a portlet's resource bundle.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
bundle false Any value   no   The name of the portlet's resource bundle.

@portlet.supports

Defines mime-type support for the portlet.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
mime-type true Any value   no   Mime-type supported by the portlet.
modes true Any value   no   Comma-separated list of modes supported for the specified mime-type.
Copyright 2003-2006 - The Codehaus. All rights reserved unless otherwise noted.
Powered by Atlassian Confluence