public interface

PortletConfiguration

implements Comparable<T>
com.atlassian.jira.portal.PortletConfiguration
Known Indirect Subclasses

Class Overview

A representation of a configuration for a Google Gadget.

Only the main implementation (PortletConfigurationImpl), properly uses the full interface.

Summary

Public Methods
Color getColor()
Returns the color to use when rendering the Chrome of this gadget.
Integer getColumn()
Represents the column that the configured portlet resides in.
Option<ModuleCompleteKey> getCompleteModuleKey()
Return optional module key which identifies dashboard items which are described in atlassian-plugin.xml.
Long getDashboardPageId()
Provides the dashboard page id.
@Nullable @Deprecated URI getGadgetURI()
Returns the URI pointing to the OpenSocial gadget XML specification.
Long getId()
Return the id of the PortletConfiguration.
Option<URI> getOpenSocialSpecUri()
Returns optional URI pointing to the OpenSocial gadget XML specification.
Integer getRow()
Represents the row that the configured portlet resides in.
Map<String, String> getUserPrefs()
An unmodifiable map of user preferences stored for this gadget.
void setColor(Color color)
Set the color of the chrome for a gadget.
void setColumn(Integer column)
Sets the column for the Portlet, effectively moving the portlet left or right on the page.
void setDashboardPageId(Long portalPageId)
Sets the dashboard page id.
void setRow(Integer row)
Sets the row for the Portlet, effectively moving the portlet up or down on the page.
void setUserPrefs(Map<String, String> userPrefs)
Sets the userPreferences for this portletconfig.
[Expand]
Inherited Methods
From interface java.lang.Comparable

Public Methods

public Color getColor ()

Returns the color to use when rendering the Chrome of this gadget.

Returns
  • color to use when rendering the Chrome of this gadget

public Integer getColumn ()

Represents the column that the configured portlet resides in.

Returns
  • the column number starting from 1.

public Option<ModuleCompleteKey> getCompleteModuleKey ()

Return optional module key which identifies dashboard items which are described in atlassian-plugin.xml.

Returns
  • optional complete module key

public Long getDashboardPageId ()

Provides the dashboard page id.

Returns
  • the dashboard page id.

@Nullable @Deprecated public URI getGadgetURI ()

Returns the URI pointing to the OpenSocial gadget XML specification. May return null for legacy portlets (that don't implement the Gadget spec) or dashboard item without replacement uri.

Returns
See Also
  • http://code.google.com/apis/gadgets/docs/reference.html

public Long getId ()

Return the id of the PortletConfiguration.

Returns
  • the id of the PortletConfiguration.

public Option<URI> getOpenSocialSpecUri ()

Returns optional URI pointing to the OpenSocial gadget XML specification. It returns an empty com.atlassian.fugue.Option for dashboard item without replacement uri.

Returns
  • optional URI pointing to the Gadget XML
See Also
  • http://code.google.com/apis/gadgets/docs/reference.html

public Integer getRow ()

Represents the row that the configured portlet resides in.

Returns
  • the row number starting from 1.

public Map<String, String> getUserPrefs ()

An unmodifiable map of user preferences stored for this gadget.

Returns
  • map of user preferences stored for this gadget.
See Also
  • http://code.google.com/apis/gadgets/docs/reference.html#Userprefs_Ref

public void setColor (Color color)

Set the color of the chrome for a gadget.

Parameters
color the color of the chrome for a gadget.

public void setColumn (Integer column)

Sets the column for the Portlet, effectively moving the portlet left or right on the page.

Parameters
column the column number starting from 1.

public void setDashboardPageId (Long portalPageId)

Sets the dashboard page id.

Parameters
portalPageId the dashboard page id.

public void setRow (Integer row)

Sets the row for the Portlet, effectively moving the portlet up or down on the page.

Parameters
row the row number starting from 1.

public void setUserPrefs (Map<String, String> userPrefs)

Sets the userPreferences for this portletconfig.

Parameters
userPrefs A map of key value pairs