com.atlassian.gadgets.dashboard.internal
Interface Gadget

All Known Implementing Classes:

GadgetImpl

public interface Gadget

Method Summary

Color	getColor()
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()
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()

Method Detail

getId

GadgetId getId()

getTitle

String getTitle()

getTitleUrl

URI getTitleUrl()

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

getGadgetSpecUrl

String getGadgetSpecUrl()

getHeight

Integer getHeight()

getWidth

Integer getWidth()

getColor

Color getColor()

isMaximizable

boolean isMaximizable()

hasNonHiddenUserPrefs

boolean hasNonHiddenUserPrefs()

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

Iterable<UserPref> getUserPrefs()

getState

GadgetState getState()

getErrorMessage

String getErrorMessage()

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

isLoaded

boolean isLoaded()

Tells if the gadget has been loaded successfully