CAF Noodle JavaScript

Class Noodle.Portlet.Model

Object
   |
   +--Noodle.Model
         |
         +--Noodle.Portlet.Model
Direct Known Subclasses:
Noodle.Portlet.TempModel

class Noodle.Portlet.Model
extends Noodle.Model


Base noodle portlet model methods.
Defined in portlet.js


Constructor Summary
Noodle.Portlet.Model ()
           
 
Method Summary
<static> void _copyTo(pageID, name)
           Copy portlet to the specified page.
<static> void _del()
           Delete implementation.
<static> Object allowDragDrop(<object> cur, <Draggable> drag, <Droppable> drop)
           Returns true if this draggable is droppable.
<static> void attachResize()
           Attach drag-to-resize behavior to this portlet.
<static> void attachSelect()
           Attach click-to-select behavior to this portlet.
<static> void autoPosition()
           Make this portlet a hobo.
<static> void autoSize()
           Make this portlet auto-sized.
<static> Object canAddToHome()
           True if current user can add this portlet to user's home.
<static> Object canMaximize()
           True if current user can maximize this portlet.
<static> Object canMinimize()
           True if current user can minimize this portlet.
<static> Object canNormal()
           True if current user can restore this portlet's window state.
<static> void copyTo()
           Copy contents of the workspace picker to the page.
<static> Object createDraggable()
           Create noodle portlet draggable items.
<static> Object createMenuItems()
           Create noodle portlet menu items.
<static> void del()
           Deletes this portlet.
<static> void detachResize()
           Detach drag-to-resize behavior from this portlet.
<static> void detachSelect()
           Detach click-to-select behavior from this portlet.
<static> void drawBorder(<boolean> show)
           Shows/hides this portlet's border, but does not change the portlet's layout state (use setBordered() instead).
<static> void drawTitlebar(<boolean> show)
           Shows/hides this portlet's titlebar, but does not change the portlet's layout state (use setTitlebared() instead).
<static> void edit()
           Toggles portlet into edit mode.
<static> void editSubmit()
           Submits edit mode.
<static> Object editValidate()
           Validates edit mode.
<static> void float(<Position.Rect> rect)
           Makes this portlet absolutely positioned.
<static> Object getBody()
           Inner portlet content container.
<static> Object getBodyOrOther()
           Inner portlet content container, or whatever portlet panel is visible (like help mode or edit mode, etc.)
<static> Object getContainer()
           Outer portlet container.
<static> Object getContentURL(<boolean> resetState)
           Gets the async-content url for this portlet.
<static> Object getHorizontalPadding()
           Calculate's portlet's horizontal padding.
<static> Object getMenuCSS()
           Get noodle portlet menu CSS.
<static> Object getMode()
           Returns the current mode.
<static> Object getModes()
           List of modes the portlet has.
<static> Object getPage()
           Object model of this portlet's page.
<static> Object getPortletMode()
           Returns the current portlet-mode.
<static> Object getPortletModes()
           List the portlet-modes the portlet has.
<static> Object getPropertiesModeLabel(<string> mode)
           Localized label for specified mode.
<static> Object getPropertiesModes()
           List the properties-modes the portlet has.
<static> Object getScratchDbID()
           Calculate scratch thing's db id.
<static> Object getTitlebar()
           Portlet titlebar.
<static> Object getVerticalPadding()
           Calculate's portlet's vertical padding.
<static> Object getWindowState()
           Returns portlet's current window state ("normal", "minimized", or "maximized").
<static> Object getWiring(<string> name)
           Returns the thing wiring of the modeled object.
<static> Object hasMode(<string> mode)
           True if portlet has the specified mode.
<static> Object hasPortletMode(<string> mode)
           True if portlet has the specified portlet-mode.
<static> Object hasPropertiesMode(<string> mode)
           True if portlet has specified properties-mode.
<static> void help()
           Toggles portlet into help mode.
<static> void initialize()
           Initialize noodle portlet.
<static> Object isBordered()
           True if portlet's border is displayed.
<static> Object isFloated()
           True if this portlet is a floater.
<static> Object isMaximized()
           True if portlet is minimized.
<static> Object isMinimized()
           True if portlet is minimized.
<static> Object isPositioned()
           True if portlet has been manually positioned.
<static> Object isSized()
           True if portlet has been manually sized.
<static> Object isStyled()
           True if portlet has been manually styled.
<static> Object isTitlebared()
           True if portlet's titlebar is displayed.
<static> void layoutMode()
           Toggles portlet into layout mode.
<static> void layoutSubmit()
           Submits layout properties panel.
<static> void load()
           Further initializes portlet once page is loaded.
<static> void manualPosition()
           Find this portlet a home.
<static> void manualSize()
           Make this portlet manual-sized.
<static> void maximize()
           Maximizes this portlet's window.
<static> void metadataMode()
           Toggles portlet into metadata mode.
<static> void metadataSubmit()
           Submits metadata properties panel.
<static> Object metadataValidate()
           Validates metadata properties panel.
<static> void minimize()
           Minimizes this portlet's window.
<static> void normal()
           Restores this portlet's window.
<static> void onDragFinish(cur, drag)
           Called when the portlet finishes dragging.
<static> void onDragStart(cur, drag)
           Called when the portlet start to be dragged.
<static> void onExpertMode(<event> event)
           Handles expertMode changes for the this portlet.
<static> void onResizeFinish(<object> cur, <element> handle, <Position.Point> mouse)
           Handles onresizefinish event for this portlet.
<static> void onResizeStart(<object> cur, <element> handle, <Position.Point> mouse)
           Handles onresizestart event for this portlet.
<static> void onResizing(<object> cur, <element> handle, <Position.Point> mouse)
           Handles onresizing event for this portlet.
<static> void onUpdateContentSuccess(<string> html)
           Refreshes this portlet's content with the specified html.
<static> void onUpdateMetadata(<event> event)
           Handle update-metadata events for this portlet.
<static> void onUpdatePageLayout(<event> event)
           Handle update-page-layout events for this portlet.
<static> void onUpdateWiring(<event> event)
           Handle update-wiring events for this portlet.
<static> void permissions()
           Toogles portlet into permissions mode
<static> void properties()
           Toggles portlet into properties mode.
<static> void propertiesSubmit()
           Submits metadata properties panel.
<static> Object propertiesValidate()
           Validates metadata properties panel.
<static> Object recalculateContainerWidth()
           Recalculates whath the portlet's container width should be for the portlet's current body width.
<static> void release()
           Release noodle portlet data structures.
<static> void select(<boolean> scroll)
           Selects this portlet (makes it top-most, etc).
<static> void setBordered(<boolean> show)
           Shows/hides this portlet's border.
<static> void setFloated(<boolean> float)
           Floats/unfloats this portlet.
<static> void setMaximized(maximize)
           Maximizes/restores this portlet's window.
<static> void setMinimized(<boolean> minimize)
           Minimizes/restores this portlet's window.
<static> void setMode(<string> mode)
           Sets the current mode.
<static> void setPortletMode(<string> mode)
           Sets the current portlet-mode.
<static> void setPositioned(position)
           Flags this portlet as manually positioned.
<static> void setSized(<string> width, <string> height)
           Resizes this portlet.
<static> void setStyled(<string> cssClass, <string> cssStyle, <string> bgImg)
           Restyles this portlet.
<static> void setTitlebared(<boolean> show)
           Shows/hides this portlet's titlebar.
<static> void setWindowState(<string> state)
           Sets the portlet's window state ("normal", "minimized", or "maximized").
<static> void setWiring(<string> name, <Noodle.Portlet.WiredProperty> value)
           Sets the thing wiring of the modeled object.
<static> Object toggleMode(<string> mode)
           Hides div for current mode, and creates div for specified mode.
<static> void togglePosition()
           Toggles between auto- and manual-positioned.
<static> void toggleSize()
           Toggles between auto- and manual-sized.
<static> void unfloat(<element> cell)
           Makes this portlet positioned in a table.
<static> void updateContent(<boolean> resetState)
           Refreshes this portlet's content from the server.
<static> void updateTitlebar()
           Update freshly rendered titlebar with current titlebar state.
<static> void view()
           Toggles portlet into view mode.
<static> void wiringMode()
           Toggles portlet into wiring mode.
<static> void wiringSubmit()
           Submits wiring properties panel.

Constructor Detail

Noodle.Portlet.Model

Noodle.Portlet.Model()

Method Detail

_copyTo

<static> void _copyTo(pageID, name)

_del

<static> void _del()

allowDragDrop

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

attachResize

<static> void attachResize()

attachSelect

<static> void attachSelect()

autoPosition

<static> void autoPosition()

autoSize

<static> void autoSize()

canAddToHome

<static> Object canAddToHome()

canMaximize

<static> Object canMaximize()

canMinimize

<static> Object canMinimize()

canNormal

<static> Object canNormal()

copyTo

<static> void copyTo()

createDraggable

<static> Object createDraggable()

createMenuItems

<static> Object createMenuItems()

del

<static> void del()

detachResize

<static> void detachResize()

detachSelect

<static> void detachSelect()

drawBorder

<static> void drawBorder(<boolean> show)

drawTitlebar

<static> void drawTitlebar(<boolean> show)

edit

<static> void edit()

editSubmit

<static> void editSubmit()

editValidate

<static> Object editValidate()

float

<static> void float(<Position.Rect> rect)

getBody

<static> Object getBody()

getBodyOrOther

<static> Object getBodyOrOther()

getContainer

<static> Object getContainer()

getContentURL

<static> Object getContentURL(<boolean> resetState)

getHorizontalPadding

<static> Object getHorizontalPadding()

getMenuCSS

<static> Object getMenuCSS()

getMode

<static> Object getMode()

getModes

<static> Object getModes()

getPage

<static> Object getPage()

getPortletMode

<static> Object getPortletMode()

getPortletModes

<static> Object getPortletModes()

getPropertiesModeLabel

<static> Object getPropertiesModeLabel(<string> mode)

getPropertiesModes

<static> Object getPropertiesModes()

getScratchDbID

<static> Object getScratchDbID()

getTitlebar

<static> Object getTitlebar()

getVerticalPadding

<static> Object getVerticalPadding()

getWindowState

<static> Object getWindowState()

getWiring

<static> Object getWiring(<string> name)

hasMode

<static> Object hasMode(<string> mode)

hasPortletMode

<static> Object hasPortletMode(<string> mode)

hasPropertiesMode

<static> Object hasPropertiesMode(<string> mode)

help

<static> void help()

initialize

<static> void initialize()

isBordered

<static> Object isBordered()

isFloated

<static> Object isFloated()

isMaximized

<static> Object isMaximized()

isMinimized

<static> Object isMinimized()

isPositioned

<static> Object isPositioned()

isSized

<static> Object isSized()

isStyled

<static> Object isStyled()

isTitlebared

<static> Object isTitlebared()

layoutMode

<static> void layoutMode()

layoutSubmit

<static> void layoutSubmit()

load

<static> void load()

manualPosition

<static> void manualPosition()

manualSize

<static> void manualSize()

maximize

<static> void maximize()

metadataMode

<static> void metadataMode()

metadataSubmit

<static> void metadataSubmit()

metadataValidate

<static> Object metadataValidate()

minimize

<static> void minimize()

normal

<static> void normal()

onDragFinish

<static> void onDragFinish(cur, drag)

onDragStart

<static> void onDragStart(cur, drag)

onExpertMode

<static> void onExpertMode(<event> event)

onResizeFinish

<static> void onResizeFinish(<object> cur, <element> handle, <Position.Point> mouse)

onResizeStart

<static> void onResizeStart(<object> cur, <element> handle, <Position.Point> mouse)

onResizing

<static> void onResizing(<object> cur, <element> handle, <Position.Point> mouse)

onUpdateContentSuccess

<static> void onUpdateContentSuccess(<string> html)

onUpdateMetadata

<static> void onUpdateMetadata(<event> event)

onUpdatePageLayout

<static> void onUpdatePageLayout(<event> event)

onUpdateWiring

<static> void onUpdateWiring(<event> event)

permissions

<static> void permissions()

properties

<static> void properties()

propertiesSubmit

<static> void propertiesSubmit()

propertiesValidate

<static> Object propertiesValidate()

recalculateContainerWidth

<static> Object recalculateContainerWidth()

release

<static> void release()

select

<static> void select(<boolean> scroll)

setBordered

<static> void setBordered(<boolean> show)

setFloated

<static> void setFloated(<boolean> float)

setMaximized

<static> void setMaximized(maximize)

setMinimized

<static> void setMinimized(<boolean> minimize)

setMode

<static> void setMode(<string> mode)

setPortletMode

<static> void setPortletMode(<string> mode)

setPositioned

<static> void setPositioned(position)

setSized

<static> void setSized(<string> width, <string> height)

setStyled

<static> void setStyled(<string> cssClass, <string> cssStyle, <string> bgImg)

setTitlebared

<static> void setTitlebared(<boolean> show)

setWindowState

<static> void setWindowState(<string> state)

setWiring

<static> void setWiring(<string> name, <Noodle.Portlet.WiredProperty> value)

toggleMode

<static> Object toggleMode(<string> mode)

togglePosition

<static> void togglePosition()

toggleSize

<static> void toggleSize()

unfloat

<static> void unfloat(<element> cell)

updateContent

<static> void updateContent(<boolean> resetState)

updateTitlebar

<static> void updateTitlebar()

view

<static> void view()

wiringMode

<static> void wiringMode()

wiringSubmit

<static> void wiringSubmit()

CAF Noodle JavaScript

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