| 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.dashboard.view | |
| com.atlassian.gadgets.directory | |
| 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 | Field and Description |
|---|---|
static GadgetRequestContext |
GadgetRequestContext.NO_CURRENT_REQUEST |
| Modifier and Type | Method and Description |
|---|---|
GadgetRequestContext |
GadgetRequestContext.Builder.build()
Returns the final constructed
GadgetRequestContext. |
GadgetRequestContext |
GadgetRequestContextFactory.get(javax.servlet.http.HttpServletRequest request)
Returns a
GadgetRequestContext based on the values in
the specified request. |
| Modifier and Type | Method and Description |
|---|---|
GadgetRequestContext |
DashboardItemRepresentationService.RenderingContext.getRequestContext() |
| Modifier and Type | Method and Description |
|---|---|
static DashboardItemRepresentationService.RenderingContext |
DashboardItemRepresentationService.RenderingContext.editable(GadgetRequestContext requestContext,
DashboardId dashboardId,
DashboardState.ColumnIndex columnIndex) |
static DashboardItemRepresentationService.RenderingContext |
DashboardItemRepresentationService.RenderingContext.readOnly(GadgetRequestContext requestContext,
DashboardId dashboardId,
DashboardState.ColumnIndex columnIndex) |
| Modifier and Type | Method and Description |
|---|---|
ViewComponent |
DashboardTabViewFactory.createDashboardView(Iterable<DashboardTab> tabs,
DashboardState selectedTabDashboardState,
String username,
int maxGadgets,
GadgetRequestContext gadgetRequestContext)
Returns a
ViewComponent that will render the DashboardState and DashboardTabs
customizing the view based on the permissions the user has to view/edit the dashboard and the
specified Locale. |
| Modifier and Type | Method and Description |
|---|---|
Iterable<Directory.Entry<?>> |
Directory.getEntries(GadgetRequestContext gadgetRequestContext)
Returns all the entries available, localized by the
locale. |
Iterable<Directory.Entry<?>> |
Directory.getEntries(GadgetRequestContext gadgetRequestContext,
Directory.EntryScope entryScope)
Returns all entries with the given scope.
|
| Modifier and Type | Method and Description |
|---|---|
GadgetSpec |
GadgetSpecFactory.getGadgetSpec(GadgetState gadgetState,
GadgetRequestContext gadgetRequestContext)
Create a
GadgetSpec from a GadgetState |
GadgetSpec |
GadgetSpecFactory.getGadgetSpec(URI uri,
GadgetRequestContext gadgetRequestContext)
Create a
GadgetSpec from a spec URI |
| 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)
|
Copyright © 2024 Atlassian. All rights reserved.