Index

A B C D E F G H I J K L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

A - Enum constant in enum class com.atlassian.gadgets.dashboard.Layout

single column

AA - Enum constant in enum class com.atlassian.gadgets.dashboard.Layout

two columns of equal size

AAA - Enum constant in enum class com.atlassian.gadgets.dashboard.Layout

three columns, each of equal size

AB - Enum constant in enum class com.atlassian.gadgets.dashboard.Layout

two columns, the first being smaller than the second

ABA - Enum constant in enum class com.atlassian.gadgets.dashboard.Layout

three columns, the first and third are of equal size with the second column larger than the others

aboutMe(String) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Sets the value of the "about me" string for the Person being constructed

accept(DashboardItemModuleIdVisitor<T>) - Method in interface com.atlassian.gadgets.DashboardItemModuleId

accept(DashboardItemModuleIdVisitor<T>) - Method in class com.atlassian.gadgets.LocalDashboardItemModuleId

accept(DashboardItemModuleIdVisitor<T>) - Method in class com.atlassian.gadgets.OpenSocialDashboardItemModuleId

accept(DashboardItemStateVisitor<V>) - Method in interface com.atlassian.gadgets.DashboardItemState

accept(DashboardItemStateVisitor<V>) - Method in class com.atlassian.gadgets.GadgetState

accept(DashboardItemStateVisitor<V>) - Method in class com.atlassian.gadgets.LocalDashboardItemState

accept(DirectoryEntryVisitor<V>) - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Accepts the visitor.

Activity - Class in com.atlassian.gadgets.opensocial.model

Represents an activity, such as the creation of a wiki page

Activity.Builder - Class in com.atlassian.gadgets.opensocial.model

A builder that facilitates construction of Activity objects.

Activity.Field - Enum Class in com.atlassian.gadgets.opensocial.model

Activity fields that can be loaded when retrieving an activity

ActivityId - Class in com.atlassian.gadgets.opensocial.model

Representation of the unique identifier for a particular activity.

ActivityId(String) - Constructor for class com.atlassian.gadgets.opensocial.model.ActivityId

Creates a new ActivityId that wraps the id passed in

AddGadgetEvent - Class in com.atlassian.gadgets.event

When a gadget is added to the directory, this event will be fired.

AddGadgetEvent(URI) - Constructor for class com.atlassian.gadgets.event.AddGadgetEvent

AddGadgetFeedEvent - Class in com.atlassian.gadgets.event

This event is fired when a gadget subscription is added by an administrator.

AddGadgetFeedEvent(URI) - Constructor for class com.atlassian.gadgets.event.AddGadgetFeedEvent

Address - Class in com.atlassian.gadgets.opensocial.model

Representation of a Person's address

Address(String) - Constructor for class com.atlassian.gadgets.opensocial.model.Address

addresses(List<Address>) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Set the list of addresses for the Person being constructed

addViewParam(String, String) - Method in class com.atlassian.gadgets.view.View.Builder

Add a view parameter as a name value pair

addViewParams(Map<String, String>) - Method in class com.atlassian.gadgets.view.View.Builder

Add a number of view parameters as name value pairs

ADMIN - Enum constant in enum class com.atlassian.gadgets.directory.Category

ALL - Enum constant in enum class com.atlassian.gadgets.directory.Directory.EntryScope

ALL - Static variable in class com.atlassian.gadgets.opensocial.model.Group

ALLOW - Enum constant in enum class com.atlassian.gadgets.Vote

The user is allowed to perform the requested action.

ALWAYS_TRUE_CONDITION - Static variable in interface com.atlassian.gadgets.plugins.DashboardItemModule

APP_ID - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

appendGadgetToColumn(GadgetState, DashboardState.ColumnIndex) - Method in class com.atlassian.gadgets.dashboard.DashboardState

Deprecated.

appendItemToColumn(DashboardItemState, DashboardState.ColumnIndex) - Method in class com.atlassian.gadgets.dashboard.DashboardState

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

appId(AppId) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the application (gadget type) id of the Activity under construction and return this Builder to allow further construction to be done.

AppId - Class in com.atlassian.gadgets.opensocial.model

Representation of the identifier for a particular application, e.g.

AppId(String) - Constructor for class com.atlassian.gadgets.opensocial.model.AppId

Creates a new AppId that wraps the id passed in

assertRenderable(String) - Method in interface com.atlassian.gadgets.GadgetSpecUrlChecker

Returns normally if the specified gadget spec is permitted to render.

AUDIO - Enum constant in enum class com.atlassian.gadgets.opensocial.model.MediaItem.Type

author(String) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the author of the GadgetSpec under construction and return this Builder to allow further construction to be done.

authorEmail(String) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the author email of the GadgetSpec under construction and return this Builder to allow further construction to be done.

B

BA - Enum constant in enum class com.atlassian.gadgets.dashboard.Layout

two columns, the first being larger than the second

BAMBOO - Enum constant in enum class com.atlassian.gadgets.directory.Category

body(String) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the body of the Activity under construction and return this Builder to allow further construction to be done.

BODY - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

BODY_ID - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

BOOL - Enum constant in enum class com.atlassian.gadgets.spec.DataType

build() - Method in class com.atlassian.gadgets.dashboard.DashboardState.Builder

Returns the final constructed DashboardState

build() - Method in class com.atlassian.gadgets.GadgetRequestContext.Builder

Returns the final constructed GadgetRequestContext.

build() - Method in class com.atlassian.gadgets.GadgetState.Builder

Returns the final constructed GadgetState

build() - Method in class com.atlassian.gadgets.LocalDashboardItemState.Builder

build() - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Returns the final constructed Activity

build() - Method in class com.atlassian.gadgets.opensocial.model.MediaItem.Builder

Returns the final constructed MediaItem

build() - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Build the Person

build() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpecBuilder

build() - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Returns the final constructed GadgetSpec

build() - Method in class com.atlassian.gadgets.spec.UserPrefSpec.Builder

Returns the final constructed UserPrefSpec

build() - Method in class com.atlassian.gadgets.view.View.Builder

Returns a new ViewSettings object using the values in this Builder.

build(GadgetState, ModuleId, View, GadgetRequestContext) - Method in interface com.atlassian.gadgets.view.RenderedGadgetUriBuilder

Returns the URL to the rendered gadget.

build(GadgetState, View, GadgetRequestContext) - Method in interface com.atlassian.gadgets.view.RenderedGadgetUriBuilder

Deprecated.

as of 2.0, use RenderedGadgetUriBuilder.build(GadgetState, ModuleId, View, GadgetRequestContext)

builder() - Static method in class com.atlassian.gadgets.LocalDashboardItemState

builder() - Static method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

builder(LocalDashboardItemState) - Static method in class com.atlassian.gadgets.LocalDashboardItemState

Builder() - Constructor for class com.atlassian.gadgets.GadgetRequestContext.Builder

Builder() - Constructor for class com.atlassian.gadgets.LocalDashboardItemState.Builder

Builder() - Constructor for class com.atlassian.gadgets.view.View.Builder

Builder(GadgetState) - Constructor for class com.atlassian.gadgets.GadgetState.Builder

Builder(Activity) - Constructor for class com.atlassian.gadgets.opensocial.model.Activity.Builder

Create a new Activity.Builder with the same field values as the passed in Activity

Builder(Person) - Constructor for class com.atlassian.gadgets.opensocial.model.Person.Builder

Create a builder initialized with the values from the specified person argument

Builder(PersonId) - Constructor for class com.atlassian.gadgets.opensocial.model.Person.Builder

Create a builder with the given the PersonId for the Person to be constructed

Builder(String) - Constructor for class com.atlassian.gadgets.opensocial.model.Activity.Builder

Create a new Activity.Builder that can be used to create an Activity

Builder(URI) - Constructor for class com.atlassian.gadgets.opensocial.model.MediaItem.Builder

C

canRenderInViewType(GadgetState, ViewType, GadgetRequestContext) - Method in interface com.atlassian.gadgets.view.GadgetViewFactory

Returns true if the gadget represented by state can be rendered with the given ViewType for the locale specified in the GadgetRequestContext.

CANVAS - Static variable in class com.atlassian.gadgets.view.ViewType

Category - Enum Class in com.atlassian.gadgets.directory

CHARTS - Enum constant in enum class com.atlassian.gadgets.directory.Category

checkContentsNotNull(Iterable<T>) - Static method in class com.atlassian.gadgets.dashboard.util.Iterables

Checks every element of an Iterable to make sure that none of the elements are null

ClearHttpCacheEvent - Class in com.atlassian.gadgets.event

An event that a host application can throw to clear shindig's cache.

ClearHttpCacheEvent() - Constructor for class com.atlassian.gadgets.event.ClearHttpCacheEvent

ClearSpecCacheEvent - Class in com.atlassian.gadgets.event

This event is published when the cache with all gadgets specs should be invalidated.

ClearSpecCacheEvent() - Constructor for class com.atlassian.gadgets.event.ClearSpecCacheEvent

CLOVER - Enum constant in enum class com.atlassian.gadgets.directory.Category

color(Color) - Method in class com.atlassian.gadgets.GadgetState.Builder

Set the Color of the GadgetState under construction and return this Builder to allow further construction to be done.

color(Color) - Method in class com.atlassian.gadgets.LocalDashboardItemState.Builder

Color - Enum Class in com.atlassian.gadgets.dashboard

The possible colors that can be used to customize dashboards and gadgets.

color1 - Enum constant in enum class com.atlassian.gadgets.dashboard.Color

color2 - Enum constant in enum class com.atlassian.gadgets.dashboard.Color

color3 - Enum constant in enum class com.atlassian.gadgets.dashboard.Color

color4 - Enum constant in enum class com.atlassian.gadgets.dashboard.Color

color5 - Enum constant in enum class com.atlassian.gadgets.dashboard.Color

color6 - Enum constant in enum class com.atlassian.gadgets.dashboard.Color

color7 - Enum constant in enum class com.atlassian.gadgets.dashboard.Color

color8 - Enum constant in enum class com.atlassian.gadgets.dashboard.Color

columns(Iterable<? extends Iterable<GadgetState>>) - Method in class com.atlassian.gadgets.dashboard.DashboardState.Builder

Deprecated.

com.atlassian.gadgets - package com.atlassian.gadgets

This package contains the main APIs for interacting with gadgets.

com.atlassian.gadgets.dashboard - package com.atlassian.gadgets.dashboard

This package contains the main APIs for interacting with dashboards and gadgets.

com.atlassian.gadgets.dashboard.util - package com.atlassian.gadgets.dashboard.util

Contains utility classes.

com.atlassian.gadgets.dashboard.view - package com.atlassian.gadgets.dashboard.view

com.atlassian.gadgets.directory - package com.atlassian.gadgets.directory

com.atlassian.gadgets.event - package com.atlassian.gadgets.event

com.atlassian.gadgets.feed - package com.atlassian.gadgets.feed

com.atlassian.gadgets.opensocial - package com.atlassian.gadgets.opensocial

com.atlassian.gadgets.opensocial.model - package com.atlassian.gadgets.opensocial.model

com.atlassian.gadgets.plugins - package com.atlassian.gadgets.plugins

Contains classes related to plugins that contain gadgets.

com.atlassian.gadgets.spec - package com.atlassian.gadgets.spec

Contains classes related to Gadgets' Specification XML.

com.atlassian.gadgets.view - package com.atlassian.gadgets.view

Contains classes related to the rendering and display of gadgets.

CONFLUENCE - Enum constant in enum class com.atlassian.gadgets.directory.Category

contains(DashboardState.ColumnIndex) - Method in enum class com.atlassian.gadgets.dashboard.Layout

Checks if the column exists in this layout.

contains(URI) - Method in interface com.atlassian.gadgets.directory.Directory

contains(URI) - Method in interface com.atlassian.gadgets.feed.GadgetFeedReader

Determines if the provided gadget spec exists in the gadget feed.

contains(URI) - Method in interface com.atlassian.gadgets.GadgetSpecProvider

Returns true if the URI is in the store, false otherwise.

createDashboardView(Iterable<DashboardTab>, DashboardState, String, int, GadgetRequestContext) - Method in interface com.atlassian.gadgets.dashboard.view.DashboardTabViewFactory

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.

createGadgetView(GadgetState, ModuleId, View, GadgetRequestContext) - Method in interface com.atlassian.gadgets.view.GadgetViewFactory

Returns a ViewComponent that will render the GadgetState, customizing the view based on the Locale specified in the GadgetRequestContext and the desired ViewType.

createGadgetView(GadgetState, View, GadgetRequestContext) - Method in interface com.atlassian.gadgets.view.GadgetViewFactory

Deprecated.

as of 2.0, use GadgetViewFactory.createGadgetView(com.atlassian.gadgets.GadgetState, ModuleId, View, com.atlassian.gadgets.GadgetRequestContext)

createViewType(String, String...) - Static method in class com.atlassian.gadgets.view.ViewType

Creates a ViewType with the given canonical name and optional aliases.

CROWD - Enum constant in enum class com.atlassian.gadgets.directory.Category

currentLocation(Address) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Sets the current location for the person.

D

dashboard(DashboardId) - Static method in class com.atlassian.gadgets.dashboard.DashboardState

Factory method to create a new builder which can be used to create DashboardState objects.

dashboard(DashboardState) - Static method in class com.atlassian.gadgets.dashboard.DashboardState

Factory method which allows you to create a new DashboardState object based on an existing DashboardState.

dashboardColumns(Iterable<? extends Iterable<DashboardItemState>>) - Method in class com.atlassian.gadgets.dashboard.DashboardState.Builder

Set the columns of the DashboardState under construction and return this Builder to allow further construction to be done.

DashboardColumns - Class in com.atlassian.gadgets.dashboard

DashboardId - Class in com.atlassian.gadgets.dashboard

Representation of the identifier for a particular dashboard.

dashboardItem(String, String, String) - Static method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentation

DashboardItemModule - Interface in com.atlassian.gadgets.plugins

Inline dashboard item to render directly on the dashboard rather than via opensocial iframes.

DashboardItemModule.Author - Interface in com.atlassian.gadgets.plugins

DashboardItemModule.DirectoryDefinition - Interface in com.atlassian.gadgets.plugins

Specification of the dashboard item.

DashboardItemModuleDescriptor - Interface in com.atlassian.gadgets.plugins

Module descriptor to represent a non-opensocial dashboard item that can be used to render a dashboard content inline without iframes.

dashboardItemModuleId(LocalDashboardItemModuleId) - Method in class com.atlassian.gadgets.LocalDashboardItemState.Builder

DashboardItemModuleId - Interface in com.atlassian.gadgets

This is the identifier for modules, which can be added to dashboard.

DashboardItemModuleIdVisitor<T> - Interface in com.atlassian.gadgets

DashboardItemModules - Interface in com.atlassian.gadgets.dashboard

DashboardItemRepresentation - Class in com.atlassian.gadgets.dashboard

Detailed information that can be used to render the dashboard item.

DashboardItemRepresentationService - Interface in com.atlassian.gadgets.dashboard

Service used to get representations of dashboard items.

DashboardItemRepresentationService.RenderingContext - Class in com.atlassian.gadgets.dashboard

Context in which the dashboard item is rendered.

DashboardItemState - Interface in com.atlassian.gadgets

Representation of the dashboard item state.

DashboardItemStateVisitor<T> - Interface in com.atlassian.gadgets

Visitor for implementations of DashboardItemState.

DashboardItemType - Enum Class in com.atlassian.gadgets

DashboardNotFoundException - Exception in com.atlassian.gadgets.dashboard

Thrown if the dashboard identified by the DashboardId does not exist.

DashboardNotFoundException(DashboardId) - Constructor for exception com.atlassian.gadgets.dashboard.DashboardNotFoundException

DashboardService - Interface in com.atlassian.gadgets.dashboard

Service that saves or fetches the DashboardState, after checking to make sure that the user has access to the dashboard.

DashboardState - Class in com.atlassian.gadgets.dashboard

An immutable representation of a dashboard.

DashboardState.Builder - Class in com.atlassian.gadgets.dashboard

A builder that allows the Layout or the columns of the DashboardState under construction to be set.

DashboardState.ColumnIndex - Enum Class in com.atlassian.gadgets.dashboard

There are a predetermined number of columns that a dashboard can contain, and ColumnIndex is the enumeration of those columns.

DashboardState.TitleBuilder - Class in com.atlassian.gadgets.dashboard

A builder that allows you to set the title of the DashboardState object under construction.

DashboardTab - Class in com.atlassian.gadgets.dashboard

Represents a Dashboard Tab

DashboardTab(DashboardId, String, URI) - Constructor for class com.atlassian.gadgets.dashboard.DashboardTab

DashboardTabViewFactory - Interface in com.atlassian.gadgets.dashboard.view

A factory which provides a way to create ViewComponents for dashboards displaying other dashboards available as tabs.

dataType(DataType) - Method in class com.atlassian.gadgets.spec.UserPrefSpec.Builder

Set the DataType of the UserPrefSpec under construction and return this Builder to allow further construction to be done.

DataType - Enum Class in com.atlassian.gadgets.spec

Represents the data type of a user preference.

dateOfBirth(Date) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Sets the person's date of birth

debug(boolean) - Method in class com.atlassian.gadgets.GadgetRequestContext.Builder

Sets whether debugging should be enabled when rendering the gadget.

DEFAULT - Static variable in class com.atlassian.gadgets.view.View

Default View, which uses the default ViewType and is writable.

DEFAULT - Static variable in class com.atlassian.gadgets.view.ViewType

defaultColor() - Static method in enum class com.atlassian.gadgets.dashboard.Color

defaultValue(String) - Method in class com.atlassian.gadgets.spec.UserPrefSpec.Builder

Set the default value of the UserPrefSpec under construction and return this Builder to allow further construction to be done.

DENY - Enum constant in enum class com.atlassian.gadgets.Vote

The user is forbidden to perform the requested action.

description(String) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the description of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Directory - Interface in com.atlassian.gadgets.directory

DIRECTORY - Static variable in class com.atlassian.gadgets.view.View

DIRECTORY - Static variable in class com.atlassian.gadgets.view.ViewType

DIRECTORY_FEATURE_CATEGORIES_NAME - Static variable in interface com.atlassian.gadgets.directory.Directory

DIRECTORY_FEATURE_NAME - Static variable in interface com.atlassian.gadgets.directory.Directory

Directory.DashboardDirectoryEntry - Interface in com.atlassian.gadgets.directory

Entry in the directory which is local P2 module.

Directory.Entry<T> - Interface in com.atlassian.gadgets.directory

A single entry in the directory.

Directory.EntryScope - Enum Class in com.atlassian.gadgets.directory

This scope is used to determine entries that get retrieved when Directory.getEntries(com.atlassian.gadgets.GadgetRequestContext, com.atlassian.gadgets.directory.Directory.EntryScope) is called.

Directory.OpenSocialDirectoryEntry - Interface in com.atlassian.gadgets.directory

Entry in the directory which is based on Open Social specification.

DirectoryEntryVisitor<T> - Interface in com.atlassian.gadgets.directory

Visitor for Directory.Entry.

directoryTitle(String) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the directory title of the GadgetSpec under construction and return this Builder to allow further construction to be done.

displayName(String) - Method in class com.atlassian.gadgets.spec.UserPrefSpec.Builder

Set the display name of the UserPrefSpec under construction and return this Builder to allow further construction to be done.

E

editable(GadgetRequestContext, DashboardId, DashboardState.ColumnIndex) - Static method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentationService.RenderingContext

elementsEqual(Iterable<?>, Iterable<?>) - Static method in class com.atlassian.gadgets.dashboard.util.Iterables

Compares two Iterables to determine if they are of equal lengths and contain equal elements in the same order.

EmailAddress - Class in com.atlassian.gadgets.opensocial.model

Representation of a Person's e-mail address

EmailAddress(String) - Constructor for class com.atlassian.gadgets.opensocial.model.EmailAddress

emailAddresses(List<EmailAddress>) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Sets the list of email addressees for the Person being constructed

enabledCondition(Condition) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpecBuilder

entries() - Method in interface com.atlassian.gadgets.feed.GadgetFeedReader

Get all of the gadget spec URI available in the feed.

entries() - Method in interface com.atlassian.gadgets.GadgetSpecProvider

Returns all the gadget URIs contained by this store.

ENUM - Enum constant in enum class com.atlassian.gadgets.spec.DataType

enumValues(Map<String, String>) - Method in class com.atlassian.gadgets.spec.UserPrefSpec.Builder

Set the Map of the possible values for an enumerated UserPrefSpec under construction and return this Builder to allow further construction to be done.

equals(Object) - Method in class com.atlassian.gadgets.dashboard.DashboardColumns

equals(Object) - Method in class com.atlassian.gadgets.dashboard.DashboardId

equals(Object) - Method in class com.atlassian.gadgets.dashboard.DashboardState

equals(Object) - Method in class com.atlassian.gadgets.dashboard.DashboardTab

equals(Object) - Method in class com.atlassian.gadgets.GadgetId

equals(Object) - Method in class com.atlassian.gadgets.GadgetRequestContext.User

equals(Object) - Method in class com.atlassian.gadgets.GadgetState

equals(Object) - Method in class com.atlassian.gadgets.LocalDashboardItemModuleId

equals(Object) - Method in class com.atlassian.gadgets.LocalDashboardItemState

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.Activity

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.ActivityId

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.Address

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.AppId

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.EmailAddress

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.MediaItem

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.Name

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.Person

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.PersonId

equals(Object) - Method in class com.atlassian.gadgets.opensocial.model.PhoneNumber

equals(Object) - Method in class com.atlassian.gadgets.OpenSocialDashboardItemModuleId

equals(Object) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

equals(Object) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec.Key

equals(Object) - Method in class com.atlassian.gadgets.view.ModuleId

EXTERNAL - Enum constant in enum class com.atlassian.gadgets.directory.Directory.EntryScope

EXTERNAL_ID - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

externalId(String) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the externalId of the Activity under construction and return this Builder to allow further construction to be done.

F

FE_CRU - Enum constant in enum class com.atlassian.gadgets.directory.Category

Feature - Interface in com.atlassian.gadgets.spec

Represents a feature that is declared to be used in a gadget spec.

features(Map<String, Feature>) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the Map of Feature for the GadgetSpec under construction and return this Builder to allow further construction to be done.

forName(String) - Static method in enum class com.atlassian.gadgets.DashboardItemType

FRIENDS - Static variable in class com.atlassian.gadgets.opensocial.model.Group

from(int) - Static method in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

Returns the column index as an instance of ColumnIndex.

from(Iterable<? extends Iterable<DashboardItemState>>, int) - Static method in class com.atlassian.gadgets.dashboard.DashboardColumns

G

gadget(GadgetId) - Static method in class com.atlassian.gadgets.GadgetState

Factory method to create a new builder which can be used to create GadgetState objects.

gadget(GadgetState) - Static method in class com.atlassian.gadgets.GadgetState

Factory method which allows you to create a new GadgetState object based on an existing GadgetState.

GadgetFeedHostConnectionException - Exception in com.atlassian.gadgets.feed

Exception thrown if the reader cannot connect to the host of the gadget spec feed cannot.

GadgetFeedHostConnectionException(String, URI, Throwable) - Constructor for exception com.atlassian.gadgets.feed.GadgetFeedHostConnectionException

GadgetFeedParsingException - Exception in com.atlassian.gadgets.feed

Exception thrown if the gadget spec feed cannot be parsed

GadgetFeedParsingException(String, URI, Throwable) - Constructor for exception com.atlassian.gadgets.feed.GadgetFeedParsingException

GadgetFeedReader - Interface in com.atlassian.gadgets.feed

Reads a gadget feed and provides access to the feed's properties.

GadgetFeedReaderFactory - Interface in com.atlassian.gadgets.feed

Factory for creating GadgetFeedReader

gadgetId(GadgetId) - Method in class com.atlassian.gadgets.LocalDashboardItemState.Builder

GadgetId - Class in com.atlassian.gadgets

Representation of the identifier for a particular gadget.

GadgetLocationTranslator - Interface in com.atlassian.gadgets.plugins

Version 3.4 added the ability to define a custom URI location for gadget specs.

GadgetNotFoundException - Exception in com.atlassian.gadgets

Thrown if the gadget identified by the GadgetId does not exist.

GadgetNotFoundException(GadgetId) - Constructor for exception com.atlassian.gadgets.GadgetNotFoundException

GadgetParsingException - Exception in com.atlassian.gadgets

Thrown when the gadget spec is malformed or cannot be parsed for other reasons.

GadgetParsingException(String) - Constructor for exception com.atlassian.gadgets.GadgetParsingException

GadgetParsingException(Throwable) - Constructor for exception com.atlassian.gadgets.GadgetParsingException

GadgetRenderingException - Exception in com.atlassian.gadgets.view

Thrown if there is a problem trying to render a gadget (for example, if the request view is not defined)

GadgetRenderingException(GadgetState, Throwable) - Constructor for exception com.atlassian.gadgets.view.GadgetRenderingException

GadgetRenderingException(String, GadgetState) - Constructor for exception com.atlassian.gadgets.view.GadgetRenderingException

GadgetRenderingException(String, GadgetState, Throwable) - Constructor for exception com.atlassian.gadgets.view.GadgetRenderingException

gadgetRequestContext() - Static method in class com.atlassian.gadgets.GadgetRequestContext.Builder

Get a new GadgetRequestContext Builder.

GadgetRequestContext - Class in com.atlassian.gadgets

Holds information associated with a gadget request that the system will need to use.

GadgetRequestContext.Builder - Class in com.atlassian.gadgets

A builder that facilitates construction of GadgetRequestContext objects.

GadgetRequestContext.User - Class in com.atlassian.gadgets

GadgetRequestContextFactory - Interface in com.atlassian.gadgets

Provides methods for constructing GadgetRequestContext instances from various sources.

gadgetSpec(GadgetSpec) - Static method in class com.atlassian.gadgets.spec.GadgetSpec

Factory method which allows you to create a new GadgetSpec object based on an existing GadgetSpec.

gadgetSpec(URI) - Static method in class com.atlassian.gadgets.spec.GadgetSpec

Factory method to create a new builder which can be used to create GadgetSpec objects.

GadgetSpec - Class in com.atlassian.gadgets.spec

Represents a gadget specification

GadgetSpec.Builder - Class in com.atlassian.gadgets.spec

A builder that facilitates construction of GadgetSpec objects.

GadgetSpecFactory - Interface in com.atlassian.gadgets.spec

Factory for creating GadgetSpecs

GadgetSpecProvider - Interface in com.atlassian.gadgets

A simple representation of a container of gadget spec URIs.

GadgetSpecUriNotAllowedException - Exception in com.atlassian.gadgets

Thrown when a gadget spec URI is not valid for rendering on the dashboard.

GadgetSpecUriNotAllowedException(String) - Constructor for exception com.atlassian.gadgets.GadgetSpecUriNotAllowedException

GadgetSpecUriNotAllowedException(Throwable) - Constructor for exception com.atlassian.gadgets.GadgetSpecUriNotAllowedException

GadgetSpecUrlChecker - Interface in com.atlassian.gadgets

Models permission and validation checks on gadget specs.

GadgetState - Class in com.atlassian.gadgets

An immutable extension of DashboardItemState.

GadgetState.Builder - Class in com.atlassian.gadgets

A builder that allows you to set the Color and the user preferences of the GadgetState under construction.

GadgetState.SpecUriBuilder - Class in com.atlassian.gadgets

A builder that allows you to set the spec URI of the gadget state under construction

GadgetViewFactory - Interface in com.atlassian.gadgets.view

A factory which provides a way to create ViewComponents for gadgets.

get(DashboardId, String) - Method in interface com.atlassian.gadgets.dashboard.DashboardService

Fetch the DashboardState if the user has permission.

get(HttpServletRequest) - Method in interface com.atlassian.gadgets.GadgetRequestContextFactory

Returns a GadgetRequestContext based on the values in the specified request.

getAboutMe() - Method in class com.atlassian.gadgets.opensocial.model.Person

An "about me" blurb

getActiveUrl() - Method in interface com.atlassian.gadgets.opensocial.OpenSocialRequestContext

getAddresses() - Method in class com.atlassian.gadgets.opensocial.model.Person

A list of the person's addresses

getAliases() - Method in class com.atlassian.gadgets.view.ViewType

Gets the aliases for this ViewType

getAmdModule() - Method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentation

Returns a JavaScript AMD module that renders the dashboard item.

getAMDModule() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule

getAppId() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get the app id this activity is associated with.

getApplicationName() - Method in interface com.atlassian.gadgets.feed.GadgetFeedReader

Get the name of the application providing the feed.

getAuthor() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule.DirectoryDefinition

Author/Vendor of the dashboard item.

getAuthor() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the author of the gadget in this spec

getAuthorEmail() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Returns the email address of the author of the gadget for this directory entry.

getAuthorEmail() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the email for the author of the gadget in this spec

getAuthorName() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Returns the name of the author of the gadget for this directory entry.

getBaseUri() - Method in interface com.atlassian.gadgets.feed.GadgetFeedReader

Get the base URI of the applications

getBody() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get a body string specifying an optional expanded version of an activity.

getBuilder(HttpServletRequest) - Method in interface com.atlassian.gadgets.GadgetRequestContextFactory

Returns a GadgetRequestContext.Builder based on the values in the specified request.

getCanonicalName() - Method in class com.atlassian.gadgets.view.ViewType

Gets the canonical name of this ViewType

getCategories() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Returns the directory categories of this entry.

getCategories() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule.DirectoryDefinition

Returns categories of this directory definition.

getColor() - Method in interface com.atlassian.gadgets.DashboardItemState

getColor() - Method in class com.atlassian.gadgets.GadgetState

Returns the Color scheme that should be used to decorate the chrome surrounding the gadget.

getColor() - Method in class com.atlassian.gadgets.LocalDashboardItemState

getColorMode() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the colorMode of the gadget in this spec

getColumnIndex() - Method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentationService.RenderingContext

getColumnRange() - Method in enum class com.atlassian.gadgets.dashboard.Layout

Return an immutable Iterable over the ColumnIndexes that exist in this layout.

getColumns() - Method in class com.atlassian.gadgets.dashboard.DashboardColumns

Returns an immutable List of all columns represented as a list of items.

getColumns() - Method in class com.atlassian.gadgets.dashboard.DashboardState

Deprecated.

getCondition() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule

getCurrentLocation() - Method in class com.atlassian.gadgets.opensocial.model.Person

getDashboardColumns() - Method in class com.atlassian.gadgets.dashboard.DashboardState

getDashboardForGadget(GadgetId, String) - Method in interface com.atlassian.gadgets.dashboard.DashboardService

Gets dashboard state which contains the specified gadget

getDashboardId() - Method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentationService.RenderingContext

getDashboardId() - Method in exception com.atlassian.gadgets.dashboard.DashboardNotFoundException

getDashboardId() - Method in class com.atlassian.gadgets.dashboard.DashboardTab

getDashboardItemForModuleKey(ModuleCompleteKey) - Method in interface com.atlassian.gadgets.dashboard.DashboardItemModules

getDashboardItemModuleDescriptor(String) - Method in interface com.atlassian.gadgets.dashboard.DashboardItemModules

Returns an optional DashboardItemModuleDescriptor for a given OpenSocial gadget URI identifier.

getDashboardItemModuleId() - Method in class com.atlassian.gadgets.LocalDashboardItemState

getDashboardItemsWithDirectoryDefinition() - Method in interface com.atlassian.gadgets.dashboard.DashboardItemModules

Returns all dashboard items which declared a specification.

getDataType() - Method in class com.atlassian.gadgets.spec.UserPrefSpec

Returns the DataType of this pref.

getDateLoaded() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

getDateOfBirth() - Method in class com.atlassian.gadgets.opensocial.model.Person

getDefaultValue() - Method in class com.atlassian.gadgets.spec.UserPrefSpec

Returns the pref's default value.

getDescription() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Returns a textual description of the gadget for this directory entry.

getDescription() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the description of the gadget in this spec

getDirectoryDefinition() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule

Returns the description of this dashboard item.

getDirectoryDefinition() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModuleDescriptor

getDirectoryTitle() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the title for the directory of the gadget in this spec

getDisplayName() - Method in class com.atlassian.gadgets.spec.UserPrefSpec

Returns the display name of this parameter.

getEmail() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule.Author

getEmailAddresses() - Method in class com.atlassian.gadgets.opensocial.model.Person

getEnabledCondition() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

getEntries(GadgetRequestContext) - Method in interface com.atlassian.gadgets.directory.Directory

Returns all the entries available, localized by the locale.

getEntries(GadgetRequestContext, Directory.EntryScope) - Method in interface com.atlassian.gadgets.directory.Directory

Returns all entries with the given scope.

getEnumValues() - Method in class com.atlassian.gadgets.spec.UserPrefSpec

Returns the possible values for an enumerated pref.

getExternalId() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get an optional string ID generated by the posting application.

getFeatures() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the features in this spec

getFeedReader(URI) - Method in interface com.atlassian.gadgets.feed.GadgetFeedReaderFactory

Get a feed reader for the provided URI

getFeedUri() - Method in class com.atlassian.gadgets.event.AddGadgetFeedEvent

getFeedUri() - Method in exception com.atlassian.gadgets.feed.GadgetFeedHostConnectionException

getFeedUri() - Method in exception com.atlassian.gadgets.feed.GadgetFeedParsingException

getFeedUri() - Method in exception com.atlassian.gadgets.feed.NonAtomGadgetSpecFeedException

getFullModuleKey() - Method in class com.atlassian.gadgets.LocalDashboardItemModuleId

getFullname() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule.Author

Fullname of the author.

getGadgetId() - Method in exception com.atlassian.gadgets.GadgetNotFoundException

getGadgetsInColumn(DashboardState.ColumnIndex) - Method in class com.atlassian.gadgets.dashboard.DashboardState

Deprecated.

getGadgetSpec(GadgetState, GadgetRequestContext) - Method in interface com.atlassian.gadgets.spec.GadgetSpecFactory

Create a GadgetSpec from a GadgetState

getGadgetSpec(URI, GadgetRequestContext) - Method in interface com.atlassian.gadgets.spec.GadgetSpecFactory

Create a GadgetSpec from a spec URI

getGadgetSpecUri() - Method in class com.atlassian.gadgets.GadgetState

Returns the URI of the gadget spec, which defines the gadget as described in the gadget spec reference.

getGadgetSpecUriToReplace() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModuleDescriptor

getGadgetState() - Method in exception com.atlassian.gadgets.view.GadgetRenderingException

getGadgetUri() - Method in class com.atlassian.gadgets.event.AddGadgetEvent

getGadgetUrl() - Method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentation

Open social gadget URL

getHeight() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the height of the gadget in this spec

getHtml() - Method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentation

Returns a verbatim html which represents the dashboard item.

getIcon() - Method in interface com.atlassian.gadgets.feed.GadgetFeedReader

Get the icon of the gadget feed.

getId() - Method in class com.atlassian.gadgets.dashboard.DashboardState

Returns the unique identifier, represented by a DashboardId, for the dashboard's state.

getId() - Method in interface com.atlassian.gadgets.DashboardItemModuleId

getId() - Method in interface com.atlassian.gadgets.DashboardItemState

getId() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Returns the id of the directory entry.

getId() - Method in class com.atlassian.gadgets.GadgetState

Returns the unique identifier, represented by a GadgetId, for the gadget's state.

getId() - Method in class com.atlassian.gadgets.LocalDashboardItemModuleId

getId() - Method in class com.atlassian.gadgets.LocalDashboardItemState

getId() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get the activity id that is permanently associated with this activity.

getId() - Method in class com.atlassian.gadgets.OpenSocialDashboardItemModuleId

getIgnoreCache() - Method in class com.atlassian.gadgets.GadgetRequestContext

Returns the cache setting used for this request.

getInputStream() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

Returns the spec resource as an input stream, for processing.

getItemsInColumn(DashboardState.ColumnIndex) - Method in class com.atlassian.gadgets.dashboard.DashboardColumns

Returns an immutable List of the DashboardStateItems in the given column.

getJsonRepresentation() - Method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentation

It is defined in case of local dashboard items and contains a stringified JSON object.

getKey() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

Returns a unique identifier for this spec.

getLastModified(URI) - Method in interface com.atlassian.gadgets.LocalGadgetSpecProvider

Return the date the gadget spec was last modified.

getLayout() - Method in class com.atlassian.gadgets.dashboard.DashboardState

Returns the Layout of the dashboard.

getLocalCondition() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

getLocale() - Method in class com.atlassian.gadgets.GadgetRequestContext

Returns the locale used for this request.

getLocation() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

If isHostedExternally() returns true, this method returns the absolute URL of the gadget spec file, beginning with http or https.

getLocation() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec.Key

Returns the location of the spec this key is for.

getMediaItems() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get the media items associated with the activity.

getMimeType() - Method in class com.atlassian.gadgets.opensocial.model.MediaItem

getModuleKey() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

Returns the module key for this spec.

getName() - Method in enum class com.atlassian.gadgets.DashboardItemType

getName() - Method in enum class com.atlassian.gadgets.directory.Category

getName() - Method in class com.atlassian.gadgets.opensocial.model.Person

The full name for this person

getName() - Method in interface com.atlassian.gadgets.spec.Feature

Get the name of this feature

getName() - Method in class com.atlassian.gadgets.spec.UserPrefSpec

Returns the pref name.

getNumberOfColumns() - Method in enum class com.atlassian.gadgets.dashboard.Layout

Returns the number of columns in this layout.

getOwnerId() - Method in interface com.atlassian.gadgets.opensocial.OpenSocialRequestContext

getParameter(String) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

getParameterValue(String) - Method in interface com.atlassian.gadgets.spec.Feature

Get the value for this parameter passed in the spec

getPersonId() - Method in class com.atlassian.gadgets.opensocial.model.Person

A (unique) username/id for this person

getPhoneNumbers() - Method in class com.atlassian.gadgets.opensocial.model.Person

getPluginKey() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

Returns the plugin key for this spec.

getPluginKey() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec.Key

Returns the key of the plugin that the spec this key is for is contained in.

getPostedTime() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get the time at which this activity took place in milliseconds since the epoch.

getPriority() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get the priority, a number between 0 and 1 representing the relative priority of this activity in relation to other activities from the same source.

getProfileUrl() - Method in class com.atlassian.gadgets.opensocial.model.Person

getProperties() - Method in class com.atlassian.gadgets.LocalDashboardItemState

getPublishLocation() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

getReplacedGadgetId() - Method in class com.atlassian.gadgets.LocalDashboardItemModuleId

getRepresentation(DashboardItemState, DashboardItemRepresentationService.RenderingContext) - Method in interface com.atlassian.gadgets.dashboard.DashboardItemRepresentationService

Returns a dashboard item representation.

getRequestContext() - Method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentationService.RenderingContext

getSelf() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Returns the unique URI of the directory entry.

getSpecUri() - Method in class com.atlassian.gadgets.OpenSocialDashboardItemModuleId

getStatus() - Method in class com.atlassian.gadgets.opensocial.model.Person

getStreamFaviconUrl() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get a string specifying the URL for the stream's favicon.

getStreamSourceUrl() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get a string specifying the stream's source URL.

getStreamTitle() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get a string specifing the title of the stream.

getStreamUrl() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get a string specifying the stream's URL.

getTabUri() - Method in class com.atlassian.gadgets.dashboard.DashboardTab

getTheme() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the theme of the gadget in this spec

getThumbnail() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule.DirectoryDefinition

Returns an absolute URL of the thumbnail.

getThumbnail() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the URI for the thumbnail image representing the gadget

getThumbnailUri() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Returns the URI of an image to display as a thumbnail or icon in the directory for this entry.

getThumbnailUrl() - Method in class com.atlassian.gadgets.opensocial.model.Person

getTimeZone() - Method in class com.atlassian.gadgets.opensocial.model.Person

getTitle() - Method in class com.atlassian.gadgets.dashboard.DashboardState

Returns the title of the dashboard.

getTitle() - Method in class com.atlassian.gadgets.dashboard.DashboardTab

getTitle() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Returns the title of the directory entry.

getTitle() - Method in interface com.atlassian.gadgets.feed.GadgetFeedReader

Get the title of the gadget feed.

getTitle() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get a string specifying the primary text of an activity.

getTitle() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule.DirectoryDefinition

The title of the dashboard item.

getTitle() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the title of the gadget in this spec

getTitleI18nKey() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule.DirectoryDefinition

The optional i18n key of the title of the dashboard item.

getTitleUri() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Returns a URI of the gadget author's choosing that is displayed as a link in the directory, with the title as the link text.

getTitleUrl() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the url that the title of the gadget in this spec should link to

getType() - Method in interface com.atlassian.gadgets.DashboardItemModuleId

getType() - Method in class com.atlassian.gadgets.LocalDashboardItemModuleId

getType() - Method in class com.atlassian.gadgets.opensocial.model.MediaItem

getType() - Method in class com.atlassian.gadgets.OpenSocialDashboardItemModuleId

getUnsupportedFeatureNames() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the features that are needed (required, not optional) but aren't available

getUpdated() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get the last updated date of the activity.

getUrl() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get a string specifying the URL that represents this activity.

getUrl() - Method in class com.atlassian.gadgets.opensocial.model.MediaItem

getUrl() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the uri for this gadget spec

getUrls() - Method in class com.atlassian.gadgets.opensocial.model.Person

getUser() - Method in class com.atlassian.gadgets.GadgetRequestContext

Returns the current user or none if user is anonymous.

getUserId() - Method in class com.atlassian.gadgets.opensocial.model.Activity

Get the id of the user who this activity is for.

getUserKey() - Method in class com.atlassian.gadgets.GadgetRequestContext.User

getUsername() - Method in class com.atlassian.gadgets.GadgetRequestContext.User

getUserPrefs() - Method in class com.atlassian.gadgets.GadgetState

An immutable Map of the user preference values for the gadget, keyed by the name of the user preference.

getUserPrefs() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the user prefs in this spec

getVersion() - Method in class com.atlassian.gadgets.dashboard.DashboardState

Returns this state's version so that it can be used by implementations when storing DashboardStates, to make sure the same object is stored and retrieved

getView() - Method in class com.atlassian.gadgets.GadgetRequestContext

Returns the dashboard view.

getViewer() - Method in class com.atlassian.gadgets.GadgetRequestContext

Returns the viewer (the current user) for this request.

getViewerId() - Method in interface com.atlassian.gadgets.opensocial.OpenSocialRequestContext

getViewType() - Method in class com.atlassian.gadgets.view.View

Returns the ViewType of this gadget which will be rendered.

getWebResourceKey() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule

getWidth() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the width of the gadget in this spec

Group - Class in com.atlassian.gadgets.opensocial.model

Represents a group name.

H

hashCode() - Method in class com.atlassian.gadgets.dashboard.DashboardColumns

hashCode() - Method in class com.atlassian.gadgets.dashboard.DashboardId

hashCode() - Method in class com.atlassian.gadgets.dashboard.DashboardState

hashCode() - Method in class com.atlassian.gadgets.dashboard.DashboardTab

hashCode() - Method in class com.atlassian.gadgets.GadgetId

hashCode() - Method in class com.atlassian.gadgets.GadgetRequestContext.User

hashCode() - Method in class com.atlassian.gadgets.GadgetState

hashCode() - Method in class com.atlassian.gadgets.LocalDashboardItemModuleId

hashCode() - Method in class com.atlassian.gadgets.LocalDashboardItemState

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.Activity

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.ActivityId

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.Address

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.AppId

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.EmailAddress

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.MediaItem

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.Name

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.Person

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.PersonId

hashCode() - Method in class com.atlassian.gadgets.opensocial.model.PhoneNumber

hashCode() - Method in class com.atlassian.gadgets.OpenSocialDashboardItemModuleId

hashCode() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

hashCode() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec.Key

hashCode() - Method in class com.atlassian.gadgets.view.ModuleId

hasNext() - Method in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

Returns true if there are more possible columns after this one, false otherwise.

hasParameter(String) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

height(int) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the height of the GadgetSpec under construction and return this Builder to allow further construction to be done.

HIDDEN - Enum constant in enum class com.atlassian.gadgets.spec.DataType

I

id(ActivityId) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the id of the Activity under construction and return this Builder to allow further construction to be done.

ID - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

ignoreCache(boolean) - Method in class com.atlassian.gadgets.GadgetRequestContext.Builder

Set the cache setting of the GadgetRequestContext under construction and return this Builder to allow further construction to be done.

IMAGE - Enum constant in enum class com.atlassian.gadgets.opensocial.model.MediaItem.Type

index() - Method in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

Returns the actual value of the ColumnIndex as an int.

INSTANCE - Static variable in class com.atlassian.gadgets.event.ClearHttpCacheEvent

isAnonymous() - Method in interface com.atlassian.gadgets.opensocial.OpenSocialRequestContext

isColumnSizingFair(DashboardState.ColumnIndex) - Method in enum class com.atlassian.gadgets.dashboard.Layout

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.

isConfigurable() - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule

Return true if this dashboarditem requires configuration to be entered by the user

isDebuggingEnabled() - Method in class com.atlassian.gadgets.GadgetRequestContext

Returns true if the gadget should be rendered with debugging enabled, false otherwise.

isDeletable() - Method in interface com.atlassian.gadgets.directory.Directory.Entry

Can this Gadget Spec File be removed from the directory?

isHostedExternally() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

Returns true if this spec is hosted externally (meaning it is not part of a plugin served by the Gadgets Publisher plugin), false otherwise.

isOpenSocialGadget() - Method in enum class com.atlassian.gadgets.DashboardItemType

Determines whether or not the item type is for an open social gadget or a local dashboard item.

isRequired() - Method in class com.atlassian.gadgets.spec.UserPrefSpec

Returns true if the pref is required.

isScrolling() - Method in class com.atlassian.gadgets.spec.GadgetSpec

Get the scrolling setting of the gadget in this spec

isWritable() - Method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentationService.RenderingContext

isWritable() - Method in class com.atlassian.gadgets.view.View

Returns true if the viewer is allowed to make changes to the gadget state.

Iterables - Class in com.atlassian.gadgets.dashboard.util

Convenience methods for dealing with Iterables, since we want to avoid introducing a dependency on Google Collections in our public API

J

JIRA - Enum constant in enum class com.atlassian.gadgets.directory.Category

K

Key(String, String) - Constructor for class com.atlassian.gadgets.plugins.PluginGadgetSpec.Key

Constructs a new PluginGadgetSpec.Key from the specified plugin key and resource location.

L

LAST_UPDATED - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

layout(Layout) - Method in class com.atlassian.gadgets.dashboard.DashboardState.Builder

Set the Layout of the DashboardState under construction and return this Builder to allow further construction to be done.

Layout - Enum Class in com.atlassian.gadgets.dashboard

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.

LIST - Enum constant in enum class com.atlassian.gadgets.spec.DataType

LOCAL - Enum constant in enum class com.atlassian.gadgets.directory.Directory.EntryScope

LOCAL_DASHBOARD_ITEM - Enum constant in enum class com.atlassian.gadgets.DashboardItemType

localCondition(Condition) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpecBuilder

LocalDashboardItemModuleId - Class in com.atlassian.gadgets

LocalDashboardItemModuleId(ModuleCompleteKey) - Constructor for class com.atlassian.gadgets.LocalDashboardItemModuleId

LocalDashboardItemModuleId(ModuleCompleteKey, Option<OpenSocialDashboardItemModuleId>) - Constructor for class com.atlassian.gadgets.LocalDashboardItemModuleId

LocalDashboardItemState - Class in com.atlassian.gadgets

Represents the state of the dashboard item which is not based on Open Social specification but is based on the description provided in the plugin.

LocalDashboardItemState(GadgetId, Color, LocalDashboardItemModuleId, Map<String, String>) - Constructor for class com.atlassian.gadgets.LocalDashboardItemState

LocalDashboardItemState.Builder - Class in com.atlassian.gadgets

locale(Locale) - Method in class com.atlassian.gadgets.GadgetRequestContext.Builder

Set the Locale of the GadgetRequestContext under construction and return this Builder to allow further construction to be done.

LocalGadgetSpecProvider - Interface in com.atlassian.gadgets

A provider of gadget specs that are avaiable locally, without making an HTTP request to fetch them.

location(String) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpecBuilder

M

MEDIA_ITEMS - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

MediaItem - Class in com.atlassian.gadgets.opensocial.model

MediaItem(MediaItem.Builder) - Constructor for class com.atlassian.gadgets.opensocial.model.MediaItem

MediaItem.Builder - Class in com.atlassian.gadgets.opensocial.model

A builder that facilitates construction of MediaItem objects.

MediaItem.Type - Enum Class in com.atlassian.gadgets.opensocial.model

An enumeration of potential media types.

mediaItems(List<MediaItem>) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the mediaItems associated with the Activity under construction and return this Builder to allow further construction to be done.

mimeType(String) - Method in class com.atlassian.gadgets.opensocial.model.MediaItem.Builder

Set the mime type of the MediaItem under construction and return this Builder to allow further construction to be done.

ModuleId - Class in com.atlassian.gadgets.view

Representation of the identifier for an instance of a gadget rendered on a page.

moduleKey(String) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpecBuilder

N

name(Name) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Set the Name of the Person being constructed

Name - Class in com.atlassian.gadgets.opensocial.model

Representation of a Person's full name

Name(String) - Constructor for class com.atlassian.gadgets.opensocial.model.Name

named(String) - Static method in enum class com.atlassian.gadgets.directory.Category

newSecurityToken(GadgetState, String) - Method in interface com.atlassian.gadgets.view.SecurityTokenFactory

Create a new security token for the gadget.

next() - Method in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

Returns the next column index after this one if there is one, equivalent to doing i+1 when the index is an int.

NO_CURRENT_REQUEST - Static variable in class com.atlassian.gadgets.GadgetRequestContext

NonAtomGadgetSpecFeedException - Exception in com.atlassian.gadgets.feed

Thrown if the feed that we are trying to use as a gadget spec feed is not an Atom feed.

NonAtomGadgetSpecFeedException(URI) - Constructor for exception com.atlassian.gadgets.feed.NonAtomGadgetSpecFeedException

NUMBER - Enum constant in enum class com.atlassian.gadgets.spec.DataType

numberOfColumns() - Method in class com.atlassian.gadgets.dashboard.DashboardColumns

O

of(String) - Static method in class com.atlassian.gadgets.opensocial.model.Group

Retrieve the group corresponding to the specified name

ONE - Enum constant in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

The second, middle column (in a three column layout) on the dashboard

OPEN_SOCIAL_GADGET - Enum constant in enum class com.atlassian.gadgets.DashboardItemType

OpenSocialDashboardItemModuleId - Class in com.atlassian.gadgets

OpenSocialDashboardItemModuleId(URI) - Constructor for class com.atlassian.gadgets.OpenSocialDashboardItemModuleId

openSocialGadget(String) - Static method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentation

OpenSocialRequestContext - Interface in com.atlassian.gadgets.opensocial

An adapter for Shindig's SecurityToken interface.

OTHER - Enum constant in enum class com.atlassian.gadgets.directory.Category

P

params(Map<String, String>) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpecBuilder

paramsAsMap() - Method in class com.atlassian.gadgets.view.View

Returns an unmodifiable Map of all view parameters.

parse(String) - Static method in enum class com.atlassian.gadgets.spec.DataType

Parses a data type from the input string.

PASS - Enum constant in enum class com.atlassian.gadgets.Vote

The implementation has no opinion on whether the user may perform the requested action.

PermissionException - Exception in com.atlassian.gadgets.dashboard

Thrown if a user tries a non-permissible operation on a dashboard or gadget.

PermissionException() - Constructor for exception com.atlassian.gadgets.dashboard.PermissionException

Person - Class in com.atlassian.gadgets.opensocial.model

Immutable container class encapsulating social data for a person.

Person.Builder - Class in com.atlassian.gadgets.opensocial.model

A builder that facilitates construction of Person objects.

PersonId - Class in com.atlassian.gadgets.opensocial.model

Representation of the unique identifier for a person.

PersonId(String) - Constructor for class com.atlassian.gadgets.opensocial.model.PersonId

Creates a new PersonId that wraps the id passed in

PhoneNumber - Class in com.atlassian.gadgets.opensocial.model

Representation of a Person's phone number

PhoneNumber(String) - Constructor for class com.atlassian.gadgets.opensocial.model.PhoneNumber

phoneNumbers(List<PhoneNumber>) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Set the list of phone numbers for the Person being constructed

plugin(Plugin) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpecBuilder

PluginGadgetSpec - Class in com.atlassian.gadgets.plugins

A gadget spec provided by a plugin.

PluginGadgetSpec(Plugin, String, String, Map<String, String>) - Constructor for class com.atlassian.gadgets.plugins.PluginGadgetSpec

Deprecated.

Use PluginGadgetSpec.builder() instead.

PluginGadgetSpec.Key - Class in com.atlassian.gadgets.plugins

An immutable representation of a unique identifier for plugin gadget specs, composed of a plugin key and resource location path name.

PluginGadgetSpecBuilder - Class in com.atlassian.gadgets.plugins

PluginGadgetSpecBuilder() - Constructor for class com.atlassian.gadgets.plugins.PluginGadgetSpecBuilder

pluginGadgetSpecDisabled(PluginGadgetSpec) - Method in interface com.atlassian.gadgets.plugins.PluginGadgetSpecEventListener

Called when a gadget spec is disabled from a plugin.

pluginGadgetSpecEnabled(PluginGadgetSpec) - Method in interface com.atlassian.gadgets.plugins.PluginGadgetSpecEventListener

Called when a gadget spec is enabled from a plugin.

PluginGadgetSpecEventListener - Interface in com.atlassian.gadgets.plugins

A listener for gadget spec modules that are enabled and disabled in plugins.

POSTED_TIME - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

postedTime(Long) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the postedTime of the Activity under construction and return this Builder to allow further construction to be done.

prependGadgetToColumn(GadgetState, DashboardState.ColumnIndex) - Method in class com.atlassian.gadgets.dashboard.DashboardState

Deprecated.

Use DashboardState.prependItemToColumn(com.atlassian.gadgets.DashboardItemState, com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex) instead. Since v3.11.

prependItemToColumn(DashboardItemState, DashboardState.ColumnIndex) - Method in class com.atlassian.gadgets.dashboard.DashboardState

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

priority(Float) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the priority of the Activity under construction and return this Builder to allow further construction to be done.

PRIORITY - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

profileUri(URI) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Set the profile URI of the Person being constructed

properties(Map<String, String>) - Method in class com.atlassian.gadgets.LocalDashboardItemState.Builder

publishLocation(String) - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpecBuilder

R

range(DashboardState.ColumnIndex, DashboardState.ColumnIndex) - Static method in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

Returns an immutable Iterable over ColumnIndexes starting from start and ending with end, inclusive.

readOnly(GadgetRequestContext, DashboardId, DashboardState.ColumnIndex) - Static method in class com.atlassian.gadgets.dashboard.DashboardItemRepresentationService.RenderingContext

removeViewType(ViewType) - Static method in class com.atlassian.gadgets.view.ViewType

Removes a ViewType.

renderContent(Writer, Map<String, Object>) - Method in interface com.atlassian.gadgets.plugins.DashboardItemModule

Renders server side content for the dashboard item.

RenderedGadgetUriBuilder - Interface in com.atlassian.gadgets.view

Builds URLs to the rendered gadget.

required(boolean) - Method in class com.atlassian.gadgets.spec.UserPrefSpec.Builder

Set the setting of the UserPrefSpec under construction whether it is required or not and return this Builder to allow further construction to be done.

S

save(DashboardState, String) - Method in interface com.atlassian.gadgets.dashboard.DashboardService

Save the DashboardState if the user has permission.

scrolling(boolean) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the scrolling setting of the GadgetSpec under construction and return this Builder to allow further construction to be done.

SecurityTokenFactory - Interface in com.atlassian.gadgets.view

A factory for generating security tokens that is used when rendering gadgets.

SELF - Static variable in class com.atlassian.gadgets.opensocial.model.Group

specUri(String) - Method in class com.atlassian.gadgets.GadgetState.SpecUriBuilder

Sets the spec URI of the GadgetState under construction and returns a Builder to allow the Color and user prefs to be set.

specUri(URI) - Method in class com.atlassian.gadgets.GadgetState.SpecUriBuilder

Sets the spec URI of the GadgetState under construction and returns a Builder to allow the Color and user prefs to be set.

status(String) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Sets the value of the person's "status" text

STREAM_FAVICON_URL - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

STREAM_SOURCE_URL - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

STREAM_TITLE - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

STREAM_URL - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

streamFaviconUrl(String) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the streamFaviconUrl of the Activity under construction and return this Builder to allow further construction to be done.

streamSourceUrl(String) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the streamSourceUrl of the Activity under construction and return this Builder to allow further construction to be done.

streamTitle(String) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the streamTitle of the Activity under construction and return this Builder to allow further construction to be done.

streamUrl(String) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the streamUrl of the Activity under construction and return this Builder to allow further construction to be done.

STRING - Enum constant in enum class com.atlassian.gadgets.spec.DataType

supportsViewType(ViewType) - Method in class com.atlassian.gadgets.spec.GadgetSpec

Check if a particular view is supported in this spec

T

TEMPLATE_PARAMS - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

thumbnail(URI) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the thumbnail URI of the GadgetSpec under construction and return this Builder to allow further construction to be done.

thumbnailUri(URI) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Set the thumbnail URI of the Person being constructed

timeZone(int) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Sets the time zone offset for the person.

title(String) - Method in class com.atlassian.gadgets.dashboard.DashboardState.Builder

Set the title of the DashboardState under construction and return this Builder to allow further construction to be done.

title(String) - Method in class com.atlassian.gadgets.dashboard.DashboardState.TitleBuilder

Sets the title of the DashboardState under construction and returns a Builder to allow the Layout and the columns to be set.

title(String) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the title of the GadgetSpec under construction and return this Builder to allow further construction to be done.

TITLE - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

TITLE_ID - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

titleUrl(URI) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the title URI of the GadgetSpec under construction and return this Builder to allow further construction to be done.

toString() - Method in class com.atlassian.gadgets.dashboard.DashboardColumns

toString() - Method in class com.atlassian.gadgets.dashboard.DashboardId

toString() - Method in class com.atlassian.gadgets.dashboard.DashboardState

toString() - Method in class com.atlassian.gadgets.dashboard.DashboardTab

toString() - Method in class com.atlassian.gadgets.GadgetId

toString() - Method in class com.atlassian.gadgets.GadgetRequestContext.User

toString() - Method in class com.atlassian.gadgets.GadgetState

toString() - Method in class com.atlassian.gadgets.LocalDashboardItemState

toString() - Method in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

emit the field as a json element.

toString() - Method in class com.atlassian.gadgets.opensocial.model.Activity

toString() - Method in class com.atlassian.gadgets.opensocial.model.ActivityId

toString() - Method in class com.atlassian.gadgets.opensocial.model.Address

toString() - Method in class com.atlassian.gadgets.opensocial.model.AppId

toString() - Method in class com.atlassian.gadgets.opensocial.model.EmailAddress

toString() - Method in class com.atlassian.gadgets.opensocial.model.Group

The String representation of a group (its name)

toString() - Method in class com.atlassian.gadgets.opensocial.model.Name

toString() - Method in class com.atlassian.gadgets.opensocial.model.Person

toString() - Method in class com.atlassian.gadgets.opensocial.model.PersonId

toString() - Method in class com.atlassian.gadgets.opensocial.model.PhoneNumber

toString() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec.Key

toString() - Method in class com.atlassian.gadgets.plugins.PluginGadgetSpec

toString() - Method in class com.atlassian.gadgets.spec.GadgetSpec

toString() - Method in class com.atlassian.gadgets.spec.UserPrefSpec

toString() - Method in class com.atlassian.gadgets.view.ModuleId

toString() - Method in class com.atlassian.gadgets.view.ViewType

translate(PluginGadgetSpec.Key) - Method in interface com.atlassian.gadgets.plugins.GadgetLocationTranslator

Translate public-facing gadget spec key to internal plugin gadget spec key.

translate(URI) - Method in interface com.atlassian.gadgets.plugins.GadgetLocationTranslator

Translate public-facing gadget spec URI to internal plugin gadget spec URI.

TWO - Enum constant in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

The third, and last column (in a three column layout) on the dashboard

type(MediaItem.Type) - Method in class com.atlassian.gadgets.opensocial.model.MediaItem.Builder

Set the type of the MediaItem under construction and return this Builder to allow further construction to be done.

U

unsupportedFeatureNames(Iterable<String>) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the list of unsupported features for the GadgetSpec under construction and return this Builder to allow further construction to be done.

updated(Date) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the updated date of the Activity under construction and return this Builder to allow further construction to be done.

url(String) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the url of the Activity under construction and return this Builder to allow further construction to be done.

url(URI) - Method in class com.atlassian.gadgets.opensocial.model.MediaItem.Builder

Set the url of the MediaItem under construction and return this Builder to allow further construction to be done.

URL - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

urls(List<URI>) - Method in class com.atlassian.gadgets.opensocial.model.Person.Builder

Sets a list of interesting URLs for the person

user(GadgetRequestContext.User) - Method in class com.atlassian.gadgets.GadgetRequestContext.Builder

Sets the current user.

User(String, String) - Constructor for class com.atlassian.gadgets.GadgetRequestContext.User

USER_ID - Enum constant in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

userId(PersonId) - Method in class com.atlassian.gadgets.opensocial.model.Activity.Builder

Set the user id of the Activity under construction and return this Builder to allow further construction to be done.

userPrefs(Iterable<UserPrefSpec>) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the list of UserPrefSpec objects for the GadgetSpec under construction and return this Builder to allow further construction to be done.

userPrefs(Map<String, String>) - Method in class com.atlassian.gadgets.GadgetState.Builder

Set the Map of user preference values for the GadgetState under construction and return this Builder to allow further construction to be done.

userPrefSpec(UserPrefSpec) - Static method in class com.atlassian.gadgets.spec.UserPrefSpec

Factory method which allows you to create a new UserPrefSpec object based on an existing UserPrefSpec.

userPrefSpec(String) - Static method in class com.atlassian.gadgets.spec.UserPrefSpec

Factory method to create a new builder which can be used to create UserPrefSpec objects.

UserPrefSpec - Class in com.atlassian.gadgets.spec

Represents a user pref containing the details from the gadget spec XML

UserPrefSpec.Builder - Class in com.atlassian.gadgets.spec

A builder that facilitates construction of UserPrefSpec objects.

V

value() - Method in class com.atlassian.gadgets.dashboard.DashboardId

Returns the value of the identifier as a String.

value() - Method in class com.atlassian.gadgets.GadgetId

Returns the value of the identifier as a String

value() - Method in class com.atlassian.gadgets.opensocial.model.ActivityId

Returns the value of the identifier as a String.

value() - Method in class com.atlassian.gadgets.opensocial.model.Address

value() - Method in class com.atlassian.gadgets.opensocial.model.AppId

Returns the value of the identifier as a String.

value() - Method in class com.atlassian.gadgets.opensocial.model.EmailAddress

value() - Method in class com.atlassian.gadgets.opensocial.model.Name

value() - Method in class com.atlassian.gadgets.opensocial.model.PersonId

Returns the value of the identifier as a String.

value() - Method in class com.atlassian.gadgets.opensocial.model.PhoneNumber

value() - Method in class com.atlassian.gadgets.view.ModuleId

Returns the value of the identifier as a long.

valueOf() - Method in class com.atlassian.gadgets.opensocial.model.Group

Fetch the (unique) name of this group

valueOf(long) - Static method in class com.atlassian.gadgets.view.ModuleId

Converts the long value to a ModuleId object.

valueOf(String) - Static method in enum class com.atlassian.gadgets.dashboard.Color

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in class com.atlassian.gadgets.dashboard.DashboardId

Convert the String value to a DashboardId object.

valueOf(String) - Static method in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.atlassian.gadgets.dashboard.Layout

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.atlassian.gadgets.DashboardItemType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.atlassian.gadgets.directory.Category

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.atlassian.gadgets.directory.Directory.EntryScope

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in class com.atlassian.gadgets.GadgetId

Converts the String value to a GadgetId object.

valueOf(String) - Static method in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in class com.atlassian.gadgets.opensocial.model.ActivityId

Convert the String value to a ActivityId object.

valueOf(String) - Static method in class com.atlassian.gadgets.opensocial.model.Address

valueOf(String) - Static method in class com.atlassian.gadgets.opensocial.model.AppId

Convert the String value to a AppId object.

valueOf(String) - Static method in class com.atlassian.gadgets.opensocial.model.EmailAddress

valueOf(String) - Static method in enum class com.atlassian.gadgets.opensocial.model.MediaItem.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in class com.atlassian.gadgets.opensocial.model.Name

valueOf(String) - Static method in class com.atlassian.gadgets.opensocial.model.PersonId

Convert the String value to a PersonId object.

valueOf(String) - Static method in class com.atlassian.gadgets.opensocial.model.PhoneNumber

valueOf(String) - Static method in enum class com.atlassian.gadgets.spec.DataType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in class com.atlassian.gadgets.view.ModuleId

Converts the String value to a ModuleId object.

valueOf(String) - Static method in class com.atlassian.gadgets.view.ViewType

Returns the ViewType associated with the value.

valueOf(String) - Static method in enum class com.atlassian.gadgets.Vote

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.atlassian.gadgets.dashboard.Color

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.gadgets.dashboard.Layout

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.gadgets.DashboardItemType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.gadgets.directory.Category

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.gadgets.directory.Directory.EntryScope

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.gadgets.opensocial.model.Activity.Field

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.gadgets.opensocial.model.MediaItem.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.gadgets.spec.DataType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.gadgets.Vote

Returns an array containing the constants of this enum class, in the order they are declared.

version(long) - Method in class com.atlassian.gadgets.dashboard.DashboardState.Builder

Set the version of the DashboardState under construction and return this Builder to allow further construction to be done.

VIDEO - Enum constant in enum class com.atlassian.gadgets.opensocial.model.MediaItem.Type

view(View) - Method in class com.atlassian.gadgets.GadgetRequestContext.Builder

Set the current view of the GadgetRequestContext under construction and return this Builder to allow further construction to be done.

View - Class in com.atlassian.gadgets.view

Models information the renderer needs to know about a gadget to render it properly.

View.Builder - Class in com.atlassian.gadgets.view

Builder for View.

ViewComponent - Interface in com.atlassian.gadgets.view

A ViewComponent represents a view of an entity in the gadgets system.

viewsNames(Set<String>) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the list of view names for the GadgetSpec under construction and return this Builder to allow further construction to be done.

viewType(ViewType) - Method in class com.atlassian.gadgets.view.View.Builder

Sets the ViewType to use

ViewType - Class in com.atlassian.gadgets.view

Represents a context under which a gadget will be viewed.

visit(Directory.DashboardDirectoryEntry) - Method in interface com.atlassian.gadgets.directory.DirectoryEntryVisitor

visit(Directory.OpenSocialDirectoryEntry) - Method in interface com.atlassian.gadgets.directory.DirectoryEntryVisitor

visit(GadgetState) - Method in interface com.atlassian.gadgets.DashboardItemStateVisitor

visit(LocalDashboardItemModuleId) - Method in interface com.atlassian.gadgets.DashboardItemModuleIdVisitor

visit(LocalDashboardItemState) - Method in interface com.atlassian.gadgets.DashboardItemStateVisitor

visit(OpenSocialDashboardItemModuleId) - Method in interface com.atlassian.gadgets.DashboardItemModuleIdVisitor

Vote - Enum Class in com.atlassian.gadgets

Votes are used in the gadget system to determine whether a user is allowed to perform certain actions, such as seeing a gadget in the gadget browser or being allowed to render a gadget on their dashboard.

W

WALLBOARD - Enum constant in enum class com.atlassian.gadgets.directory.Category

width(int) - Method in class com.atlassian.gadgets.spec.GadgetSpec.Builder

Set the width of the GadgetSpec under construction and return this Builder to allow further construction to be done.

writable(boolean) - Method in class com.atlassian.gadgets.view.View.Builder

Sets whether this view is writable.

writeGadgetSpecTo(URI, OutputStream) - Method in interface com.atlassian.gadgets.LocalGadgetSpecProvider

Writes the gadget spec found at the specified URI, to the specified OutputStream.

writeTo(Writer) - Method in interface com.atlassian.gadgets.view.ViewComponent

Renders the component represented by this view and writes it to the Writer.

Z

ZERO - Enum constant in enum class com.atlassian.gadgets.dashboard.DashboardState.ColumnIndex

The first, left-most column on the dashboard.

A B C D E F G H I J K L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form