Portlet Plugin Module

Purpose of this Module Type

A portlet plugin module defines a portlet that users can add to their Dashboards.

In JIRA 4, portlets have been superseded by gadgets.

For details, please see Gadgets and JIRA Portlets.

構成

The root element for the portlet plugin module is portlet. It allows the following attributes and child elements for configuration:

属性

名前	説明	既定
クラス	[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、 The Java class of the component. Portlet implementation classes are required to implement the `com.atlassian.jira.portlet.Portlet` interface, but we strongly recommend that you extend the convenience class `com.atlassian.jira.portlet.PortletImpl`.
鍵 (キー)	[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、 I.e. the identifier of the component.	N/A
i18n-name-key	[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、
name	[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、 I.e. the human-readable name of the component.	The plugin key.

Elements

名前	必須	説明
description		A human-readable description of this portlet module. May be specified as the value of this element for plain text or with the `key` attribute to use the value of a key from the i18n system.
ラベル		The user-visible name of this portlet. May be specified as the value of this element for plain text or with the `key` attribute to use the value of a key from the i18n system.
サムネイル		An optional thumbnail image used to preview the portlet for users.
権限		Permission required to add this portlet to a dashboard. Value must be one of the fields of `com.atlassian.jira.security.Permissions`.
objectdescriptor		Allows configuration of this portlet with an object descriptor class (see this page for more details). We recommend using a `key` attribute containing the localized name of your plugin.
lazy		Whether to load this portlet lazily.

例

<portlet key="assignedtome" name="Assigned Issues"
    class="com.atlassian.jira.portal.portlets.AssignedToMePortlet">
    <description key="portlet.assignedtome.description">i18n description</description>
    <!-- this template produces the eventual HTML of the portlet -->
    <resource type="velocity" name="view" location="templates/plugins/jira/portlets/assignedtome.vm" />
    <label key="portlet.assignedtome.name" />
    <!-- an optional thumbmail image used to preview the portlet for users -->
    <thumbnail>portlets/dashboard/thumbnails/assigned.gif</thumbnail>
    <!-- 
        the permissions required to add this portlet
        (optional - not often required)
     -->
    <permission>assignable</permission>
    <objectdescriptor key="portlet.assignedtome.display.name" />
    <!-- same as the properties of the report plugin module -->
    <properties>
        <property>
            <key>numofentries</key>
            <name>portlet.assignedtome.field.numofentries.name</name>
            <description>portlet.assignedtome.field.numofentries.description</description>
            <type>long</type>
            <default>10</default>
        </property>
    </properties>
</portlet>

注意

Also see How to create a JIRA Portlet.

Child pages

Portlet Plugin Module

Purpose of this Module Type

構成

属性

Elements

例

注意