public class PortletConfigurationImpl extends Object implements PortletConfiguration
Constructor and Description |
---|
PortletConfigurationImpl(Long id,
Long dashboardPageId,
Integer column,
Integer row,
io.atlassian.fugue.Option<URI> openSocialSpecUri,
com.atlassian.gadgets.dashboard.Color color,
Map<String,String> userPrefs,
io.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey> completeModuleKey) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(PortletConfiguration that) |
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()
Returns the URI pointing to the OpenSocial gadget XML specification.
|
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 dashboardPageId)
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.
|
String |
toString() |
public PortletConfigurationImpl(Long id, Long dashboardPageId, Integer column, Integer row, io.atlassian.fugue.Option<URI> openSocialSpecUri, com.atlassian.gadgets.dashboard.Color color, Map<String,String> userPrefs, io.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey> completeModuleKey)
public Long getId()
PortletConfiguration
getId
in interface PortletConfiguration
public Integer getColumn()
PortletConfiguration
getColumn
in interface PortletConfiguration
public void setColumn(Integer column)
PortletConfiguration
setColumn
in interface PortletConfiguration
column
- the column number starting from 1.public Integer getRow()
PortletConfiguration
getRow
in interface PortletConfiguration
public Long getDashboardPageId()
PortletConfiguration
getDashboardPageId
in interface PortletConfiguration
public void setDashboardPageId(Long dashboardPageId)
PortletConfiguration
setDashboardPageId
in interface PortletConfiguration
dashboardPageId
- the dashboard page id.public void setRow(Integer row)
PortletConfiguration
setRow
in interface PortletConfiguration
row
- the row number starting from 1.public URI getGadgetURI()
PortletConfiguration
getGadgetURI
in interface PortletConfiguration
PortletConfiguration.getOpenSocialSpecUri()
instead. Since v6.4.http://code.google.com/apis/gadgets/docs/reference.html
public Map<String,String> getUserPrefs()
PortletConfiguration
getUserPrefs
in interface PortletConfiguration
http://code.google.com/apis/gadgets/docs/reference.html#Userprefs_Ref
public void setUserPrefs(Map<String,String> userPrefs)
PortletConfiguration
setUserPrefs
in interface PortletConfiguration
userPrefs
- A map of key value pairspublic com.atlassian.gadgets.dashboard.Color getColor()
PortletConfiguration
getColor
in interface PortletConfiguration
public void setColor(com.atlassian.gadgets.dashboard.Color color)
PortletConfiguration
setColor
in interface PortletConfiguration
color
- the color of the chrome for a gadget.public io.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey> getCompleteModuleKey()
PortletConfiguration
getCompleteModuleKey
in interface PortletConfiguration
public io.atlassian.fugue.Option<URI> getOpenSocialSpecUri()
PortletConfiguration
Option
for dashboard item without replacement uri.getOpenSocialSpecUri
in interface PortletConfiguration
http://code.google.com/apis/gadgets/docs/reference.html
public int compareTo(PortletConfiguration that)
compareTo
in interface Comparable<PortletConfiguration>
Copyright © 2002-2024 Atlassian. All Rights Reserved.