|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.sonar.api.web.Dashboard
public final class Dashboard
Definition of a dashboard.
Its name and description can be retrieved using the i18n mechanism, using the keys "dashboard.<id>.name" and "dashboard.<id>.description".
Nested Class Summary | |
---|---|
static class |
Dashboard.Widget
Note that this class is an inner class to avoid confusion with the extension point org.sonar.api.web.Widget. |
Method Summary | |
---|---|
Dashboard.Widget |
addWidget(String widgetId,
int columnId)
Add a widget with the given parameters, and return the newly created Dashboard.Widget object if one wants to add parameters to it. |
static Dashboard |
create()
Creates a new Dashboard . |
String |
getDescription()
Returns the description of the dashboard. |
DashboardLayout |
getLayout()
Returns the layout. |
Collection<Dashboard.Widget> |
getWidgets()
|
List<Dashboard.Widget> |
getWidgetsOfColumn(int columnId)
|
Dashboard |
setDescription(String description)
Sets the description of the dashboard. |
Dashboard |
setLayout(DashboardLayout dl)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static Dashboard create()
Dashboard
.
public Dashboard.Widget addWidget(String widgetId, int columnId)
Dashboard.Widget
object if one wants to add parameters to it.
The widget ids are listed by the web service /api/widgets
widgetId
- id of an existing widgetcolumnId
- column starts with 1. The widget is ignored if the column id does not match the layout.public Collection<Dashboard.Widget> getWidgets()
public List<Dashboard.Widget> getWidgetsOfColumn(int columnId)
public String getDescription()
public Dashboard setDescription(String description)
description
- the description to setpublic DashboardLayout getLayout()
public Dashboard setLayout(DashboardLayout dl)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |