|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Dashboard
Method Summary | |
---|---|
void |
addGadget(com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex column,
Gadget gadget)
Add a gadget to the first position of the specified column |
void |
addGadget(Gadget gadget)
|
void |
appendGadget(com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex column,
Gadget gadget)
Add a gadget to the end of the specified column |
void |
appendGadget(Gadget gadget)
Add a gadget to the default tab. |
void |
changeGadgetColor(com.atlassian.gadgets.GadgetId gadgetId,
com.atlassian.gadgets.dashboard.Color color)
Change the color of the gadgets chrome. |
void |
changeLayout(com.atlassian.gadgets.dashboard.Layout layout,
com.atlassian.gadgets.dashboard.spi.GadgetLayout gadgetLayout)
Change the layout of the dashboard and use the gadget layout to update the gadget positioning. |
void |
clearChanges()
Clears the stored list of changes that have been made to this Dashboard |
Gadget |
findGadget(com.atlassian.gadgets.GadgetId gadgetId)
Lookup a Gadget in this Dashboard given the gadget's id. |
List<com.atlassian.gadgets.dashboard.spi.changes.DashboardChange> |
getChanges()
Returns an immutable list of changes that have been made to this Dashboard , in the order that they
occurred. |
Iterable<Gadget> |
getGadgetsInColumn(com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex column)
|
com.atlassian.gadgets.dashboard.DashboardId |
getId()
|
com.atlassian.gadgets.dashboard.Layout |
getLayout()
|
int |
getNumberOfGadgets()
Get the total number of gadgets on this dashboard |
com.atlassian.gadgets.dashboard.DashboardState |
getState()
|
String |
getTitle()
|
void |
rearrangeGadgets(com.atlassian.gadgets.dashboard.spi.GadgetLayout layout)
Rearrange and reposition the gadgets on the dashboard according to the specified layout. |
void |
removeGadget(com.atlassian.gadgets.GadgetId gadgetId)
Remove the gadget with the provided id from the dashboard. |
void |
updateGadgetUserPrefs(com.atlassian.gadgets.GadgetId gadgetId,
Map<String,String> prefValues)
Save user prefs for a gadget |
Method Detail |
---|
com.atlassian.gadgets.dashboard.DashboardId getId()
String getTitle()
com.atlassian.gadgets.dashboard.Layout getLayout()
Iterable<Gadget> getGadgetsInColumn(com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex column)
com.atlassian.gadgets.dashboard.DashboardState getState()
Gadget findGadget(com.atlassian.gadgets.GadgetId gadgetId)
gadgetId
- The gadgetId of the gadget to lookup
List<com.atlassian.gadgets.dashboard.spi.changes.DashboardChange> getChanges()
Dashboard
, in the order that they
occurred.
Dashboard
void clearChanges()
Dashboard
void appendGadget(Gadget gadget)
gadget
- the gadget being addedvoid addGadget(Gadget gadget)
void appendGadget(com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex column, Gadget gadget)
column
- index of column to append the gadget togadget
- the gadget being addedvoid addGadget(com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex column, Gadget gadget)
column
- index of the column to add the gadget togadget
- the gadget being addedint getNumberOfGadgets()
void removeGadget(com.atlassian.gadgets.GadgetId gadgetId)
gadgetId
- id of the gadget to removevoid rearrangeGadgets(com.atlassian.gadgets.dashboard.spi.GadgetLayout layout) throws GadgetLayoutException
layout
- Layout to match
GadgetLayoutException
- thrown if the layout is invalidvoid changeLayout(com.atlassian.gadgets.dashboard.Layout layout, com.atlassian.gadgets.dashboard.spi.GadgetLayout gadgetLayout) throws GadgetLayoutException
layout
- New layout to use for the dashboardgadgetLayout
- New positioning of the gadgets
GadgetLayoutException
- thrown if the positioning of the gadgets is not valid for the new layout - e.g.
threre are gadgets in columns that don't exist in the new layoutvoid changeGadgetColor(com.atlassian.gadgets.GadgetId gadgetId, com.atlassian.gadgets.dashboard.Color color) throws com.atlassian.gadgets.GadgetNotFoundException, GadgetNotLoadedException
gadgetId
- Id of gadget to change the color of.color
- Color to change the chrome to
com.atlassian.gadgets.GadgetNotFoundException
- if the gadget could not be found by ID
GadgetNotLoadedException
- if the gadget wasn't loadedvoid updateGadgetUserPrefs(com.atlassian.gadgets.GadgetId gadgetId, Map<String,String> prefValues) throws com.atlassian.gadgets.GadgetNotFoundException, GadgetNotLoadedException
gadgetId
- Id of gadget to change the color of.prefValues
- preferences to save
com.atlassian.gadgets.GadgetNotFoundException
- if the gadget could not be found by ID
GadgetNotLoadedException
- if the gadget wasn't loaded
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |