CAF Noodle JavaScript

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 Summary
Noodle.Page.Model ()
           
 
Method Summary
<static> Object addNear(<element> near, <function> addToColumn, <function> addAsFloater)
           Create container for new portlet.
<static> Object addPortlet(<string> portletID, <object> portlet, <element> near)
           Create a new portlet and add it to this page.
<static> Object addRow(<element> near)
           Create a new row and add it to this page.
<static> Object addTempPortlet(<object> portlet, <element> near)
           Create a new temp portlet and add it to this page.
<static> Object allowDrop(<object> cur, <Draggable> drag, <Droppable> drop)
           Returns true if draggable is droppable for this page.
<static> void attachPortletFinder()
           Attach this page's portlet finder to the portlet-finder link.
<static> Object canEdit(layout)
           True if current user can edit the page in any way (like moving portlets).
<static> Object canSave()
           True if current user can save changes to the page.
<static> void changesMode()
           Toggles page into changes mode.
<static> Object createDraggable()
           Create noodle page model draggable item.
<static> void detachPortletFinder()
           Detach this page's portlet finder from the portlet-finder link.
<static> void edit()
           Toggles portlet into edit mode.
<static> Object getGeneralLayoutPropertiesHTML(<string> pfx)
           Custom layout property-line html.
<static> Object getGrid(<boolean> calcRect)
           Builds a structure of rows, columns, and portlets representing the non-floating portlets on the page.
<static> Object getLayoutXML()
           Creates the new layout xml for this page.
<static> Object getMaximizedPortlet()
           The maximized portlet's model, or null, if no maximized portlet.
<static> Object getPage()
           Returns this page.
<static> Object getPortletFinderLink()
           Returns the portlet-finder link element.
<static> Object getPropertiesModeLabel(<string> mode)
           Localized label for specified mode.
<static> Object getPropertiesModes()
           List the properties-modes the portlet has.
<static> Object getRows()
           Array of all the "portlet-row" descendant divs in this page.
<static> void hidePortletFinder()
           Hide the portlet-finder menu.
<static> void initialize()
           Initialize noodle page model.
<static> Object isDirty()
           True if the page is dirty.
<static> Object isFreeForm()
           True if page is in free-form mode; false if page in columnar mode.
<static> void load()
           Loads this page.
<static> void minimizeAll()
           Minimize all portlets on this page.
<static> void onDrop(<object> cur, <Draggable> drag, <Droppable> drop)
           Handles ondrop event for this page.
<static> void onDropActivate(<object> cur, <Draggable> drag, <Droppable> drop)
           Handles ondragover event for this page.
<static> void onDropDeactivate(<object> cur, <Draggable> drag, <Droppable> drop)
           Handles ondragout event for this page.
<static> void onDropHover(<object> cur, <Draggable> drag, <Droppable> drop)
           Handles ondragmove event for this page.
<static> void onExpertMode(<string> mode, <string> oldMode)
           Handles expert-mode change.
<static> void onUpdateMetadata(<event> event)
           Handle update-metadata events for this page.
<static> Object parseLayoutXML(<string> xml)
           Parse a layout object from the specified xml.
<static> void propertiesMode()
           Toggles portlet into properties mode.
<static> void propertiesSubmit()
           Submits metadata properties panel.
<static> Object propertiesValidate()
           Validates metadata properties panel.
<static> void release()
           Releases page model data structures.
<static> void removeTemp()
           Removes temporary saved state of this page from user session.
<static> void requireScratch(<function> fn, <boolean> dirty)
           Executes the specified function once the scratch page has been created.
<static> void restoreAll()
           Restore (switch to normal from minimized or maximized) all portlets on this page.
<static> void revertAndReturn(<string> returnUrl)
           Reverts this page and redirects to returnUrl.
<static> void save()
           Saves this page.
<static> void saveAndReturn(<string> returnUrl)
           Saves this page and redirects to returnUrl.
<static> void saveAs()
           Displays a save-as dialog allowing the user to save this page as a new page.
<static> void saveTemp()
           Temporarily Saves this page to the user session.
<static> void setDirty(<boolean> dirty)
           Sets the page dirty/clean.
<static> void setLayout(layout)
           Set noodle page model layout.
<static> void showPortletFinder()
           Display the portlet-finder menu over the portlet-finder link.
<static> Object toggleMode(<string> mode)
           Hides div for current mode, and creates div for specified mode.
<static> void view()
           Toggles portlet into view mode.

Constructor Detail

Noodle.Page.Model

Noodle.Page.Model()

Method Detail

addNear

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

addPortlet

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

addRow

<static> Object addRow(<element> near)

addTempPortlet

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

allowDrop

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

attachPortletFinder

<static> void attachPortletFinder()

canEdit

<static> Object canEdit(layout)

canSave

<static> Object canSave()

changesMode

<static> void changesMode()

createDraggable

<static> Object createDraggable()

detachPortletFinder

<static> void detachPortletFinder()

edit

<static> void edit()

getGeneralLayoutPropertiesHTML

<static> Object getGeneralLayoutPropertiesHTML(<string> pfx)

getGrid

<static> Object getGrid(<boolean> calcRect)

getLayoutXML

<static> Object getLayoutXML()

getMaximizedPortlet

<static> Object getMaximizedPortlet()

getPage

<static> Object getPage()

getPortletFinderLink

<static> Object getPortletFinderLink()

getPropertiesModeLabel

<static> Object getPropertiesModeLabel(<string> mode)

getPropertiesModes

<static> Object getPropertiesModes()

getRows

<static> Object getRows()

hidePortletFinder

<static> void hidePortletFinder()

initialize

<static> void initialize()

isDirty

<static> Object isDirty()

isFreeForm

<static> Object isFreeForm()

load

<static> void load()

minimizeAll

<static> void minimizeAll()

onDrop

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

onDropActivate

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

onDropDeactivate

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

onDropHover

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

onExpertMode

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

onUpdateMetadata

<static> void onUpdateMetadata(<event> event)

parseLayoutXML

<static> Object parseLayoutXML(<string> xml)

propertiesMode

<static> void propertiesMode()

propertiesSubmit

<static> void propertiesSubmit()

propertiesValidate

<static> Object propertiesValidate()

release

<static> void release()

removeTemp

<static> void removeTemp()

requireScratch

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

restoreAll

<static> void restoreAll()

revertAndReturn

<static> void revertAndReturn(<string> returnUrl)

save

<static> void save()

saveAndReturn

<static> void saveAndReturn(<string> returnUrl)

saveAs

<static> void saveAs()

saveTemp

<static> void saveTemp()

setDirty

<static> void setDirty(<boolean> dirty)

setLayout

<static> void setLayout(layout)

showPortletFinder

<static> void showPortletFinder()

toggleMode

<static> Object toggleMode(<string> mode)

view

<static> void view()

CAF Noodle JavaScript

Documentation generated by JSDoc on Fri Sep 20 11:58:17 2013