Class Noodle

Object
   |
   +--Noodle

class Noodle

Defined in noodle.js

Field Detail

ALL

<static> Object ALL

{int} All right-bits.

ATTR

<static> Object ATTR

{int} Property not intended to be changed by end user.

BOOLEAN

<static> Object BOOLEAN

{int} Boolean data-type.

canvasMinHeight

<static> Object canvasMinHeight

{int} Minimum height for canvas in pixels.

canvasMinWidth

<static> Object canvasMinWidth

{int} Minimum width for canvas in pixels.

CLOB

<static> Object CLOB

{int} String (unbounded) data-type.

CONFIG

<static> Object CONFIG

{int} Property persisted per-portlet-type.

CONTENT

<static> Object CONTENT

{int} Property persisted per-portlet-instance.

contextPath

<static> Object contextPath

{string} Noode webapp context path.

CREATE_CONTAINER

<static> Object CREATE_CONTAINER

{int} Create-container right-bits.

CREATE_ITEM

<static> Object CREATE_ITEM

{int} Create-non-container right-bits.

CREATE_REFERENCE

<static> Object CREATE_REFERENCE

{int} Add-reference right-bits.

DATETIME

<static> Object DATETIME

{int} Date data-type.

DELETE

<static> Object DELETE

{int} Delete right-bits.

DELETE_REFERENCE

<static> Object DELETE_REFERENCE

{int} Remove-reference right-bits.

DISABLED

<static> Object DISABLED

{int} Portlet enabled.

ENABLED

<static> Object ENABLED

{int} Portlet enabled.

FLOAT

<static> Object FLOAT

{int} Real-number data-type.

HIDDEN

<static> Object HIDDEN

{int} Portlet enabled.

INTEGER

<static> Object INTEGER

{int} Integer data-type.

LONG

<static> Object LONG

{int} Long-integer data-type.

MODIFY

<static> Object MODIFY

{int} Update right-bits.

MODIFY_PERMISSION

<static> Object MODIFY_PERMISSION

{int} Change-permission right-bits.

MODIFY_REFERENCE

<static> Object MODIFY_REFERENCE

{int} Change-reference right-bits.

NONE

<static> Object NONE

{int} No right-bits.

PORTLET_MODIFY_PROP_USER

<static> Object PORTLET_MODIFY_PROP_USER

{int} modify user-scoped properties right-bits.

READ

<static> Object READ

{int} View right-bits.

RELATED_CHILDREN

<static> Object RELATED_CHILDREN

{int} Property is a related-child.

RELATED_CONTAINERS

<static> Object RELATED_CONTAINERS

{int} Property is a related-container.

requestScope

<static> Object requestScope

{string} Scope for ajax requests.

SESSION

<static> Object SESSION

{int} Property persisted per-session.

STRING

<static> Object STRING

{int} String (fixed-length) data-type.

SYSTEM

<static> Object SYSTEM

{int} Property defined by system at run-time.

USER

<static> Object USER

{int} Property persisted per-user.

Noodle

Noodle()

addModelAnnotator

<static> Object addModelAnnotator(<function> fn, key)

Registers a new model-annotator function, to be invoked every time a new noodle model is initialized.

Parameters:
fn - Function to invoke. Passed a single arg -- the initial model object; must return the annotated model object (which may be the same object as passed, or may be different).
key - Key to use to unregister the function (defaults to the function itself).

Returns:
True if key not found and function registered, false if key found already registered.

ancestor

<static> Object ancestor(element)

Returns the closest noodle model object for the specified id or html element.

Parameters:
element - Element id or dom element.

Returns:
Noodle model object or null.

baseModelAnnotator

<static> Object baseModelAnnotator(<Noodle.Model> m)

Base noodle model annotator.

Parameters:
m - Model to annotate.

Returns:
Annotated model.

can

<static> Object can(<int> needs, <int> has)

Returns true if the current user has the right bits she needs.

Parameters:
needs - Bits user needs.
has - Bits user has.

Returns:
True if user has the right bits she needs.

convert

<static> Object convert(<DataType> type, value)

Converts specified value to specified type.

Parameters:
type - Type to which to convert.
value - Value to convert.

Returns:
Converted value.

dispatchToModelMethod

<static> Object dispatchToModelMethod(<string> methodName)

Creates an event subscriber which dispatches to the specified method of the model for which the event was published.

Parameters:
methodName - Name of method on portlet model to call to handle event.

Returns:
Event subscriber function.

error

<static> void error(<string> err, <string[]> args)

Display error message for specified error id.

Parameters:
err - Error message id (from Noodle.RESOURCES).
args - Message arguments.

getExpertMode

<static> Object getExpertMode()

Editor expert-mode. Available modes are:

""

Non-expert mode.

"actions"

Display expert actions.

"view"

Display expert actions and expert view of page.

Returns:
Expert mode.

go

<static> void go(<string> url, options)

Opens the specified page.

Parameters:
url - URL of page to open.
options - Map of options.
method - HTTP method (defaults to "get").
parameters - Map of request parameters (ie post body; defaults to empty).
skipHistory - True to avoid a history entry with async page loading (defaults to false).

isLoadPagesAsync

<static> Object isLoadPagesAsync()

True if navigating loads pages asynchronously.

model

<static> Object model(x)

Builds the noodle model object for the specified id, html element, or initial object.

Parameters:
x - Element id, dom element, or initial object.

Returns:
Noodle model object or null.

release

<static> void release()

Clean up any data that needs to be cleared when editor is closed.

removeModelAnnotator

<static> Object removeModelAnnotator(key)

Unregisters an existing model-annotator function.

Parameters:
key - Key used originally to register the function.

Returns:
True if key found and function unregistered, false if nothing found to unregister.

setExpertMode

<static> void setExpertMode(<string> mode)

Editor expert-mode. Available modes are:

""

Non-expert mode.

"actions"

Display expert actions.

"view"

Display expert actions and expert view of page.

Parameters:
mode - Expert mode.

waitForDND

<static> void waitForDND(<function> fn)

Executes specified function if noodle drag-n-drop api is available now, or executes function when noodle drag-n-drop api becomes available.

Parameters:
fn - Function to execute.

warn

<static> void warn(<string> err, <string[]> args)

Display warning message for specified error id.

Parameters:
err - Error message id (from Noodle.RESOURCES).
args - Message arguments.