public interface PortletConfiguration extends Comparable<PortletConfiguration>
Only the main implementation (PortletConfigurationImpl), properly uses the full interface.
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.
|
compareTo
Long getId()
Integer getColumn()
void setColumn(Integer column)
column
- the column number starting from 1.Integer getRow()
void setRow(Integer row)
row
- the row number starting from 1.Long getDashboardPageId()
void setDashboardPageId(Long portalPageId)
portalPageId
- the dashboard page id.@Nullable @Deprecated URI getGadgetURI()
getOpenSocialSpecUri()
instead. Since v6.4.http://code.google.com/apis/gadgets/docs/reference.html
com.atlassian.gadgets.dashboard.Color getColor()
void setColor(com.atlassian.gadgets.dashboard.Color color)
color
- the color of the chrome for a gadget.Map<String,String> getUserPrefs()
http://code.google.com/apis/gadgets/docs/reference.html#Userprefs_Ref
void setUserPrefs(Map<String,String> userPrefs)
userPrefs
- A map of key value pairsio.atlassian.fugue.Option<URI> getOpenSocialSpecUri()
Option
for dashboard item without replacement uri.http://code.google.com/apis/gadgets/docs/reference.html
io.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey> getCompleteModuleKey()
Copyright © 2002-2022 Atlassian. All Rights Reserved.