|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public NavigationModel
Interface for a navigation model. This tree model describes the topology in which the navigation is structured. Elements in this model are navigation elements, such as navigation nodes or labels.
The navigation model supports the following strategies:
Method Summary | |
---|---|
Boolean |
hasLayoutModel(NavigationElement element)
Indicates if the specified navigation element has a layout model. |
LayoutModel |
getLayoutModel(NavigationElement element)
Returns the layout model for the given navigation element. |
Object |
getSharedRoot()
Deprecated. Use findDefaultAcceptParent instead. |
Object |
findDefaultAcceptParent()
Returns a Deferred object to obtain a special node of the model defining the root of all pages, which are shared with a user. |
Boolean |
confirmExport(NavigationElement element)
Indicates whether the navigation element can be exported. |
Object |
create(JSON context)
Creates a new navigation entity. |
DeferredOperation |
commit()
Commits the modifications applied to this model and all dependent models. |
Methods inherited from interface com.ibm.mashups.enabler.TreeModelController |
---|
create, confirmCreate, insert, confirmInsert, remove, confirmRemove |
Methods inherited from interface com.ibm.mashups.enabler.TreeModel |
---|
getRoot, hasChildren, getChildren, getParent |
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.model.SelectionLocator |
---|
findDefaultAcceptParent |
Methods inherited from interface com.ibm.mashups.enabler.Discardable |
---|
discard |
Methods inherited from interface com.ibm.mashups.enabler.Invalidatable |
---|
invalidate |
Method Detail |
---|
Boolean hasLayoutModel(NavigationElement element)
element
-
navigation element or URI of navigation element for which to check if it has a layout model. Must not be null
.
LayoutModel getLayoutModel(NavigationElement element)
element
-
navigation element or the URI of the navigation element for which to return its layout model. The navigation element must be part of this model; must not be null
.
null
if none exists.Object getSharedRoot()
null
if the navigation tree is empty
Object findDefaultAcceptParent()
null
if the navigation tree is empty
Boolean confirmExport(NavigationElement element)
element
-
navigation element or URI of the navigation element; must not be null
true
if the page can be exported, false
otherwise.Object create(JSON context)
insert
method.
context
-
context of predefined information used for the creation of the navigation entity. Must not be null
. Accepted names are:type
- type of navigation entity to create as defined in Constants
; must be one of be one of the following:template
- creates a new navigation node based on the specified com.ibm.mashups.enabler.navigation.NavigationNodeprivate
NavigationNode
,
NavigationLabel
,
NavigationURL
,
Constants
DeferredOperation commit()
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |