|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Object java.lang.Enum<Layout> com.atlassian.gadgets.dashboard.Layout
public enum Layout
Dashboards can be laid out in multiple ways: with a single column (A), with two columns of equal size (AA), with two columns where one is smaller and the other is larger (AB), etc. A larger column is said to be "greedy" because it takes up more room than any of the other columns in the tab. A normal column is said to be "fair" because it tries to share space equally with the other tabs.
Enum Constant Summary | |
---|---|
A
single column |
|
AA
two columns of equal size |
|
AAA
three columns, each of equal size |
|
AB
two columns, the first being smaller than the second |
|
ABA
three columns, the first and third are of equal size with the second column larger than the others |
|
BA
two columns, the first being larger than the second |
Method Summary | |
---|---|
boolean |
contains(DashboardState.ColumnIndex column)
Checks if the column exists in this layout. |
Iterable<DashboardState.ColumnIndex> |
getColumnRange()
Return an immutable Iterable over the ColumnIndex es that exist in this layout. |
int |
getNumberOfColumns()
Returns the number of columns in this layout. |
boolean |
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. |
static Layout |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static Layout[] |
values()
Returns an array containing the constants of this enum type, in the order they're declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final Layout A
public static final Layout AA
public static final Layout AB
public static final Layout BA
public static final Layout AAA
public static final Layout ABA
Method Detail |
---|
public static final Layout[] values()
for(Layout c : Layout.values()) System.out.println(c);
public static Layout valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified namepublic int getNumberOfColumns()
public boolean contains(DashboardState.ColumnIndex column)
column
exists in this layout.
column
- Column to check exists in this layout
true
if the column exists in this layout, false
otherwisepublic Iterable<DashboardState.ColumnIndex> getColumnRange()
Iterable
over the ColumnIndex
es that exist in this layout.
Iterable
over the ColumnIndex
es that exist in this layout.public boolean isColumnSizingFair(DashboardState.ColumnIndex column)
column
shares the space with the other columns on the screen equally or if it is greedy
and should take up more space.
column
- column index to check for sizing fairness
IllegalArgumentException
- thrown if the column is not contained in this layout
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |