|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public WidgetModel
This interface provides a model for widgets. It exposes widget definitions, instances, and windows. You may create widget instances based on definitions and remove widget instances.
The widget model supports the following strategies:
Method Summary | |
---|---|
Deferred |
find(Identifiable id)
Returns the widget definition specified with the id. |
Deferred |
findWidgetWindow(String windowID,
String pageID)
Returns the widget window for the specified windowID and pageID. |
Deferred |
getWidgetDefinitionByWindow(WidgetWindow window)
Returns the widget definition specified with the widget window |
Deferred |
getWidgetDefinitionByInstance(WidgetInstance instance)
Returns the widget definition specified with the widget instance |
Deferred |
getWidgetWindow(LayoutControl control)
Returns the widget window of the specified layout control. |
boolean |
isWidgetWindowCached(String id)
Returns true in case the WidgetWindow
identified by id is cached in this model. |
Deferred |
getWidgetInstance(WidgetWindow window)
Returns the widget instance of the specified widget window. |
Deferred |
getHierarchicalPreferences(PreferencesProvider preferenceProvider)
Gets hierarchical preferences of the specified PreferenceProvider
down to the levels. |
Deferred |
getHierarchicalEventProvider(EventProvider eventProvider)
Gets the hierarchical EventProvider
for the specified EventProvider
down to the levels. |
Methods inherited from interface com.ibm.mashups.enabler.Commitable |
---|
isDirty, commit |
Methods inherited from interface com.ibm.mashups.enabler.model.Model |
---|
setStrategy, getStrategies, getStrategy, addStrategy, removeStrategy |
Methods inherited from interface com.ibm.mashups.enabler.Locator |
---|
find |
Methods inherited from interface com.ibm.mashups.enabler.Discardable |
---|
discard |
Method Detail |
---|
Deferred find(Identifiable id)
id
-
of the widget definition
null
. The return value when executed through the deferred object is a WidgetDefinition
for the given Identifiable
or null if no widget definition is found.Deferred findWidgetWindow(String windowID, String pageID)
windowID
-
the ID of the window to lookuppageID
-
the page ID of the window to lookup
WidgetWindow
for the given IDs or null if no widget window is found.Deferred getWidgetDefinitionByWindow(WidgetWindow window)
window
-
the widget window
null
. The return value when executed through the deferred object is a WidgetDefinition
for the given WidgetWindow
or null if no widget definition is found.Deferred getWidgetDefinitionByInstance(WidgetInstance instance)
instance
-
the widget instance
null
. The return value when executed through the deferred object is a WidgetDefinition
for the given WidgetInstance
or null if no widget definition is found.Deferred getWidgetWindow(LayoutControl control)
control
-
the layout control
null
. The return value when executed through the deferred object is a WidgetWindow
for the given LayoutControl
or null if no widget window is found.boolean isWidgetWindowCached(String id)
WidgetWindow
identified by id is cached in this model. false otherwise.
id
-
the identifier of the window
Deferred getWidgetInstance(WidgetWindow window)
window
-
the widget window
null
. The return value when executed through the deferred object is a WidgetInstance
for the given WidgetWindow
or null if no widget instance is found.Deferred getHierarchicalPreferences(PreferencesProvider preferenceProvider)
PreferenceProvider
down to the levels. This means, that the preferences of each level (definition, instance and window) will be aggregated, depending on which preference provider you provided as argument.
preferenceProvider
-
the preference provider from which to aggregate preferences down.
ModifiablePreferences
object, that represents the aggregated preferences down to the lowest level, starting on the preference level of the given PreferenceProvider
Deferred getHierarchicalEventProvider(EventProvider eventProvider)
EventProvider
for the specified EventProvider
down to the levels. This means, that the events of each level (definition, instance and window) will be aggregated, depending on which event provider you provided as argument and then be accessible through the retuned eventprovider.
eventProvider
-
the event provider from which to aggregate events down.
ModifiableEventProvider
providing the aggregated events down to the lowest level, starting on the event level of the given EventProvider
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |