Class Noodle.Page.Model

Object
   |
   +--Noodle.Model
         |
         +--Noodle.Row.Model
               |
               +--Noodle.Page.Model

class Noodle.Page.Model

extends Noodle.Row.Model

Base noodle page model methods.
Defined in page.js

Constructor Detail

Noodle.Page.Model

Noodle.Page.Model()

addNear

<static> Object addNear(<element> near, <function> addToColumn, <function> addAsFloater)

Create container for new portlet.

Parameters:
near - Element near which to display new portlet.
addToColumn - Callback for creating container in a column.
addAsFloater - Callback for creating container as a floater.

Returns:
New container element.

addPortlet

<static> Object addPortlet(<string> portletID, <object> portlet, <element> near)

Create a new portlet and add it to this page.

Parameters:
portletID - ThingID of portlet to clone, or xtypeID of portlet to create.
portlet - Inital portlet model object; specify at least the "name" property.
near - Element near which to display new portlet.

Returns:
New portlet model.

addRow

<static> Object addRow(<element> near)

Create a new row and add it to this page.

Parameters:
near - Element near which to display new portlet.

Returns:
New row model.

addTempPortlet

<static> Object addTempPortlet(<object> portlet, <element> near)

Create a new temp portlet and add it to this page.

Parameters:
portlet - Inital portlet model object; specify at least the "name" property.
near - Element near which to display new portlet.

Returns:
New portlet model.

allowDrop

<static> Object allowDrop(<object> cur, <Draggable> drag, <Droppable> drop)

Returns true if draggable is droppable for this page.

Parameters:
cur - Current drag operation data.
drag - Daggable object.
drop - Page droppable object.

Returns:
True if draggable is allowed to be dropped on droppable.

attachPortletFinder

<static> void attachPortletFinder()

Attach this page's portlet finder to the portlet-finder link.

canEdit

<static> Object canEdit(layout)

True if current user can edit the page in any way (like moving portlets).

Returns:
True if user can edit.

canSave

<static> Object canSave()

True if current user can save changes to the page.

Returns:
True if user can save.

changesMode

<static> void changesMode()

Toggles page into changes mode.

createDraggable

<static> Object createDraggable()

Create noodle page model draggable item.

detachPortletFinder

<static> void detachPortletFinder()

Detach this page's portlet finder from the portlet-finder link.

edit

<static> void edit()

Toggles portlet into edit mode.

getGeneralLayoutPropertiesHTML

<static> Object getGeneralLayoutPropertiesHTML(<string> pfx)

Custom layout property-line html.

Parameters:
pfx - Id prefix.

Returns:
HTML.

getGrid

<static> Object getGrid(<boolean> calcRect)

Builds a structure of rows, columns, and portlets representing the non-floating portlets on the page.

Parameters:
calcRect - True to calculate the positioning rectangle for each row, column, and portlet.

Returns:
Structure like

[     { rect: { Noodle.Page.Model.left = 0; Noodle.Page.Model.top = 0; Noodle.Page.Model.right = 800; Noodle.Page.Model.bottom = 600;}, element: <div class="portal-page|portlet-row">, columns: [         { rect: { Noodle.Page.Model.left = 0; Noodle.Page.Model.top = 0; Noodle.Page.Model.right = 400; Noodle.Page.Model.bottom = 600;}, elemnent: <td class="portlet-column">, rows: [], portlets: [             { rect: { Noodle.Page.Model.left = 0; Noodle.Page.Model.top = 0; Noodle.Page.Model.right = 400; Noodle.Page.Model.bottom = 200;}, element: <div class="portlet-container"> },             { rect: { Noodle.Page.Model.left = 0; Noodle.Page.Model.top = 200; Noodle.Page.Model.right = 400; Noodle.Page.Model.bottom = 500;}, element: <div class="portlet-container"> }         ] },         { rect: { Noodle.Page.Model.left = 0; Noodle.Page.Model.top = 0; Noodle.Page.Model.right = 400; Noodle.Page.Model.bottom = 600;}, elemnent: <td class="portlet-column">, rows: [], portlets: [             { rect: { Noodle.Page.Model.left = 400; Noodle.Page.Model.top = 0; Noodle.Page.Model.right = 800; Noodle.Page.Model.bottom = 250;}, element: <div class="portlet-container"> }         ] }     ] } ]

getLayoutXML

<static> Object getLayoutXML()

Creates the new layout xml for this page.

Returns:
Layout XML string.

getMaximizedPortlet

<static> Object getMaximizedPortlet()

The maximized portlet's model, or null, if no maximized portlet.

Returns:
Portlet model or null.

getPage

<static> Object getPage()

Returns this page.

Returns:
This page.

getPortletFinderLink

<static> Object getPortletFinderLink()

Returns the portlet-finder link element.

Returns:
DOM element or null.

getPropertiesModeLabel

<static> Object getPropertiesModeLabel(<string> mode)

Localized label for specified mode.

Parameters:
mode - Mode.

Returns:
Localized mode label.

getPropertiesModes

<static> Object getPropertiesModes()

List the properties-modes the portlet has.

Returns:
(Non-null) array of properties-modes.

getRows

<static> Object getRows()

Array of all the "portlet-row" descendant divs in this page.

Returns:
Array of DOM elements.

hidePortletFinder

<static> void hidePortletFinder()

Hide the portlet-finder menu.

initialize

<static> void initialize()

Initialize noodle page model.

isDirty

<static> Object isDirty()

True if the page is dirty.

Returns:
True if page is dirty.

isFreeForm

<static> Object isFreeForm()

True if page is in free-form mode; false if page in columnar mode.

Returns:
True if page is free-form.

load

<static> void load()

Loads this page.

minimizeAll

<static> void minimizeAll()

Minimize all portlets on this page.

onDrop

<static> void onDrop(<object> cur, <Draggable> drag, <Droppable> drop)

Handles ondrop event for this page.

Parameters:
cur - Current drag operation data.
drag - Daggable object.
drop - Page droppable object.

onDropActivate

<static> void onDropActivate(<object> cur, <Draggable> drag, <Droppable> drop)

Handles ondragover event for this page.

Parameters:
cur - Current drag operation data.
drag - Daggable object.
drop - Page droppable object.

onDropDeactivate

<static> void onDropDeactivate(<object> cur, <Draggable> drag, <Droppable> drop)

Handles ondragout event for this page.

Parameters:
cur - Current drag operation data.
drag - Daggable object.
drop - Page droppable object.

onDropHover

<static> void onDropHover(<object> cur, <Draggable> drag, <Droppable> drop)

Handles ondragmove event for this page.

Parameters:
cur - Current drag operation data.
drag - Daggable object.
drop - Page droppable object.

onExpertMode

<static> void onExpertMode(<string> mode, <string> oldMode)

Handles expert-mode change.

Parameters:
mode - New mode.
oldMode - Old mode.

onUpdateMetadata

<static> void onUpdateMetadata(<event> event)

Handle update-metadata events for this page.

Parameters:
event - Event.

parseLayoutXML

<static> Object parseLayoutXML(<string> xml)

Parse a layout object from the specified xml.

Parameters:
xml - Layout xml (ie "").

Returns:
Layout structure (ie { row: { Noodle.Page.Model.r1 = 'rv1';}, columns: [ { Noodle.Page.Model.c1 = 'cv1';} ], portlets: { p: { Noodle.Page.Model.p1 = 'pv1';} } }).

propertiesMode

<static> void propertiesMode()

Toggles portlet into properties mode.

propertiesSubmit

<static> void propertiesSubmit()

Submits metadata properties panel.

propertiesValidate

<static> Object propertiesValidate()

Validates metadata properties panel.

release

<static> void release()

Releases page model data structures.

removeTemp

<static> void removeTemp()

Removes temporary saved state of this page from user session.

requireScratch

<static> void requireScratch(<function> fn, <boolean> dirty)

Executes the specified function once the scratch page has been created.

Parameters:
fn - Function to execute.
dirty - True to dirty page (defaults to true).

restoreAll

<static> void restoreAll()

Restore (switch to normal from minimized or maximized) all portlets on this page.

revertAndReturn

<static> void revertAndReturn(<string> returnUrl)

Reverts this page and redirects to returnUrl.

Parameters:
returnUrl - Url to redirect; defaults to returnUrl page parameter.

save

<static> void save()

Saves this page.

saveAndReturn

<static> void saveAndReturn(<string> returnUrl)

Saves this page and redirects to returnUrl.

Parameters:
returnUrl - Url to redirect; defaults to returnUrl page parameter.

saveAs

<static> void saveAs()

Displays a save-as dialog allowing the user to save this page as a new page.

saveTemp

<static> void saveTemp()

Temporarily Saves this page to the user session.

setDirty

<static> void setDirty(<boolean> dirty)

Sets the page dirty/clean.

Parameters:
dirty - True to dirty page, false to clean (defaults to true).

setLayout

<static> void setLayout(layout)

Set noodle page model layout.

showPortletFinder

<static> void showPortletFinder()

Display the portlet-finder menu over the portlet-finder link.

toggleMode

<static> Object toggleMode(<string> mode)

Hides div for current mode, and creates div for specified mode.

Parameters:
mode - New mode name.

Returns:
Div for new mode.

view

<static> void view()

Toggles portlet into view mode.