Class Noodle.Leftnav

Object
   |
   +--Noodle.Leftnav

class Noodle.Leftnav

Standard left hand side navigation functions.
Defined in leftnav.js

Constructor Detail

Noodle.Leftnav

Noodle.Leftnav()

addWorkspace

<static> void addWorkspace(<string> workspaceURI, <string> folderID)

Add an item to the Recently Added workspaces section There are two default Noodle.Leftnav.folderID = wsfolder;-analysis and wsfolder-recent should always exist

Parameters:
workspaceURI - Workspace to add.
folderID - Folder to which to add workspace.

addWorkspaceFolder

<static> void addWorkspaceFolder(<string> parentFolderID, <string> folderName)

Add a workspace folder to an existing workspace folder There are two default Noodle.Leftnav.folderID = wsfolder;-analysis and wsfolder-recent should always exist

Parameters:
parentFolderID - ID of parent folder to add new folder to
folderName - Name of new folder

addWorkspaceWithUI

<static> void addWorkspaceWithUI( <string> name, <Noodle.Page.WorkspaceType> type, <string> contextURI, <string> templateURI, <boolean> createView, <boolean> createTab, <boolean> redirect )

Creates a new workspace without a prompt for its name.

Parameters:
name - New name for workspace.
type - Workspace type.
contextURI - URI of thing being analyzed (may be null or undefined).
templateURI - URI of template workspace to copy (may be null or undefined).
createView - True to add the workspace to the leftnav.
createTab - True to create a new tab for the workspace.
redirect - True to display workspace after creating.
options - Map of options.

Deprecated

collapseBranch

<static> void collapseBranch(<string> configurationID, <CAF.Oak.Branch> branch, <string> boughID, <optional> branchID)

Saves collapse branch state.

Parameters:
configurationID - PortletID with LHS configuration.
branch - Existing oak branch.
boughID - Logical id of bough to collapse.
branchID - Logical row id of branch to collapse.

createChildBranches

<static> void createChildBranches(configurationId, <string> lhsId, <CAF.Oak.Branch> branch, <array> nodeData)

Creates noodle oak child branches from JSON data.

Parameters:
lhsId - LHS gobal id.
branch - Existing oak branch.
nodeData - JSON data.
configurationID - Portlet ID with LHS configuration.

expandBranch

<static> void expandBranch(<optional> configurationID, <CAF.Oak.Branch> branch, <optional> boughID, <optional> branchID)

Expands a noodle oak branch.

Parameters:
configurationID - PortletID with LHS configuration.
branch - Existing oak branch.
boughID - Logical id of bough to expand.
branchID - Logical row id of branch to expand.

getBranch

<static> Object getBranch(<string> branchID)

Gets the noodle branch model for the specified branch id.

Parameters:
branchID - Branch id (ex "wsfolder-recent").

Returns:
Branch model or null.

handleNoodleEvents

<static> Object handleNoodleEvents(<string> name)

Creates a noodle event handler for leftnav branches.

Parameters:
name - Name of method on leftnav-branch model to call to handle event.

Returns:
Event handler function.

handleOakEvents

<static> Object handleOakEvents(<string> name)

Creates a oak event handler for leftnav branches.

Parameters:
name - Name of method on leftnav-branch model to call to handle event.

Returns:
Event handler function.

handlePageLoad

<static> void handlePageLoad(<string> ename, <Noodle.Page.Model> page)

Handles page load event.

Parameters:
ename - Event name.
page - Loaded page.

handleTabDeselect

<static> void handleTabDeselect(<string> n, <Noodle.Tab.Model> tab)

Handles tab deselection event.

Parameters:
n - Event name.
tab - Deseleted tab.

handleTabSelect

<static> void handleTabSelect(<string> n, <Noodle.Tab.Model> tab)

Handles tab selection event.

Parameters:
n - Event name.
tab - Selected tab.

handleWorkspaceAddEvent

<static> void handleWorkspaceAddEvent(<string> n, <event> o)

Handle node rename events from the tab. Noodle.Leftnav.NOTE = expects;an object with workspaceURI and type properties.

Parameters:
n - Event name.
o - Event object.

handleWorkspaceDeleteEvent

<static> void handleWorkspaceDeleteEvent(<string> n, <string> workspaceID)

Handle workspace deletion events (to keep leftnav workspace view in sync).

Parameters:
n - Event name.
workspaceID - Workspace ID.

handleWorkspaceFolderAddEvent

<static> void handleWorkspaceFolderAddEvent(<string> n, o )

Handle workspace folder add events (to keep leftnav workspace view in sync).

Parameters:
n - Event name.
folderID - - folder ID.

handleWorkspaceRenameEvent

<static> void handleWorkspaceRenameEvent(<string> n, <event> o)

Handle workspace rename events (to sync tabs and left nav nodes).

Parameters:
n - Event name.
o - Event object.

modelAnnotator

<static> Object modelAnnotator(<Noodle.Model> m)

Standard leftnav model annotator.

Parameters:
m - Model to annotate.

Returns:
Annotated model.

promptAddWorkspaceWithUI

<static> void promptAddWorkspaceWithUI( <Noodle.Page.WorkspaceType> type, <string> contextURI, <string> templateURI, <boolean> createView, <boolean> createTab, <boolean> redirect )

Creates a new workspace, prompting for the name if not specified.

Parameters:
type - Workspace type.
contextURI - URI of thing being analyzed (may be null or undefined).
templateURI - URI of template workspace to copy (may be null or undefined).
createView - True to add the workspace to the leftnav.
createTab - True to create a new tab for the workspace.
redirect - True to display workspace after creating.
options - Map of options.

Deprecated

removeWorkspace

<static> void removeWorkspace(<string> workspaceID)

Add an item to the Recently Added workspaces section

Parameters:
workspaceID - Workspace to remove.