| Package | Description |
|---|---|
| com.atlassian.gadgets |
This package contains the main APIs for interacting with gadgets.
|
| com.atlassian.gadgets.dashboard |
This package contains the main APIs for interacting with dashboards and gadgets.
|
| com.atlassian.gadgets.spec |
Contains classes related to Gadgets' Specification XML.
|
| com.atlassian.gadgets.view |
Contains classes related to the rendering and display of gadgets.
|
| Modifier and Type | Method and Description |
|---|---|
GadgetState |
GadgetState.Builder.build()
Returns the final constructed
GadgetState |
| Modifier and Type | Method and Description |
|---|---|
static GadgetState.Builder |
GadgetState.gadget(GadgetState state)
Factory method which allows you to create a new
GadgetState object based on an existing
GadgetState. |
T |
DashboardItemStateVisitor.visit(GadgetState openSocialGadgetState) |
| Constructor and Description |
|---|
Builder(GadgetState state) |
| Modifier and Type | Method and Description |
|---|---|
Iterable<? extends Iterable<GadgetState>> |
DashboardState.getColumns()
Deprecated.
|
Iterable<GadgetState> |
DashboardState.getGadgetsInColumn(DashboardState.ColumnIndex column)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
DashboardState |
DashboardState.appendGadgetToColumn(GadgetState gadgetState,
DashboardState.ColumnIndex index)
Deprecated.
|
DashboardState |
DashboardState.prependGadgetToColumn(GadgetState dashboardItemState,
DashboardState.ColumnIndex index)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
DashboardState.Builder |
DashboardState.Builder.columns(Iterable<? extends Iterable<GadgetState>> columns)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
GadgetSpec |
GadgetSpecFactory.getGadgetSpec(GadgetState gadgetState,
GadgetRequestContext gadgetRequestContext)
Create a
GadgetSpec from a GadgetState |
| Modifier and Type | Method and Description |
|---|---|
GadgetState |
GadgetRenderingException.getGadgetState() |
| Modifier and Type | Method and Description |
|---|---|
URI |
RenderedGadgetUriBuilder.build(GadgetState gadgetState,
ModuleId moduleId,
View view,
GadgetRequestContext gadgetRequestContext)
Returns the URL to the rendered gadget.
|
URI |
RenderedGadgetUriBuilder.build(GadgetState gadgetState,
View view,
GadgetRequestContext gadgetRequestContext)
Deprecated.
|
boolean |
GadgetViewFactory.canRenderInViewType(GadgetState state,
ViewType viewType,
GadgetRequestContext gadgetRequestContext)
Returns
true if the gadget represented by state can be rendered with the given ViewType for
the locale specified in the GadgetRequestContext. |
ViewComponent |
GadgetViewFactory.createGadgetView(GadgetState state,
ModuleId moduleId,
View view,
GadgetRequestContext gadgetRequestContext)
Returns a
ViewComponent that will render the GadgetState, customizing the view based on the
Locale specified in the GadgetRequestContext and the desired ViewType. |
ViewComponent |
GadgetViewFactory.createGadgetView(GadgetState state,
View view,
GadgetRequestContext gadgetRequestContext)
|
String |
SecurityTokenFactory.newSecurityToken(GadgetState state,
String viewer)
Create a new security token for the gadget.
|
| Constructor and Description |
|---|
GadgetRenderingException(GadgetState gadget,
Throwable cause) |
GadgetRenderingException(String message,
GadgetState gadget) |
GadgetRenderingException(String message,
GadgetState gadget,
Throwable cause) |
Copyright © 2024 Atlassian. All rights reserved.