com.atlassian.gadgets.dashboard.internal.impl

Class OpenSocialDashboardItem

java.lang.Object

com.atlassian.gadgets.dashboard.internal.SpecificationBasedDashboardItem

com.atlassian.gadgets.dashboard.internal.impl.OpenSocialDashboardItem

All Implemented Interfaces:

Gadget

public class OpenSocialDashboardItem
extends SpecificationBasedDashboardItem

Represents a local gadget defined via a dashboard-item module that replaces an open social gadget. This uses the underlying opensocial spec to look up things like title, description etc. DashboardItem is the Gadget implementation which is fully based on information passed in the descriptor.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.gadgets.dashboard.internal.Gadget

Gadget.Visitor<T>

Constructor Summary

Constructors

Constructor and Description
OpenSocialDashboardItem(GadgetState state, DashboardItemModule dashboardItemModule, String dashboardItemModuleKey, GadgetSpec gadgetSpec)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(Gadget.Visitor<T> visitor)
Color	getColor()
DashboardItemModule	getDashboardItemModule()
String	getErrorMessage() Returns an error message if the gadget was constructed with one, which should be the case when isLoaded() returns false
String	getGadgetSpecUrl()
Integer	getHeight()
GadgetId	getId()
GadgetState	getState()
String	getTitle()
URI	getTitleUrl() Returns an optional URL that the gagdget's title will link to
Iterable<UserPref>	getUserPrefs() Returns preferences of the user which are associated with this Gadget.
Integer	getWidth()
boolean	hasNonHiddenUserPrefs() Returns true if the gadget contains at least one pref that isn't hidden.
boolean	isLoaded() Tells if the gadget has been loaded successfully
boolean	isMaximizable()

Methods inherited from class com.atlassian.gadgets.dashboard.internal.SpecificationBasedDashboardItem

getProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenSocialDashboardItem

public OpenSocialDashboardItem(GadgetState state,
                               DashboardItemModule dashboardItemModule,
                               String dashboardItemModuleKey,
                               GadgetSpec gadgetSpec)

Method Detail

getId

public GadgetId getId()

getTitle

public String getTitle()

getTitleUrl

public URI getTitleUrl()

Description copied from interface: Gadget

Returns an optional URL that the gagdget's title will link to

getGadgetSpecUrl

public String getGadgetSpecUrl()

Specified by:

getGadgetSpecUrl in class SpecificationBasedDashboardItem

getHeight

public Integer getHeight()

getWidth

public Integer getWidth()

getColor

public Color getColor()

isMaximizable

public boolean isMaximizable()

hasNonHiddenUserPrefs

public boolean hasNonHiddenUserPrefs()

Description copied from interface: Gadget

Returns true if the gadget contains at least one pref that isn't hidden. If the gadget has no prefs of any sort, this will return false.

Returns:

true if the gadget contains at least one non-hidden pref

getUserPrefs

public Iterable<UserPref> getUserPrefs()

Description copied from interface: Gadget

Returns preferences of the user which are associated with this Gadget.

getState

public GadgetState getState()

getErrorMessage

public String getErrorMessage()

Description copied from interface: Gadget

Returns an error message if the gadget was constructed with one, which should be the case when isLoaded() returns false

Returns:

an error message if the gadget was constructed with one (currently only possible with one of two constructors)

isLoaded

public boolean isLoaded()

Description copied from interface: Gadget

Tells if the gadget has been loaded successfully

Returns:

true if the gadget is loaded, i.e. has been constructed with a gadgetSpec and no error (currently only possible with one of two constructors)

accept

public <T> T accept(Gadget.Visitor<T> visitor)

getDashboardItemModule

public DashboardItemModule getDashboardItemModule()