com.atlassian.jira.portal

Interface PortletConfiguration

All Superinterfaces:

Comparable<PortletConfiguration>

All Known Implementing Classes:

PortletConfigurationImpl

public interface PortletConfiguration
extends Comparable<PortletConfiguration>

A representation of a configuration for a Google Gadget.

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

Method Summary

Modifier and Type	Method and Description
com.atlassian.gadgets.dashboard.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.
io.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey>	getCompleteModuleKey() Return optional module key which identifies dashboard items which are described in atlassian-plugin.xml.
Long	getDashboardPageId() Provides the dashboard page id.
URI	getGadgetURI() Deprecated.
Long	getId() Return the id of the PortletConfiguration.
io.atlassian.fugue.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(com.atlassian.gadgets.dashboard.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.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

Long getId()

Return the id of the PortletConfiguration.

Returns:

the id of the PortletConfiguration.

getColumn

Integer getColumn()

Represents the column that the configured portlet resides in.

Returns:

the column number starting from 1.

setColumn

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.

getRow

Integer getRow()

Represents the row that the configured portlet resides in.

Returns:

the row number starting from 1.

setRow

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.

getDashboardPageId

Long getDashboardPageId()

Provides the dashboard page id.

Returns:

the dashboard page id.

setDashboardPageId

void setDashboardPageId(Long portalPageId)

Sets the dashboard page id.

Parameters:

portalPageId - the dashboard page id.

getGadgetURI

@Nullable
 @Deprecated
URI getGadgetURI()

Deprecated.

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:

URI pointing to the Gadget XML or null deprecated Use getOpenSocialSpecUri() instead. Since v6.4.

See Also:

http://code.google.com/apis/gadgets/docs/reference.html

getColor

com.atlassian.gadgets.dashboard.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

setColor

void setColor(com.atlassian.gadgets.dashboard.Color color)

Set the color of the chrome for a gadget.

Parameters:

color - the color of the chrome for a gadget.

getUserPrefs

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

setUserPrefs

void setUserPrefs(Map<String,String> userPrefs)

Sets the userPreferences for this portletconfig.

Parameters:

userPrefs - A map of key value pairs

getOpenSocialSpecUri

io.atlassian.fugue.Option<URI> getOpenSocialSpecUri()

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

Returns:

optional URI pointing to the Gadget XML

Since:

6.4

See Also:

http://code.google.com/apis/gadgets/docs/reference.html

getCompleteModuleKey

io.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey> getCompleteModuleKey()

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

Returns:

optional complete module key

Since:

6.4