| Package | Description |
|---|---|
| com.atlassian.gadgets.dashboard |
This package contains the main APIs for interacting with dashboards and gadgets.
|
| Modifier and Type | Method and Description |
|---|---|
static DashboardState.ColumnIndex |
DashboardState.ColumnIndex.from(int index)
Returns the column
index as an instance of ColumnIndex. |
DashboardState.ColumnIndex |
DashboardItemRepresentationService.RenderingContext.getColumnIndex() |
DashboardState.ColumnIndex |
DashboardState.ColumnIndex.next()
Returns the next column index after this one if there is one, equivalent to doing i+1 when the index is an
int. |
static DashboardState.ColumnIndex |
DashboardState.ColumnIndex.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static DashboardState.ColumnIndex[] |
DashboardState.ColumnIndex.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
| Modifier and Type | Method and Description |
|---|---|
Iterable<DashboardState.ColumnIndex> |
Layout.getColumnRange()
Return an immutable
Iterable over the ColumnIndexes that exist in this layout. |
static Iterable<DashboardState.ColumnIndex> |
DashboardState.ColumnIndex.range(DashboardState.ColumnIndex start,
DashboardState.ColumnIndex end)
Returns an immutable
Iterable over ColumnIndexes starting from start and
ending with end, inclusive. |
| Modifier and Type | Method and Description |
|---|---|
DashboardState |
DashboardState.appendGadgetToColumn(GadgetState gadgetState,
DashboardState.ColumnIndex index)
Deprecated.
|
DashboardState |
DashboardState.appendItemToColumn(DashboardItemState itemState,
DashboardState.ColumnIndex index)
Returns a new DashboardState built with the same data as
this, except that the column with index
index has had a new gadget added to its bottom |
boolean |
Layout.contains(DashboardState.ColumnIndex column)
Checks if the
column exists in this layout. |
static DashboardItemRepresentationService.RenderingContext |
DashboardItemRepresentationService.RenderingContext.editable(GadgetRequestContext requestContext,
DashboardId dashboardId,
DashboardState.ColumnIndex columnIndex) |
Iterable<GadgetState> |
DashboardState.getGadgetsInColumn(DashboardState.ColumnIndex column)
Deprecated.
|
List<DashboardItemState> |
DashboardColumns.getItemsInColumn(DashboardState.ColumnIndex column)
Returns an immutable
List of the DashboardStateItems in the given column. |
boolean |
Layout.isColumnSizingFair(DashboardState.ColumnIndex column)
Checks if the
column shares the space with the other columns on the screen equally or if it is greedy
and should take up more space. |
DashboardState |
DashboardState.prependGadgetToColumn(GadgetState dashboardItemState,
DashboardState.ColumnIndex index)
Deprecated.
|
DashboardState |
DashboardState.prependItemToColumn(DashboardItemState itemState,
DashboardState.ColumnIndex index)
Returns a new DashboardState built with the same data as
this, except that the column with index
index has had a new gadget added to its top |
static Iterable<DashboardState.ColumnIndex> |
DashboardState.ColumnIndex.range(DashboardState.ColumnIndex start,
DashboardState.ColumnIndex end)
Returns an immutable
Iterable over ColumnIndexes starting from start and
ending with end, inclusive. |
static DashboardItemRepresentationService.RenderingContext |
DashboardItemRepresentationService.RenderingContext.readOnly(GadgetRequestContext requestContext,
DashboardId dashboardId,
DashboardState.ColumnIndex columnIndex) |
Copyright © 2024 Atlassian. All rights reserved.