|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletConfiguration
A representation of a configuration for a Portlet on a page. In addition to the ObjectConfigurable properties of the Portlet, the row and column are available as well as the id of the dashboard page. The interface is a bit bogus - partially a dashboard page position bean with some other stuff on it.
Only the main implementation,PortletConfigurationImpl
, properly uses
the full interface. Bear in mind there is an implementation in the JIRA Charting Plugin called
SearchRequestViewPortletConfiguration which is used to quickly render charts as issue navigator views.
Method Summary | |
---|---|
Integer |
getColumn()
Represents the column that the configured portlet resides in. |
Long |
getDashboardPageId()
Provides the dashboard page id. |
Long |
getId()
Return the id of the PortletConfiguration. |
Portlet |
getPortlet()
Returns the portlet implementation that this PortletConfiguration is for. |
Integer |
getRow()
Represents the row that the configured portlet resides in. |
boolean |
isResourcesProvided()
Declares whether the portlet should expect to have resources such as CSS and JavaScript files included in the page. |
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. |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Methods inherited from interface com.atlassian.configurable.ObjectConfigurable |
---|
getDefaultProperty, getKey, getLongProperty, getObjectConfiguration, getProperties, getProperty, getTextProperty, hasProperty |
Method Detail |
---|
Long getId()
Portlet getPortlet()
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.boolean isResourcesProvided()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |