com.ibm.mashups.enabler.widget
Interface WidgetDefinition

All Superinterfaces:

com.ibm.mashups.enabler.DirtyFlagProvider, EventProvider, Identifiable, Localized, MetaData, ModifiableEventProvider, ModifiableLocalized, ModifiableMetaData, PreferencesProvider

public WidgetDefinition
extends Identifiable, ModifiableLocalized, ModifiableMetaData, PreferencesProvider, ModifiableEventProvider

Interface for a widget definition.

Method Summary

String	getURL() This method returns the url pointing to the widget definition xml file.
String	getType() This method returns the type of the entity represented by this definition (e.g. iWidgets or OpenSocial gadget).
String[]	getSupportedModes() This method returns an array of supported modes such as "view" and "edit".

Methods inherited from interface com.ibm.mashups.enabler.Identifiable

getID

Methods inherited from interface com.ibm.mashups.enabler.ModifiableLocalized

setTitle, confirmSetTitle, removeTitle, confirmRemoveTitle, removeTitles, confirmRemoveTitles, setDescription, confirmSetDescription, removeDescription, confirmRemoveDescription, removeDescriptions, confirmRemoveDescriptions

Methods inherited from interface com.ibm.mashups.enabler.Localized

getLocales, getTitle, getTitles, getDescription, getDescriptions

Methods inherited from interface com.ibm.mashups.enabler.ModifiableMetaData

setMetaData, confirmSetMetaData, removeMetaData, confirmRemoveMetaData

Methods inherited from interface com.ibm.mashups.enabler.MetaData

getMetaDataNames, getMetaData

Methods inherited from interface com.ibm.mashups.enabler.widget.PreferencesProvider

getPreferences

Methods inherited from interface com.ibm.mashups.enabler.widget.ModifiableEventProvider

createEvent, getEvents, getEvent, addEvent, removeEvent, confirmAddEvent, confirmRemoveEvent

Methods inherited from interface com.ibm.mashups.enabler.widget.EventProvider

getEvents, getEvent, getEventByID

Method Detail

getURL

String getURL()

This method returns the url pointing to the widget definition xml file.

Returns:

URL pointing to the widget definition xml file.

Since:

3.0

getType

String getType()

This method returns the type of the entity represented by this definition (e.g. iWidgets or OpenSocial gadget).

Returns:

the type of the entity represented in the definition xml file.

Since:

3.0

getSupportedModes

String[] getSupportedModes()

This method returns an array of supported modes such as "view" and "edit".

Returns:

an array of modes this iWidget supports.

Since:

2.4