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 Detail

Noodle.Portlet.Model

Noodle.Portlet.Model()

_copyTo

<static> void _copyTo(pageID, name)

Copy portlet to the specified page.

Parameters:
pageID - Page to copy to.
name - Portlet name.

_del

<static> void _del()

Delete implementation. Removes this portlet from canvas without confirmation.

allowDragDrop

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

Returns true if this draggable is droppable.

Parameters:
cur - Current drag operation data.
drag - Draggable object.
drop - Droppable object.

attachResize

<static> void attachResize()

Attach drag-to-resize behavior to this portlet.

attachSelect

<static> void attachSelect()

Attach click-to-select behavior to this portlet.

autoPosition

<static> void autoPosition()

Make this portlet a hobo.

autoSize

<static> void autoSize()

Make this portlet auto-sized.

canAddToHome

<static> Object canAddToHome()

True if current user can add this portlet to user's home.

Returns:
True if user can add to home.

canMaximize

<static> Object canMaximize()

True if current user can maximize this portlet.

Returns:
True if user can maximize.

canMinimize

<static> Object canMinimize()

True if current user can minimize this portlet.

Returns:
True if user can minimize.

canNormal

<static> Object canNormal()

True if current user can restore this portlet's window state.

Returns:
True if user can restore.

copyTo

<static> void copyTo()

Copy contents of the workspace picker to the page.

createDraggable

<static> Object createDraggable()

Create noodle portlet draggable items.

createMenuItems

<static> Object createMenuItems()

Create noodle portlet menu items.

del

<static> void del()

Deletes this portlet. (Not called "delete" because delete is a js keyword.)

detachResize

<static> void detachResize()

Detach drag-to-resize behavior from this portlet.

detachSelect

<static> void detachSelect()

Detach click-to-select behavior from this portlet.

drawBorder

<static> void drawBorder(<boolean> show)

Shows/hides this portlet's border, but does not change the portlet's layout state (use setBordered() instead).

Parameters:
show - True to show, false to hide (defaults to true).

drawTitlebar

<static> void drawTitlebar(<boolean> show)

Shows/hides this portlet's titlebar, but does not change the portlet's layout state (use setTitlebared() instead).

Parameters:
show - True to show, false to hide (default to true).

edit

<static> void edit()

Toggles portlet into edit mode.

editSubmit

<static> void editSubmit()

Submits edit mode.

editValidate

<static> Object editValidate()

Validates edit mode.

float

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

Makes this portlet absolutely positioned.

Parameters:
rect - New absolute positioning rectangle.

getBody

<static> Object getBody()

Inner portlet content container.

Returns:
DOM element.

getBodyOrOther

<static> Object getBodyOrOther()

Inner portlet content container, or whatever portlet panel is visible (like help mode or edit mode, etc.)

Returns:
DOM element.

getContainer

<static> Object getContainer()

Outer portlet container.

Returns:
DOM element.

getContentURL

<static> Object getContentURL(<boolean> resetState)

Gets the async-content url for this portlet.

Parameters:
resetState - True to kill page-flow state (defaults to true).

Returns:
Content url.

getHorizontalPadding

<static> Object getHorizontalPadding()

Calculate's portlet's horizontal padding.

Returns:
Padding in pixels.

getMenuCSS

<static> Object getMenuCSS()

Get noodle portlet menu CSS.

getMode

<static> Object getMode()

Returns the current mode.

Returns:
Current mode.

getModes

<static> Object getModes()

List of modes the portlet has.

Returns:
(Non-null) array of modes.

getPage

<static> Object getPage()

Object model of this portlet's page.

Returns:
Page model.

getPortletMode

<static> Object getPortletMode()

Returns the current portlet-mode.

Returns:
Current portlet-mode.

getPortletModes

<static> Object getPortletModes()

List the portlet-modes the portlet has.

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

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.

getScratchDbID

<static> Object getScratchDbID()

Calculate scratch thing's db id.

Returns:
Scratch db id (or thing's db id, if portlet doesn't have scratch portlet).

getTitlebar

<static> Object getTitlebar()

Portlet titlebar.

Returns:
DOM element.

getVerticalPadding

<static> Object getVerticalPadding()

Calculate's portlet's vertical padding.

Returns:
Padding in pixels.

getWindowState

<static> Object getWindowState()

Returns portlet's current window state ("normal", "minimized", or "maximized").

Returns:
Window state.

getWiring

<static> Object getWiring(<string> name)

Returns the thing wiring of the modeled object.

Parameters:
name - Name of wired property to get.

Returns:
Individual Noodle.Portlet.WiredProperty property, if name specified; all wired properties, if name not specified.

hasMode

<static> Object hasMode(<string> mode)

True if portlet has the specified mode.

Parameters:
mode - Mode (like "wiring").

Returns:
True if portlet has mode.

hasPortletMode

<static> Object hasPortletMode(<string> mode)

True if portlet has the specified portlet-mode.

Parameters:
mode - Portlet-mode ("view", "edit", or "help").

Returns:
True if portlet has portlet-mode.

hasPropertiesMode

<static> Object hasPropertiesMode(<string> mode)

True if portlet has specified properties-mode.

Parameters:
mode - Properties-mode (like "properties", "layout", "wiring", etc.).

Returns:
True if portlet has properties-mode.

help

<static> void help()

Toggles portlet into help mode.

initialize

<static> void initialize()

Initialize noodle portlet.

isBordered

<static> Object isBordered()

True if portlet's border is displayed.

Returns:
True if bordered.

isFloated

<static> Object isFloated()

True if this portlet is a floater.

Returns:
True if floater.

isMaximized

<static> Object isMaximized()

True if portlet is minimized.

Returns:
True if minimized.

isMinimized

<static> Object isMinimized()

True if portlet is minimized.

Returns:
True if minimized.

isPositioned

<static> Object isPositioned()

True if portlet has been manually positioned.

Returns:
True if positioned.

isSized

<static> Object isSized()

True if portlet has been manually sized.

Returns:
True if sized.

isStyled

<static> Object isStyled()

True if portlet has been manually styled.

Returns:
True if styled.

isTitlebared

<static> Object isTitlebared()

True if portlet's titlebar is displayed.

Returns:
True if titlebared.

layoutMode

<static> void layoutMode()

Toggles portlet into layout mode.

layoutSubmit

<static> void layoutSubmit()

Submits layout properties panel.

load

<static> void load()

Further initializes portlet once page is loaded.

manualPosition

<static> void manualPosition()

Find this portlet a home.

manualSize

<static> void manualSize()

Make this portlet manual-sized.

maximize

<static> void maximize()

Maximizes this portlet's window.

metadataMode

<static> void metadataMode()

Toggles portlet into metadata mode.

metadataSubmit

<static> void metadataSubmit()

Submits metadata properties panel.

metadataValidate

<static> Object metadataValidate()

Validates metadata properties panel.

minimize

<static> void minimize()

Minimizes this portlet's window.

normal

<static> void normal()

Restores this portlet's window.

onDragFinish

<static> void onDragFinish(cur, drag)

Called when the portlet finishes dragging.

onDragStart

<static> void onDragStart(cur, drag)

Called when the portlet start to be dragged.

onExpertMode

<static> void onExpertMode(<event> event)

Handles expertMode changes for the this portlet.

Parameters:
event - Event object.

onResizeFinish

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

Handles onresizefinish event for this portlet.

Parameters:
cur - Current resize operation data.
handle - Resize handle.
mouse - Mouse coords top, left point.

onResizeStart

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

Handles onresizestart event for this portlet.

Parameters:
cur - Current resize operation data.
handle - Resize handle.
mouse - Mouse coords top, left point.

onResizing

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

Handles onresizing event for this portlet.

Parameters:
cur - Current resize operation data.
handle - Resize handle.
mouse - Mouse coords top, left point.

onUpdateContentSuccess

<static> void onUpdateContentSuccess(<string> html)

Refreshes this portlet's content with the specified html.

Parameters:
html - Updated content.

onUpdateMetadata

<static> void onUpdateMetadata(<event> event)

Handle update-metadata events for this portlet.

Parameters:
event - Event.

onUpdatePageLayout

<static> void onUpdatePageLayout(<event> event)

Handle update-page-layout events for this portlet.

Parameters:
event - Event.

onUpdateWiring

<static> void onUpdateWiring(<event> event)

Handle update-wiring events for this portlet.

Parameters:
event - Event.

permissions

<static> void permissions()

Toogles portlet into permissions mode

properties

<static> void properties()

Toggles portlet into properties mode.

propertiesSubmit

<static> void propertiesSubmit()

Submits metadata properties panel.

propertiesValidate

<static> Object propertiesValidate()

Validates metadata properties panel.

recalculateContainerWidth

<static> Object recalculateContainerWidth()

Recalculates whath the portlet's container width should be for the portlet's current body width.

Returns:
Width in pixels.

release

<static> void release()

Release noodle portlet data structures.

select

<static> void select(<boolean> scroll)

Selects this portlet (makes it top-most, etc).

Parameters:
scroll - True to scroll portlet into view (defaults to false).

setBordered

<static> void setBordered(<boolean> show)

Shows/hides this portlet's border.

Parameters:
show - True to show, false to hide (defaults to true).

setFloated

<static> void setFloated(<boolean> float)

Floats/unfloats this portlet.

Parameters:
float - True to float (defaults to true).

setMaximized

<static> void setMaximized(maximize)

Maximizes/restores this portlet's window.

Parameters:
minimize - True to minimize, false to restore (defaults to true).

setMinimized

<static> void setMinimized(<boolean> minimize)

Minimizes/restores this portlet's window.

Parameters:
minimize - True to minimize, false to restore (defaults to true).

setMode

<static> void setMode(<string> mode)

Sets the current mode.

Parameters:
mode - Mode to make current.

setPortletMode

<static> void setPortletMode(<string> mode)

Sets the current portlet-mode.

Parameters:
mode - Portlet-mode to make current.

setPositioned

<static> void setPositioned(position)

Flags this portlet as manually positioned.

Parameters:
positioned - True to flag as positioned, false to flag as hobo (defaults to true).

setSized

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

Resizes this portlet.

Parameters:
width - New width.
height - New height.
size - True to size manually to current size, false to auto-size.

setStyled

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

Restyles this portlet.

Parameters:
cssClass - New css class.
cssStyle - New css style.
bgImg - New skin background-image.

setTitlebared

<static> void setTitlebared(<boolean> show)

Shows/hides this portlet's titlebar.

Parameters:
show - True to show, false to hide (default to true).

setWindowState

<static> void setWindowState(<string> state)

Sets the portlet's window state ("normal", "minimized", or "maximized").

Parameters:
state - Window state.

setWiring

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

Sets the thing wiring of the modeled object.

Parameters:
name - Name of wired property to set.
value - New value of the wired property.
map - Map of all wired properties.

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.

togglePosition

<static> void togglePosition()

Toggles between auto- and manual-positioned.

toggleSize

<static> void toggleSize()

Toggles between auto- and manual-sized.

unfloat

<static> void unfloat(<element> cell)

Makes this portlet positioned in a table.

Parameters:
cell - Table column to which to add this portlet.

updateContent

<static> void updateContent(<boolean> resetState)

Refreshes this portlet's content from the server.

Parameters:
resetState - True to kill page-flow state (defaults to true).

updateTitlebar

<static> void updateTitlebar()

Update freshly rendered titlebar with current titlebar state.

view

<static> void view()

Toggles portlet into view mode.

wiringMode

<static> void wiringMode()

Toggles portlet into wiring mode.

wiringSubmit

<static> void wiringSubmit()

Submits wiring properties panel.