Class Noodle.Leftnav.Model

Object
   |
   +--Noodle.Model
         |
         +--Noodle.Leftnav.Model

class Noodle.Leftnav.Model

extends Noodle.Model

Noodle leftnav container model.
Defined in leftnav.js

Constructor Detail

Noodle.Leftnav.Model

Noodle.Leftnav.Model()

collapseLeftNav

<static> void collapseLeftNav(<boolean> preserveState)

Display left nav in collapsed state.

Parameters:
preserveState - Preserve the collapsed state to the portlet.

displayLeftNav

<static> void displayLeftNav(<boolean> preserveState)

Displays the left nav expanded or collapsed.

Parameters:
preserveState - Preserve the expanded or collapsed state to the portlet.

expandLeftNav

<static> void expandLeftNav(<boolean> preserveState)

Display left nav in expanded state.

Parameters:
preserveState - Preserve the expanded state to the portlet.

hideDragResize

<static> void hideDragResize(<object> event)

Hide drag resize icon.

Parameters:
event - Mouse event.

highlightSelectedBranch

<static> void highlightSelectedBranch(thingID)

This function highlights the branch for the current page.

initialize

<static> void initialize()

Initialize noodle leftnav model.

layoutComponents

<static> void layoutComponents()

Set positioning, widths, paddings, and borders of the left nav based upon the current left nav state.

load

<static> void load()

Loads the leftnav.

onLeftNavDrag

<static> void onLeftNavDrag(<object> draggableObject, <object> event)

Drag event handler called as left nav resize icon is dragged.

Parameters:
draggableObject - Left nav draggable icon.
event - Mouse event.

onLeftNavDragEnd

<static> void onLeftNavDragEnd(<object> draggableObject, <object> event)

Drag event handler called when drag is completed (user releases mouse button).

Parameters:
draggableObject - Left nav draggable icon.
event - Mouse event.

onLeftNavDragStart

<static> void onLeftNavDragStart(<object> draggableObject, <object> event)

Drag event handler called when drag is initiated..

Parameters:
draggableObject - Left nav draggable icon.
event - Mouse event.

onWindowResize

<static> void onWindowResize()

Called on window resize to resize the leftnav's height.

preserveLeftNavCollapseState

<static> void preserveLeftNavCollapseState()

Save collapse state to the user portlet preferences.

preserveLeftNavSelectedTab

<static> void preserveLeftNavSelectedTab(index)

Save which tab has been selected to the server.

preserveLHSPosition

<static> void preserveLHSPosition(<String> configurationID, <int> xStartPosition, <int> xLastPosition)

Save the initial start position and last position of the left nav resize icon to the user portlet preferences.

Parameters:
configurationID - Portlet ID for left nav.
xStartPosition - Initial start position of left nav resize icon.
xLastPosition - Last position of the left nav resize icon.

refresh

<static> void refresh()

Refresh the LHS after flushing the server side caching

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.

release

<static> void release()

Releases tabs data structure.

setUserPreferences

<static> void setUserPreferences(<int> selectedTabIndex, <boolean> showLHS, <int> xLHSDragStart, <int> xLHSDragLast)

Set the left nav user portlet preferences.

Parameters:
selectedTabIndex - Index of the selected LHS tab.
showLHS - Boolean indicator of whether to display LHS in expanded or collapsed state.
xLHSDragStart - Initial right x coordinate position of LHS.
xLHSDragLast - Last resized resize x coordinate position of LHS.

showDragResize

<static> void showDragResize(<object> event)

Display drag resize icon.

Parameters:
event - Mouse event.

toggleTab

<static> void toggleTab(<int> index, preserve)

Toggles specified leftnav tab visible.

Parameters:
index - Index of tab to show.

unhighlightSelectedBranch

<static> void unhighlightSelectedBranch(thingID)

This function removes highlighting for the specified page id.