Class orion.breadcrumbs.BreadCrumbs
Bread crumbs show the current position within a resource tree and allow navigation
to different places in the tree. Unlike the fairy tale, bread crumbs typically don't lead
to a cottage made of gingerbread. Sorry!
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/breadcrumbs.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
orion.breadcrumbs.BreadCrumbs(options)
Constructs a new BreadCrumb with the given options.
|
| Method Attributes | Method Name and Description |
|---|---|
|
addSegmentHref(seg, section)
|
|
|
addTitle(seg, firstSegmentName)
|
|
|
append(section)
|
|
|
buildSegment(name)
|
|
|
buildSegments(firstSegmentName, direction)
|
|
|
finalSegment(seg, firstSegmentName)
|
|
|
firstSegment(segment)
|
|
|
measure()
|
|
|
refresh()
|
|
|
render()
|
Class Detail
orion.breadcrumbs.BreadCrumbs(options)
Constructs a new BreadCrumb with the given options.
- Parameters:
- {Object} options
- The options object, which must specify the parent container.
- options.container
- The parent container for the bread crumb presentation
- options.resource Optional
- The current resource
- options.rootSegmentName Optional
- The name to use for the root segment in lieu of the metadata name.
- options.workspaceRootSegmentName Optional
- The name to use for the workspace root. If not specified, the workspace root will not be shown.
- {Function} options.makeHref Optional
- The callback function to make the href on a bread crumb item. If not defined "/edit/edit.html#" is used.
- {Function} option.getFirstSegment Optional
- The callback function to make DOM node for the first segment in breadcrumb.
Method Detail
addDivider()
addSegmentHref(seg, section)
- Parameters:
- seg
- section
addTitle(seg, firstSegmentName)
- Parameters:
- seg
- firstSegmentName
append(section)
- Parameters:
- section
buildSegment(name)
- Parameters:
- name
buildSegments(firstSegmentName, direction)
- Parameters:
- firstSegmentName
- direction
drawSegments()
finalSegment(seg, firstSegmentName)
- Parameters:
- seg
- firstSegmentName
firstSegment(segment)
- Parameters:
- segment
getNavigatorWorkspaceRootSegment()
measure()
measureSegments()
refresh()
render()