com.atlassian.gadgets.dashboard.spi

Class GadgetLayout

java.lang.Object

com.atlassian.gadgets.dashboard.spi.GadgetLayout

public final class GadgetLayout
extends Object

Defines how gadgets should be layed out on a dashboard.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
GadgetLayout(List<? extends Iterable<GadgetId>> columnLayout)

Method Summary

Modifier and Type	Method and Description
Iterable<GadgetId>	getGadgetsInColumn(int column) Returns the IDs of the gadgets that appear in a given column.
int	getNumberOfColumns() Returns the number of columns that should be on the dashboard.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GadgetLayout

public GadgetLayout(List<? extends Iterable<GadgetId>> columnLayout)

Method Detail

getNumberOfColumns

public int getNumberOfColumns()

Returns the number of columns that should be on the dashboard.

Returns:

number of columns that should be on the dashboard

getGadgetsInColumn

public Iterable<GadgetId> getGadgetsInColumn(int column)

Returns the IDs of the gadgets that appear in a given column.

Parameters:

column - number of the column to get the gadgets it contains

Returns:

IDs of the gadgets that appear in a given column