|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public NavigationStateModel
Interface for a Navigation state model.
Navigation State API does not garantee that any modifications issued on the API have any further impact on the
user experience of any widgets or components on the page. Widgets or components may choose to listen to changes on the Navigation State Model and react properly upon those changes. However any user experience change cuased by those components are not part of the contract of this API and therefore these UI behaviour may change going forward
AccessorFactory API should be used to read/write navigation state within NavigationStateModel.
var navStateModel=com.ibm.mashups.enabler.model.state.NavigationStateModelFactory.getNavigationStateModel();
var widgetAccessor = com.ibm.mashups.enabler.model.state.AccessorFactory.getWidgetAccessor(navStateModel);
widgetAccessor.setSize("200","300");
var deferred = navStateModel.commit();
deferred.setFinishedCallback(cb);
deferred.start();
Field Summary | |
---|---|
String |
ONNAVSTATEUPDATED
The name of the event to handle to get NavState update notifications. |
Method Summary | |
---|---|
void |
startTransaction()
This method starts a global transaction for a NavigationStateModel object |
void |
commitTransaction()
This method commits all changes done withing a global transaction for a NavigationStateModel object |
void |
discardTransaction()
This method discards all changes done within a transaction for a NavigationStateModel object and restores the original NavigationStateModel object. |
boolean |
isTransaction()
This method starts a global transaction for a NavigationStateModel object |
DeferredOperation |
commit(Object additionalParams)
Commits the modifications applied to this model and all dependent models. |
void |
discard()
Discards the modifications applied to this model. |
void |
dispose()
Dispose this model completely all the navigation state will be destroyed. |
Field Detail |
---|
String ONNAVSTATEUPDATED
Method Detail |
---|
void startTransaction()
void commitTransaction()
void discardTransaction()
boolean isTransaction()
DeferredOperation commit(Object additionalParams)
additionalParams
-
Optional JSON object to control various aspects while commiting addToHistory
(Boolean) - true
if the state should be added to the browser history, false
otherwise allowRedirect
(Boolean) - true
if the page should be refreshed after the commit, false
otherwise. Note, this parameter is ignored if the commit is synchronous null
void discard()
void dispose()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |